Retrieve Transactions
Request to retrieve transaction details in a WS API version-neutral format (version neutral with respect to the WS API version the transaction was submitted in) for transactions that have been created in the gateway within a defined start and end date/time.
You can limit the result list to transactions that
- have last been updated after a defined start date/time and before a defined end date/time and
- contain one or more specified fields.
For a successful request, the response will contain a list of transactions that match the criteria defined in the predicate query parameter. Where no transaction(s) match the criteria defined in the predicate, the response will be empty.
The response contains
- the transaction details in the WS API version-neutral format, and
- the complete RETRIEVE_TRANSACTION response as returned to the merchant when retrieving the transaction via the merchant WS API.
By default the response will contain all fields, however you can use the fields parameter in the request to limit which transaction and API fields are provided in the response.
For details refer to transaction reports integration documentation.
Note:
- Provide your Reporting API credentials to access this operation.
- The transactions in the result set are not ordered.
- The response provides a content length and MD5 check sum in the standard fields.
Authentication
This operation requires authentication via one of the following methods:
- Certificate authentication.
-
Basic HTTP authentication as described at
w3.org.
Provide 'MSO.
<your gateway MSO ID>' in the userid portion and your Reporting API password in the password portion.
Request
URL Parameters
Alphanumeric + additional characters
REQUIRED
The identifier that uniquely identifies you or an MSO that has authorized you to use this operation on their behalf.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.'
Min length: 1 Max length: 16Fields
To view the optional fields, please toggle on the "Show optional fields" setting.
String
OPTIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Data can consist of any characters
JSON Text
OPTIONAL
By default the response contains all transaction and API fields.
Use this parameter to limit the response to only the fields listed.
For a full description refer to transaction reports integration documentation.
Data is valid Json Format
Alphanumeric + additional characters
REQUIRED
For a response with a large number of transactions the response to your Retrieve Transactions request only returns a subset of transactions and an iterator (field iterator in the HTTP header).
Use the iterator in a subsequent request to retrieve the next set of transactions in the result set.
Where all transactions have been provided, the response will not contain an iterator.
For the full result set, combine the subsets of all responses for all iterators.
When providing an iterator you do not need to provide a predicate.
Data may consist of the characters 0-9, a-z, A-Z, '_', '-'
JSON Text
REQUIRED
The predicate allows you to define what transactions you would like to retrieve.
For a full description of the predicate structure and supported fields, see transaction reports integration documentation.
When providing a predicate you do not need to provide an iterator.
Data is valid Json Format
Response
Fields
To view the conditional fields, please toggle on the "Show conditional fields" setting.
String
CONDITIONAL
The ID of the acquirer settlement batch that contains the transaction.
String
CONDITIONAL
The unique identifier of the acquirer that has been used to process this transaction.
Which acquirer is used to process a transaction is determined by the gateway based on the merchant acquirer links configured for the merchant.
String
CONDITIONAL
The Acquirer Merchant Identifier (also known as Card Acceptor Identification Code or CAIC) allocated to the merchant by the acquirer.
String
CONDITIONAL
The transaction processing response code (indicating the success or otherwise of the transaction) as provided by the aqcuirer or other provider, for example, PayPal, ACH, Sofortbanking.
String
CONDITIONAL
The textual description of the response code that indicates the result of the transaction as provided by the acquirer or other provider, for example, PayPal, ACH, Sofortbanking.
Date
CONDITIONAL
The date the acquirer expects the funds to be transferred to (in the case of payments) or from (in the case of refunds) the merchant's account.
The date is defined in the acquirer's time zone (see acquirerTimeZone).
String
CONDITIONAL
The terminal configured at the acquirer used to process the transaction (as provided by the acquirer).
String
CONDITIONAL
The acquirer's time zone associated with the settlement date for the transaction (see acquirerSettlementDate).
String
CONDITIONAL
The identifier used in the communication between the merchant and the acquirer to identify the transaction.
For example, this could be the RRN, the order ID or an identifier issued by the gateway (often based on the merchant ID, order ID and/or transaction ID). The acquirer may, for example, use this identifier in Settlement Reports for card payments or Exception Detail Reports for ACH.
String
CONDITIONAL
The record locator used to access a specific Passenger Name Record (PNR).
The PNR is a record in the database of a booking system that contains the itinerary for a passenger, or a group of passengers traveling together.
Array
CONDITIONAL
String
CONDITIONAL
The 2-character IATA airline code of the airline carrier for the trip leg.
String
CONDITIONAL
The ticket containing the coupon for this leg for an itinerary with more than four trip legs.
String
CONDITIONAL
The coupon number on the ticket for the trip leg.
Each trip leg requires a separate coupon. The coupon within the series is identified by the coupon number.
String
CONDITIONAL
The 3-character IATA airport code of the departure airport for the trip leg.
Date
CONDITIONAL
The date of departure for the trip leg.
Time
CONDITIONAL
The departure time in local time for the departure airport for this trip leg.
String
CONDITIONAL
The 3-character IATA airport code for the destination airport for the trip leg.
Date
CONDITIONAL
The arrival date in local time for the destination airport for this trip leg
Time
CONDITIONAL
The arrival time in local time for the destination airport for this trip leg.
String
CONDITIONAL
The restrictions (e.g. non-refundable) or endorsements applicable to the trip leg.
String
CONDITIONAL
The new ticket number issued when a ticket is exchanged for the trip leg.
Money
CONDITIONAL
The total fare payable for the trip leg.
The field includes both the amount and currency.
String
CONDITIONAL
The code defining the rules forming the basis of the fare (type of fare, class entitlement, etc.)
Money
CONDITIONAL
The total fees payable for the trip leg.
The field includes both the amount and currency.
String
CONDITIONAL
The flight number for the trip leg
Boolean
CONDITIONAL
An indicator if a stopover is permitted for the trip leg.
Money
CONDITIONAL
The total amount of taxes payable for the trip leg.
The field includes both the amount and currency.
String
CONDITIONAL
The industry code indicating the class of service (e.g. Business, Coach) for the leg.
Array
CONDITIONAL
String
CONDITIONAL
The Frequent Flyer or Loyalty Program number for this passenger.
String
CONDITIONAL
The name of the passenger to whom the ticket is being issued, including the title, first, middle and last name.
Date
CONDITIONAL
The date the ticket was issued.
String
CONDITIONAL
The industry code of the travel agent issuing the ticket.
String
CONDITIONAL
The airline ticket number associated with the transaction.
Money
CONDITIONAL
The amount by which the original authorization amount was adjusted.The original authorized amount was increased (positive value) or decreased (negative value) by this amount.
The field includes both the amount and currency.
String
CONDITIONAL
A value generated by the issuing bank for a successful Authorization request.
This value must be provided when submitting subsequent Capture transactions to the acquirer to identify the Authorization.
String
CONDITIONAL
A response code for the Address Verification Service (AVS) result generated by the card issuing institution as provided by the acquirer.
Enumeration
CONDITIONAL
A response code for the Address Verification Service (AVS) validation result generated by the gateway indicating whether the billing address details provided by the payer matched the billing address details held by the cardholder's issuing bank.
Value must be a member of the following list. The values are case sensitive.
MATCH
The address details provided matched with the address details at the issuer.
NOT_VERIFIED
The address details provided were not verfied.
NO_MATCH
None of the address details provided matched with the address details at the issuer.
PARTIAL_MATCH
Some of the address details provided matched with the address details at the issuer.
String
CONDITIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
String
CONDITIONAL
A response code for the Card Security Code (CSC) validation result generated by the card issuing institution as provided by the acquirer.
Enumeration
CONDITIONAL
A response code for the Card Security Code (CSC) validation result generated by the gateway indicating whether the CSC provided by the payer matched the CSC data held by the cardholder's issuing bank.
Value must be a member of the following list. The values are case sensitive.
MATCH
The Card Security Code (CSC) provided is valid and matches the one on the card.
NOT_PRESENT
The merchant indicated that no Card Security Code (CSC) was present on the card.
NOT_VERIFIED
The Card Security Code (CSC) provided was not verified.
NO_MATCH
The Card Security Code (CSC) provided is either invalid or did not match the one on the card.
Enumeration
CONDITIONAL
The format used to represent the transaction as understood by the merchant.
For example, Web Service.
Value must be a member of the following list. The values are case sensitive.
FLEXIBLE_FORMAT
The transaction was provided in the FlexibleFormat format.
VPC_M
The transaction was provided in the VPC-M format.
VPC_T
The transaction was provided in the VPC-T format.
WEB_SERVICE
The transaction was provided in the WebService format.
Date
CONDITIONAL
The date before which necessary action needs to be taken by the merchant to avoid funds from being debited from their account for a disptuted transaction.
Enumeration
CONDITIONAL
The step in the dispute management process that triggered this transaction.
Value must be a member of the following list. The values are case sensitive.
ACTION_REQUIRED
An action from the merchant is required.
CHARGEBACK_DEBITED
The chargeback amount will soon be debited to the merchant's account.
CHARGEBACK_PENDING
The chargeback amount will soon be debited to the merchant's account. The merchant should ensure there are sufficient funds in the account.
CHARGEBACK_REVERSED
The chargeback amount that was previously debited has been credited back to the merchant's account.
INFORMATION_ONLY
Information about the status of the dispute is provided.
INFORMATION_RECEIVED
The acquirer has received information requested from the merchant.
INFORMATION_REQUESTED
The issuer has requested additional information about a disputed transaction.
RECURRING_PAYMENT_CANCELLED
The payer has disputed a recurring payment transaction and it is cancelled. For example, the recurring payment amount was more than agreed.
Date
CONDITIONAL
The date of the event in the dispute management process described by transaction.dispute.event.
String
CONDITIONAL
Additional information about the dispute event.
The terms used here will reflect the terms used by the acquiring bank.
String
CONDITIONAL
A description of why the transaction is disputed.
String
CONDITIONAL
The code provided by the acquirer to indicate the reason for the chargeback.
Date
CONDITIONAL
The date the payer notified the issuer to cancel a recurring payment that is being disputed.
Enumeration
CONDITIONAL
The code generated by the gateway that provides more details for a payment where the result indicates that a failure occurred during processing of the transaction.
Value must be a member of the following list. The values are case sensitive.
APPROVED
The transaction has been approved.
AUTHENTICATION_IN_PROGRESS
The operation determined that payer authentication is possible for the given card, but this has not been completed, and requires further action by the merchant to proceed.
BLOCKED
The transaction has been blocked as a result of a risk assessment.
CANCELLED
The transaction has been cancelled by the payer.
DECLINED_HARD
The transaction has been declined by the issuer, acquirer or other Payment Service Provider. The merchant must ask the payer for another set of payment details.
DECLINED_SOFT
The transaction has been declined by the issuer, acquirer or other Payment Service Provider. The problem might be resolved by retrying the request later (e.g. for insufficient funds the merchant may contact the payer and retry once the payer has indicated that fundsa r now available).
NOT_SUPPORTED
The transaction request could not be processed. Reasons include the requested functionality not being supported by the acquirer, missing request fields that are mandatory for the acquirer, and failed acquirer-specific validation. A later retry will not succeed.
PARTIALLY_APPROVED
The transaction has been approved, however the approved transaction amount differs from the requested transaction amount.
PENDING_RESPONSE
The gateway has not yet received a response from the acquirer or other Payment Service Provider (e.g. PayPal) about the status of the transaction.
PENDING_SETTLEMENT
The gateway has accepted the transaction and either has not yet submitted it to the acquirer for settlement, submitted it to the acquirer for settlement but has not yet received a response from the acquirer, or has received a response from the acquirer but not yet updated the status of the transaction.
PROCESSING_ERROR
The transaction could not be processed, as a technical error occurred during processing of the transaction. This includes acquirer system errors, gateway internal errors, connectivity issues etc. A later retry attempt may succeed.
REFERRED
The transaction has been delined and the merchant is asked to contact the issuer. The issuer may provide the merchant with an Authorization Code that will allow the merchant to subsequently capture the funds for the transaction.
UNSPECIFIED_FAILURE
The transaction request could not be processed. The gateway does not know if the transaction was successful or not. Reasons include merchant requests that cannot be processed due to a gateway internal error, the gateway being unable to retrieve a response from the acquirer (after exhausting all retry or reversal attempts), and a response from the acquirer that is not understood by the gateway. The merchant needs to contact their acquirer.
String
CONDITIONAL
The name of the batch file, uploaded by the merchant to the gateway, that contains this transaction.
String
CONDITIONAL
The unique identifier of the merchant that has submitted this order for processing by the gateway.
String
CONDITIONAL
The merchant's reference for this order if it differs from the unique order ID used by the gateway.
For example, when the merchant supports multiple payments on a single order, rolls their order identifier or where the order ID is provided by an alternate system. For example, the system used by the sub-merchant of an aggregator. This identifier may not be unique for all orders for the merchant in the gateway.
Enumeration
CONDITIONAL
Indicates the channel through which the transaction was initiated by the payer, for example, Internet or Card Present.
Value must be a member of the following list. The values are case sensitive.
CARD_PRESENT
The payer initiated the order in a scenario where the payment instrument (e.g. the credit card) was physically presented.
INTERNET
The payer initiated the order via the Internet. This applies to online orders and all e-commerce scenarios.
MERCHANT
The merchant initiated the order based on an agreement with the payer.
MOTO
The payer initiated the order by mail or telephone, including Call Center interactions.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the merchant.
SCHEDULED
The payment is a scheduled payment that was triggered by a recurring payment agreement between the payer and the merchant.
SERVICE_PROVIDER
The transaction was provided by a service provider (e.g. chargeback, funding).
VOICE_RESPONSE
The payer initiated the order via an Interactive Voice Response (IVR) system.
Money
CONDITIONAL
The amount of the transaction in the currency the merchant uses for their inventory.
This is typically derived from the rate quote and the payer amount for the transaction.
String
CONDITIONAL
Additional data of interest to the Multi-Currency Pricing (MCP) service provider.
String
CONDITIONAL
The unique identifier for this order.
String
CONDITIONAL
DEPRECATED This code may be returned by the acquirer for a failed recurring transaction (also known as Merchant Advice Code or Recurring Payment Advice Cancellation.
Enumeration
CONDITIONAL
DEPRECATED The response code generated by the gateway to indicate what action you should take for a failed recurring transaction.
A value can be provided if the information is provided by the acquirer.
Value must be a member of the following list. The values are case sensitive.
OBTAIN_NEW_ACCOUNT_INFORMATION
The merchant may attempt this transaction again with updated account information. This may indicate for example that the card has expired, that the account has been upgraded or a new card number has been issued.
SEEK_OTHER_PAYMENT_METHOD
The merchant must not attempt this transaction again. This payer may wish to continue with the recurring payment agreement, however, the merchant must obtain another source for this payment from the payer.
STOP_RECURRING_PAYMENT
The merchant must not attempt this transaction again. The payer has requested that this payment, all recurring payments for the merchant, or all recurring payments for this card are stopped.
TRY_AGAIN_LATER
The merchant may attempt this transaction again (with same account information).
JSON Text
CONDITIONAL
The response returned to the merchant when they retrieve this transaction using the WS API RETRIEVE_TRANSACTION operation.
This response is provided in the WS API version used by the merchant when submitting the transaction for processing via the gateway.
Response parameters are the same as Transaction: Retrieve Transaction. Note that the link refers to the latest API version.
Data is valid Json Format
String
CONDITIONAL
The gateway's unique identifier for the transaction provided to the acquirer.
Also called Reference Retrieval Number (RRN).
String
CONDITIONAL
The System Trace Audit Number (STAN) assigned by the gateway to assist in identifying the transaction when communicating with the acquirer.
It remains unchanged for the life of the transaction.
Enumeration
CONDITIONAL
The payer authentication status for this transaction.
For example, payer authentication performed using 3DS version 1, EMV 3DS, or RuPay PaySecure.
Value must be a member of the following list. The values are case sensitive.
AUTHENTICATION_ATTEMPTED
Payer authentication was attempted and a proof of authentication attempt was obtained.
AUTHENTICATION_AVAILABLE
Payer authentication is available for the payment method provided, but has not yet been performed.
AUTHENTICATION_EXEMPT
An exemption from the Regulatory Technical Standards (RTS) requirements for Strong Customer Authentication (SCA) under the Payment Services Directive 2 (PSD2) regulations in the European Economic Area has been claimed or granted.
AUTHENTICATION_FAILED
The payer was not authenticated. The merchant should not proceed with this transaction.
AUTHENTICATION_NOT_AVAILABLE
The payer was not able to be authenticated due to a technical or other issue.
AUTHENTICATION_NOT_IN_EFFECT
There is no authentication information associated with this transaction.
AUTHENTICATION_NOT_SUPPORTED
The requested authentication method is not supported for this payment method.
AUTHENTICATION_PENDING
Payer authentication is pending completion of a challenge process.
AUTHENTICATION_PROCESSING_ERROR
Payer authentication could not be performed because of a processing error.
AUTHENTICATION_REJECTED
The payment method provider (for example, the card issuer) rejected the authentication request and requested that the merchant does not attempt authorization of a payment.
AUTHENTICATION_REQUIRED
Payer authentication is required for this payment, but was not provided.
AUTHENTICATION_SUCCESSFUL
The payer was successfully authenticated.
String
CONDITIONAL
The Electronic Commerce Indicator (ECI) for the transaction, as returned by the issuer in the 3-D Secure Authentication response.
The ECI is an indicator for the authentication result and liability shift.
Enumeration
CONDITIONAL
An indicator for the card used for this transaction being enrolled in 3-D Secure Authentication.
Value must be a member of the following list. The values are case sensitive.
AUTHENTICATION_AVAILABLE
Payer authentication is available for the payment method provided, but has not yet been performed.
AUTHENTICATION_EXEMPT
An exemption from the Regulatory Technical Standards (RTS) requirements for Strong Customer Authentication (SCA) under the Payment Services Directive 2 (PSD2) regulations in the European Economic Area has been claimed or granted.
AUTHENTICATION_NOT_SUPPORTED
The requested authentication method is not supported for this payment method.
AUTHENTICATION_PENDING
Payer authentication is pending completion of a challenge process.
AUTHENTICATION_REJECTED
The payment method provider (for example, the card issuer) rejected the authentication request and requested that the merchant does not attempt authorization of a payment.
AUTHENTICATION_REQUIRED
Payer authentication is required for this payment, but was not provided.
ENROLLED
The card is enrolled for 3-D Secure Authentication.
ENROLLMENT_PROCESSING_ERROR
An error occurred when attempting to determine if the card is enrolled for 3-D Secure Authentication.
ENROLLMENT_UNDETERMINED
The card issuer's Access Control Server (ACS) was unable to process the request to determine if the card is enrolled for 3-D Secure Authentication.
NOT_ENROLLED
The card is not enrolled for 3-D Secure Authentication.
String
CONDITIONAL
The name of the account holder for the account used to pay for the transaction.
Depending on the payment type, this can be the name of the card or the name registered with a PayPal account or a bank account.
String
CONDITIONAL
The identifier of the account used by the payer to pay for this transaction.
Depending on the payment type, this can be a card number, PayPal email address or bank identifier and account number.
Enumeration
CONDITIONAL
The way by which the account identifier used for this transaction entered the gateway.
For example, transaction details were provided in a batch file. This matches the PCI boundary for the gateway.
Value must be a member of the following list. The values are case sensitive.
BATCH
The account identifier was provided by the merchant in a request submitted within a Batch.
CHECKOUT
The account identifier was provided by the payer on a Checkout page provided by the gateway. The Checkout page was launched from the merchant's website.
CLIENT_API
The account identifier was provided in a request submitted by the merchant via a client-side API, for example, Payment Client.
EXTERNAL_TOKEN
The account identifier was provided by providing a token issued by an external token provider.
GATEWAY_TOKEN
The account identifier was provided by providing a token issued by the gateway.
NOT_PROVIDED
No information is available about how the account identifier entered the gateway.
PHYSICAL_TERMINAL
The account identifier was provided by the payer at a physical terminal, for example, a POS terminal or PED.
SERVER_API
The account identifier was provided by the merchant in a request submitted via a server-side API, for example, Web Service API or a 2-Party VPC integration.
SERVICE_PROVIDER_API
The account identifier was imported into the gateway by a service provider using an API provided
VIRTUAL_TERMINAL
The account identifier was provided by the merchant when creating the order via virtial terminal, for example Merchant Administration.
WALLET
The account identifier was provided by the payer using a wallet, for example, MasterPass.
Enumeration
CONDITIONAL
The way by which the account identifier was entered for Card Present transactions.
Value must be a member of the following list. The values are case sensitive.
CONTACT
The card details were read from a card that was inserted into a PED, e.g. Chip read and PIN entered by payer.
CONTACTLESS
The card details were read via a contactless payment at a PED.
KEYED
The merchant keyed the card details into a PED.
SCANNED
The card details were scanned, for example via a OCR/MICR code reader.
SWIPED
The card was swiped at a PED.
UNKNOWN
It is unknown how the card details were entered.
String
CONDITIONAL
A value that uniquely identifies the account identifier for a transaction.
It can be used as a proxy to match transactions with the same account identifier, when the unmasked account identifier is not available (e.g. for PCI reasons).
Enumeration
CONDITIONAL
The Standard Entry Class (SEC) code as defined by NACHA, describing the origin and intent of the payment.
For details refer to https://www.nacha.org/.
Value must be a member of the following list. The values are case sensitive.
ARC
An ACH Debit entry based on a paper check remitted by US Mail or a drop box and converted into an electronic payment. May be used for B2C and B2B payments.
BOC
An ACH Debit entry created when a paper check written at point of sale and converted into an electronic payment through back office processing. May be used for B2C and B2B payments.
CCD
An ACH Debit or ACH Credit entry created by an organization for B2B payments. The customer authorizes the organization to make a debit or credit transaction against their account.
POP
An ACH Debit entry based on a paper check presented at the point of purchase. The paper check is used solely as a source document for routing and account number information. The merchant voids the paper check and returns it to the customer along with a POP receipt. Used for B2C and B2B payments.
PPD
An ACH debit or credit payment (B2C) that has been authorized by an authenticated customer in written form (signed or similarly authenticated). PPD is used for pre-arranged payments (e.g. employee payroll, mortgage payments, expense reimbursement).
RCK
An ACH Debit entry used to re-present a paper check that was originally unpaid. For example, when the check was originally presented insufficient funds were in the account or the account had uncollected (inaccessible) funds.
TEL
An ACH debit payment (B2C) that has been authorized by an authenticated customer via phone. TEL may only be used if a relationship already exists between the merchant and the consumer, or, the consumer initiates the contact with the merchant.
WEB
An ACH debit payment (B2C) that has been authorized by an authenticated customer via the internet or a wireless network.
Money
CONDITIONAL
The total amount for this transaction.
For a partially approved transaction this amount is the approved amount. The field includes both the amount and currency.
Enumeration
CONDITIONAL
The type of authentication performed for the transaction.
For example 3DS version 1, EMV 3DS, or RuPay PaySecure.
Value must be a member of the following list. The values are case sensitive.
3DS1
The payer has been authenticated using 3-D Secure Authentication Version 1.
EMV_3DS
The payer has been authenticated using EMV 3DS (also called 3-D Secure Authentication Version 2.0)
NONE
Payer Authentication has not been performed for this order.
RUPAY_PAYSECURE
The payer has been authenticated using RuPay PaySecure.
Enumeration
CONDITIONAL
The type of the bank account used for this transaction, e.g. Savings or Checking.
Value must be a member of the following list. The values are case sensitive.
CHECKING
The payer has selected a Checking account.
CORPORATE_CHECKING
The payer has selected a Corporate Checking account.
SAVINGS
The payer has selected a Savings account.
String
CONDITIONAL
The internationally recognized identifier for the payer's bank (also known as Bank Identifier Code or BIC).
String
CONDITIONAL
The identifier for the payer's bank as used in that country.
Enumeration
CONDITIONAL
The method of encryption used for the card number, as received by the gateway.
Value must be a member of the following list. The values are case sensitive.
DEVICE
A device encrypted the payment details.
DIGITAL_WALLET
A digital wallet encrypted the payment details.
DUKPT
Derived Unique Key Per Transaction (DUKPT)
String
CONDITIONAL
The expiry date for the card used for this transaction as printed on the card in the format MM/YY.
Enumeration
CONDITIONAL
The method used by the payer to provide the funds for the payment, e.g. Credit or Debit.
Value must be a member of the following list. The values are case sensitive.
CREDIT
The payer has a revolving line of credit with the issuer.
DEBIT
Funds are immediately debited from the payer's account with the issuer.
UNKNOWN
The account funding method could not be determined by the gateway.
Enumeration
CONDITIONAL
Indicates how Dynamic Currency Conversion (DCC) was used for this transaction.
For example, offer accepted or offer declined.
Value must be a member of the following list. The values are case sensitive.
ACCEPTED
DCC was offered to the payer and the payer accepted the offer and is paying in the currency of their card (instead of the currency of the transaction). The conditions of the DCC offer are applied in the processing of this transaction.
DECLINED
DCC was offered to the payer but the payer declined the offer and is paying in the currency of the transaction.
NOT_AVAILABLE
DCC was not offered to the payer. However, a DCC rate quote was requested for this payment, but no DCC offer was provided by the DCC provider.
NOT_REQUIRED
DCC is not required for this transaction.
Money
CONDITIONAL
The transaction amount in the payer's currency when Dynamic Currency Conversion (DCC) was used to convert the amount to the merchant's currency at the point of sale.
The field includes both the amount and currency.
Numeric
CONDITIONAL
The exchange rate used to convert the transaction amount into the payer's currency.
This rate includes the foreign exchange markup.
Enumeration
CONDITIONAL
The name of the Dynamic Currency Conversion (DCC) provider that provided the DCC rate quote.
Value must be a member of the following list. The values are case sensitive.
FEXCO
The FEXCO Dynamic Currency Conversion (DCC) provider.
FTT
The FTT Dynamic Currency Conversion (DCC) provider.
GLOBAL_PAYMENTS
The Global Payments Dynamic Currency Conversion (DCC) provider.
IBM
The IBM Dynamic Currency Conversion (DCC) provider.
TRAVELEX_CURRENCY_SELECT
The Travelex Currency Select Dynamic Currency Conversion (DCC) provider.
UNICREDIT
The Unicredit Dynamic Currency Conversion (DCC) provider.
Money
CONDITIONAL
The total fee amount debited from the merchant's bank account for the transaction as reported to the gateway by the acquirer.
The field includes both the amount and currency.
Enumeration
CONDITIONAL
Indicates where this transaction occurs within a sequence of payments agreed between the payer and the merchant.
For example, an installment payment, a one-off payment, or a recurring payment.
Value must be a member of the following list. The values are case sensitive.
INSTALLMENT
A transaction where the payer has authorized the merchant to deduct an agreed number of installments.
OTHER
A transaction where the payer has authorized the merchant to deduct funds for a payment, for any purpose other than processing recurring, installment, or unscheduled payments. For example, split tender payments.
RECURRING
A transaction where the payer has authorized the merchant for recurring payments, e.g. subscriptions or recurring invoices for services.
SINGLE
A transaction where the payer has authorized the merchant for a single (one off) payment. This value is also used for the first payment in a series of recurring or installment payments.
UNSCHEDULED
A transaction where the payer has authorized the merchant to deduct funds for a payment for an agreed purchase when required (unscheduled). For example, auto top-ups when the account value falls below a threshold.
Array
CONDITIONAL
String
CONDITIONAL
The fee name as provided by the service provider.
Money
CONDITIONAL
The fee amount charged to the merchant for the given fee type.
The field includes both the amount and currency.
Date
CONDITIONAL
The date the fees are debited from the merchant's bank account (defined in the acquirer's time zone).
This value is only populated if the date is known with certainty.
Date
CONDITIONAL
The date the acquirer estimates that the fees are being debited from the merchant's bank account (defined in the acquirer's time zone).
This value is only populated if neither the initiated date nor the actual date the funds are debited are available.
Date
CONDITIONAL
The date the acquirer estimates that the fees are being debited from the merchant's bank account (defined in the acquirer's time zone).
This value is only populated if neither the initiated date nor the actual date the funds are debited are available.
String
CONDITIONAL
The rate (percentage) applied to the transaction amount to determine the fee amount charged to the merchant for the given fee type.
Enumeration
CONDITIONAL
The gateway category for the fee that has been charged to the merchant.
Value must be a member of the following list. The values are case sensitive.
CHARGEBACK_FEE
Fees associated with Chargeback transactions.
FUNDING_FEE
Fees associated with transferring the money into the merchant's account.
MERCHANT_FEE
Fees associated with the merchant account. For example: Merchant monthly fee, Minimum monthly fee
OTHER_FEE
Any other fees that have not been captured by the above types.
TRANSACTION_FEE
Fees associated with Authorization, Capture and Refund transactions.
String
CONDITIONAL
The acquirer's description for the Funding event.
Provides additional information regarding the event that has resulted in movement of funds from/to the merchant bank account.
Money
CONDITIONAL
The total amount that has been succesfully credited or debited to the merchant's bank account for this transaction as reported to the gateway by the acquirer.
This may be a credit (positive value) or debit (negative value). The field includes both the amount and currency.
Date
CONDITIONAL
The date the funds arrive in the merchant's bank account (defined in the acquirer's time zone).
This value is only populated if the date is known with certainty.
Date
CONDITIONAL
The date the acquirer estimates the funds to arrive in the merchant's bank account (defined in the acquirer's time zone).
This value is only populated if neither the initiated date nor the actual funding date are available.
Date
CONDITIONAL
The date the acquirer initiated the funds transfer into the merchant's bank account (defined in the acquirer's time zone).
This value is only populated if the date of transfer is known with certainty, but the date the funds will settle to the merchant's account is uncertain.
String
CONDITIONAL
The service providers identifier for the group of transactions settled to merchant account.
Enumeration
CONDITIONAL
The current status of funding for the money the merchant can reasonably expect from their service provider for this transaction.
It reflects both money into and out of the merchant's bank account (that is, both sales and refunds).The funding status does not take into account any fees charged to merchant.
Value must be a member of the following list. The values are case sensitive.
FUNDED
The transaction is clearing and will move money into the merchant's account.
FUNDING_ADJUSTED
Funding for the transaction has been adjusted, meaning either funds have been to / from your account. This can happen for both successful or failed funding.
FUNDING_ASSURED
The transaction is guaranteed to settle, but has not yet done so.
FUNDING_FAILED
The transaction could result in the transfer of money to / from your account, however the service provider has not yet received funds from the payer. In case of a refund the service provider was not able to transfer funds to the payer.
FUNDING_ON_HOLD
The transaction could result in the transfer of money to / from your account, however the financial provider is unable to complete the transfer of funds. This might be a transient state.
IN_PROGRESS
The transaction could result in the transfer of money to / from the merchant's account, but has not yet done so. This is usually a transient state.
NON_FUNDED
The transaction cannot result in transfer of money to / from the merchant's account.
NOT_SUPPORTED
The transaction was settled to an institution from which the gateway does not receive funding information.
String
CONDITIONAL
The unique identifier for this transaction that distinguishes it from any other transactions on the order.
Array
CONDITIONAL
String
CONDITIONAL
The brand of the item.
For example, Dell.
String
CONDITIONAL
The category of the item.
For example, computers.
String
CONDITIONAL
A description for the item with information such as size, color, etc.
For example, 'Color:Red, Size:M'.
String
CONDITIONAL
A short name describing the item.
Numeric
CONDITIONAL
The quantity of the item.
String
CONDITIONAL
The SKU (Stock Keeping Unit) or the item identifier for this item.
Money
CONDITIONAL
The cost price for the item.
This amount is multiplied with item.quantity to determine the total amount for this item. The field includes both the amount and currency.
Money
CONDITIONAL
The tax amount for the item.
This amount is multiplied with item.quantity to determine the total tax amount for this item. The field includes both the amount and currency.
Datetime
CONDITIONAL
The date and time when the transaction was last updated in the gateway.
String
CONDITIONAL
A note for the transaction, provided by the merchant.
Enumeration
CONDITIONAL
The token service provider that issued the network token, if a network token was used for this transaction.
Value must be a member of the following list. The values are case sensitive.
AETS
American Express Token Service
MDES
Mastercard Digital Enablement Service
VTS
Visa Token Service
String
CONDITIONAL
The bank or location where the payer completed this payment.
For example, the store location, the ATM location, and/or the terminal identifier. When you map to this field, you could choose to concatenate location and terminal identifier (for example: <bankLocation> : <terminalIdentifier>).
Array Enumeration
CONDITIONAL
The payment method the payer has chosen for this transaction.
Value must be a member of the following list. The values are case sensitive.
ACH
The payer chose to pay using an electronic fund transfer, to be processed via the Automated Clearing House (ACH) Network.
ALIPAY
The payer chose to pay using Alipay.
AMERICAN_EXPRESS
The payer chose to pay using an American Express credit or debit card.
BANAMEX_COSTCO
The payer chose to pay using a Banamex Costco card.
BANCANET
The payer chose to pay using the Banamex online banking (BancaNet).
BANKAXEPT
The payer chose to pay using BankAxept.
BED_BATH_AND_BEYOND
The payer chose to pay using a Bed, Bath & Beyond card.
BOLETO_BANCARIO
The payer chose to pay using Boleto Bancario.
CARNET
The payer chose to pay using a Carnet card.
CARTE_BANCAIRE
The payer chose to pay using a Carte Bancaire card.
COSTCO_CASH_CARD
The payer chose to pay using a Costco Cash Card (gift card).
COSTCO_PRIVATE_LABEL_CARD
The payer chose to pay using a Costco card.
CRATE_AND_BARREL
The payer chose to pay using a Crate&Barrel card.
DILLARDS_PRIVATE_LABEL_CARD
The payer chose to pay using a Dillards Private Label Card.
DINERS_CLUB
The payer chose to pay using a Diners Club credit card.
DISCOVER
The payer chose to pay using a Discover credit card.
ELO
The payer chose to pay using a ELO card.
ENETS
The payer chose to pay using eNETS.
FARMERS
The payer chose to pay using a Farmers card.
GIROCARD
The payer chose to pay using Girocard.
GIROPAY
The payer chose to pay using giropay (redirect to the payer's online banking).
IDEAL
The payer chose to pay using iDEAL.
JAYWAN
The payer chose to pay using a Jaywan card.
JCB
The payer chose to pay using a JCB credit card.
KLARNA
The payer chose to pay using Klarna.
LASER
The payer chose to pay using a Laser card.
MADA
The payer chose to pay using a mada card.
MAESTRO
The payer chose to pay using a Maestro (debit) card.
MASTERCARD
The payer chose to pay using a Mastercard credit or debit card.
MERCADO_PAGO_CHECKOUT
The payer chose to pay using Mercado Pago Checkout.
MULTIBANCO
The payer chose to pay using Multibanco.
NONE
The transaction transfers money to or from the merchant, without the involvement of a payer. For example, recording monthly merchant service fees from the payment service provider.
OPEN_BANKING_BANK_TRANSFER
The payer choose to pay using Open Banking Bank Transfer.
OXXO
The payer chose to pay using OXXO.
PAGOBANCOMAT
The payer chose to pay using PagoBANCOMAT.
PAYPAK
The payer chose to pay using a PayPak card.
PAYPAL
The payer chose to pay using PayPal.
PBBA
The payer chose to pay using Pay by Bank app.
POLI
The payer chose to pay using POLi.
Q_CARD
The payer chose to pay using a Q-card card.
RUPAY
The payer chose to pay using RuPay.
SEPA
The payer chose to pay using SEPA.
SOFORTBANKING
The payer chose to pay using Sofortbanking.
SORIANA
The payer chose to pay using a Soriana card.
TRUE_REWARDS
The payer chose to pay using a True Rewards card.
UATP
The payer chose to pay using a UATP card.
UNION_PAY
The payer chose to pay using UnionPay SecurePay.
UNKNOWN_CARD
The payer chose to pay using a card, however the card brand could not be determined.
VERVE
The payer chose to pay using a VERVE card.
VISA
The payer chose to pay using a Visa credit or debit card.
VITAMIN_SHOPPE_GIFT_CARD
The payer chose to pay using a Vitamin Shoppe gift card.
WECHAT_PAY
The payer chose to pay using WeChat Pay.
Numeric
CONDITIONAL
The number of months for which the (first) payment is deferred.
String
CONDITIONAL
The gateway's identifier for the payment plan, for example PLANN, PLANAMEX, CIELO.
Money
CONDITIONAL
The amount for each instalment to be made on this payment plan, excluding the initial payment.
The field includes both the amount and currency.
Numeric
CONDITIONAL
The interest rate applied to the transaction amount.
Numeric
CONDITIONAL
The number of payments the payer has to make on this payment plan.
Money
CONDITIONAL
The total amount payable on this payment plan, including any interest.
The field includes both the amount and currency.
Enumeration
CONDITIONAL
The overall result of the risk assessment for the transaction.
Value must be a member of the following list. The values are case sensitive.
ACCEPTED
The order was risk assessed and accepted.
NOT_ASSESSED
The order was not risk assessed, apart from the system risk rules and these did not reject the order.
REJECTED
The order was risk assessed and rejected.
REVIEW_REQUIRED
The order was risk assessed and requires a review.
String
CONDITIONAL
The reason selected and/or note entered by the merchant when reviewing the transaction or overriding the risk assessment decision.
Enumeration
CONDITIONAL
The status of the risk review for this transaction by the merchant.
Value must be a member of the following list. The values are case sensitive.
ACCEPTED
The order did require a risk review and has been accepted.
NOT_REQUIRED
The order did not require a risk review.
OVERRIDDEN
The order has been rejected by the Risk Service Provider and subsequently accepted by the merchant.
PENDING
The order requires a risk review and is pending a risk review decision.
REJECTED
The order did require a risk review and has been rejected.
Datetime
CONDITIONAL
The date and time the merchant reviewed the transaction, if the transaction has been flagged for review as a result of the risk assessment.
String
CONDITIONAL
The user ID of the person that reviewed the transaction when the transaction was flagged for review by the merchant as a result of risk assessment.
Array
CONDITIONAL
String
CONDITIONAL
A string that contains details about the risk rule triggered, including e.g. an identifier for the rule plus the data the rule applied to.
String
CONDITIONAL
The score or recommendation determined for the transaction after applying this risk rule.
Numeric
CONDITIONAL
The total of the risk scores for all risk rules applied when assessing the risk for the transaction being fraudulent.
String
CONDITIONAL
The unique identifier for the target transaction on the gateway.
For example, the identifier of the transaction that was voided or refunded.
Datetime
CONDITIONAL
The date and time the gateway considers the processing of the transaction to have occurred.
The gateway uses this time as a point-in-time value for operations such as sorting, billing, and reporting.
String
CONDITIONAL
The token that has been provided for this transaction and used by the gateway to retrieve all or some of the payment details (stored against the token) used for this transaction.
Enumeration
CONDITIONAL
The type of action performed with respect to the order.
For example, Authorization, Capture, Refund.
Value must be a member of the following list. The values are case sensitive.
AUTHENTICATION
A transaction that authenticates the payer.
AUTHORIZATION
A transaction that, if approved, puts a hold on the funds in the payer's account for subsequent capture.
AUTHORIZATION_UPDATE
A transaction that updates an existing Authorization transaction. Usually used to prevent an Authorization from expiring.
CAPTURE
A transaction that captures an Authorization, i.e. moves the funds that were previously put on hold only from the payer's account to the merchant's account.
CHARGEBACK
A transaction that indicates a dispute has been raised by the payer. A dispute can indicate that more information is requested about the transaction or funds have been deducted from the merchant's account.
FUNDING
A transaction that provides details about merchant or event related funding or fee information only.
OTHER
Any other transaction types.
PAYMENT
A transaction that, if approved, moves the funds from the payer's to the merchant's account.
REFUND
A transaction that refunds a payer, i.e. moves funds from the merchant's to the payer's account.
REFUND_REQUEST
A transaction that indicates that a Refund against a Capture transaction has been requested but not yet executed. Further action is required to approve the requested Refund.
VERIFICATION
A transaction that verifies the payer's account exists. No funds are put on hold.
VOID_AUTHORIZATION
A transaction that voids a successful Authorization transaction, i.e. releases the funds that had been put on hold.
VOID_CAPTURE
A transaction that voids a successful Capture transaction, i.e. returns the funds that were previously moved from the payer's to the merchant's account into the payer's account.
VOID_PAYMENT
A transaction that voids a successful Payment transaction i.e. returns the funds that were previously moved from the payer's to the merchant's account into the payer's account.
VOID_REFUND
A transaction that voids a successful Refund transaction i.e. returns the funds that were previously returned from the merchant's to the payer's account into the merchant's account.
Array
CONDITIONAL
Enumeration
CONDITIONAL
The new response gateway code for the transaction after the status change happening at the date and time defined in transactionUpdate.time.
Value must be a member of the following list. The values are case sensitive.
APPROVED
The transaction has been approved.
AUTHENTICATION_IN_PROGRESS
The operation determined that payer authentication is possible for the given card, but this has not been completed, and requires further action by the merchant to proceed.
BLOCKED
The transaction has been blocked as a result of a risk assessment.
CANCELLED
The transaction has been cancelled by the payer.
DECLINED_HARD
The transaction has been declined by the issuer, acquirer or other Payment Service Provider. The merchant must ask the payer for another set of payment details.
DECLINED_SOFT
The transaction has been declined by the issuer, acquirer or other Payment Service Provider. The problem might be resolved by retrying the request later (e.g. for insufficient funds the merchant may contact the payer and retry once the payer has indicated that fundsa r now available).
NOT_SUPPORTED
The transaction request could not be processed. Reasons include the requested functionality not being supported by the acquirer, missing request fields that are mandatory for the acquirer, and failed acquirer-specific validation. A later retry will not succeed.
PARTIALLY_APPROVED
The transaction has been approved, however the approved transaction amount differs from the requested transaction amount.
PENDING_RESPONSE
The gateway has not yet received a response from the acquirer or other Payment Service Provider (e.g. PayPal) about the status of the transaction.
PENDING_SETTLEMENT
The gateway has accepted the transaction and either has not yet submitted it to the acquirer for settlement, submitted it to the acquirer for settlement but has not yet received a response from the acquirer, or has received a response from the acquirer but not yet updated the status of the transaction.
PROCESSING_ERROR
The transaction could not be processed, as a technical error occurred during processing of the transaction. This includes acquirer system errors, gateway internal errors, connectivity issues etc. A later retry attempt may succeed.
REFERRED
The transaction has been delined and the merchant is asked to contact the issuer. The issuer may provide the merchant with an Authorization Code that will allow the merchant to subsequently capture the funds for the transaction.
UNSPECIFIED_FAILURE
The transaction request could not be processed. The gateway does not know if the transaction was successful or not. Reasons include merchant requests that cannot be processed due to a gateway internal error, the gateway being unable to retrieve a response from the acquirer (after exhausting all retry or reversal attempts), and a response from the acquirer that is not understood by the gateway. The merchant needs to contact their acquirer.
Datetime
CONDITIONAL
The date and time that the status (responseGatewayCode) of the transaction changed.
String
CONDITIONAL
The person who initiated the transaction for the merchant, e.g. the logon name of the user submitting the transaction in the gateway's back office.
Errors
Information on possible error conditions that may occur while processing an operation using the API.
Enumeration
Broadly categorizes the cause of the error.
For example, errors may occur due to invalid requests or internal system failures.
Value must be a member of the following list. The values are case sensitive.
INVALID_REQUEST
The request was rejected because it did not conform to the API protocol.
REQUEST_REJECTED
The request was rejected due to security reasons such as firewall rules, expired certificate, etc.
SERVER_BUSY
The server did not have enough resources to process the request at the moment.
SERVER_FAILED
There was an internal system failure.
String
Textual description of the error based on the cause.
This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.
Data can consist of any characters
String
Indicates the name of the field that failed validation.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Data can consist of any characters
String
Indicates the code that helps the support team to quickly identify the exact cause of the error.
This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.
Data can consist of any characters
Enumeration
Indicates the type of field validation error.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Value must be a member of the following list. The values are case sensitive.
INVALID
The request contained a field with a value that did not pass validation.
MISSING
The request was missing a mandatory field.
UNSUPPORTED
The request contained a field that is unsupported.
Enumeration
A system-generated high level overall result of the operation.
Value must be a member of the following list. The values are case sensitive.
ERROR
The operation resulted in an error and hence cannot be processed.