Transaction payloads

A quick reference for response payloads across transaction types.

Transaction payloads

This reference provides payload examples across the various transaction types.

Cash Withdrawal payload

Below is a payload example for a cash withdrawal transaction:

{
   "transaction_id":"30a2b5a4-c8af-49b3-8272-f9cda6b5654d",
   "bond_brand_id":"00000000-0000-0000-0000-000000000000",
   "customer_id":"35ae74c5-cb4f-4166-b4f4-146caf104973",
   "account_id":"bdd9154f-2c7a-4834-9184-33791616367c",
   "payment_type":"card",
   "transaction_type":"Cash Withdrawal",
   "state":"completed",
   "description":"Domestic ATM Cash Withdrawal",
   "amount":"-20.00",
   "currency":"USD",
   "created_time":"2022-08-03T20:41:55+00:00",
   "updated_time":"2022-08-03T20:41:55+00:00",
   "balances":{
      "prior_balance":"-358.36",
      "new_balance":"-383.66"
   },
   "details":{
      "card_id":"aebe6b3a-e9df-42ed-8d71-280d13ef75ec",
      "mcc":"6011",
      "mcc_description":"Automated Cash Disbursement - Member Institution",
      "currency":"USD",
      "exchange_rate":"1.00",
      "merchant_id":"TFND/MONEYPASS",
      "merchant_name":"Transfund",
      "merchant_city":"ROUND ROCK",
      "merchant_state":"TX",
      "merchant_currency":"USD",
      "merchant_amount":"-20",
      "cardholder_presence":true,
      "statement_descriptor":"TRANSFUND                ROUND ROCK   TXUSA"
   }
}

A separate transaction may be processed for the ATM withdrawal fee. The payload for a Fee transaction is shown below:

{
   "transaction_id":"2db09df4-0911-491f-86dd-a200563cffae",
   "bond_brand_id":"00000000-0000-0000-0000-000000000000",
   "customer_id":"35ae74c5-cb4f-4166-b4f4-146caf104973",
   "account_id":"bdd9154f-2c7a-4834-9184-33791616367c",
   "payment_type":"card",
   "transaction_type":"Fee",
   "state":"completed",
   "description":"Fee of Domestic ATM Cash Withdrawal",
   "amount":"-0.99",
   "currency":"USD",
   "created_time":"2022-07-28T22:05:09+00:00",
   "updated_time":"2022-07-28T22:05:09+00:00",
   "balances":{
      "prior_balance":"-151.91",
      "new_balance":"-228.04"
   },
   "details":{
      "card_id":"aebe6b3a-e9df-42ed-8d71-280d13ef75ec",
      "fee_type":"Generic",
      "linked_transaction_id":"97141e4e-ee2d-47d3-b1ea-40b9a2f74969"
   }
}

Pre-Authorization payload

This payload will be a POS Purchase with state pending, as shown below:

{
    "transaction_id": "59a2e7c1-9853-4aed-b1a4-f41ab0516b6e",
    "bond_brand_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "0bb749c9-ca8f-4010-950f-071f3667b3fc",
    "account_id": "73401ad8-ece1-4018-bba4-93c21b451900",
    "payment_type": "card",
    "transaction_type": "POS Purchase",
    "state": "pending",
    "description": "Pre-Auth Transaction-POS Signature Purchase",
    "amount": "-4.50",
    "currency": "USD",
    "created_time": "2022-08-05T17:22:19+00:00",
    "updated_time": "2022-08-05T17:22:19+00:00",
    "balances": {
        "prior_balance": "-12.00",
        "new_balance": "-16.50"
    },
    "details": {
        "card_id": "e68adbcc-d76d-47b9-b7c0-d7aa65337f88",
        "mcc": "5814",
        "mcc_description": "Fast Food",
        "currency": "USD",
        "exchange_rate": "1.00",
        "merchant_id": "242632000053360",
        "merchant_name": "Sq *Rising Star Coffee   Cleveland    Ohusa",
        "merchant_city": "Cleveland    ",
        "merchant_state": "OH",
        "merchant_currency": "USD",
        "merchant_amount": "-4.5",
        "cardholder_presence": true,
        "statement_descriptor": "SQ *RISING STAR COFFEE   Cleveland    OHUSA"
    }
}

POS Purchase payload

This will be a POS Purchase with state completed, as shown below:

{
   "transaction_id":"03cc5178-243b-42fa-a73a-27000da36e7c",
   "bond_brand_id":"00000000-0000-0000-0000-000000000000",
   "customer_id":"35ae74c5-cb4f-4166-b4f4-146caf104973",
   "account_id":"bdd9154f-2c7a-4834-9184-33791616367c",
   "payment_type":"card",
   "transaction_type":"POS Purchase",
   "state":"completed",
   "description":"Pre-Auth Transaction-POS Signature Purchase",
   "amount":"-6.68",
   "currency":"USD",
   "created_time":"2022-08-03T20:31:56+00:00",
   "updated_time":"2022-08-03T20:31:56+00:00",
   "balances":{
      "prior_balance":"-397.53",
      "new_balance":"-397.53"
   },
   "details":{
      "card_id":"aebe6b3a-e9df-42ed-8d71-280d13ef75ec",
      "mcc":"5542",
      "mcc_description":"Automatic Fuel Dispenser",
      "currency":"USD",
      "exchange_rate":"1.00",
      "merchant_id":"195000005833001",
      "merchant_name":"Qt 4134",
      "merchant_city":"ROUND ROCK",
      "merchant_state":"TX",
      "merchant_currency":"USD",
      "merchant_amount":"-6.68",
      "statement_descriptor":"QT 4134                  ROUND ROCK   TXUSA"
   }
}

Credit Adjustment payload

The below payload example shows a credit adjustment, for instance, issued to a customer in the case of a refund to a credit card by a merchant:

{
    "transaction_id": "f0926a5e-6175-4cb1-acda-8c092ffeb278",
    "bond_brand_id": "dbdac53b-0336-4edc-aa68-911db00f04e1",
    "business_id": "d2caf7b4-8348-448c-8aad-826b2f387dde",
    "account_id": "ae5f947e-ad40-4893-bb15-fb7a5b720e68",
    "payment_type": "card",
    "transaction_type": "Credit Adjustment",
    "state": "returned",
    "description": "POS Signature Credit Adjustment",
    "amount": "172.97",
    "currency": "USD",
    "created_time": "2022-03-24T03:06:17+00:00",
    "updated_time": "2022-03-24T03:06:17+00:00",
    "balances": {
        "prior_balance": "0.00",
        "new_balance": "0.00"
    },
    "details": {
        "card_id": "76b257f1-87c7-464d-a3ec-5141fec741ff",
        "mcc": "5942",
        "mcc_description": "Book Stores",
        "currency": "USD",
        "exchange_rate": "1.00",
        "merchant_id": "784959000762203",
        "merchant_name": "Amazon.Com",
        "merchant_city": "Amzn.com/bill",
        "merchant_state": "WA",
        "merchant_currency": "USD",
        "merchant_amount": "172.97",
        "cardholder_presence": false,
        "statement_descriptor": "Amazon.com               Amzn.com/billWAUSA"
    }
}

📘

Usage Tips

When figuring out how to organize transaction payloads, you can generally exclude $0 transactions in your transaction list views and statements displayed to end users. An exception, however, is to include $0 transactions where the details.merchant_amount is positive, since this can help users keep track of declined POS transactions.


Did this page help you?