Webhooks — delivery & payloads
Swirepay sends HTTPS POST requests to the webhook URLs you configure in the dashboard. Each delivery carries a JSON body describing the resource state change (for example a payment session after capture or refund).
Dashboard setup—Developer → Webhooks, secrets, event checkboxes, and test/live mode—is documented in Webhooks (guides).
HTTP headers
Every webhook request includes:
| Header | Description |
|---|---|
x-swirepay-event | Identifies which event triggered this delivery (for example PAYMENT_SUCCEEDED, PAYMENT_REFUND, PAYMENT_DISPUTE_CREATED). Use this to route logic in your handler. |
x-swirepay-signature | HMAC digest of the raw JSON body, produced with the secret you configured for that webhook. Use it to verify the request genuinely came from Swirepay and was not tampered with in transit. |
Treat the raw POST body as bytes exactly as received when verifying the signature.
Verification
- Read the raw request body (do not parse JSON before verifying unless your framework exposes raw bytes separately).
- Compute an HMAC of that payload using your webhook secret (algorithm aligns with dashboard-generated signatures—typically HMAC-SHA256 over the UTF-8 bytes of the body).
- Compare your computed digest to
x-swirepay-signatureusing a constant-time comparison to avoid timing attacks.
Reject requests where verification fails.
Reliability
Return 2xx promptly after enqueueing work; heavy processing should happen asynchronously. Failures may trigger retries and alert emails configured on the webhook.
Sample payloads
Shapes vary by event and product surface. Below are representative payment session–centric payloads for Payment Center–oriented events (amounts are commonly in minor units, e.g. cents).
PAYMENT_SUCCEEDED
Successful capture—status is SUCCEEDED. Nested paymentMethod, customer, currency, receipt fields, and linkage fields such as spObjectType / spObjectGid (here tied to a payment link) show where the payment originated.
{
"gid": "paymentsession-886874979b3f4d448fb0570a2873e50b",
"createdAt": "2026-04-28T15:15:02.555251",
"updatedAt": "2026-04-28T15:15:16.858203",
"paymentMethod": {
"gid": "paymentmethod-ad632167fb1b4fbb9b94a69de63fcdd2",
"createdAt": "2026-04-28T15:15:02.448619",
"updatedAt": "2026-04-28T15:15:16.377633",
"paymentType": {
"id": 1,
"name": "CREDIT_CARD_NOT_PRESENT",
"category": "CARD",
"createdAt": "2020-09-01T00:23:29",
"updatedAt": "2021-07-14T10:24:06",
"deleted": false,
"recurringPaymentType": true
},
"card": {
"gid": "card-7ff723d7c9e14ef18a6db3ea972289d3",
"createdAt": "2026-04-28T15:15:02.424761",
"updatedAt": "2026-04-28T15:15:16.408778",
"customer": {
"gid": "customer-9513fa98631c4ba6b2d81a7566da6581",
"createdAt": "2026-04-28T15:15:02.25588",
"updatedAt": "2026-04-28T15:15:02.25589",
"name": "Siva Sankar",
"phoneNumber": "+12345678901",
"email": "sivasankar@swirepay.com",
"tax": {
"id": 1,
"type": "NONE",
"country": null
},
"taxStatus": "TAXABLE",
"billingAddress": null,
"shippingAddress": null,
"referenceNumber": null,
"doNotDuplicate": false,
"deleted": false
},
"name": "Siva Sankar",
"scheme": "VISA",
"expiryMonth": 12,
"expiryYear": 2027,
"lastFour": "4242",
"fingerprint": "g2taiX2w0C2pXlNp4+RyxrA9DfJC69+UVJUO2dFnFjU=",
"type": "CREDIT",
"bankName": "Swirepay Test Bank",
"country": {
"id": 1,
"name": "United States of America",
"alpha2": "US",
"alpha3": "USA",
"unCode": "840"
},
"currency": {
"id": 2,
"name": "INR",
"prefix": "₹",
"toFixed": 2,
"countryAlpha2": "IN"
},
"isPresent": false,
"brand": "VISA",
"expiresAt": "2027-12-31",
"device": false,
"deleted": false
},
"googlePayUS": null,
"applePayUS": null,
"instantPayment": null,
"customer": {
"gid": "customer-9513fa98631c4ba6b2d81a7566da6581",
"createdAt": "2026-04-28T15:15:02.25588",
"updatedAt": "2026-04-28T15:15:02.25589",
"name": "Siva Sankar",
"phoneNumber": "+12345678901",
"email": "sivasankar@swirepay.com",
"tax": {
"id": 1,
"type": "NONE",
"country": null
},
"taxStatus": "TAXABLE",
"billingAddress": null,
"shippingAddress": null,
"referenceNumber": null,
"doNotDuplicate": false,
"deleted": false
},
"isVerified": false,
"referenceId": "13419205458979372540",
"upi": null,
"bank": null,
"netbanking": null,
"postalCode": "600009",
"paymentMethodBillingAddress": null,
"cardpointeCard": null,
"swirepayUS": null,
"payPalWallet": null,
"venmo": null,
"zelle": null,
"skipBillingAddress": false,
"tapToPayCard": null,
"directoryConsent": null,
"directory": null,
"default": false,
"device": false,
"saved": false,
"deleted": false
},
"currency": {
"id": 1,
"name": "USD",
"prefix": "$",
"toFixed": 2,
"countryAlpha2": "US"
},
"customer": {
"gid": "customer-9513fa98631c4ba6b2d81a7566da6581",
"createdAt": "2026-04-28T15:15:02.25588",
"updatedAt": "2026-04-28T15:15:02.25589",
"name": "Siva Sankar",
"phoneNumber": "+12345678901",
"email": "sivasankar@swirepay.com",
"tax": {
"id": 1,
"type": "NONE",
"country": null
},
"taxStatus": "TAXABLE",
"billingAddress": null,
"shippingAddress": null,
"referenceNumber": null,
"doNotDuplicate": false,
"deleted": false
},
"status": "SUCCEEDED",
"amount": 1000,
"amountRefunded": 0,
"description": "test for apple pay",
"statementDescriptor": "Square Park",
"paymentMethodType": [
"CARD",
"ACH_LEGACY",
"ZIP_ACH",
"X_ACH"
],
"meta": null,
"receiptEmail": "sivasankar@swirepay.com",
"receiptSms": "+12345678901",
"confirmMethod": "AUTOMATIC",
"captureMethod": "AUTOMATIC",
"errorCode": null,
"errorDescription": "",
"amountUnCaptured": 0,
"amountReceived": 1000,
"refundReason": null,
"disputeStatus": null,
"disputeType": null,
"respondBy": null,
"refundNote": null,
"paymentDate": "2026-04-28T15:15:16.870361",
"refundDate": null,
"disputeDate": null,
"amountDisputed": null,
"disputeFee": null,
"receiptNumber": null,
"feeAmount": 0,
"feeTax": 0,
"net": 1000,
"mdr": "MERCHANT_MDR",
"nextActionUrl": null,
"psClientSecret": "paymentsession-886874979b3f4d448fb0570a2873e50b_7d194928440144e29681c9308e96b300",
"returnUrl": null,
"secureStatus": null,
"paymentLinkId": 36464,
"paymentLinkGid": "paymentlink-19f70a83f0574c188fa305a83976cfd1",
"checkoutPageGid": null,
"checkoutPageId": null,
"subscription": null,
"invoice": null,
"paymentButtonId": null,
"paymentButtonGid": null,
"paymentPage": null,
"mrn": null,
"authorizationId": "118450740516",
"authCode": "PPS903",
"partnerAccountGid": null,
"applicationFee": 0,
"paymentWidgetId": null,
"paymentWidgetGid": null,
"woocommerceOrder": null,
"terminal": null,
"batchNumber": null,
"spLink": "https://secure.swirepay.com/payment-link/paymentlink-19f70a83f0574c188fa305a83976cfd1",
"shouldWhatsAppNotify": null,
"tip": null,
"serviceFee": 0,
"tax": null,
"paidAmount": 1000,
"seatPage": null,
"inventoryOrder": null,
"paymentSessionRewards": null,
"paymentSessionErrorRecordDtos": null,
"spObjectType": "PAYMENT_LINK",
"spObjectGid": "paymentlink-19f70a83f0574c188fa305a83976cfd1",
"marketplaceAmount": 0,
"contactGid": null,
"internalRefund": null,
"deleted": false
}
PAYMENT_REFUND
Refund completed against the same payment session—note status (here VOID)**, amountRefunded, refundReason, refundNote, and refundDate.
{
"gid": "paymentsession-886874979b3f4d448fb0570a2873e50b",
"createdAt": "2026-04-28T15:15:03",
"updatedAt": "2026-04-28T15:55:06.90496",
"paymentMethod": {
"gid": "paymentmethod-ad632167fb1b4fbb9b94a69de63fcdd2",
"createdAt": "2026-04-28T15:15:02",
"updatedAt": "2026-04-28T15:15:16",
"paymentType": {
"id": 1,
"name": "CREDIT_CARD_NOT_PRESENT",
"category": "CARD",
"createdAt": "2020-09-01T00:23:29",
"updatedAt": "2021-07-14T10:24:06",
"deleted": false,
"recurringPaymentType": true
},
"card": {
"gid": "card-7ff723d7c9e14ef18a6db3ea972289d3",
"createdAt": "2026-04-28T15:15:02",
"updatedAt": "2026-04-28T15:15:16",
"customer": {
"gid": "customer-9513fa98631c4ba6b2d81a7566da6581",
"createdAt": "2026-04-28T15:15:02",
"updatedAt": "2026-04-28T15:15:02",
"name": "Siva Sankar",
"phoneNumber": "+12345678901",
"email": "sivasankar@swirepay.com",
"tax": {
"id": 1,
"type": "NONE",
"country": null
},
"taxStatus": "TAXABLE",
"billingAddress": null,
"shippingAddress": null,
"referenceNumber": null,
"doNotDuplicate": false,
"deleted": false
},
"name": "Siva Sankar",
"scheme": "VISA",
"expiryMonth": 12,
"expiryYear": 2027,
"lastFour": "4242",
"fingerprint": "g2taiX2w0C2pXlNp4+RyxrA9DfJC69+UVJUO2dFnFjU=",
"type": "CREDIT",
"bankName": "Swirepay Test Bank",
"country": {
"id": 1,
"name": "United States of America",
"alpha2": "US",
"alpha3": "USA",
"unCode": "840"
},
"currency": {
"id": 2,
"name": "INR",
"prefix": "₹",
"toFixed": 2,
"countryAlpha2": "IN"
},
"isPresent": false,
"brand": "VISA",
"expiresAt": "2027-12-31",
"device": false,
"deleted": false
},
"googlePayUS": null,
"applePayUS": null,
"instantPayment": null,
"customer": {
"gid": "customer-9513fa98631c4ba6b2d81a7566da6581",
"createdAt": "2026-04-28T15:15:02",
"updatedAt": "2026-04-28T15:15:02",
"name": "Siva Sankar",
"phoneNumber": "+12345678901",
"email": "sivasankar@swirepay.com",
"tax": {
"id": 1,
"type": "NONE",
"country": null
},
"taxStatus": "TAXABLE",
"billingAddress": null,
"shippingAddress": null,
"referenceNumber": null,
"doNotDuplicate": false,
"deleted": false
},
"isVerified": false,
"referenceId": "13419205458979372540",
"upi": null,
"bank": null,
"netbanking": null,
"postalCode": "600009",
"paymentMethodBillingAddress": null,
"cardpointeCard": null,
"swirepayUS": null,
"payPalWallet": null,
"venmo": null,
"zelle": null,
"skipBillingAddress": false,
"tapToPayCard": null,
"directoryConsent": null,
"directory": null,
"default": false,
"device": null,
"saved": false,
"deleted": false
},
"currency": {
"id": 1,
"name": "USD",
"prefix": "$",
"toFixed": 2,
"countryAlpha2": "US"
},
"customer": {
"gid": "customer-9513fa98631c4ba6b2d81a7566da6581",
"createdAt": "2026-04-28T15:15:02",
"updatedAt": "2026-04-28T15:15:02",
"name": "Siva Sankar",
"phoneNumber": "+12345678901",
"email": "sivasankar@swirepay.com",
"tax": {
"id": 1,
"type": "NONE",
"country": null
},
"taxStatus": "TAXABLE",
"billingAddress": null,
"shippingAddress": null,
"referenceNumber": null,
"doNotDuplicate": false,
"deleted": false
},
"status": "VOID",
"amount": 1000,
"amountRefunded": 1000,
"description": "test for apple pay",
"statementDescriptor": "Square Park",
"paymentMethodType": [
"CARD",
"ACH_LEGACY",
"ZIP_ACH",
"X_ACH"
],
"meta": null,
"receiptEmail": "sivasankar@swirepay.com",
"receiptSms": "+12345678901",
"confirmMethod": "AUTOMATIC",
"captureMethod": "AUTOMATIC",
"errorCode": null,
"errorDescription": "",
"amountUnCaptured": 0,
"amountReceived": 1000,
"refundReason": "DUPLICATE",
"disputeStatus": null,
"disputeType": null,
"respondBy": null,
"refundNote": "test",
"paymentDate": "2026-04-28T15:15:17",
"refundDate": "2026-04-28T15:55:06.878298",
"disputeDate": null,
"amountDisputed": null,
"disputeFee": null,
"receiptNumber": "8fb0570a2873e50b",
"feeAmount": 0,
"feeTax": 0,
"net": 0,
"mdr": "MERCHANT_MDR",
"nextActionUrl": null,
"psClientSecret": "paymentsession-886874979b3f4d448fb0570a2873e50b_7d194928440144e29681c9308e96b300",
"returnUrl": null,
"secureStatus": null,
"paymentLinkId": 36464,
"paymentLinkGid": "paymentlink-19f70a83f0574c188fa305a83976cfd1",
"checkoutPageGid": null,
"checkoutPageId": null,
"subscription": null,
"invoice": null,
"paymentButtonId": null,
"paymentButtonGid": null,
"paymentPage": null,
"mrn": null,
"authorizationId": "118450740516",
"authCode": "PPS903",
"partnerAccountGid": null,
"applicationFee": 0,
"paymentWidgetId": null,
"paymentWidgetGid": null,
"woocommerceOrder": null,
"terminal": null,
"batchNumber": null,
"spLink": "https://secure.swirepay.com/payment-link/paymentlink-19f70a83f0574c188fa305a83976cfd1",
"shouldWhatsAppNotify": null,
"tip": null,
"serviceFee": 0,
"tax": null,
"paidAmount": 1000,
"seatPage": null,
"inventoryOrder": null,
"paymentSessionRewards": null,
"paymentSessionErrorRecordDtos": null,
"spObjectType": "PAYMENT_LINK",
"spObjectGid": "paymentlink-19f70a83f0574c188fa305a83976cfd1",
"marketplaceAmount": 0,
"contactGid": null,
"internalRefund": null,
"deleted": false
}
PAYMENT_DISPUTE_CREATED
Dispute opened—status moves into a disputed state (here DISPUTED_NEEDS_RESPONSE), with disputeStatus, disputeType, respondBy, disputeDate, amountDisputed, disputeFee. When the underlying charge relates to an invoice, a nested invoice object may appear with full invoice detail.
{
"gid": "paymentsession-4765e53fa58a48ea95ddf338e0fff2e1",
"createdAt": "2026-04-10T08:13:11",
"updatedAt": "2026-04-28T15:55:56.002068",
"paymentMethod": {
"gid": "paymentmethod-3e7e59263d2d4f5e99cf2c337d9267f3",
"createdAt": "2026-02-20T07:32:16",
"updatedAt": "2026-02-20T07:32:29",
"paymentType": {
"id": 1,
"name": "CREDIT_CARD_NOT_PRESENT",
"category": "CARD",
"createdAt": "2020-09-01T00:23:29",
"updatedAt": "2021-07-14T10:24:06",
"deleted": false,
"recurringPaymentType": true
},
"card": {
"gid": "card-63209970c53c44c9ae311826ed1cef8f",
"createdAt": "2026-02-20T07:32:16",
"updatedAt": "2026-02-20T07:32:29",
"customer": {
"gid": "customer-e3691f531b9449628352f5a8af907ada",
"createdAt": "2025-08-10T23:00:42",
"updatedAt": "2026-02-20T07:32:16",
"name": "siva sankar test",
"phoneNumber": "+14259952799",
"email": "sivasankar@swirepay.com",
"tax": {
"id": 1,
"type": "NONE",
"country": null
},
"taxStatus": "TAXABLE",
"billingAddress": {
"street": "testtt",
"city": "testtt",
"state": "KA",
"postalCode": "600001",
"country": {
"id": 2,
"name": "India",
"alpha2": "IN",
"alpha3": "IND",
"unCode": "356"
},
"deleted": false
},
"shippingAddress": {
"street": "test test",
"city": "test",
"state": "CA",
"postalCode": "62400",
"country": {
"id": 1,
"name": "United States of America",
"alpha2": "US",
"alpha3": "USA",
"unCode": "840"
},
"deleted": false
},
"referenceNumber": null,
"doNotDuplicate": false,
"deleted": false
},
"name": "Siva Sankar",
"scheme": "VISA",
"expiryMonth": 12,
"expiryYear": 2027,
"lastFour": "4242",
"fingerprint": "g2taiX2w0C2pXlNp4+RyxrA9DfJC69+UVJUO2dFnFjU=",
"type": "CREDIT",
"bankName": "Swirepay Test Bank",
"country": {
"id": 1,
"name": "United States of America",
"alpha2": "US",
"alpha3": "USA",
"unCode": "840"
},
"currency": {
"id": 2,
"name": "INR",
"prefix": "₹",
"toFixed": 2,
"countryAlpha2": "IN"
},
"isPresent": false,
"brand": "VISA",
"expiresAt": "2027-12-31",
"device": false,
"deleted": false
},
"googlePayUS": null,
"applePayUS": null,
"instantPayment": null,
"customer": {
"gid": "customer-e3691f531b9449628352f5a8af907ada",
"createdAt": "2025-08-10T23:00:42",
"updatedAt": "2026-02-20T07:32:16",
"name": "siva sankar test",
"phoneNumber": "+14259952799",
"email": "sivasankar@swirepay.com",
"tax": {
"id": 1,
"type": "NONE",
"country": null
},
"taxStatus": "TAXABLE",
"billingAddress": {
"street": "testtt",
"city": "testtt",
"state": "KA",
"postalCode": "600001",
"country": {
"id": 2,
"name": "India",
"alpha2": "IN",
"alpha3": "IND",
"unCode": "356"
},
"deleted": false
},
"shippingAddress": {
"street": "test test",
"city": "test",
"state": "CA",
"postalCode": "62400",
"country": {
"id": 1,
"name": "United States of America",
"alpha2": "US",
"alpha3": "USA",
"unCode": "840"
},
"deleted": false
},
"referenceNumber": null,
"doNotDuplicate": false,
"deleted": false
},
"isVerified": true,
"referenceId": "15456171048248362076",
"upi": null,
"bank": null,
"netbanking": null,
"postalCode": "600001",
"paymentMethodBillingAddress": null,
"cardpointeCard": null,
"swirepayUS": null,
"payPalWallet": null,
"venmo": null,
"zelle": null,
"skipBillingAddress": false,
"tapToPayCard": null,
"directoryConsent": null,
"directory": null,
"default": false,
"device": null,
"saved": false,
"deleted": false
},
"currency": {
"id": 1,
"name": "USD",
"prefix": "$",
"toFixed": 2,
"countryAlpha2": "US"
},
"customer": {
"gid": "customer-e3691f531b9449628352f5a8af907ada",
"createdAt": "2025-08-10T23:00:42",
"updatedAt": "2026-02-20T07:32:16",
"name": "siva sankar test",
"phoneNumber": "+14259952799",
"email": "sivasankar@swirepay.com",
"tax": {
"id": 1,
"type": "NONE",
"country": null
},
"taxStatus": "TAXABLE",
"billingAddress": {
"street": "testtt",
"city": "testtt",
"state": "KA",
"postalCode": "600001",
"country": {
"id": 2,
"name": "India",
"alpha2": "IN",
"alpha3": "IND",
"unCode": "356"
},
"deleted": false
},
"shippingAddress": {
"street": "test test",
"city": "test",
"state": "CA",
"postalCode": "62400",
"country": {
"id": 1,
"name": "United States of America",
"alpha2": "US",
"alpha3": "USA",
"unCode": "840"
},
"deleted": false
},
"referenceNumber": null,
"doNotDuplicate": false,
"deleted": false
},
"status": "DISPUTED_NEEDS_RESPONSE",
"amount": 1500,
"amountRefunded": 0,
"description": "test",
"statementDescriptor": "Square Park",
"paymentMethodType": [
"CARD"
],
"meta": null,
"receiptEmail": "sivasankar@swirepay.com",
"receiptSms": "+14259952799",
"confirmMethod": "AUTOMATIC",
"captureMethod": "AUTOMATIC",
"errorCode": null,
"errorDescription": "",
"amountUnCaptured": 0,
"amountReceived": 1500,
"refundReason": null,
"disputeStatus": "NEEDS_RESPONSE",
"disputeType": "adsbsfad",
"respondBy": "2026-04-28T07:00:00",
"refundNote": null,
"paymentDate": "2026-04-10T08:13:13",
"refundDate": null,
"disputeDate": "2026-04-28T15:55:56.154401",
"amountDisputed": 1500,
"disputeFee": 2000,
"receiptNumber": "95ddf338e0fff2e1",
"feeAmount": 0,
"feeTax": 0,
"net": 1500,
"mdr": "MERCHANT_MDR",
"nextActionUrl": null,
"psClientSecret": "paymentsession-4765e53fa58a48ea95ddf338e0fff2e1_b74d3c870d2d499fb7fc470f7bea26a9",
"returnUrl": null,
"secureStatus": null,
"paymentLinkId": null,
"paymentLinkGid": null,
"checkoutPageGid": null,
"checkoutPageId": null,
"subscription": null,
"invoice": {
"gid": "invoice-ccbe625151784a3780c4f2ef42471e43",
"createdAt": "2026-04-10T07:19:03",
"updatedAt": "2026-04-28T15:55:56.138927",
"status": "PAID",
"invoiceNumber": "CARD-000082",
"amount": 1000,
"paymentMethodType": [
"CARD"
],
"statementDescriptor": null,
"description": "test",
"paymentDate": "2026-04-10T08:13:13",
"lastProcessed": "2026-04-10T08:13:13",
"noRetries": 0,
"billingAddress": null,
"shippingAddress": null,
"paymentDueDate": "2026-04-10T07:00:00",
"currency": {
"id": 1,
"name": "USD",
"prefix": "$",
"toFixed": 2,
"countryAlpha2": "US"
},
"customer": {
"gid": "customer-e3691f531b9449628352f5a8af907ada",
"createdAt": "2025-08-10T23:00:42",
"updatedAt": "2026-02-20T07:32:16",
"name": "siva sankar test",
"phoneNumber": "+14259952799",
"email": "sivasankar@swirepay.com",
"tax": {
"id": 1,
"type": "NONE",
"country": null
},
"taxStatus": "TAXABLE",
"billingAddress": {
"street": "testtt",
"city": "testtt",
"state": "KA",
"postalCode": "600001",
"country": {
"id": 2,
"name": "India",
"alpha2": "IN",
"alpha3": "IND",
"unCode": "356"
},
"deleted": false
},
"shippingAddress": {
"street": "test test",
"city": "test",
"state": "CA",
"postalCode": "62400",
"country": {
"id": 1,
"name": "United States of America",
"alpha2": "US",
"alpha3": "USA",
"unCode": "840"
},
"deleted": false
},
"referenceNumber": null,
"doNotDuplicate": false,
"deleted": false
},
"invoiceLineItems": [
{
"gid": "invoicelineitem-33305818853441368343e32c84d7f84d",
"createdAt": "2026-04-10T07:19:03",
"updatedAt": "2026-04-10T07:19:02",
"name": "test",
"amount": 1000,
"description": "test",
"note": "test",
"quantity": 1,
"invoiceGid": "invoice-ccbe625151784a3780c4f2ef42471e43",
"totalStr": "$10.00",
"amountStr": "$10.00",
"itemGid": null,
"deleted": false
}
],
"invoiceLinks": [
{
"gid": "invoicelink-d4414f67060c46ffb4b72685dcbb1acd",
"createdAt": "2026-04-10T07:19:03",
"updatedAt": "2026-04-10T07:19:02",
"invoiceGid": "invoice-ccbe625151784a3780c4f2ef42471e43",
"redirectUri": null,
"link": "https://secure.swirepay.com/invoice-link/invoicelink-d4414f67060c46ffb4b72685dcbb1acd",
"nextActionUrl": null,
"paymentSession": null,
"notificationType": null,
"deleted": false
}
],
"invoicePdfKey": "a926a9d8-a2fe-4e3c-bec1-cffd0122aa5a",
"paymentMethod": {
"gid": "paymentmethod-3e7e59263d2d4f5e99cf2c337d9267f3",
"createdAt": "2026-02-20T07:32:16",
"updatedAt": "2026-02-20T07:32:29",
"paymentType": {
"id": 1,
"name": "CREDIT_CARD_NOT_PRESENT",
"category": "CARD",
"createdAt": "2020-09-01T00:23:29",
"updatedAt": "2021-07-14T10:24:06",
"deleted": false,
"recurringPaymentType": true
},
"card": {
"gid": "card-63209970c53c44c9ae311826ed1cef8f",
"createdAt": "2026-02-20T07:32:16",
"updatedAt": "2026-02-20T07:32:29",
"customer": {
"gid": "customer-e3691f531b9449628352f5a8af907ada",
"createdAt": "2025-08-10T23:00:42",
"updatedAt": "2026-02-20T07:32:16",
"name": "siva sankar test",
"phoneNumber": "+14259952799",
"email": "sivasankar@swirepay.com",
"tax": {
"id": 1,
"type": "NONE",
"country": null
},
"taxStatus": "TAXABLE",
"billingAddress": {
"street": "testtt",
"city": "testtt",
"state": "KA",
"postalCode": "600001",
"country": {
"id": 2,
"name": "India",
"alpha2": "IN",
"alpha3": "IND",
"unCode": "356"
},
"deleted": false
},
"shippingAddress": {
"street": "test test",
"city": "test",
"state": "CA",
"postalCode": "62400",
"country": {
"id": 1,
"name": "United States of America",
"alpha2": "US",
"alpha3": "USA",
"unCode": "840"
},
"deleted": false
},
"referenceNumber": null,
"doNotDuplicate": false,
"deleted": false
},
"name": "Siva Sankar",
"scheme": "VISA",
"expiryMonth": 12,
"expiryYear": 2027,
"lastFour": "4242",
"fingerprint": "g2taiX2w0C2pXlNp4+RyxrA9DfJC69+UVJUO2dFnFjU=",
"type": "CREDIT",
"bankName": "Swirepay Test Bank",
"country": {
"id": 1,
"name": "United States of America",
"alpha2": "US",
"alpha3": "USA",
"unCode": "840"
},
"currency": {
"id": 2,
"name": "INR",
"prefix": "₹",
"toFixed": 2,
"countryAlpha2": "IN"
},
"isPresent": false,
"brand": "VISA",
"expiresAt": "2027-12-31",
"device": false,
"deleted": false
},
"googlePayUS": null,
"applePayUS": null,
"instantPayment": null,
"customer": {
"gid": "customer-e3691f531b9449628352f5a8af907ada",
"createdAt": "2025-08-10T23:00:42",
"updatedAt": "2026-02-20T07:32:16",
"name": "siva sankar test",
"phoneNumber": "+14259952799",
"email": "sivasankar@swirepay.com",
"tax": {
"id": 1,
"type": "NONE",
"country": null
},
"taxStatus": "TAXABLE",
"billingAddress": {
"street": "testtt",
"city": "testtt",
"state": "KA",
"postalCode": "600001",
"country": {
"id": 2,
"name": "India",
"alpha2": "IN",
"alpha3": "IND",
"unCode": "356"
},
"deleted": false
},
"shippingAddress": {
"street": "test test",
"city": "test",
"state": "CA",
"postalCode": "62400",
"country": {
"id": 1,
"name": "United States of America",
"alpha2": "US",
"alpha3": "USA",
"unCode": "840"
},
"deleted": false
},
"referenceNumber": null,
"doNotDuplicate": false,
"deleted": false
},
"isVerified": true,
"referenceId": "15456171048248362076",
"upi": null,
"bank": null,
"netbanking": null,
"postalCode": "600001",
"paymentMethodBillingAddress": null,
"cardpointeCard": null,
"swirepayUS": null,
"payPalWallet": null,
"venmo": null,
"zelle": null,
"skipBillingAddress": false,
"tapToPayCard": null,
"directoryConsent": null,
"directory": null,
"default": false,
"device": null,
"saved": false,
"deleted": false
},
"subscription": null,
"issueDate": "2026-04-10T07:19:03",
"customerNote": null,
"daysUntilDue": null,
"paymentProcessDate": "2026-04-10T07:00:00",
"redirectUrl": null,
"paymentSession": null,
"taxAmount": [
{
"taxRates": {
"gid": "taxrates-2d011418bec34baa8dc5ec392c5d859a",
"createdAt": "2025-08-11T06:19:46",
"updatedAt": "2025-08-11T06:19:46",
"cloverReferenceId": null,
"displayName": "Sales Tax",
"description": "Sales Tax",
"jurisdiction": "USA",
"percentage": 10.0,
"isDefault": false,
"inclusive": true,
"deleted": false
},
"tax": 91
},
{
"taxRates": {
"gid": "taxrates-c8292f2f2f074176a1f9651e8280080f",
"createdAt": "2025-08-11T06:20:08",
"updatedAt": "2025-08-11T06:20:08",
"cloverReferenceId": null,
"displayName": "GST",
"description": "GST",
"jurisdiction": "USA",
"percentage": 15.0,
"isDefault": false,
"inclusive": true,
"deleted": false
},
"tax": 130
}
],
"total": 1500,
"subscriptionDiscountAmount": null,
"paymentTerms": 0,
"applicationFee": 0,
"partnerAccountGid": null,
"shippingAmount": 500,
"qbTaxPercent": null,
"percentageBased": false,
"qbDiscount": null,
"recipientsEmail": null,
"invoiceTimeLines": [
{
"gid": "invoicetimeline-33c90e9e706d41b683a641a32654d903",
"createdAt": "2026-04-10T07:19:03",
"updatedAt": "2026-04-10T07:19:03",
"text": "Invoice is active and ready to pay",
"subText": null,
"type": "INFO",
"timelineStatus": "ACTIVE",
"event": null,
"timestamp": "2026-04-10T07:19:03",
"deleted": false
},
{
"gid": "invoicetimeline-ea2bc0c00ab94e0fbd5322ead8329ca8",
"createdAt": "2026-04-10T08:13:14",
"updatedAt": "2026-04-10T08:13:14",
"text": "Payment of $1500 Received. Invoice is now Fully Paid And Closed.",
"subText": null,
"type": "SUCCESS",
"timelineStatus": "PAID",
"event": null,
"timestamp": "2026-04-10T08:13:14",
"deleted": false
}
],
"meta": null,
"invoicePoojaData": [],
"invoicePaymentType": null,
"enableAutopay": null,
"invoiceType": "REGULAR",
"invoiceTermsAndConditions": null,
"lateFeeAmount": null,
"overdueInterestAmount": null,
"overdueFeeAmount": null,
"paidAmount": 1500,
"expiryDate": null,
"interestProcessDate": null,
"invoiceDocument": null,
"serviceDate": null,
"surchargeEnabled": null,
"surchargeAmount": null,
"deleted": false
},
"paymentButtonId": null,
"paymentButtonGid": null,
"paymentPage": null,
"mrn": null,
"authorizationId": "100036015192",
"authCode": "PPS585",
"partnerAccountGid": null,
"applicationFee": 0,
"paymentWidgetId": null,
"paymentWidgetGid": null,
"woocommerceOrder": null,
"terminal": null,
"batchNumber": null,
"spLink": null,
"shouldWhatsAppNotify": null,
"tip": null,
"serviceFee": 0,
"tax": null,
"paidAmount": 1500,
"seatPage": null,
"inventoryOrder": null,
"paymentSessionRewards": null,
"paymentSessionErrorRecordDtos": null,
"spObjectType": "INVOICE",
"spObjectGid": "invoice-ccbe625151784a3780c4f2ef42471e43",
"marketplaceAmount": 0,
"contactGid": null,
"internalRefund": null,
"deleted": false
}
CONTACT_UPDATE
Fired when a Transfer Center contact changes—commonly when a sub-merchant completes funding source verification and status moves to VERIFIED. Use this in marketplace integrations to enable live charges only after bank details are verified.
The x-swirepay-event header value is CONTACT_UPDATE. See Transfer Center webhook events.
{
"gid": "contact-1ae78802264d41519cea2ff9f485f4a6",
"createdAt": "2026-01-30T16:58:16",
"updatedAt": "2026-01-30T17:46:46.796599",
"name": "John Smith",
"email": "john.doe@swirepay.com",
"paymentTermsDays": null,
"referenceId": null,
"contactType": "MARKETPLACE",
"customType": null,
"meta": {
"internalERPReference": "ABC123"
},
"address": {
"street": "2 Pierce Avenue, San Jose, CA, USA",
"city": "San Jose",
"state": "CA",
"postalCode": "95113",
"country": {
"id": 1,
"name": "United States of America",
"alpha2": "US",
"alpha3": "USA",
"unCode": "840"
},
"deleted": false
},
"tax": {
"id": 1,
"type": "NONE",
"country": null
},
"phoneNumber": "+14145448582",
"doNotDuplicate": false,
"status": "VERIFIED",
"marketplaceActive": true,
"primary": false,
"verified": false,
"deleted": false
}
See also
- Webhooks (guides) — dashboard setup and full event catalog
- Marketplace integration — contact onboarding and
CONTACT_UPDATEusage - Getting started