Transaction webhook payload examples
Inspect the documented JSON payloads for transaction notifications.
Use samples as fixtures
These payloads reproduce the documented event examples. A sample is not a complete schema: optional fields, nulls, amounts and types may vary by event. Route using event_type, retain event_id for deduplication, and use the corresponding event_body shape. Event catalog and behavior
Gateway signature and delivery
Verify Webhook-Signature with your gateway signing key before parsing the body. This family signs nonce + a period + the original body. It is separate from Sign-Up subscriptions. Gateway webhook verification
Credit Card Sale
Documented sample payload; not generated account activity. Where labeled syntax corrected, missing or trailing commas in the source have been repaired without changing field names or values. { "event_id": "9b312dfd-3174-4748-9447-d63c8744305a", "event_type": "transaction.sale.success", "event_body": { "merchant": { "id": "1234", "name": "Test Account" }, "features": { "is_test_mode": true }, "transaction_id": "1234560000", "transaction_type": "cc", "condition": "pendingsettlement", "processor_id": "ccprocessora", "ponumber": "123456789", "order_description": "this is a description", "order_id": "12345678", "customerid": "", "customertaxid": "", "website": "https://example.com", "shipping": "", "currency": "USD", "tax": "0.08", "surcharge": "", "convenience_fee": "", "misc_fee": "", "misc_fee_name": "", "cash_discount": "", "tip": "", "requested_amount": "54.04", "shipping_carrier": "", "tracking_number": "", "shipping_date": "", "partial_payment_id": "", "partial_payment_balance": "", "platform_id": "", "authorization_code": "123456", "social_security_number": "", "drivers_license_number": "", "drivers_license_state": "", "drivers_license_dob": "", "billing_address": { "first_name": "Jessica", "last_name": "Jones", "address_1": "123 Fake St.", "address_2": "123123", "company": "Alias Investigations", "city": "New York City", "state": "NY", "postal_code": "12345", "country": "US", "email": "someone@example.com", "phone": "555-555-5555", "cell_phone": "", "fax": "444-555-6666" }, "shipping_address": { "first_name": "Jessica", "last_name": "Jones", "address_1": "123 Fake St.", "address_2": "123123", "company": "Alias Investigations", "city": "New York City", "state": "NY", "postal_code": "12345", "country": "US", "email": "someone@example.com", "phone": "", "fax": "" }, "card": { "cc_number": "411111******1111", "cc_exp": "1022", "cavv": "", "cavv_result": "", "xid": "", "eci": "", "avs_response": "N", "csc_response": "", "cardholder_auth": "", "cc_start_date": "", "cc_issue_number": "", "card_balance": "", "card_available_balance": "", "entry_mode": "", "cc_bin": "", "cc_type": "" }, "action": { "amount": "54.04", "action_type": "sale", "date": "20200406175755", "success": "1", "ip_address": "1.2.3.4", "source": "virtual_terminal", "api_method": "virtual_terminal", "username": "exampleuser", "response_text": "SUCCESS", "response_code": "100", "network_token_used": false, "network_token_cryptogram_created": false, "processor_response_text": "", "processor_response_code": "", "device_license_number": "", "device_nickname": "" } } } false
Electronic Check Sale
Documented sample payload; not generated account activity. Where labeled syntax corrected, missing or trailing commas in the source have been repaired without changing field names or values. { "event_id": "c1ee29d9-dd29-45d0-903a-c78da43bca32", "event_type": "transaction.sale.success", "event_body": { "merchant": { "id": "12345", "name": "Test Account" }, "features": { "is_test_mode": true }, "transaction_id": "1234560000", "transaction_type": "ck", "condition": "pendingsettlement", "processor_id": "ckprocessora", "ponumber": "", "order_description": "", "order_id": "", "customerid": "", "customertaxid": "", "website": "", "shipping": "", "currency": "USD", "tax": "1.00", "surcharge": "", "convenience_fee": "", "misc_fee": "", "misc_fee_name": "", "cash_discount": "", "tip": "", "requested_amount": "60.49", "shipping_carrier": "", "tracking_number": "", "shipping_date": "", "partial_payment_id": "", "partial_payment_balance": "", "platform_id": "", "authorization_code": "123456", "social_security_number": "", "drivers_license_number": "", "drivers_license_state": "", "drivers_license_dob": "****-**-**", "billing_address": { "first_name": "Jessica", "last_name": "Jones", "address_1": "123 Fake St.", "address_2": "", "company": "Alias Investigations", "city": "New York City", "state": "NY", "postal_code": "12345", "country": "US", "email": "someone@example.com", "phone": "5555555555", "cell_phone": "", "fax": "" }, "shipping_address": { "first_name": "Jessica", "last_name": "Jones", "address_1": "123 Fake St.", "address_2": "", "company": "Alias Investigations", "city": "New York City", "state": "NY", "postal_code": "12345", "country": "US", "email": "someone@example.com", "phone": "", "fax": "" }, "check": { "check_account": "*****1234", "check_aba": "100000000", "check_name": "Jessica Jones", "account_holder_type": "personal", "account_type": "checking", "sec_code": "WEB" }, "action": { "amount": "60.49", "action_type": "sale", "date": "20200406180124", "success": "1", "ip_address": "1.2.3.4", "source": "virtual_terminal", "api_method": "virtual_terminal", "username": "exampleuser", "response_text": "SUCCESS", "response_code": "100", "network_token_used": false, "network_token_cryptogram_created": false, "processor_response_text": "", "processor_response_code": "", "device_license_number": "", "device_nickname": "" } } } true
Cash Sale
Documented sample payload; not generated account activity. Where labeled syntax corrected, missing or trailing commas in the source have been repaired without changing field names or values. { "event_id": "e88bfc27-2d42-46a1-8427-65b4a7f11f16", "event_type": "transaction.sale.success", "event_body": { "merchant": { "id": "123456", "name": "Test Account" }, "features": { "is_test_mode": true }, "transaction_id": "1234560000", "transaction_type": "cs", "condition": "complete", "processor_id": "csprocessora", "ponumber": "", "order_description": "", "order_id": "", "customerid": "", "customertaxid": "", "website": "", "shipping": "", "currency": "USD", "tax": "1.00", "surcharge": "", "convenience_fee": "", "misc_fee": "", "misc_fee_name": "", "cash_discount": "", "tip": "", "requested_amount": "60.49", "shipping_carrier": "", "tracking_number": "", "shipping_date": "", "partial_payment_id": "", "partial_payment_balance": "", "platform_id": "1", "authorization_code": "", "social_security_number": "", "drivers_license_number": "", "drivers_license_state": "", "drivers_license_dob": "", "billing_address": { "first_name": "Jessica", "last_name": "Jones", "address_1": "123 Fake St.", "address_2": "", "company": "Alias Investigations", "city": "New York City", "state": "NY", "postal_code": "12345", "country": "US", "email": "someone@example.com", "phone": "+15555555555", "cell_phone": "", "fax": "" }, "shipping_address": { "first_name": "Jessica", "last_name": "Jones", "address_1": "123 Fake St.", "address_2": "", "company": "Alias Investigations", "city": "New York City", "state": "NY", "postal_code": "12345", "country": "US", "email": "someone@example.com", "phone": "", "fax": "" }, "action": { "amount": "60.49", "action_type": "sale", "date": "20200406180150", "success": "1", "ip_address": "1.2.3.4", "source": "virtual_terminal", "api_method": "virtual_terminal", "username": "exampleuser", "response_text": "APPROVED", "response_code": "100", "network_token_used": false, "network_token_cryptogram_created": false, "processor_response_text": "Approved", "processor_response_code": "1", "device_license_number": "", "device_nickname": "" } } } true
Auth Success
Documented sample payload; not generated account activity. Where labeled syntax corrected, missing or trailing commas in the source have been repaired without changing field names or values. { "event_id": "322ac05a-cf6c-4c16-948a-3048d007f742", "event_type": "transaction.auth.success", "event_body": { "merchant": { "id": "944025", "name": "Test merchant account" }, "features": { "is_test_mode": true }, "transaction_id": "8584341675", "transaction_type": "cc", "condition": "pending", "processor_id": "ccprocessora", "ponumber": "", "order_description": "", "order_id": "", "customerid": "", "customertaxid": "", "website": "", "shipping": "", "currency": "USD", "tax": "", "surcharge": "", "convenience_fee": "", "misc_fee": "", "misc_fee_name": "", "cash_discount": "", "tip": "", "requested_amount": "10.00", "shipping_carrier": "", "tracking_number": "", "shipping_date": "", "partial_payment_id": "", "partial_payment_balance": "", "platform_id": "", "authorization_code": "123456", "social_security_number": "", "drivers_license_number": "", "drivers_license_state": "", "drivers_license_dob": "", "duty_amount": "0.00", "discount_amount": "0.00", "national_tax_amount": "0.00", "summary_commodity_code": "", "alternate_tax_amount": "0.00", "vat_tax_amount": "0.00", "vat_tax_rate": "0.00", "billing_address": { "first_name": "", "last_name": "", "address_1": "", "address_2": "", "company": "", "city": "", "state": "", "postal_code": "", "country": "", "email": "", "phone": "", "cell_phone": "", "fax": "" }, "shipping_address": { "first_name": "", "last_name": "", "address_1": "", "address_2": "", "company": "", "city": "", "state": "", "postal_code": "", "country": "", "email": "", "phone": "", "fax": "" }, "card": { "cc_number": "411111******1111", "cc_exp": "1025", "cavv": "", "cavv_result": "", "xid": "", "eci": "", "avs_response": "", "csc_response": "M", "cardholder_auth": "", "cc_start_date": "", "cc_issue_number": "", "card_balance": "", "card_available_balance": "", "entry_mode": "4", "cc_bin": "", "cc_type": "Visa", "feature_token": "" }, "merchant_defined_fields": {}, "action": { "amount": "10.00", "action_type": "auth", "date": "20230801113700", "success": "1", "ip_address": "123.123.123.123", "source": "api", "api_method": "direct_post", "username": "test", "response_text": "SUCCESS", "response_code": "100", "processor_response_text": "", "tap_to_mobile": false, "network_token_used": false, "network_token_cryptogram_created": false, "processor_response_code": "", "device_license_number": "", "device_nickname": "" } } } true
Auth Failure
Documented sample payload; not generated account activity. Where labeled syntax corrected, missing or trailing commas in the source have been repaired without changing field names or values. { "event_id": "322ac05a-cf6c-4c16-948a-3048d007f742", "event_type": "transaction.auth.failure", "event_body": { "merchant": { "id": "944025", "name": "Test merchant account" }, "features": { "is_test_mode": true }, "transaction_id": "8597004002", "transaction_type": "cc", "condition": "failed", "processor_id": "ccprocessora", "ponumber": "", "order_description": "", "order_id": "", "customerid": "", "customertaxid": "", "website": "", "shipping": "", "currency": "USD", "tax": "", "surcharge": "", "convenience_fee": "", "misc_fee": "", "misc_fee_name": "", "cash_discount": "", "tip": "", "requested_amount": "0.50", "shipping_carrier": "", "tracking_number": "", "shipping_date": "", "partial_payment_id": "", "partial_payment_balance": "", "platform_id": "", "authorization_code": "123456", "social_security_number": "", "drivers_license_number": "", "drivers_license_state": "", "drivers_license_dob": "", "duty_amount": "0.00", "discount_amount": "0.00", "national_tax_amount": "0.00", "summary_commodity_code": "", "alternate_tax_amount": "0.00", "vat_tax_amount": "0.00", "vat_tax_rate": "0.00", "billing_address": { "first_name": "", "last_name": "", "address_1": "", "address_2": "", "company": "", "city": "", "state": "", "postal_code": "", "country": "", "email": "", "phone": "", "cell_phone": "", "fax": "" }, "shipping_address": { "first_name": "", "last_name": "", "address_1": "", "address_2": "", "company": "", "city": "", "state": "", "postal_code": "", "country": "", "email": "", "phone": "", "fax": "" }, "card": { "cc_number": "411111******1111", "cc_exp": "1025", "cavv": "", "cavv_result": "", "xid": "", "eci": "", "avs_response": "", "csc_response": "M", "cardholder_auth": "", "cc_start_date": "", "cc_issue_number": "", "card_balance": "", "card_available_balance": "", "entry_mode": "4", "cc_bin": "", "cc_type": "Visa", "feature_token": "" }, "merchant_defined_fields": {}, "action": { "amount": "10.00", "action_type": "auth", "date": "20230801113700", "success": "0", "ip_address": "123.123.123.123", "source": "api", "api_method": "direct_post", "username": "test", "response_text": "DECLINE", "response_code": "200", "processor_response_text": "", "tap_to_mobile": false, "network_token_used": false, "network_token_cryptogram_created": false, "processor_response_code": "", "device_license_number": "", "device_nickname": "" } } } true
Capture Success
Documented sample payload; not generated account activity. Where labeled syntax corrected, missing or trailing commas in the source have been repaired without changing field names or values. { "event_id": "e5267749-c235-45c9-b93e-21f4379b94d1", "event_type": "transaction.capture.success", "event_body": { "merchant": { "id": "944025", "name": "Test merchant account" }, "features": { "is_test_mode": true }, "transaction_id": "8584341675", "transaction_type": "cc", "condition": "pendingsettlement", "processor_id": "ccprocessora", "ponumber": "", "order_description": "", "order_id": "", "customerid": "", "customertaxid": "", "website": "", "shipping": "0.00", "currency": "USD", "tax": "0.00", "surcharge": "", "convenience_fee": "", "misc_fee": "", "misc_fee_name": "", "cash_discount": "", "tip": "", "requested_amount": "10.00", "shipping_carrier": "", "tracking_number": "", "shipping_date": "", "partial_payment_id": "", "partial_payment_balance": "", "platform_id": "", "authorization_code": "123456", "social_security_number": "", "drivers_license_number": "", "drivers_license_state": "", "drivers_license_dob": "", "duty_amount": "0.00", "discount_amount": "0.00", "national_tax_amount": "0.00", "summary_commodity_code": "", "alternate_tax_amount": "0.00", "vat_tax_amount": "0.00", "vat_tax_rate": "0.00", "billing_address": { "first_name": "", "last_name": "", "address_1": "", "address_2": "", "company": "", "city": "", "state": "", "postal_code": "", "country": "", "email": "", "phone": "", "cell_phone": "", "fax": "" }, "shipping_address": { "first_name": "", "last_name": "", "address_1": "", "address_2": "", "company": "", "city": "", "state": "", "postal_code": "", "country": "", "email": "", "phone": "", "fax": "" }, "card": { "cc_number": "411111******1111", "cc_exp": "1025", "cavv": "", "cavv_result": "", "xid": "", "eci": "", "avs_response": "", "csc_response": "M", "cardholder_auth": "", "cc_start_date": "", "cc_issue_number": "", "card_balance": "", "card_available_balance": "", "entry_mode": "4", "cc_bin": "", "cc_type": "Visa", "feature_token": "" }, "merchant_defined_fields": {}, "action": { "amount": "10.00", "action_type": "capture", "date": "20230801113955", "success": "1", "ip_address": "123.123.123.123", "source": "api", "api_method": "direct_post", "username": "test", "response_text": "SUCCESS", "response_code": "100", "processor_response_text": "", "tap_to_mobile": false, "network_token_used": false, "network_token_cryptogram_created": false, "processor_response_code": "", "device_license_number": "", "device_nickname": "" } } } true
Refund Success
Documented sample payload; not generated account activity. Where labeled syntax corrected, missing or trailing commas in the source have been repaired without changing field names or values. { "event_id": "e5267749-c235-45c9-b93e-21f4379b94d1", "event_type": "transaction.refund.success", "event_body": { "merchant": { "id": "944025", "name": "Test merchant account" }, "features": { "is_test_mode": true }, "transaction_id": "8597047042", "transaction_type": "cc", "condition": "pendingsettlement", "processor_id": "ccprocessora", "ponumber": "", "order_description": "", "order_id": "", "customerid": "", "customertaxid": "", "website": "", "shipping": "0.00", "currency": "USD", "tax": "0.00", "surcharge": "", "convenience_fee": "", "misc_fee": "", "misc_fee_name": "", "cash_discount": "", "tip": "", "requested_amount": "-1.50", "shipping_carrier": "", "tracking_number": "", "shipping_date": "", "partial_payment_id": "", "partial_payment_balance": "", "platform_id": "", "authorization_code": "123456", "social_security_number": "", "drivers_license_number": "", "drivers_license_state": "", "drivers_license_dob": "", "duty_amount": "0.00", "discount_amount": "0.00", "national_tax_amount": "0.00", "summary_commodity_code": "", "alternate_tax_amount": "0.00", "vat_tax_amount": "0.00", "vat_tax_rate": "0.00", "billing_address": { "first_name": "", "last_name": "", "address_1": "", "address_2": "", "company": "", "city": "", "state": "", "postal_code": "", "country": "", "email": "", "phone": "", "cell_phone": "", "fax": "" }, "shipping_address": { "first_name": "", "last_name": "", "address_1": "", "address_2": "", "company": "", "city": "", "state": "", "postal_code": "", "country": "", "email": "", "phone": "", "fax": "" }, "card": { "cc_number": "411111******1111", "cc_exp": "1025", "cavv": "", "cavv_result": "", "xid": "", "eci": "", "avs_response": "", "csc_response": "", "cardholder_auth": "", "cc_start_date": "", "cc_issue_number": "", "card_balance": "", "card_available_balance": "", "entry_mode": "4", "cc_bin": "", "cc_type": "Visa", "feature_token": "" }, "merchant_defined_fields": {}, "action": { "amount": "-1.50", "action_type": "refund", "date": "20230804155935", "success": "1", "ip_address": "123.123.123.123", "source": "api", "api_method": "direct_post", "username": "test", "response_text": "SUCCESS", "response_code": "100", "processor_response_text": "", "tap_to_mobile": false, "network_token_used": false, "network_token_cryptogram_created": false, "processor_response_code": "", "device_license_number": "", "device_nickname": "" } } } true
Void Success
Documented sample payload; not generated account activity. Where labeled syntax corrected, missing or trailing commas in the source have been repaired without changing field names or values. { "event_id": "56fce295-ee70-46a1-83c2-1f423c43c34c", "event_type": "transaction.void.success", "event_body": { "merchant": { "id": "944025", "name": "Test merchant account" }, "features": { "is_test_mode": true }, "transaction_id": "8584341675", "transaction_type": "cc", "condition": "canceled", "processor_id": "ccprocessora", "ponumber": "", "order_description": "", "order_id": "", "customerid": "", "customertaxid": "", "website": "", "shipping": "0.00", "currency": "USD", "tax": "0.00", "surcharge": "", "convenience_fee": "", "misc_fee": "", "misc_fee_name": "", "cash_discount": "", "tip": "", "requested_amount": "10.00", "shipping_carrier": "", "tracking_number": "", "shipping_date": "", "partial_payment_id": "", "partial_payment_balance": "", "platform_id": "", "authorization_code": "123456", "social_security_number": "", "drivers_license_number": "", "drivers_license_state": "", "drivers_license_dob": "", "duty_amount": "0.00", "discount_amount": "0.00", "national_tax_amount": "0.00", "summary_commodity_code": "", "alternate_tax_amount": "0.00", "vat_tax_amount": "0.00", "vat_tax_rate": "0.00", "billing_address": { "first_name": "", "last_name": "", "address_1": "", "address_2": "", "company": "", "city": "", "state": "", "postal_code": "", "country": "", "email": "", "phone": "", "cell_phone": "", "fax": "" }, "shipping_address": { "first_name": "", "last_name": "", "address_1": "", "address_2": "", "company": "", "city": "", "state": "", "postal_code": "", "country": "", "email": "", "phone": "", "fax": "" }, "card": { "cc_number": "411111******1111", "cc_exp": "1025", "cavv": "", "cavv_result": "", "xid": "", "eci": "", "avs_response": "", "csc_response": "M", "cardholder_auth": "", "cc_start_date": "", "cc_issue_number": "", "card_balance": "", "card_available_balance": "", "entry_mode": "4", "cc_bin": "", "cc_type": "Visa", "feature_token": "" }, "merchant_defined_fields": {}, "action": { "amount": "10.00", "action_type": "void", "date": "20230801115329", "success": "1", "ip_address": "123.123.123.123", "source": "api", "api_method": "direct_post", "username": "test", "response_text": "SUCCESS", "response_code": "100", "processor_response_text": "", "tap_to_mobile": false, "network_token_used": false, "network_token_cryptogram_created": false, "processor_response_code": "", "device_license_number": "", "device_nickname": "" } } } true