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
Cash Withdrawal
payloadBelow 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"
}
}
Fee
payload
Fee
payloadATM Withdrawal Fee payload
A separate transaction may be processed for the ATM withdrawal fee. This webhook payload will be sent along with the Cash Withdrawal one. 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"
}
}
Card Reissue Fee payload
When a card is reissued, a payload for the $4.99 reissue fee will be sent. The payload for this Fee transaction is shown below:
{
"transaction_id": "10c2ef09-dd32-4ee5-b8ee-a4613a9c8a96",
"bond_brand_id": "3d6a093b-ff34-413d-a7a9-4972f4149bec",
"customer_id": "4e04c6e4-0b5a-4ba2-9edc-655f7653fd9f",
"account_id": "3bf93342-7264-4e95-b7c9-1ea5682123f6",
"payment_type": "card",
"transaction_type": "Fee",
"state": "completed",
"description": "Fee-Reissue Card - From Card Number (51*************8396)",
"amount": "-4.99",
"currency": "USD",
"created_time": "2023-01-02T01:31:14+00:00",
"updated_time": "2023-01-02T01:31:14+00:00",
"details": {
"card_id": "3bc18277-c37d-4684-9004-a9055ced779a",
"fee_type": "Reissue Card"
},
"balances": {
"prior_balance": "-4.99",
"new_balance": "-4.99"
}
}
Pre-Authorization
payload
Pre-Authorization
payloadThis 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
POS Purchase
payloadThis 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
Credit Adjustment
payloadThe payload example below 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": "af827f08-95cc-423d-95f7-c9f5d1e41587",
"bond_brand_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "baae67f7-00e6-4e1e-8a08-03d4daad9e43",
"account_id": "e14fee38-118b-43db-87db-b9da975a679f",
"payment_type": "card",
"transaction_type": "Credit Adjustment",
"state": "completed",
"amount": "11.00",
"currency": "USD",
"created_time": "2022-01-07T15:39:37+00:00",
"updated_time": "2022-01-07T15:39:37+00:00",
"balances": {
"prior_balance": "17.02",
"new_balance": "11.02"
},
"details": {
"card_id": "030bbe79-4272-4b43-8d64-5cd558ed65fa",
"mcc": "5999",
"mcc_description": "Misc Retail",
"currency": "USD",
"exchange_rate": "1.0",
"merchant_id": "242661000053360",
"merchant_name": "Sq *Bond Financial Tec San Franciscocausa",
"merchant_city": "San Francisco",
"merchant_state": "CA",
"merchant_currency": "USD",
"merchant_amount": "11",
"cardholder_presence": false,
"statement_descriptor": "SQ *BOND FINANCIAL TEC San FranciscoCAUSA"
}
}
Provisional Credit
Payload
Provisional Credit
PayloadChargebacks in Bond take the form of provisional credit sent to a cardholder's account when the cardholder opens a dispute on a transaction. If the dispute is resolved in favor of the cardholder, the credit will remain in the account; otherwise, a provisional debit will be sent to the account to offset this credit. A sample payload for a provisional credit transaction is shown below:*
{
"transaction_id": "defa388d-29e3-4d77-a853-80893a09cdb1",
"bond_brand_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "ea326d41-0d2a-4c3a-9b90-4d18fb410191",
"account_id": "670b3035-4c04-4999-985b-b53e14d5146f",
"payment_type": "card",
"transaction_type": "Provisional Credit",
"state": "completed",
"description": "Provisional Credit",
"amount": "1.21",
"fee": "0.00",
"currency": "USD",
"created_time": "2022-06-16T22:16:57+00:00",
"updated_time": "2022-06-16T22:16:57+00:00",
"details": {
"card_id": "90107917-3b9e-4411-8a1e-b8fcbf17eae9",
"mcc": "0",
"mcc_description": "Merchant Unknown",
"currency": "USD",
"exchange_rate": "1.00",
"merchant_name": "Usa",
"merchant_currency": "USD",
"merchant_amount": "1.21",
"statement_descriptor": " USA"
}
}
*Note: this payload will be finalized and may be subject to change in the future.
Purchase Returns
payload
Purchase Returns
payloadBelow is a sample payload for a completed Purchase Returns transaction:
{
"transaction_id": "9c80fac3-885d-4534-bbba-3a2598864b9f",
"bond_brand_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "bf0b1891-cd63-46ef-8c6f-c98f3468af9c",
"account_id": "91b9f9af-fdbc-44d0-93df-c68865b525a5",
"payment_type": "card",
"transaction_type": "Purchase Returns",
"state": "completed",
"description": "POS Signature Return International (with currency conversion) [European EMU, Euro: 1.28], Fx @1.0312",
"amount": "1.32",
"currency": "USD",
"created_time": "2022-08-14T00:40:27+00:00",
"updated_time": "2022-08-14T00:40:27+00:00",
"balances": {
"prior_balance": "-42.06",
"new_balance": "-43.38"
},
"details": {
"card_id": "ab386833-0903-4a03-93b0-49d75bb3e124",
"mcc": "5734",
"mcc_description": "Computer Software",
"currency": "USD",
"exchange_rate": "1.03125",
"merchant_id": "AWBI8FHJQJHZYIP",
"merchant_name": "Stripe Secure",
"merchant_city": "LONDON",
"merchant_state": "LN",
"merchant_currency": "EUR",
"merchant_amount": "1.28",
"statement_descriptor": "STRIPE SECURE LONDON LNGBR"
}
}
Payroll
payload (to Debit or Credit Accounts)
Payroll
payload (to Debit or Credit Accounts){
"transaction_id": "b8ef629e-8833-49f5-bf31-94b610b87522",
"bond_brand_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "a8d9de10-0eb8-476f-8cb9-9a1f99b166b0",
"account_id": "12354a17-91c0-4575-849d-e05ded46af5c",
"payment_type": "ach",
"transaction_type": "External ACH Deposit",
"state": "completed",
"amount": "50.00",
"currency": "USD",
"created_time": "2023-03-01T05:45:09.579917+00:00",
"updated_time": "2023-03-01T05:45:09.579917+00:00",
"details": {
"card_id": "6457faff-937e-4f8b-9b22-cd992842da40",
"class_code": "PPD",
"direction": "credit",
"description": "PAYROLL"
},
"balances": {
"prior_balance": "1326.32",
"new_balance": "1326.32"
}
}
Payroll
payload (to Deposit Accounts or Security Deposit Accounts)
Payroll
payload (to Deposit Accounts or Security Deposit Accounts){
"transaction_id": "7604955a-fa1b-4025-88c5-6948533b8111",
"bond_brand_id": "3d6a093b-ff34-413d-a7a9-4972f4149bec",
"customer_id": "8d9a3c7b-1891-4176-b873-bca398a316d9",
"account_id": "08c4745f-4c4a-442c-a40a-1fab9fbd39b1",
"payment_type": "account",
"transaction_type": "External ACH Deposit",
"state": "completed",
"description": "BOND::Prithvi Ramakrishnan",
"amount": "50.00",
"currency": "USD",
"created_time": "2023-02-15T09:30:10.042120+00:00",
"updated_time": "2023-02-15T09:30:10.042120+00:00",
"details": {
"originating_account_id": "08c4745f-4c4a-442c-a40a-1fab9fbd39b1",
"destination_account_id": "96940004-569f-4672-acd2-30901224c54e",
"class_code": "PPD",
"same_day": false,
"return_code": "",
"failure_reason": ""
},
"balances": {}
}
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.
Updated almost 2 years ago