GiveCard Webhook Event Types
This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.
bankTransfer.completed
Receive a notification when a bank transfer completes.
Example
JSON
{
"bankTransfers": {
"amount": 500.75,
"businessId": "8d8b40ef-1760-462c-b53f-8580b1f8157f",
"completedAt": "2024-09-05T12:34:56.000Z",
"createdAt": "2024-09-01T12:34:56.000Z",
"estimatedDeliveryDate": "2024-09-05T12:00:00.000Z",
"failedAt": null,
"failureReason": "",
"id": "bt1234567-b890-1234-c567-89abcdef1234",
"initiatedAt": "2024-09-01T12:34:56.000Z",
"recipient": {
"businessId": "9a9b40ef-1760-462c-b53f-8580b1f8157a",
"createdAt": "2024-09-01T12:00:00.000Z",
"externalBankAccounts": [
{
"accountNumberLast4Digits": "6789",
"businessId": "9a9b40ef-1760-462c-b53f-8580b1f8157a",
"createdAt": "2024-09-01T12:00:00.000Z",
"id": "eb1234567-b890-1234-c567-89abcdef1234",
"instantTransferEligible": true,
"nameOnAccount": "Star Dust",
"recipientId": "r1234567-b890-1234-c567-89abcdef1234",
"routingNumber": "253075028",
"type": "checking",
"updatedAt": "2024-09-01T12:30:00.000Z"
}
],
"externalId": "MAGIC1234",
"firstName": "Star",
"id": "r1234567-b890-1234-c567-89abcdef1234",
"lastName": "Dust",
"updatedAt": "2024-09-01T12:30:00.000Z"
},
"recipientId": "r1234567-b890-1234-c567-89abcdef1234",
"status": "completed",
"transferMethod": "ach",
"transferPurpose": "disbursement",
"updatedAt": "2024-09-05T12:34:56.000Z"
},
"eventType": "bankTransfer.completed"
}bankTransfer.failed
Receive a notification when a bank transfer fails
Example
JSON
{
"bankTransfers": {
"amount": 500.75,
"businessId": "8d8b40ef-1760-462c-b53f-8580b1f8157f",
"completedAt": null,
"createdAt": "2024-09-01T12:34:56.000Z",
"estimatedDeliveryDate": "2024-09-05T00:00:00.000Z",
"failedAt": "2024-09-02T14:20:00.000Z",
"failureReason": "Insufficient funds",
"id": "bt1234567-b890-1234-c567-89abcdef1234",
"initiatedAt": "2024-09-01T12:34:56.000Z",
"recipient": {
"businessId": "9a9b40ef-1760-462c-b53f-8580b1f8157a",
"createdAt": "2024-09-01T12:00:00.000Z",
"externalBankAccounts": [
{
"accountNumberLast4Digits": "6789",
"businessId": "9a9b40ef-1760-462c-b53f-8580b1f8157a",
"createdAt": "2024-09-01T12:00:00.000Z",
"id": "eb1234567-b890-1234-c567-89abcdef1234",
"instantTransferEligible": true,
"nameOnAccount": "Star Dust",
"recipientId": "r1234567-b890-1234-c567-89abcdef1234",
"routingNumber": "123456789",
"type": "checking",
"updatedAt": "2024-09-01T12:30:00.000Z"
}
],
"externalId": "MAGIC1234",
"firstName": "Star",
"id": "r1234567-b890-1234-c567-89abcdef1234",
"lastName": "Dust",
"updatedAt": "2024-09-01T12:30:00.000Z"
},
"recipientId": "r1234567-b890-1234-c567-89abcdef1234",
"status": "failed",
"transferMethod": "",
"transferPurpose": "disbursement",
"updatedAt": "2024-09-02T14:20:00.000Z"
},
"eventType": "bankTransfer.failed"
}bankTransfer.processing
Receive a notification when a bank transfer is processing.
Example
JSON
{
"bankTransfers": {
"amount": 500.75,
"businessId": "8d8b40ef-1760-462c-b53f-8580b1f8157f",
"completedAt": null,
"createdAt": "2024-09-01T12:34:56.000Z",
"estimatedDeliveryDate": "2024-09-05T00:00:00.000Z",
"failedAt": null,
"failureReason": "",
"id": "bt1234567-b890-1234-c567-89abcdef1234",
"initiatedAt": "2024-09-01T12:34:56.000Z",
"recipient": {
"businessId": "9a9b40ef-1760-462c-b53f-8580b1f8157a",
"createdAt": "2024-09-01T12:00:00.000Z",
"externalBankAccounts": [
{
"accountNumberLast4Digits": "6789",
"businessId": "9a9b40ef-1760-462c-b53f-8580b1f8157a",
"createdAt": "2024-09-01T12:00:00.000Z",
"id": "eb1234567-b890-1234-c567-89abcdef1234",
"instantTransferEligible": true,
"nameOnAccount": "Star Dust",
"recipientId": "r1234567-b890-1234-c567-89abcdef1234",
"routingNumber": "253075028",
"type": "checking",
"updatedAt": "2024-09-01T12:30:00.000Z"
}
],
"externalId": "MAGIC1234",
"firstName": "Star",
"id": "r1234567-b890-1234-c567-89abcdef1234",
"lastName": "Dust",
"updatedAt": "2024-09-01T12:30:00.000Z"
},
"recipientId": "r1234567-b890-1234-c567-89abcdef1234",
"status": "processing",
"transferMethod": "ach",
"transferPurpose": "disbursement",
"updatedAt": "2024-09-02T14:20:00.000Z"
},
"eventType": "bankTransfer.processing"
}card.reassociated
Receive a notification when a card has been reassociated. This occurs when a business gives a cardholder a new physical card from backstock, rather than reissuing the card. Re-associating a card migrates all tags, autoloads, merchant rules, funds, and the cardholder's account to the new card.
Example
JSON
{
"eventType": "card.reassociated",
"newCard": {
"bin": "511114",
"businessID": "8d8b40ef-1760-462c-b53f-8580b1f8157f",
"createdAt": "2024-07-01T00:00:00.000",
"expirationDate": "2028-07-01T00:00:00Z",
"externalId": "PHOENIX4567",
"id": "a1234567-b890-1234-c567-89abcdef1234",
"last4": "5678",
"lastLoadedAt": "2024-06-30T00:00:00Z",
"merchantRuleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"personalization": {
"line1": "Realm of Givetopia",
"line2": "Citizen 456"
},
"shippingAddress": {
"city": "Los Angeles",
"company": "Givetopia",
"country": "USA",
"firstName": "Luna",
"lastName": "Stellar",
"postalCode": "90001",
"state": "CA",
"street": "456 Givetopia Blvd",
"street2": "Suite 101"
},
"status": "active",
"tags": [
{
"colorHex": "#18a058",
"createdAt": "2023-06-01T00:00:00.000",
"id": "ce60503a-b920-4436-ac55-406d7dbd3892",
"name": "Distribution",
"updatedAt": "2023-06-01T00:00:00.000",
"value": "In-Person"
}
],
"trackingNumber": "1234 5678 9012 3456 7890 00",
"type": "physical",
"updatedAt": "2024-07-01T00:00:00.000",
"virtualCardActivationStatus": "",
"virtualCardEmail": ""
},
"originalCard": {
"bin": "511113",
"businessID": "7c7b40ef-1650-462c-b43f-8580a1f8056g",
"createdAt": "2023-06-01T00:00:00.000",
"expirationDate": "2027-06-01T00:00:00Z",
"externalId": "WIZARD5678",
"id": "b2345678-c901-2345-d678-90abcdef1234",
"last4": "1234",
"lastLoadedAt": "2023-05-30T00:00:00Z",
"merchantRuleId": "b2c3d4e5-f678-9012-abcd-ef1234567890",
"personalization": {
"line1": "Land of Givetopia",
"line2": "Citizen 123"
},
"shippingAddress": {
"city": "New York",
"company": "Givetopia",
"country": "USA",
"firstName": "Tizza",
"lastName": "Armando",
"postalCode": "11345",
"state": "NY",
"street": "123 GiveCard Way",
"street2": "Apt 9 3/4"
},
"status": "closed",
"tags": [
{
"colorHex": "#18a058",
"createdAt": "2023-06-01T00:00:00.000",
"id": "ce60503a-b920-4436-ac55-406d7dbd3892",
"name": "Distribution",
"updatedAt": "2023-06-01T00:00:00.000",
"value": "In-Person"
}
],
"trackingNumber": "9400 1000 0000 0000 0000 00",
"type": "physical",
"updatedAt": "2023-06-01T00:00:00.000",
"virtualCardActivationStatus": "",
"virtualCardEmail": ""
}
}card.reissued
Receive a notification when a card has been reissued. When a card is reissued, all fields stay the same except expiration date, last 4, and potentially shipping address.
Example
JSON
{
"card": {
"bin": "511114",
"businessID": "8d8b40ef-1760-462c-b53f-8580b1f8157f",
"createdAt": "2024-01-01T00:00:00.000Z",
"expirationDate": "2028-01-01T00:00:00Z",
"externalId": "WIZARD1234",
"id": "fe3347f4-a377-474a-a4fa-07eeb8ec257d",
"last4": "8901",
"lastLoadedAt": "2023-12-01T00:00:00Z",
"merchantRuleId": "63af006a-68c3-4233-866d-b54143a1ca6b",
"personalization": {
"line1": "Land of Givetopia",
"line2": "Citizen 123"
},
"shippingAddress": {
"city": "New York",
"company": "Givetopia",
"country": "USA",
"firstName": "Tizza",
"lastName": "Armando",
"postalCode": "11345",
"state": "NY",
"street": "123 GiveCard Way",
"street2": "Apt 9 3/4"
},
"status": "active",
"tags": [
{
"colorHex": "#18a058",
"createdAt": "2024-01-01T00:00:00.000Z",
"id": "ce60503a-b920-4436-ac55-406d7dbd3892",
"name": "Distribution",
"updatedAt": "2024-01-01T00:00:00.000Z",
"value": "In-Person"
}
],
"trackingNumber": "9400100000000000000000",
"type": "physical",
"updatedAt": "2024-01-01T00:00:00.000Z",
"virtualCardActivationStatus": "",
"virtualCardEmail": ""
},
"eventType": "card.reissued"
}fundingAccount.depositReceived
Receive a notification once a deposit to your funding account has been processed and is available in your funding account.
Example
JSON
{
"deposit": {
"amount": "10000",
"businessId": "8d8b40ef-1760-462c-b53f-8580b1f8157f",
"clearedAt": "2024-05-03T03:14:15.009Z",
"createdAt": "2024-05-01T00:00:00.000Z",
"depositType": "ach",
"id": "d90013ec-359b-4570-8f3f-b60f1ef89b75",
"status": "processed",
"updatedAt": "2024-05-03T03:14:15.009Z"
},
"eventType": "fundingAccount.depositReceived"
}transaction.authApproved
Receive a notification when a transaction is authorized.
Example
JSON
{
"eventType": "transaction.authApproved",
"transaction": {
"approvedAmount": {
"currencyCode": "USD",
"value": 7.25
},
"availableBalance": {
"currencyCode": "USD",
"value": 130
},
"avsResponseCode": "NOT_PROVIDED",
"cardId": "88a5601d-d957-48e1-99e3-22f0a83cecc9",
"cardSummary": {
"externalId": "WIZARD5678",
"id": "b2345678-c901-2345-d678-90abcdef1234"
},
"cvvResponseCode": "MATCH",
"declineReason": "",
"friendlyDeclineReason": "",
"id": "3fedcdeb-1fe9-45ad-89cb-38b4507252bf",
"merchant": {
"address": {
"city": "New York",
"country": "USA",
"postalCode": "10003",
"state": "NY",
"street": "",
"street2": ""
},
"category": "FAST_FOOD_RESTAURANTS",
"categoryCode": "5914",
"description": "JOES PIZZA NEW YORK NYUS",
"id": "267021382841",
"name": "JOES PIZZA"
},
"originalTransactionId": "",
"posDetails": {
"category": "POS_TERMINAL",
"isCardPresent": true,
"isCardholderPresent": true,
"isRecurring": false,
"panEntryMode": "INTEGRATED_CIRCUIT_CARD",
"pinEntryMode": "NO_PIN_ENTRY_CAPABILITY",
"terminalAttendance": "ATTENDED",
"terminalSupportsPartialApproval": false
},
"postalCodeResponseCode": "NOT_PROVIDED",
"requestedAmount": {
"currencyCode": "USD",
"value": 3.14
},
"transactionEventDate": "2024-01-01T00:00:00.000Z",
"transactionEventStatus": "authed",
"transactionEventType": "auth",
"transactionProcessingType": "GOODS_AND_SERVICES"
}
}transaction.authReversed
Receive a notification when an authorized transaction reverses.
Example
JSON
{
"eventType": "transaction.authReversed",
"transaction": {
"approvedAmount": {
"currencyCode": "USD",
"value": 17.75
},
"availableBalance": {
"currencyCode": "USD",
"value": 1000
},
"avsResponseCode": "NOT_PROVIDED",
"cardId": "88a5601d-d957-48e1-99e3-22f0a83cecc9",
"cardSummary": {
"externalId": "WIZARD5678",
"id": "b2345678-c901-2345-d678-90abcdef1234"
},
"cvvResponseCode": "NOT_PROVIDED",
"declineReason": "",
"friendlyDeclineReason": "",
"id": "46d6cadf-71fe-4ca6-ac50-977a727125b1",
"merchant": {
"address": {
"city": "SAN FRANCISCO",
"country": "USA",
"postalCode": "94107",
"state": "CA",
"street": "",
"street2": ""
},
"category": "TAXICABS_LIMOUSINES",
"categoryCode": "4121",
"description": "LYFT *TEMP AUTH HOLD SAN FRANCISCOCAUS",
"id": "445385180994",
"name": "LYFT *TEMP AUTH HOLD"
},
"originalTransactionId": "",
"posDetails": {
"category": "ECOMMERCE",
"isCardPresent": false,
"isCardholderPresent": false,
"isRecurring": false,
"panEntryMode": "",
"pinEntryMode": "",
"terminalAttendance": "UNATTENDED",
"terminalSupportsPartialApproval": false
},
"postalCodeResponseCode": "NOT_PROVIDED",
"requestedAmount": {
"currencyCode": "USD",
"value": 17.75
},
"transactionEventDate": "2024-01-01T00:00:00.000Z",
"transactionEventStatus": "reversed",
"transactionEventType": "auth",
"transactionProcessingType": "GOODS_AND_SERVICES"
}
}transaction.cleared
Receive a notification when a transaction successfully clears.
Example
JSON
{
"eventType": "transaction.cleared",
"transaction": {
"approvedAmount": {
"currencyCode": "USD",
"value": 20
},
"availableBalance": {
"currencyCode": "USD",
"value": 50
},
"avsResponseCode": "NOT_PROVIDED",
"card": {
"externalId": "WIZARD5678",
"id": "b2345678-c901-2345-d678-90abcdef1234"
},
"cardId": "88a5601d-d957-48e1-99e3-22f0a83cecc9",
"cvvResponseCode": "MATCH",
"declineReason": "",
"friendlyDeclineReason": "",
"id": "72dff558-3ff4-4788-9de6-6c0d557b0805",
"merchant": {
"address": {
"city": "ENCINITAS",
"country": "USA",
"postalCode": "92075",
"state": "CA",
"street": "",
"street2": ""
},
"category": "5411",
"categoryCode": "AUTOMATED_CASH_DISBURSE",
"description": "123 GiveCard Way ATM Encinitas CAUSA",
"id": "269063501",
"name": "GiveCard ATM, Encinitas"
},
"originalTransactionId": "",
"posDetails": {
"category": "AUTOMATED_TELLER_MACHINE",
"isCardPresent": true,
"isCardholderPresent": true,
"isRecurring": false,
"panEntryMode": "INTEGRATED_CIRCUIT_CARD",
"pinEntryMode": "PIN_ENTRY_CAPABILITY",
"terminalAttendance": "UNATTENDED",
"terminalSupportsPartialApproval": false
},
"postalCodeResponseCode": "NOT_PROVIDED",
"requestedAmount": {
"currencyCode": "USD",
"value": 20
},
"transactionEventDate": "2023-07-19T06:30:10.111Z",
"transactionEventStatus": "cleared",
"transactionEventType": "authAndClear",
"transactionProcessingType": "GOODS_AND_SERVICES"
}
}transaction.declined
Receive a notification when a transaction declines.
Example
JSON
{
"eventType": "transaction.declined",
"transaction": {
"approvedAmount": {
"currencyCode": "USD",
"value": 0
},
"availableBalance": {
"currencyCode": "USD",
"value": 25.89
},
"avsResponseCode": "NOT_PROVIDED",
"cardId": "88a5601d-d957-48e1-99e3-22f0a83cecc9",
"cardSummary": {
"externalId": "WIZARD5678",
"id": "b2345678-c901-2345-d678-90abcdef1234"
},
"cvvResponseCode": "NOT_PROVIDED",
"declineReason": "INSUFFICIENT_FUNDS",
"friendlyDeclineReason": "There are not enough funds on your card.",
"id": "a53d9ca2-ec94-445d-bbc1-e5d1da67b6a2",
"merchant": {
"address": {
"city": "PHILADELPHIA",
"country": "USA",
"postalCode": "19123",
"state": "PA",
"street": "",
"street2": ""
},
"category": "5411",
"categoryCode": "GROCERY_STORES_SUPERMARKETS",
"description": "TRADER JOES PHILADELPHIA PAUS",
"id": "43053389",
"name": "TRADER JOES"
},
"originalTransactionId": "",
"posDetails": {
"category": "POS_TERMINAL",
"isCardPresent": true,
"isCardholderPresent": true,
"isRecurring": false,
"panEntryMode": "INTEGRATED_CIRCUIT_CARD",
"pinEntryMode": "PIN_ENTRY_CAPABILITY",
"terminalAttendance": "ATTENDED",
"terminalSupportsPartialApproval": false
},
"postalCodeResponseCode": "NOT_PROVIDED",
"requestedAmount": {
"currencyCode": "USD",
"value": 50.12
},
"transactionEventDate": "2023-02-10T06:50:08.094Z",
"transactionEventStatus": "declined",
"transactionEventType": "auth",
"transactionProcessingType": "GOODS_AND_SERVICES"
}
}transaction.refund
Receive a notification when a transaction is refunded.
Example
JSON
{
"eventType": "transaction.refund",
"transaction": {
"approvedAmount": {
"currencyCode": "USD",
"value": 10
},
"availableBalance": {
"currencyCode": "USD",
"value": 4200
},
"avsResponseCode": "NOT_PROVIDED",
"cardId": "88a5601d-d957-48e1-99e3-22f0a83cecc9",
"cardSummary": {
"externalId": "WIZARD5678",
"id": "b2345678-c901-2345-d678-90abcdef1234"
},
"cvvResponseCode": "NOT_PROVIDED",
"declineReason": "",
"friendlyDeclineReason": "",
"id": "91e5cdec-3977-4a5b-a31a-2d23fc09d6e1",
"merchant": {
"address": {
"city": "Seattle",
"country": "USA",
"postalCode": "98105",
"state": "WA",
"street": "",
"street2": ""
},
"category": "BOOK_STORES",
"categoryCode": "5942",
"description": "440 Merry Ave Amazon.com",
"id": "235251000762203",
"name": "Amazon Marketplace US"
},
"originalTransactionId": "some string",
"posDetails": {
"category": "ECOMMERCE",
"isCardPresent": false,
"isCardholderPresent": false,
"isRecurring": false,
"panEntryMode": "",
"pinEntryMode": "",
"terminalAttendance": "UNATTENDED",
"terminalSupportsPartialApproval": false
},
"postalCodeResponseCode": "some string",
"requestedAmount": {
"currencyCode": "USD",
"value": 10
},
"transactionEventDate": "2024-01-01T00:00:00.000Z",
"transactionEventStatus": "refunded",
"transactionEventType": "refund",
"transactionProcessingType": "RETURNS"
}
}