GatewayPay Documentation
  1. H2H flow
GatewayPay Documentation
  • GatewayPay API Documentation
  • Authentication
  • Callbacks
  • Testing
  • Domains and IP Addresses
  • Account
    • Get Account profile details
      GET
    • Get Account balances
      GET
    • Get Account payment options
      GET
  • H2H flow
    • Status List
    • Create Payment Invoice
      POST
    • Send Card Data to the Gateway
      POST
    • Full List of Payment Services
      GET
    • Get Service Data by ID
      GET
    • Check Status of Payment Invoice by ID
      GET
    • Get list of Payment Invoices
      GET
  • Refunds
    • Refund
      POST
  • Cards Whitelist API
    • JSON
      POST
    • CSV
      POST
  • APM - Deposits
    • Bank Transfers - Turkey
      POST
  • APM - Payouts
    • Bank Transfers - Turkey (Invoice Initiation)
      POST
    • Bank Transfers - Turkey (Invoice processing)
      POST
  1. H2H flow

Status List

Payment statuses#

Payment status defines the stage of transaction. The status can be transitional and final.
payment-status-flow2.png
Status codeFinalDescription
creatednoInvoice has been created; processing has not started. If GatewayPay does not return response 201 (Created) HTTP status code on your request, you should admit that the payment invoice creation was failed.
expiredyesInvoice hit the lifetime limit without successful processing.
process_pendingnoProcess still being unknown and may not be known for an extended period.
processedyes**Processed successfully. It isn't a final status since the payment can be refunded for different reasons.
process_failedyesProcessing has failed, may be set when an error occurs and the corresponding payment request has failed. This status is considered final due to the maximum number of attempts has been reached (default—after 5 attempts).
refund_pendingnoRefunding is still being unknown and may not be known for an extended period.
partially_refundedyesSuccessfully refunded amount is less than the invoice amount.
refundedyesSuccessfully refunded in full.
refund_failedyesRefunding has been failed or cannot be completed.
charged_backyesThe payment transaction was claimed as a chargeback in full amount.
partially_charged_backyesThe payment transaction was claimed as a chargeback but in amount less than the invoice amount.
** — The status is considered as final, but the payment can be rejected for additional reasons or recovered (in refund or chargeback cases).

Payment resolutions#

A resolution is a transaction status clarification.
With transitional and successful final statuses, the related resolutions have an ok code. With failed final status, the resolutions get one of the following codes:
Resolution codeDescription
okThe process completed successfully
antifraud_errorTransaction is blocked by the provider's firewall
auth_3ds_required3D-Secure verification is required for processing
auth_otp_requiredOTP verification is required for processing
auth_fatal_errorThe card authorisation failed
card_expiredThe card expired
card_3ds_enrolled3D-Secure verification is required for this card processing
card_blocked_by_invalid_pinThe card is blocked because of the incorrect PIN using
card_lostThe card is reported as lost
card_not_3ds_enrolledThe card doesn't support 3D-Secure verification
card_stolenThe card is reported as stolen
card_restrictedTransaction processing on this card are restricted
card_restricted_by_acquirerThe acquirer restricts transaction processing on this card
invalid_card_typeThe card type is invalid
card_usage_limit_violationThe card usage attempts limit is exceeded
card_usage_issuer_limit_violationThe card usage issuer limit is exceeded
card_verification_failedThe card verification failed
client_auth_failedThe client authorisation failed
customer_blockedThe customer isn't allowed to make this type of transactions
general_declineGeneral decline
transaction_expiredThe transaction expired
fatal_declineFatal decline
fatal_errorFatal transaction processing error
fatal_invalid_cardThe card is invalid and its re-using is forbidden
forced_capturedThe transaction process is finalised manually
insufficient_fundsInsufficient funds
invalid_3ds_codeInvalid 3D-Secure verification code
invalid_amountInvalid transaction amount
invalid_cardThe card is invalid
invalid_cardholderThe cardholder name is incorrect
invalid_cvvThe card CVV is incorrect
invalid_detailsThe transaction details are incorrect
invalid_expire_dateThe card expiry date is incorrect
invalid_otp_codeThe OTP verification code is incorrect
issuer_declineGeneral issuer decline
issuer_unavailableThe card issuer is unavailable
limit_violationThe card limit is exceeded
unable_determine_3ds_enrolmentUnable to determine the card 3D-Secure enrollment status
unknownUnknown error
The detailed level of the transaction's failure reason depends on the information openness of payment service providers (PSP) and issuer banks (for card transactions).
GatewayPay could expand the list of resolutions lately.
Receiving a resolution other than listed should not affect the transaction processing because this attribute only informs about possible errors.
The finality and success of the transaction processing are determined solely by the payment status (status).

Payment identifiers#

At different stages of the payment received, the identifiers are processed with different names. Check the relations between them in the diagram below.
payment-ids-linking.jpg
Receiver Reference Number (RRN) and Acquirer Reference Number (ARN) are used only for card payments identification.
Modified at 6 months ago
Previous
H2H flow
Next
Create Payment Invoice
Built with
On this page
Payment statuses
Payment resolutions
Payment identifiers