API v4.14
Transaction Response Fields
Fields returned in payment transaction responses
Transaction Response
The following table defines all fields that may be returned in a transaction response.
| Field Name | Description |
|---|---|
| REQUEST_ACTION | This will return the Service Request Action the merchant sent in the transaction request. |
| TRANS_STATUS_NAME | Transaction Status |
| TRANS_VALUE | Total requested transaction amount for all line items. |
| CURR_CODE_ALPHA | Requested Currency 3-letter Code |
| TRANS_VALUE_SETTLED | Transaction Settled Amount (after conversion to settled currency). |
| CURR_CODE_ALPHA_SETTLED | Settled Currency 3-letter Code |
| TRANS_EXCH_RATE | Currency Exchange Rate |
| TRANS_ID | Transaction ID |
| CUST_ID | Customer ID |
| XTL_CUST_ID | Merchant’s Customer ID |
| PO_ID | Purchase order ID |
| XTL_PO_ID | Merchant’s Order ID |
| BATCH_ID | Settlement Batch ID |
| PROC_NAME | Merchant Processor Name (Example: “EPX”) |
| MERCH_ACCT_ID | Merchant Bank’s Account ID |
| CARD_BRAND_NAME | Credit Card Network/Brand Name |
| CARD_DETAIL | Credit or Debit Card |
| CARD_TYPE | Credit Card Type |
| CARD_CLASS | Categorizes the BIN as a Business, Corporate, Purchase, or Consumer card |
| CARD_COUNTRY | Issuer Bank country for the BIN |
| CARD_PREPAID | Indicates that the credit card is a prepaid card if value returned is “1”. |
| CARD_BANK | Credit Card Issuing Bank Name |
| CARD_BALANCE | Prepaid card balance (this is a processor-specific feature). This field will return the card’s available balance. |
| PMT_L4 | Payment account or credit card’s last 4 digits. |
| PMT_ID | Payment Unique Identifier |
| PMT_ID_XTL | External Unique Identifier |
| PROC_UDF01 | Processor User Defined Field 1 |
| PROC_UDF02 | Processor User Defined Field 2 |
| PROC_AUTH_RESPONSE | Processor Authorization Response Code |
| PROC_RETRIEVAL_NUM | Processor Retrieval Number or GUID |
| PROC_REFERENCE_NUM | Processor Reference Number |
| PROC_REDIRECT_URL | URL where customers are redirected to for external verification (i.e. 3D Secure page) |
| AVS_RESPONSE | Address Verification Service Response Code |
| CVV_RESPONSE | Card Verification Value Response Code |
| REQUEST_API_VERSION | Payment Service API Version |
| PO_LI_ID_X | Purchase Order Line Item ID |
| PO_LI_COUNT_X | Purchase Order Line Item Count |
| PO_LI_AMOUNT_X | Purchase Order Line Item Total Amount |
| PO_LI_PROD_ID_X | Purchase Order Line Item Product ID |
| MBSHP_ID | Membership ID (returned on membership transactions) |
| TRANS_NTOKEN_USED | Used to indicate on whether a Network Token was used or a PAN was used. (It will be set to “1” if a scheme token was used or set to “0” otherwise) |
| CARD_BRAND_TRANSID | This is the card scheme transaction id for the current transaction |