Webhook Samples

Webhooks can be used to provide event notifications.

Webhooks for API Endpoints

Account Updated Webhook

Event Types with Sample Payload

{
	"accounts": [
		{
			"accountIdentifier": "23b3c1e7-33dd-41c7-a8f6-d0fbc0e20a1a",
			"events": [
				{
					"eventIdentifier": "59275183-20ef-4dd7-8301-64b97b3ef44e",
					"eventType": "accountUpdated",
					"eventDateTime": "2025-06-24T11:27:39.187Z",
					"account": {
						"accountIdentifier": "23b3c1e7-33dd-41c7-a8f6-d0fbc0e20a1a",
						"status": "normal",
						"accountStatusChangedDateTime": "2025-06-24T11:27:36.163Z",
						"statusReasons": [
							"healthy"
						],
						"accountCycleDay": 24,
						"accountHolders": [
							{
								"user": {
									"firstName": "AnMfUneC",
									"lastName": "uEfzilgc",
									"dobStatus": "matched",
									"last4Identity": "7784",
									"identityType": "ssn",
									"userIdentifier": "74094ffe-a27c-4f8f-a23c-ae33b50e991b",
									"isPrimaryAccountHolder": true,
									"status": "active",
									"kycStateData": {
										"ofacStatus": "passed",
										"kycStatus": "passed",
										"kycPendingGate": "healthy"
									}
								},
								"paymentInstruments": [
									{
										"paymentInstrumentIdentifier": "f7da3e6a-d286-47ff-8cd2-d2f6c149d4d5",
										"paymentIdentifier": "3975a5f8-5a7a-479c-affd-24e39cca6dbc",
										"paymentInstrumentType": "virtual",
										"status": "activated",
										"isPinSet": true,
										"last4Pan": "0837",
										"activatedDateTime": "2025-06-24T11:27:36.12Z",
										"issuedDateTime": "2025-06-24T11:27:36.12Z"
									},
									{
										"paymentInstrumentIdentifier": "65979e27-afdf-465a-a317-c94bd4ee595b",
										"paymentIdentifier": "3975a5f8-5a7a-479c-affd-24e39cca6dbc",
										"paymentInstrumentType": "contactlessEmv",
										"status": "notActivated",
										"isPinSet": true,
										"last4Pan": "0837",
										"issuedDateTime": "2025-06-24T11:27:37.93Z"
									}
								]
							}
						]
					}
				}
			]
		}
	]
}

ACH NOC Alert Webhook

API Call Reference

POST https://yourendpoint.yourcompany.com/events/achNOCAlert

Event Types with Sample Payload

{
  "accounts":[
    {
      "accountIdentifier":"4b830092-e5d4-86b8-ad26-8a42c94eee4c",
      "events":[
        {
          "eventIdentifier":"0b830092-e5d4-45b8-ad26-8a42c94fff4c",
          "eventType":"achNOCAlert",
          "eventDateTime":"2020-03-24T22:04:37.441Z",
          "achNOCInfo":{
            "achTransferType":"ACHOut",
            "transferIdentifier":"434c1349-1edb-453b-91c3-69169b4ef3a9",
            "nocCode":"C01",
            --The following properties are all optional and conditional based on the NOC code. See the NOC Code/Request Body Mapping for details.
			"originalCustomerName":"string",
            "correctedFirst15CustomerName":"string",
			"originalRoutingNumber":"123456789",
            "correctedRoutingNumber":"123456789",
            "originalLast4AccountNumber":"9012",
            "correctedLast4AccountNumber":"9013",
            "encryptedAccountData":{
              "version":"string",
              "ephemeralPublicKey":"string",
              "publicKeyHash":"string",
              "data":"string"
            }
          }
        }
      ]
    }
  ]
}

Unencrypted Account Data

Unencrypted Account Data:-
{
  "originalAccountNumber":"123456789012",
  "correctedAccountNumber":"123456789012"
}

NOC Code/Request Body Mapping

Return Reason CodeData Passed to Partner in Webhook
CO11. Account ID 2. Correct Account Number
CO21. Account ID 2. Correct Routing Number
CO31. Account ID 2. Correct Account Number 3. Correct Routing Number
CO5
CO61. Account ID 2. Correct Account Number
CO71. Account ID 2. Correct Account Number 3. Correct Routing Number

NOC Codes

CodeReasonDescription
C01Incorrect bank account number• Bank account number incorrect or formatted incorrectly
• Time Frame: 2 banking days from original entry settlement
C02Incorrect transit/routing numberOnce valid transit/routing number must be corrected
C03Incorrect transit/routing number and bank account number• Once valid transit/routing number must be corrected
• Will cause a change to bank account number structure
C05Incorrect payment codeEntry posted to demand account should contain savings payment codes or vice versa.
C06Incorrect bank account number and transit code• Bank account number must be corrected
• Payment code should indicate posting to another account type (demand/savings)
C07Incorrect transit/routing number, bank account number and payment codeCorrections are required in the three fields indicated:

• Transit/Routing Number
• Bank Account Number
• Payment Code
CO8Incorrect Receiving DFI Identification (IAT only)The correct Receiving Depository Financial Institution (RDFI) identification appears in the first 34 positions of the corrected data field.
C09Incorrect individual ID numberThe individual’s ID number is incorrect.
C13Addenda Format ErrorA CCD Entry is received with an “05” Addenda Type Code, but the addenda information does not contain payment related ANSI ASC X12 data segments or NACHA-endorsed banking conventions.
C14Incorrect SEC Code for Outbound International PaymentA CCD or PPD Entry is received by the RDFI and is posted to the receiver’s account, but the receiver has also placed a standing instruction with the RDFI to forward all funds from the entry to the receiver’s account in another country.

ACH Transfer Webhook

Event Types with Sample Payload

ACHPull

Initial Achpull

"eventType": "achTransfer",

"transactionType": "achPull",

"transactionStatus": "pending”

{
	"accounts": [
		{
			"accountIdentifier": "d388aa0b-b786-43ee-8aec-f67b25fed0d3",
			"events": [
				{
					"eventIdentifier": "72824fd5-9b8a-45d0-b072-e70c9409042c",
					"eventType": "achTransfer",
					"eventDateTime": "2025-06-20T08:40:53.001Z",
					"transfer": {
						"achTransferType": "achPull",
						"transferIdentifier": "6d1cfb42-d48b-4ccf-b4a6-d5c09a8cd983",
						"accountIdentifier": "d388aa0b-b786-43ee-8aec-f67b25fed0d3",
						"submissionDateTime": "2025-06-20T08:40:52Z",
						"effectiveDeliveryDateTime": "2025-06-25T04:00:00Z",
						"transactionAmount": 1.0,
						"achTransferStatus": "pending"
					}
				}
			]
		}
	]
}
Successful Achpull

"eventType": "achTransfer",

"transactionType": "achPull",

"transactionStatus": "completed”

{
	""accounts"": [
		{
			""accountIdentifier"": ""7bd19bd9-3e57-4f45-a2aa-a5010209ea9d"",
			""events"": [
				{
					""eventIdentifier"": ""06a1e19f-1766-4271-b568-b7d5ba192c94"",
					""eventType"": ""achTransfer"",
					""eventDateTime"": ""2025-02-10T08:04:21.667Z"",
					""transfer"": {
						""achTransferType"": ""achPull"",
						""transferIdentifier"": ""2938b3a8-5ea8-4041-a4a3-29cc0dc42b05"",
						""accountIdentifier"": ""7bd19bd9-3e57-4f45-a2aa-a5010209ea9d"",
						""effectiveDeliveryDateTime"": ""2025-02-10T08:04:21Z"",
						""transactionAmount"": 5.12,
						""achTransferStatus"": ""successful""
					}
				}
			]
		}
	]
}

"eventType": "transaction",

"transactionType": "partnerTransferIn",

"transactionStatus": "completed”

{
	""accounts"": [
		{
			""accountIdentifier"": ""006d0e6f-1106-43ba-a860-9a058ce5ef0a"",
			""events"": [
				{
					""eventIdentifier"": ""3495adca-be82-4db9-8762-8e4a00e3fd57"",
					""eventType"": ""transaction"",
					""eventDateTime"": ""2025-02-09T11:03:08.619Z"",
					""transactions"": [
						{
							""parentTransactionIdentifier"": ""170ac26a-5330-b99b-6ac2-0a1730539bb9"",
							""transactionIdentifier"": ""170ac26a-5330-b99b-6ac2-0a1730539bb9"",
							""transactionType"": ""partnerTransferIn"",
							""transactionStatus"": ""completed"",
							""transactionTypeDescription"": ""Transfer"",
							""accountIdentifier"": ""006d0e6f-1106-43ba-a860-9a058ce5ef0a"",
							""currency"": ""USD"",
							""postedDateTime"": ""2025-02-09T11:03:01.965Z"",
							""transactionAmount"": 1.0,
							""isCredit"": true,
							""purses"": [
								{
									""purseIdentifier"": ""4ad54bb9-8b39-41fb-b929-db5d0e6ec72d"",
									""purseType"": ""primary"",
									""availableBalance"": 3.0,
									""ledgerBalance"": 3.0,
									""availableBalanceAsOfDateTime"": ""2025-02-09T11:03:01.967Z"",
									""ledgerBalanceAsOfDateTime"": ""2025-02-09T11:03:01.967Z""
								}
							],
							""postedInternalTransactionData"": {
								""transferIdentifier"": ""245e2713-3c81-44b4-8141-c0ddec50d983"",
								""description"": ""CusTACHPartne466 BaaS, GDOT BANK (-4236)"",
								""transferType"": ""achPull"",
								""bankData"": {
									""bankName"": ""GDot Bank"",
									""accountNumber"": ""*************4236"",
									""routingNumber"": ""124303162"",
									""firstName"": ""CusTACHPartne466"",
									""lastName"": ""BaaS"",
									""accountType"": ""Checking""
								}
							}
						}
					]
				}
			]
		}
	]
}
Return Achpull

"eventType": "achTransfer",

"transactionType": "achPull",

"transactionStatus": "returned”

{
	""accounts"": [
		{
			""accountIdentifier"": ""7bd19bd9-3e57-4f45-a2aa-a5010209ea9d"",
			""events"": [
				{
					""eventIdentifier"": ""e9fc58c0-4fd7-48a7-bd80-9826434f27f6"",
					""eventType"": ""achTransfer"",
					""eventDateTime"": ""2025-02-10T08:19:55.385Z"",
					""transfer"": {
						""achTransferType"": ""achPull"",
						""transferIdentifier"": ""2938b3a8-5ea8-4041-a4a3-29cc0dc42b05"",
						""accountIdentifier"": ""7bd19bd9-3e57-4f45-a2aa-a5010209ea9d"",
						""effectiveDeliveryDateTime"": ""2025-02-10T08:19:55Z"",
						""transactionAmount"": 5.12,
						""achTransferStatus"": ""returned"",
						""returnDateTime"": ""2025-02-10T08:19:55Z"",
						""returnReasonCode"": ""R01""
					}
				}
			]
		}
	]
}

"eventType": "transaction",

"transactionType": "partnerTransferIn",

"transactionStatus": "returned”

{
	""accounts"": [
		{
			""accountIdentifier"": ""c1925224-bb42-4c3d-88b0-f15dd4264b3c"",
			""events"": [
				{
					""eventIdentifier"": ""fe147968-01f5-47dd-abfc-ed3da8e30b4f"",
					""eventType"": ""transaction"",
					""eventDateTime"": ""2025-02-03T06:09:30.588Z"",
					""transactions"": [
						{
							""parentTransactionIdentifier"": ""ffaf9e9e-0a79-5938-9e9e-afff790a3859"",
							""transactionIdentifier"": ""ffaf9e9e-0a79-5938-9e9e-afff790a3859"",
							""transactionType"": ""partnerTransferIn"",
							""transactionStatus"": ""reversed"",
							""transactionTypeDescription"": ""Transfer Reversal"",
							""accountIdentifier"": ""c1925224-bb42-4c3d-88b0-f15dd4264b3c"",
							""currency"": ""USD"",
							""postedDateTime"": ""2025-02-03T04:09:24.000Z"",
							""transactionAmount"": 38.82,
							""isCredit"": false,
							""purses"": [
								{
									""purseIdentifier"": ""480a3abd-f3cc-452e-946b-8e009ca4da2b"",
									""purseType"": ""primary"",
									""availableBalance"": 75.49,
									""ledgerBalance"": 777.87,
									""availableBalanceAsOfDateTime"": ""2025-02-03T04:09:24.000Z"",
									""ledgerBalanceAsOfDateTime"": ""2025-02-03T04:09:24.000Z""
								}
							],
							""postedInternalTransactionData"": {
								""transferIdentifier"": ""86408677-745f-7226-f82f-4a9d77000000"",
								""description"": ""Partner Transfer In Reversal"",
								""transferType"": ""None""
							}
						}
					]
				}
			]
		}
	]
}

ACHOut

Initial Achout

"eventType": "achTransfer",

"transactionType": "achOut",

"transactionStatus": "pending”

{
	"accounts": [
		{
			"accountIdentifier": "278b0340-200a-42c4-af1d-570840d04557",
			"events": [
				{
					"eventIdentifier": "9e5f8ecb-7150-4920-bbcd-900ba74f9162",
					"eventType": "achTransfer",
					"eventDateTime": "2025-06-24T06:46:46.310Z",
					"transfer": {
						"achTransferType": "achOut",
						"transferIdentifier": "920a9674-99df-47ed-8c6f-7459bb75ac3e",
						"accountIdentifier": "278b0340-200a-42c4-af1d-570840d04557",
						"submissionDateTime": "2025-06-24T06:46:46Z",
						"effectiveDeliveryDateTime": "2025-06-26T07:00:00Z",
						"transactionAmount": 5.0,
						"achTransferStatus": "pending"
					}
				}
			]
		}
	]
}

"eventType": "achTransfer",

"transactionType": "achOut",

"transactionStatus": "completed”

{
	"accounts": [
		{
			"accountIdentifier": "278b0340-200a-42c4-af1d-570840d04557",
			"events": [
				{
					"eventIdentifier": "fc2ee5ce-b3d1-4f21-9dba-d0e6ed5793b8",
					"eventType": "transaction",
					"eventDateTime": "2025-06-24T06:46:51.521Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "213ecc5f-acd2-81c9-5fcc-3e21d2acc981",
							"transactionIdentifier": "213ecc5f-acd2-81c9-5fcc-3e21d2acc981",
							"transactionType": "achOut",
							"transactionStatus": "completed",
							"transactionTypeDescription": "Transfer",
							"accountIdentifier": "278b0340-200a-42c4-af1d-570840d04557",
							"currency": "USD",
							"postedDateTime": "2025-06-24T06:46:45.013Z",
							"transactionAmount": 5.0,
							"isCredit": false,
							"purses": [
								{
									"purseIdentifier": "4344e32a-55b9-4d9d-be17-f4ba397bfbad",
									"purseType": "primary",
									"availableBalance": 5.0,
									"ledgerBalance": 5.0,
									"availableBalanceAsOfDateTime": "2025-06-24T06:46:45.013Z",
									"ledgerBalanceAsOfDateTime": "2025-06-24T06:46:45.013Z"
								}
							],
							"postedInternalTransactionData": {
								"transferIdentifier": "920a9674-99df-47ed-8c6f-7459bb75ac3e",
								"description": "CusTACHPartne199 BaaS, GDOT BANK (-5512)",
								"transferType": "achOut",
								"bankData": {
									"bankName": "GDot Bank",
									"accountNumber": "*************5512",
									"routingNumber": "124303162",
									"firstName": "CusTACHPartne199",
									"lastName": "BaaS",
									"accountType": "Checking"
								}
							}
						}
					]
				}
			]
		}
	]
}
Return Achpull

"eventType": "achTransfer",

"transactionType": "achOut",

"transactionStatus": "returned”

{
	"accounts": [
		{
			"accountIdentifier": "2a36b817-4f95-4eed-840b-36f4086cd046",
			"events": [
				{
					"eventIdentifier": "f4fb2754-fe74-4b95-8161-b8317b4b4bee",
					"eventType": "achTransfer",
					"eventDateTime": "2025-06-06T14:25:07.353Z",
					"transfer": {
						"achTransferType": "achOut",
						"transferIdentifier": "73caa9d4-9042-4c29-9c25-e0ff0dbee226",
						"accountIdentifier": "2a36b817-4f95-4eed-840b-36f4086cd046",
						"transactionAmount": 10.0,
						"achTransferStatus": "returned",
						"returnDateTime": "2025-06-06T14:25:07Z",
						"returnReasonCode": ""
					}
				}
			]
		}
	]
}

Return Achout

"eventType": "transaction",

"transactionType": "achOut",

"transactionStatus": "reversed”

{
	"accounts": [
		{
			"accountIdentifier": "2a36b817-4f95-4eed-840b-36f4086cd046",
			"events": [
				{
					"eventIdentifier": "ad3d9f77-5eb8-425b-af51-2582dd93af1e",
					"eventType": "transaction",
					"eventDateTime": "2025-06-06T14:25:12.582Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "c119f8aa-3b76-9688-aaf8-19c1763b8896",
							"transactionIdentifier": "c119f8aa-3b76-9688-aaf8-19c1763b8896",
							"transactionType": "achOut",
							"transactionStatus": "reversed",
							"transactionTypeDescription": "Transfer Reversal",
							"accountIdentifier": "2a36b817-4f95-4eed-840b-36f4086cd046",
							"currency": "USD",
							"postedDateTime": "2025-06-06T14:25:05.671Z",
							"transactionAmount": 10.0,
							"isCredit": true,
							"purses": [
								{
									"purseIdentifier": "ad0dd8f2-0c4b-4622-8012-43918dafc464",
									"purseType": "primary",
									"availableBalance": 136.57,
									"ledgerBalance": 136.57,
									"availableBalanceAsOfDateTime": "2025-06-06T14:25:05.670Z",
									"ledgerBalanceAsOfDateTime": "2025-06-06T14:25:05.670Z"
								}
							],
							"postedInternalTransactionData": {
								"transferIdentifier": "73caa9d4-9042-4c29-9c25-e0ff0dbee226",
								"description": "CusTACHPartne015 BaaS, GDOT BANK (-6804)",
								"transferType": "achOut",
								"bankData": {
									"bankName": "GDot Bank",
									"accountNumber": "*************6804",
									"routingNumber": "124303162",
									"firstName": "CusTACHPartne015",
									"lastName": "BaaS",
									"accountType": "Checking"
								}
							}
						}
					]
				}
			]
		}
	]
}

Adjustment Webhook

Event Types with Sample Payload

"eventType": "adjustmentFinalStatus"

"adjustmentType": "AnyDebitOutReversal"

{
	"accounts": [
		{
			"accountIdentifier": "36910232-f980-4772-a165-5f2ddbde4fae",
			"events": [
				{
					"eventIdentifier": "ce8ada2f-c89a-433d-bb90-223a35d34c39",
					"eventType": "adjustmentFinalStatus",
					"eventDateTime": "2025-06-12T11:27:45.772Z",
					"adjustmentEvent": {
						"adjustmentIdentifier": "8e8be26c-752d-4e23-a271-940b90b526f0",
						"accountIdentifier": "36910232-f980-4772-a165-5f2ddbde4fae",
						"eventDateTime": "2025-06-12T11:27:45Z",
						"amount": 0.38,
						"currency": "USD",
						"adjustmentType": "AnyDebitOutReversal",
						"adjustmentDescription": "Driver to Citi Card Reversal - Credit",
						"fee": 0.21,
						"finalStatus": "Posted"
					}
				}
			]
		}
	]
}

AFT Webhook

Event Types with Sample Payload

AFT Initialization

"eventType": "aFTTransfer"

"aftTransferType": "A2AIn"

"transferStatus": "PendingComplete"

{
	"accounts": [
		{
			"accountIdentifier": "c34b036d-21bb-4715-9bd0-fd5c30efd4df",
			"events": [
				{
					"eventIdentifier": "40b3819f-feab-49f2-bc67-2b3cd062962a",
					"eventType": "aFTTransfer",
					"eventDateTime": "2025-06-16T08:47:41.871Z",
					"aftTransfer": {
						"aftTransferType": "A2AIn",
						"transferId": "d30162a3-c8f6-41ab-8a49-4c07aaf9e857",
						"accountIdentifier": "c34b036d-21bb-4715-9bd0-fd5c30efd4df",
						"submissionDateTime": "2025-06-16T08:47:35.8332396Z",
						"postedDateTime": "2025-06-16T08:47:41.7501007Z",
						"transactionAmount": "301.0",
						"transactionFeeAmount": "0.0",
						"currency": "USD",
						"transferStatus": "PendingComplete",
						"transferStatusReason": "TransferPendingComplete"
					}
				}
			]
		}
	]
}

📘

Some partners may not use this event type.

AFT Post Transaction

"eventType": "transaction"

"transactionType": "networkCardLoad",

"transactionStatus": "completed"

{
	"accounts": [
		{
			"accountIdentifier": "c34b036d-21bb-4715-9bd0-fd5c30efd4df",
			"events": [
				{
					"eventIdentifier": "d36c0f20-c944-41d7-82fa-454769dc112f",
					"eventType": "transaction",
					"eventDateTime": "2025-06-16T08:47:46.254Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "5e181d98-6ede-d6ca-981d-185ede6ecad6",
							"transactionIdentifier": "5e181d98-6ede-d6ca-981d-185ede6ecad6",
							"transactionType": "networkCardLoad",
							"transactionStatus": "completed",
							"transactionTypeDescription": "Deposit",
							"accountIdentifier": "c34b036d-21bb-4715-9bd0-fd5c30efd4df",
							"currency": "USD",
							"postedDateTime": "2025-06-16T08:47:40.571Z",
							"transactionAmount": 301.0,
							"isCredit": true,
							"purses": [
								{
									"purseIdentifier": "8710c6be-777f-4cb2-8e48-6f5be71a6adf",
									"purseType": "primary",
									"availableBalance": 321.0,
									"ledgerBalance": 321.0,
									"availableBalanceAsOfDateTime": "2025-06-16T08:47:40.573Z",
									"ledgerBalanceAsOfDateTime": "2025-06-16T08:47:40.573Z"
								}
							],
							"postedInternalTransactionData": {
								"partnerAdjustmentType": "networkCardLoad",
								"adjustmentIdentifier": "d30162a3-c8f6-41ab-8a49-4c07aaf9e857",
								"description": "Deposit",
								"transferType": "None"
							}
						}
					]
				}
			]
		}
	]
}

AFT Completed

"eventType": "aFTTransfer"

"eventType": "aFTTransfer"

"transferStatus": "Completed",

"transferStatusReason":"TransferCompleted"

{
	"accounts": [
		{
			"accountIdentifier": "c34b036d-21bb-4715-9bd0-fd5c30efd4df",
			"events": [
				{
					"eventIdentifier": "29247856-0544-4d17-bab1-d006231e6815",
					"eventType": "aFTTransfer",
					"eventDateTime": "2025-06-16T08:48:43.539Z",
					"aftTransfer": {
						"eventType": "aFTTransfer",
						"transferId": "d30162a3-c8f6-41ab-8a49-4c07aaf9e857",
						"accountIdentifier": "c34b036d-21bb-4715-9bd0-fd5c30efd4df",
						"submissionDateTime": "2025-06-16T08:47:35.8332396Z",
						"postedDateTime": "2025-06-16T08:48:43.5055508Z",
						"transactionAmount": "301.00",
						"transactionFeeAmount": "0.0",
						"currency": "USD",
						"transferStatus": "Completed",
						"transferStatusReason": "TransferCompleted"
					}
				}
			]
		}
	]
}

📘

Some partners may not use this event type.

AMM Rule Webhook

Event Types with Sample Payload

"eventType":"ammRule"

{
	"accounts": [
		{
			"accountIdentifier": "ab1567d9-ef90-4670-b40f-ef0e3eb6d00a",
			"events": [
				{
					"eventIdentifier": "6dba7526-8f20-4958-bf1f-f0158b782a01",
					"eventType": "ammRule",
					"eventDateTime": "2025-06-26T18:09:26.631Z",
					"ammRule": {
						"ruleID": "98520",
						"ruleType": "DateDriven",
						"ruleFrequencyType": "Monthly",
						"sourceAccountID": "ab1567d9-ef90-4670-b40f-ef0e3eb6d00a",
						"targetAccountID": "50de48af-cf70-4eb1-8b85-e27fdb018071",
						"ruleName": "SccRecurringPayment",
						"startDate": "2022-04-01T07:00:00Z",
						"endDate": "9999-12-31T23:59:59Z",
						"enrollmentDate": "2022-04-01T00:04:55Z",
						"rulePriority": 0,
						"fixedTransferAmount": 50.0,
						"scheduleDay": 26,
						"ruleStatus": "Active",
						"transferType": "SccPayment",
						"paymentAmountOption": "OtherAmount",
						"sourceOption": "DDA",
						"ruleAction": "Executed",
						"executionResult": "failed",
						"executionDate": "2025-06-26T18:09:26Z"
					}
				}
			]
		}
	]
}

ATM Pin Update Webhook

Event Types with Sample Payload

Atm Pin Reset

"eventType":"atmPinReset"

{
	"accounts": [
		{
			"accountIdentifier": "b4cec68b-b184-442d-9460-537d52f43bea",
			"events": [
				{
					"eventIdentifier": "4326fe8b-0609-4e0f-bdfa-cccf06092872",
					"eventType": "atmPinReset",
					"eventDateTime": "2025-03-19T20:41:14.768Z",
					"atmPinSetDetail": {
						"paymentInstrumentIdentifier": "bdd715e1-e8ca-4475-87ba-dabf77869c00",
						"paymentIdentifier": "b86e1ff3-f052-4df2-ba48-b68dd9369f20",
						"bin": "424067",
						"last4Pan": "1650",
						"atmPinSetDateTime": "2025-03-19T20:41:14.420Z"
					}
				}
			]
		}
	]
}

ATM Transaction

Event Types with Sample Payload

Atm Withdraw

"transactionType":"atmWithdrawal",
"transactionStatus": "completed"
"transactionType": "fee"

atmWithdrawal transaction

{
    "accounts": [
        {
            "accountIdentifier": "e59fb028-9f8e-48d8-8885-22bb66b6268f",
            "events": [
                {
                    "eventIdentifier": "1c13332c-0de5-4c16-8a8d-58a31323e332",
                    "eventType": "transaction",
                    "eventDateTime": "2025-06-12T02:01:02.644Z",
                    "transactions": [
                        {
                            "parentTransactionIdentifier": "f788c91f-2836-4fe6-1fc9-88f73628e64f",
                            "retrievalReferenceNumber": "788931549797319",
                            "transactionIdentifier": "20d47348-f5b2-ce2b-4873-d420b2f52bce",
                            "transactionType": "atmWithdrawal",
                            "transactionStatus": "completed",
                            "transactionTypeDescription": "ATM Withdrawal",
                            "accountIdentifier": "e59fb028-9f8e-48d8-8885-22bb66b6268f",
                            "bin": "499998",
                            "last4Pan": "1634",
                            "currency": "USD",
                            "postedDateTime": "2025-06-12T00:00:59.000Z",
                            "transactionAmount": 35.17,
                            "isCredit": false,
                            "userIdentifier": "d92fd763-e79f-487c-8b1d-ec74dca04a1a",
                            "paymentIdentifier": "1c242e07-c930-4e46-b355-667b40ada61e",
                            "purses": [
                                {
                                    "purseIdentifier": "a2128892-3a5b-49c9-aa06-26e76f65bef0",
                                    "purseType": "primary",
                                    "availableBalance": 58.88,
                                    "ledgerBalance": 826.57,
                                    "availableBalanceAsOfDateTime": "2025-06-12T00:00:59.000Z",
                                    "ledgerBalanceAsOfDateTime": "2025-06-12T00:00:59.000Z"
                                }
                            ],
                            "networkTransactionData": {
                                "authorizationDateTime": "2025-06-12T00:00:59.000Z",
                                "cardAcceptor": {
                                    "merchantName": "ACQUIRER NAME",
                                    "merchantIndustryCode": "6011",
                                    "merchantIndustryCategory": "Service Providers",
                                    "city": "CITY NAME",
                                    "merchantIndustryDescription": "Financial institutions -  automated cash disbursements"
                                },
                                "postTransactionData": {
                                    "localDateTime": "2025-06-11T19:00:59.000",
                                    "postingDateTime": "2025-06-12T00:00:59.000Z",
                                    "approvalCode": "045507"
                                }
                            }
                        }
                    ]
                }
            ]
        }
    ]
}

Out of Network ATM Withdrawal Fee

{
    "accounts": [
        {
            "accountIdentifier": "e59fb028-9f8e-48d8-8885-22bb66b6268f",
            "events": [
                {
                    "eventIdentifier": "22af6bdb-7ead-44ac-aca5-34e26dbe6743",
                    "eventType": "transaction",
                    "eventDateTime": "2025-06-12T02:01:58.005Z",
                    "transactions": [
                        {
                            "parentTransactionIdentifier": "335a4b2a-3b0c-ac3d-2a4b-5a330c3b3dac",
                            "transactionIdentifier": "335a4b2a-3b0c-ac3d-2a4b-5a330c3b3dac",
                            "transactionType": "fee",
                            "transactionStatus": "completed",
                            "transactionTypeDescription": "Fee",
                            "accountIdentifier": "e59fb028-9f8e-48d8-8885-22bb66b6268f",
                            "currency": "USD",
                            "postedDateTime": "2025-06-12T00:01:52.000Z",
                            "transactionAmount": 75.86,
                            "isCredit": true,
                            "userIdentifier": "d92fd763-e79f-487c-8b1d-ec74dca04a1a",
                            "paymentIdentifier": "1c242e07-c930-4e46-b355-667b40ada61e",
                            "purses": [
                                {
                                    "purseIdentifier": "a2128892-3a5b-49c9-aa06-26e76f65bef0",
                                    "purseType": "primary",
                                    "availableBalance": -11.0,
                                    "ledgerBalance": -561.24,
                                    "availableBalanceAsOfDateTime": "2025-06-12T07:01:39.000Z",
                                    "ledgerBalanceAsOfDateTime": "2025-06-12T07:01:39.000Z"
                                }
                            ],
                            "fees": [
                                {
                                    "feeType": "atmWithdrawalFee",
                                    "amount": 75.86,
                                    "currency": "USD",
                                    "description": "Out of Network ATM Withdrawal Fee"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

ATM Withdraw International

"eventType": "transaction"
"transactionType": "fee",

atmWithdrawal transaction (International)

{
    "accounts": [
        {
            "accountIdentifier": "88f15645-5a0d-4d4d-9914-fbfa8a609e4f",
            "events": [
                {
                    "eventIdentifier": "6c122225-aab8-4663-98aa-a755c4b25b3b",
                    "eventType": "transaction",
                    "eventDateTime": "2025-06-17T07:51:21.653Z",
                    "transactions": [
                        {
                            "parentTransactionIdentifier": "85ed195f-23f1-c08f-5f19-ed85f1238fc0",
                            "retrievalReferenceNumber": "",
                            "transactionIdentifier": "9414d51d-ed4d-cf97-1dd5-14944ded97cf",
                            "transactionType": "atmWithdrawal",
                            "transactionStatus": "completed",
                            "transactionTypeDescription": "ATM Withdrawal",
                            "accountIdentifier": "88f15645-5a0d-4d4d-9914-fbfa8a609e4f",
                            "bin": "424067",
                            "last4Pan": "0760",
                            "currency": "USD",
                            "postedDateTime": "2025-06-16T10:35:51.000Z",
                            "transactionAmount": 200.0,
                            "isCredit": false,
                            "userIdentifier": "7dcb5345-6b59-41e2-8d97-9d2001d2e3c2",
                            "paymentIdentifier": "c70f18a4-2d5b-4fcf-846a-3f0dd242a05a",
                            "purses": [
                                {
                                    "purseIdentifier": "99e77773-99ce-4bab-9f36-14cf27d2082a",
                                    "purseType": "primary",
                                    "availableBalance": 522.5,
                                    "ledgerBalance": 522.5,
                                    "availableBalanceAsOfDateTime": "2025-06-16T11:20:56.000Z",
                                    "ledgerBalanceAsOfDateTime": "2025-06-16T11:20:56.000Z"
                                }
                            ],
                            "networkTransactionData": {
                                "authorizationDateTime": "2025-06-16T08:35:51.000Z",
                                "cardAcceptor": {
                                    "merchantName": "CARD ACCEPTOR",
                                    "merchantIndustryCode": "6011",
                                    "merchantIndustryCategory": "Service Providers",
                                    "city": "CITY NAME",
                                    "merchantIndustryDescription": "Financial institutions -  automated cash disbursements"
                                },
                                "postTransactionData": {
                                    "localDateTime": "2025-06-16T03:35:51.000",
                                    "postingDateTime": "2025-06-16T10:35:51.000Z",
                                    "approvalCode": "323677"
                                }
                            }
                        }
                    ]
                }
            ]
        }
    ]
}

Foreign Transaction Fee

{
    "accounts": [
        {
            "accountIdentifier": "88f15645-5a0d-4d4d-9914-fbfa8a609e4f",
            "events": [
                {
                    "eventIdentifier": "23cbd035-5d9a-46cf-bf0f-38c7e750815f",
                    "eventType": "transaction",
                    "eventDateTime": "2025-06-17T12:20:13.852Z",
                    "transactions": [
                        {
                            "parentTransactionIdentifier": "275a7a82-a7db-356f-827a-5a27dba76f35",
                            "transactionIdentifier": "275a7a82-a7db-356f-827a-5a27dba76f35",
                            "transactionType": "fee",
                            "transactionStatus": "completed",
                            "transactionTypeDescription": "Fee",
                            "accountIdentifier": "88f15645-5a0d-4d4d-9914-fbfa8a609e4f",
                            "currency": "USD",
                            "postedDateTime": "2025-06-16T10:35:52.000Z",
                            "transactionAmount": 9.0,
                            "isCredit": false,
                            "userIdentifier": "7dcb5345-6b59-41e2-8d97-9d2001d2e3c2",
                            "paymentIdentifier": "c70f18a4-2d5b-4fcf-846a-3f0dd242a05a",
                            "purses": [
                                {
                                    "purseIdentifier": "99e77773-99ce-4bab-9f36-14cf27d2082a",
                                    "purseType": "primary",
                                    "availableBalance": 522.5,
                                    "ledgerBalance": 522.5,
                                    "availableBalanceAsOfDateTime": "2025-06-16T11:20:55.000Z",
                                    "ledgerBalanceAsOfDateTime": "2025-06-16T11:20:55.000Z"
                                }
                            ],
                            "fees": [
                                {
                                    "feeType": "foreignTransactionFee",
                                    "amount": 9.0,
                                    "currency": "USD",
                                    "description": "Foreign Transaction Fee"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

Bill Payment Webhook

API Call Reference

POST https://yourendpoint.yourcompany.com/events/billPayment

billPayTransfer ParametersRequired/OptionalDescription
paymentIdentifierRequired
transferIdentifierRequired
transferStatusRequiredCan be one of the following:
• completed: When bill payment is debited successfully on the scheduled date.
• failed: Bill payment failed to process.
• rejected: When bill payment is returned and credit is issued to customer account
payeeIdentifierRequired
payeeNameRequiredName of the biller.
paymentStatusRequiredCan be one of the following:
• scheduled
• failed (due to NSF)
• canceled
• inProcess

Note: In a future update, inProcess will be removed from the webhook and the status will be treated as either scheduled or processed.
amountRequired
frequencyType
paymentDateOptional
deliveryDateOptionalThe deliveryDate is provided by Fiserv and it is the date the bill payment is expected to be delivered by. Fiserv calculates this date based on the paymentDate and it is usually, 5 business days after the paymentDate.
paymentMemoOptional
noteOptional
confirmationNumberRequired

Event Types with Sample Payload

Add Payee

No webhook (N/A)

Add Payment

No webhook (N/A)

Bill Payment Transfer

"eventType":"billPayTransfer”

"transferStatus": "completed"

{
	"accounts": [
		{
			"accountIdentifier": "30da4498-7139-4753-b8fc-c6b09cb101c7",
			"events": [
				{
					"eventIdentifier": "8f303ebe-b4c8-42ea-ac60-60afcb248671",
					"eventType": "billPayTransfer",
					"eventDateTime": "2025-06-16T08:57:20.609Z",
					"billPayTransfer": {
						"paymentIdentifier": "7f559b10-57d9-4dbe-99b9-e3b255f98955",
						"transferIdentifier": "2db69a45-8770-4c05-bf99-691460c68edb",
						"transferStatus": "completed",
						"payeeIdentifier": "3069d80c-c67d-4948-a105-026096ff65d4",
						"paymentStatus": "scheduled",
						"amount": 2.15,
						"paymentDate": "2025-06-17",
						"deliveryDate": "2025-06-25",
						"paymentMemo": "testPayment",
						"note": "test",
						"confirmationNumber": "XHZL0-C3C8R",
						"payeeName": "OwkbEPGf",
						"frequencyType": "weekly"
					}
				}
			]
		}
	]
}

Bill Payment Transaction

"eventType": "transaction",

"transactionType": "billPay",

"transactionStatus": "completed"

{
	"accounts": [
		{
			"accountIdentifier": "30da4498-7139-4753-b8fc-c6b09cb101c7",
			"events": [
				{
					"eventIdentifier": "72b45975-d308-468c-b29c-f237ebf209ab",
					"eventType": "transaction",
					"eventDateTime": "2025-06-16T08:57:25.491Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "fb7ee6ab-7f01-0b66-abe6-7efb017f660b",
							"transactionIdentifier": "fb7ee6ab-7f01-0b66-abe6-7efb017f660b",
							"transactionType": "billPay",
							"transactionStatus": "completed",
							"transactionTypeDescription": "Bill Pay",
							"accountIdentifier": "30da4498-7139-4753-b8fc-c6b09cb101c7",
							"currency": "USD",
							"postedDateTime": "2025-06-16T08:57:19.378Z",
							"transactionAmount": 2.15,
							"isCredit": false,
							"purses": [
								{
									"purseIdentifier": "323baa22-8de9-44aa-b028-4945150ed40a",
									"purseType": "primary",
									"availableBalance": 97.85,
									"ledgerBalance": 97.85,
									"availableBalanceAsOfDateTime": "2025-06-16T08:57:19.380Z",
									"ledgerBalanceAsOfDateTime": "2025-06-16T08:57:19.380Z"
								}
							],
							"postedInternalTransactionData": {
								"transferIdentifier": "2db69a45-8770-4c05-bf99-691460c68edb",
								"description": "Online Payment to OwkbEPGf",
								"transferType": "billPay"
							}
						}
					]
				}
			]
		}
	]
}OwkbEPGf","transferType":"billPay"}}]}]}]}

Returned

"eventType": "billPayTransfer"

"transferStatus": "rejected"

{
	"accounts": [
		{
			"accountIdentifier": "30da4498-7139-4753-b8fc-c6b09cb101c7",
			"events": [
				{
					"eventIdentifier": "4f16e5b7-76cf-4808-92a3-56ab2c09368f",
					"eventType": "billPayTransfer",
					"eventDateTime": "2025-06-16T09:09:47.228Z",
					"billPayTransfer": {
						"paymentIdentifier": "7f559b10-57d9-4dbe-99b9-e3b255f98955",
						"transferIdentifier": "2db69a45-8770-4c05-bf99-691460c68edb",
						"transferStatus": "rejected",
						"payeeIdentifier": "3069d80c-c67d-4948-a105-026096ff65d4",
						"paymentStatus": "scheduled",
						"amount": 2.15,
						"paymentDate": "2025-06-17",
						"deliveryDate": "2025-06-25",
						"paymentMemo": "testPayment",
						"note": "test",
						"confirmationNumber": "XHZL0-C3C8R",
						"payeeName": "OwkbEPGf",
						"frequencyType": "weekly"
					}
				}
			]
		}
	]
}

Return Transaction

"eventType": "transaction"

"transactionType": "billPay",

"transactionStatus": "completed"

"transactionTypeDescription": "Bill Pay Reversal"

{
	"accounts": [
		{
			"accountIdentifier": "30da4498-7139-4753-b8fc-c6b09cb101c7",
			"events": [
				{
					"eventIdentifier": "e01ce3c1-cd88-4370-ad5d-a35bccc20a1b",
					"eventType": "transaction",
					"eventDateTime": "2025-06-16T09:09:47.609Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "64b96b21-1344-dfe3-216b-b9644413e3df",
							"transactionIdentifier": "64b96b21-1344-dfe3-216b-b9644413e3df",
							"transactionType": "billPay",
							"transactionStatus": "completed",
							"transactionTypeDescription": "Bill Pay Reversal",
							"accountIdentifier": "30da4498-7139-4753-b8fc-c6b09cb101c7",
							"currency": "USD",
							"postedDateTime": "2025-06-16T09:09:46.211Z",
							"transactionAmount": 2.15,
							"isCredit": true,
							"purses": [
								{
									"purseIdentifier": "323baa22-8de9-44aa-b028-4945150ed40a",
									"purseType": "primary",
									"availableBalance": 100.0,
									"ledgerBalance": 100.0,
									"availableBalanceAsOfDateTime": "2025-06-16T09:09:46.210Z",
									"ledgerBalanceAsOfDateTime": "2025-06-16T09:09:46.210Z"
								}
							],
							"postedInternalTransactionData": {
								"transferIdentifier": "2db69a45-8770-4c05-bf99-691460c68edb",
								"description": "Reversal Online Payment to OwkbEPGf",
								"transferType": "billPay"
							}
						}
					]
				}
			]
		}
	]
}

Bill Payment Transfer Failure

{
	"accounts”: [{
		"accountIdentifier":"4f8feff5-9a19-4277-9a6b-663d946d3c91",
		"events": [{
			"eventIdentifier":"01dfc34a-6044-4984-9569-16a344cf2119",
			"eventType":"billPayTransfer",
			"eventDateTime":"2020-07-23T15":"00":51.065Z",
			"billPayTransfer": {
				"paymentIdentifier":"00000000-0000-0000-0000-000000000000",
				"transferIdentifier":"3b6af751-6399-4e87-b9e2-4e7ab0fc508a",
				"transferStatus":"failed",
				"amount":0.0,
				"frequencyType":0
			},
			"accountIdentifier":"4f8feff5-9a19-4277-9a6b-663d946d3c91"\"
		}]
	}]
}

Card Updated Webhook

Event Types with Sample Payload

Activate Card

"eventType":"CardUpdate"

{
    "accounts": [
        {
            "accountIdentifier": "28d1db3f-9e46-4a0d-8c07-25aa3f4f64ae",
            "events": [
                {
                    "eventIdentifier": "b6391bce-1f45-4d5c-b6b8-b0a4ae71a5ca",
                    "eventType": "cardUpdate",
                    "eventDateTime": "2025-06-18T07:22:52.588Z",
                    "paymentInstrument": {
                        "userIdentifier": "bf779f0e-c79f-4893-a096-9834c9b56f03",
                        "paymentInstrumentIdentifier": "2f513594-384d-4ded-a877-a5bae539c67a",
                        "accountIdentifier": "28d1db3f-9e46-4a0d-8c07-25aa3f4f64ae",
                        "paymentInstrumentType": "virtual",
                        "status": "deactivated",
                        "isPinSet": true,
                        "last4Pan": "4143",
                        "activatedDateTime": "2025-06-18T07:22:18Z",
                        "issuedDateTime": "2025-06-18T07:22:18Z",
                        "embossedName": "spmXskpB iWLlfOkC"
                    }
                }
            ]
        }
    ]
}

Report Lost

"eventType":"CardUpdate“

{
    "accounts": [
        {
            "accountIdentifier": "64013cb3-b45b-47b6-9dfc-65ec0865d569",
            "events": [
                {
                    "eventIdentifier": "d3d5a0cd-037b-4181-84b6-e786a827e0cf",
                    "eventType": "cardUpdate",
                    "eventDateTime": "2025-06-19T09:36:41.133Z",
                    "paymentInstrument": {
                        "userIdentifier": "ba2feb19-bae4-4cad-80ca-e59b292f4e02",
                        "paymentInstrumentIdentifier": "e82decc1-25c0-4046-a3c8-79ef77012edc",
                        "accountIdentifier": "64013cb3-b45b-47b6-9dfc-65ec0865d569",
                        "paymentInstrumentType": "contactlessEmv",
                        "status": "closed",
                        "statusReasons": [
                            "lostStolen"
                        ],
                        "isPinSet": true,
                        "last4Pan": "0845",
                        "activatedDateTime": "2025-06-19T09:36:30Z",
                        "issuedDateTime": "2025-06-17T09:36:37Z",
                        "embossedName": "uUKXWAkk SeQdQARr"
                    }
                }
            ]
        }
    ]
}

Direct Deposit Switch Webhook

Event Types with Sample Payload

"eventType": "directDepositSwitch"

{
	"accounts": [
		{
			"accountIdentifier": "6e43734f-525f-4eac-9cf3-1425e95eeaca",
			"events": [
				{
					"eventIdentifier": "be1f1ff6-baf7-4184-afd0-b04866f21259",
					"eventType": "directDepositSwitch",
					"eventDateTime": "2025-06-24T23:38:44.955Z",
					"directDepositSwitch": {
						"accountIdentifier": "6e43734f-525f-4eac-9cf3-1425e95eeaca",
						"switchId": "269f7078-0a3e-6ee4-d795-911f8b8973ac",
						"Vendor": "Atomic",
						"AmountType": "All",
						"Status": "Failed",
						"StatusReason": "bad-credentials",
						"LastEventDateUTC": "2025-06-24T23:38:43.39Z",
						"Depositor": "Paychex Flex"
					}
				}
			]
		}
	]
}

eWallet Webhook

API Call Reference

POST https://yourendpoint.yourcompany.com/events/ewallet

Event Types with Sample Payload

"eventType": "Provisioning"

"transactionType":"tokenActivation"

"transactionStatus": "completed"

{
	"accounts": [
		{
			"accountIdentifier": "aa9d5776-259d-43ea-9b21-21dce17fd90c",
			"events": [
				{
					"eventIdentifier": "1d33f90d-b8f0-4ee7-9a5b-5edb31bdcc68",
					"eventType": "provisioning",
					"eventDateTime": "2025-06-16T08:18:24.168Z",
					"transactions": [
						{
							"transactionIdentifier": "5d044e4f-b270-416f-9862-7c51c4c3c6c0",
							"transactionType": "tokenActivation",
							"transactionStatus": "completed",
							"accountIdentifier": "aa9d5776-259d-43ea-9b21-21dce17fd90c",
							"bin": "424067",
							"last4Pan": "8468",
							"paymentIdentifier": "76e1b66d-b5f5-4643-9743-0344f235cd92",
							"paymentInstrumentIdentifier": "f2a5210e-1ef0-4b16-a6a3-9dde7b92341d",
							"activationData": {
								"activationCodeExpiry": "2023-11-22T21:29:02.332Z",
								"activationCode": "12345"
							}
						}
					]
				}
			]
		}
	]
}

provisioning

"transactionType": "tokenStatus",
"transactionStatus": "completed",

{
	"accounts": [
		{
			"accountIdentifier": "aa9d5776-259d-43ea-9b21-21dce17fd90c",
			"events": [
				{
					"eventIdentifier": "c510cb2a-cf69-4e8d-a839-05b6fbd8a928",
					"eventType": "provisioning",
					"eventDateTime": "2025-06-16T08:19:02.862Z",
					"transactions": [
						{
							"transactionIdentifier": "ef63c176-a779-d041-76c1-63ef79a741d0",
							"transactionType": "tokenStatus",
							"transactionStatus": "completed",
							"accountIdentifier": "aa9d5776-259d-43ea-9b21-21dce17fd90c",
							"bin": "424067",
							"last4Pan": "8468",
							"paymentIdentifier": "76e1b66d-b5f5-4643-9743-0344f235cd92",
							"paymentInstrumentIdentifier": "0b8477b9-fbc1-478f-98f7-f8ad718f5c2d",
							"tokenInformation": {
								"DPANID": "DNITHE572174385954578402",
								"FPANID": "V-5192525864420068937921",
								"PAR": "V0010015823199514748128293435",
								"last4DPAN": "9202",
								"wallet": "Google Inc.",
								"status": "deactivated",
								"walletType": "DigitalWallet"
							}
						}
					]
				}
			]
		}
	]
}

provisioning

"transactionType": "tokenComplete",
"transactionStatus": "completed",

{
	"accounts": [
		{
			"accountIdentifier": "2da5bcc1-90ca-4df4-bc8c-9c0920f8e164",
			"events": [
				{
					"eventIdentifier": "c5b2af40-ccbe-4c2f-9a2e-f89f77ad6964",
					"eventType": "provisioning",
					"eventDateTime": "2025-06-05T10:01:21.962Z",
					"transactions": [
						{
							"transactionIdentifier": "834b2201-2569-4cc1-0122-4b836925c14c",
							"transactionType": "tokenComplete",
							"transactionStatus": "completed",
							"accountIdentifier": "2da5bcc1-90ca-4df4-bc8c-9c0920f8e164",
							"bin": "424067",
							"last4Pan": "0963",
							"userIdentifier": "9f613389-db8b-4baf-a3fd-62befbe5891c",
							"paymentIdentifier": "e18bece7-00c3-499d-8909-239ded79f96b",
							"paymentInstrumentIdentifier": "eba8c3c8-6234-4252-996d-d71a784995dd",
							"tokenInformation": {
								"DPANID": "DEMULdrerio2bhabxcpkl7h3u54jg77nq3553zctm1bfzchi",
								"FPANID": "FEMULxae6arzg20shwe44bxko6mpfmo2rhp8c7oouut5u94g",
								"PAR": "5001657CGPAMLGR7NPOPI4A04Z8U8",
								"last4DPAN": "1652",
								"wallet": "Samsung Pay",
								"status": "active"
							}
						}
					]
				}
			]
		}
	]
}

Failed Transfer Webhook

API Call Reference

POST https://yourendpoint.yourcompany.com/events/failedTransfer

Sample Webhook

Sample Failed Transfer Webhook - NSF Failed Retry Transactions:-

When retried transactions fail due to Non-Sufficient Funds ("NSF)",
a failed transfer webhook will be returned containing a reference to the original disbursement.

{
  "accounts":[
    {
      "accountIdentifier":"8ca5c97a-b2fc-4108-a4fa-7f01b556e332",
      "events":[
        {
          "eventIdentifier":"fad0182e-b070-4813-8928-330303695d5d",
          "eventType":"failedTransfer",
          "eventDateTime":"2020-09-17T19:12:17.137Z",
          "transfer":{
            "transferType":"disbursementOut",
            "transferIdentifier":"7383a828-d277-4e0a-927c-e3901a783b12",
            "accountIdentifier":"8ca5c97a-b2fc-4108-a4fa-7f01b556e332",
            "transactionAmount":10.0,
            "transferStatus":"failed",
            "transferStatusReason":"insufficientFunds"
          }
        }
      ]
    }
  ]
}

Event Type: Auto Money Movement (AMM)

An AMM Webhook will be published for:

  • ACH In events
  • Date Driven events
  • Failed AMM events
  • Rule expiring reminders (3 days before rule end date)
  • Expiration notifications (rule end date or goal amount met)

Sample Webhook Notifications

Sample Webhook Notification – ACH In (P2P):-

{
  "priorityMessage":{
    "programCode":"acme",
    "attributes":[
      {
        "value":"achIn",
        "name":"ruleName"
      },
      {
        "value":"ftXsq",
        "name":"firstName"
      },
      {
        "value":"INRtH",
        "name":"lastName"
      },
      {
        "value":"24.00",
        "name":"amount"
      },
      {
        "value":"2019-08-22T18:22:01.285Z",
        "name":"date"
      },
      {
        "name":"vaultName"
      }
    ],
    "accountIdentifier":"08974d51-e290-4530-b714-2cdf98da9f08",
    "productCode":"40002",
    "contacts":[
      {
        "channelType":"1",
        "contactValue":"8199920733"
      }
    ],
    "notificationType":"57"
  },
  "eventType":"PrioritySend",
  "postBackUrl":"https":"responseMessage":{
    "responseHeader":{
      "statusMessage":"Success",
      "statusCode":"200",
      "responseId":"223c5c1a-8af3-4524-9d7e-f2a3734e9ef1"
    }
  }

Sample Webhook Notification – Date Driven (P2P):-

{
    "priorityMessage":{
      "productCode":"40002",
      "programCode":"acme",
      "contacts":[
        {
          "contactValue":"7573619525",
          "channelType":"1"
        }
      ],
      "accountIdentifier":"177f3011-9c1e-477f-8faa-a3fec6f7dd6b",
      "notificationType":"58",
      "attributes":[
        {
          "value":"dateDriven",
          "name":"ruleName"
        },
        {
          "value":"JYQhG",
          "name":"firstName"
        },
        {
          "value":"bsLoA",
          "name":"lastName"
        },
        {
          "value":"90.00",
          "name":"amount"
        },
        {
          "value":"2019-08-22T18:22:01.285Z",
          "name":"date"
        },
        {
          "name":"vaultName"
        }
      ]
    },
    "postBackUrl":"https://tbd",
    "responseMessage":{
      "responseHeader":{
        "statusCode":"200",
        "responseId":"efc8c44f-974d-465c-bd86-6b94731c762b",
        "statusMessage":"Success"
      }
    },
    "eventType":"prioritySend"
  }
]

Sample Webhook Notification – Failed (Closed account):-

{
  "priorityMessage":{
    "productCode":"40002",
    "programCode":"acme",
    "attributes":[
      {
        "value":"achIn",
        "name":"ruleName"
      },
      {
        "value":"AvYNP",
        "name":"firstName"
      },
      {
        "value":"HaWIQ",
        "name":"lastName"
      },
      {
        "value":"91.00",
        "name":"amount"
      },
      {
        "value":"accountStatus is Closed.",
        "name":"Reason"
      },
      {
        "value":"2019-08-22T18:22:01.285Z ",
        "name":"date"
      },
      {
        "name":"vaultName"
      }
    ],
    "accountIdentifier":"c79aa6fb-20ac-48a3-950c-148b63dd3fd9",
    "contacts":[
      {
        "channelType":"1",
        "contactValue":"4007239942"
      }
    ],
    "notificationType":"59"
  },
  "responseMessage":{
    "responseHeader":{
      "statusMessage":"Success",
      "statusCode":"200",
      "responseId":"4db854fd-b7ff-4c6a-935a-8231ca8a9265"
    }
  },
  "eventType":"prioritySend",
  "postBackUrl":"https://tbd"
 }]
}

Event Types with Sample Payload

"eventType": "failedTransfer"

"transferType":"disbursementOut"

"transferStatus": "failed"

{
  "accounts":[
    {
      "accountIdentifier":"8ca5c97a-b2fc-4108-a4fa-7f01b556e332",
      "events":[
        {
          "eventIdentifier":"fad0182e-b070-4813-8928-330303695d5d",
          "eventType":"failedTransfer",
          "eventDateTime":"2020-09-17T19:12:17.137Z",
          "transfer":{
            "transferType":"disbursementOut",
            "transferIdentifier":"7383a828-d277-4e0a-927c-e3901a783b12",
            "accountIdentifier":"8ca5c97a-b2fc-4108-a4fa-7f01b556e332",
            "transactionAmount":10.0,
            "transferStatus":"failed",
            "transferStatusReason":"insufficientFunds"
          }
        }
      ]
    }
  ]
}

Feature Update Webhook

Event Types with Sample Payload

"eventType": "featureUpdate"

{
	"accounts": [
		{
			"accountIdentifier": "02767a9d-b641-4381-9d54-143d24bc80fa",
			"events": [
				{
					"eventIdentifier": "bfdce6b7-2db0-410f-b69d-a14493bbefe2",
					"eventType": "featureUpdate",
					"eventDateTime": "2025-06-24T06:57:09.678Z",
					"features": [
						{
							"feature": "Od1",
							"enrolled": true,
							"extensionAttributes": {}
						}
					]
				}
			]
		}
	]
}

General Transaction Notification

API Call Reference

POST https://yourendpoint.yourcompany.com/events/transactions

Sample Request - Transaction Notification

Note: This is a generalized transactions schema. Certain fields and object groups will be included or excluded, depending on the transactionType. See Transaction Types & Statuses for details.

POST https://yourendpoint.yourcompany.com/events/transactions
Content-Type: application/json
X-GD-RequestId: 977d83e8-84d5-4c3d-98f3-fc0e739ba1ee
x-api-key: apikeyvalueforPartnerX
cache-control: no-cache
User-Agent: PostmanRuntime/7.3.0
Accept: */*
Host: https://yourendpoint.yourcompany.com
accept-encoding: gzip, deflate
content-length: 838
Connection: close
{
   "accounts":[
      {
         "accountIdentifier":"0b830092-e5d4-45b8-ad26-8a42c94ddd4c",
         "events":[
            {
               "eventIdentifier":"67659d0f-76db-44b3-a40f-d2df27d2727e",
               "eventType":"transaction",
               "eventDateTime":"2018-09-17T20:50:16.657Z",
               "transactions":[
                  {
                     "parentTransactionIdentifier":"908bd6ce-de70-4f7a-9875-88201aa086a1",
                     "transactionIdentifier":"184f9c51-4e8b-4245-a045-f545e1dd1c5a",
                     "transactionType":"purchase",
                     "transactionStatus":"pending",
                     "accountIdentifier":"0b830092-e5d4-45b8-ad26-8a42c94ddd4c",
                     "bin":"4111",
                     "last4Pan":"1234",
                     "currency":"USD",
                     "purses":[
                        {
                           "purseIdentifier":"562a27ec-6cae-4459-a522-be94b4570f78",
                           "purseType":"primary",
                           "availableBalance":0,
                           "ledgerBalance":0,
                           "availableBalanceAsOfDateTime":"2018-09-17T20:50:16.657Z",
                           "ledgerBalanceAsOfDateTime":"2018-09-17T20:50:16.657Z"
                        }
                     ],
                     "postedDateTime":"2018-09-17T20:50:16.657Z",
                     "transactionAmount":10.53,
                     "fees":[
                        {
                           "feeType":"atmWithdrawalFee",
                           "description":"ATM Withdrawal Fee",
                           "amount":2.5,
                           "currency":"USD"
                        }
                     ],
                     "isCredit":true,
                     "networkTransactionData":{
                        "authorizationDateTime":"2018-09-17T20:50:16.658Z",
                        "cashBackAmount":20,
                        "localTransactionData":{
                           "amount":25.34,
                           "currency":"CDN"
                        },
                        "cardAcceptor":{
                           "merchantName":"Acme Gas",
                           "city":"Pasadena",
                           "stateProvReg":"CA"
                        },
                        "authorizedTransactionData":{
                           "holdExpirationDate":"2018-03-03",
                           "declineReason":"insufficientFunds",
                           "eci":"eCommerce",
                           "approvalCode":"12345678"
                        }
                     },
                     "postedInternalTransactionData":{
                        "transferIdentifier":"20433e90-0935-4ca1-8beb-ae7de12ef759",
                        "adjustmentType":"provisionalDispute",
                        "description":"Acme Invest",
                        "transferType":"achOut"
                     }
                  }
               ]
            }
         ]
      }
   ]
}

Request Parameters - Transaction Notification

FieldDescription
accountsThe outer account/account balance object is only included for transaction events and provides the most recent balance for the account. This is an optional property that must be explicitly configured when the partner postback subscriptions are configured.
accountIdentifierUnique Identifier for the account.
eventsThe outer events object.
eventIdentifierA unique identifier for the event.
eventTypeThe type of event (i.e. transaction, accountUpdated, or statementReady).
eventDateTimeThe date/time (UTC) when the event happened.
transactionsThe outer transactions object containing the content of a transaction that is posted back to the client/partner in response to a transaction event.
parentTransactionIdentifierUnique parent identifier for the transaction.
transactionIdentifierUnique identifier for the transaction
transactionTypeType of transaction. See Transaction Types & Statuses for details.

Note: The transactionType for a “disbursementIn” and a“disbursementOut” request will be: • disbursementIn – partnerTransferIn • disbursementOut - disbursement. The transferType will also be returned in the transaction webhooks for disbursementIn and disbursementOut and is the recommended way to distinguish between disbursements.
transactionStatusStatus of transaction:• pending• declined • removed • expired • cleared • completed• reversed See Transaction Types & Statuses for details
accountIdentifierUnique identifier for the account.
binFirst 4-8 digits of a user’s card number that identifies a range of cards assigned to a Card Issuer (i.e. Green Dot).
last4PanLast 4 digits of the Personal Account Number of a card (# on the front of the card).
currencyString value that returns the account currency provided as an Alpha-3 ISO currency code. Default is USD.
pursesA balance holding object that returns the following information about the primary purse (used for general spending activities).
purseIdentifierUnique identifier for a purse within an account.
purseTypeIndicates the purpose of the purse.
availableBalanceThe amount of funds available for use. pending transactions are included in the availableBalance.
ledgerBalanceThe balance of the account based on all activities that have been posted to the associated ledger.
availableBalanceAsOfDateTimeThe date and time (UTC) that the available balance is reflective of. Since events can be published out of chronological order, do not update the available balance if a more recent available balance as of date was previously processed.
ledgerBalanceAsOfDateTimeThe date and time (UTC) that the ledger balance is reflective of.

Note: Since events can be published out of chronological order, do not update the ledger balance if a more recent ledger balance as of date was previously processed.
postedDateTimeDate/time (UTC) of transaction.

Note: UTC means time is offset from US time zones by approx. +4 to +11 hours.
transactionAmountAmount of transaction excluding fees.
feesA fee associated with a transaction or event.
feeTypeType of fee associated with the transaction. (i.e. atmWithdrawalFee, bankOtcFee, atmBalanceInquiryFee, foreignTransactionFee).
descriptionDescription displayed to user in fee schedule.
amountAmount of fee associated with the transaction.
currencyString value that returns the account currency provided as an Alpha-3 ISO currency code. Default is USD.
isCreditIf true, transaction is a credit. If false, transaction is a debit.
networkTransactionDataThe properties of a network transaction returned with an event object.
Note: Examples of network transactionType are authorization, purchase, atmWithdrawal and refund
authorizationDateTimeDate/time (UTC) of transaction authorization. Note: UTC means time is offset from US time zones by approx. +4 to +11 hours.
cashBackAmountAmount requested as cash back during transaction. Included in transactionAmount.
localTransactionDataThe properties of a foreign currency network transaction.
amountAmount of foreign currency network transaction.
currencyThe type of currency associated with the foreign currency network transaction.
cardAcceptorThe properties of a merchant involved in the transaction and returned in an event object. Note: May contain other merchant provided data, in addition to name, city and state, such as a phone number.
merchantNameName of merchant involved in the transaction.
merchantIndustryCodeIndustry code of the merchant involved in the transaction.
merchantIndustryCategoryIndustry category of the merchant involved in the transaction.
merchantIndustryDescriptionIndustry description of the merchant involved in the transaction.
cityCity where merchant is located.
stateProvRegState where merchant is located.
authorizedTransactionDataAn authorized transaction from the network returned in an event object.
Note: An authorized transaction will be in a pending status until it is posted, removed (i.e. through a reversal or an abandoned purchase at an automated fuel dispenser) or expires.
holdExpirationDateIf the authorized purchase is not cleared or removed by this date then the transaction will be expired, and the held funds will become available again.
declineReasonIncluded if transactionStatus=declined.

Note: Click here for decline reasons.
eciIncluded with authorized transactions. Possible values for the ECI indicator are eCommerce, recurring, installment, multiClearing, none.
approvalCodeA code assigned during authorization indicating approval. This code follows a transaction through its lifecycle, even for reversals and multi-clearing transactions.
postedInternalTransactionDataA posted transaction that was initiated within the system and returned in an event object. For example, where transactionType is achOutTransfer, peerTransfer, adjustment, directDeposit, etc.
transferIdentifierIf the transaction is initiated through the transfers API, then the transferIdentifier uniquely identifying the initiating transfer will be included.
adjustmentTypeprovisionalDispute

Included if transactionType=adjustment.

See Adjustment Types for details.
descriptionTransaction description for achIn, achOut, cashReload, partnerTransferIn (achPull), disbursement, purseTransfer and more as added. Notes:
• For achIn transaction type, the maximum length of domestic transactions is 26 characters.
• For International transactions, the maximum length is 45 characters.
• For achIn, Green Dot is the Receiving Depository Financial Institution (RDFI).
• An achIn will only generate a Transactions webhook when it is posted.
transferTypeType of transfer (I.e. achOut)

Sample Response Bodies

The following example illustrates how parentTransactionIdentifier is included in responses when partners perform the following:

  • Query the status of a transaction.
  • Programmatically check transactions periodically against the Transaction API to ensure they are in sync.

Sample Response 1

{
   "totalRecordCount":1,
   "transactions":[
      {
         "paymentIdentifier":"af0b729a-9957-4c7d-96f0-9a7057e44e79",
         "transactionIdentifier":"61ea4be3-7b20-0b7c-e34b-ea61207b7c0b",
         "parentTransactionIdentifier":"67e0695f-1143-02d7-5f69-e0674311d702",
         "transactionType":"purchase",
         "transactionTypeDescription":"Purchase",
         "transactionStatus":"completed",
         "accountIdentifier":"b7c54dfc-225a-40e4-ac89-c65beb699d07",
         "purseIdentifier":"82529298-efbb-45fc-8fd1-24d3fb4fcb93",
         "bin":"424067 ",
         "last4Pan":"5648",
         "currency":"USD",
         "postedDateTime":"2021-08-12T01:08:58Z",
         "transactionAmount":17.5600,
         "isCredit":false,
         "networkTransactionData":{
            "authorizationDateTime":"2021-08-12T01:08:58Z",
            "cashBackAmount":0.0,
            "cardAcceptor":{
               "merchantName":"GreenDot Corporation Vish",
               "merchantIndustryCode":"6011",
               "merchantIndustryCategory":"Service Providers",
               "merchantIndustryDescription":"Financial institutions - automated cash disbursements",
               "city":"E Main Pasadena",
               "stateProvReg":"CA"
            }
         }
      }
   ],
   "responseDetails":[
      {
         "code":0,
         "subCode":0,
         "description":"Success",
         "url":"http://tbd"
      }
   ]
}

Sample Response 2

{
   "count":1,
   "pn_results":[
      {
         "ResponseMessage":"Ingested 1 event(s)",
         "RequestMessageToPartner":{
            "accounts":[
               {
                  "events":[
                     {
                        "eventIdentifier":"0189030a-6027-44c5-8f92-3716ccf02298",
                        "eventType":"transaction",
                        "transactions":[
                           {
                              "transactionTypeDescription":"Purchase",
                              "last4Pan":"5648",
                              "postedDateTime":"2021-08-12T01:08:58.000Z",
                              "purses":[
                                 {
                                    "availableBalance":8,
                                    "ledgerBalanceAsOfDateTime":"2021-08-12T01:08:58.000Z",
                                    "ledgerBalance":488.98,
                                    "purseIdentifier":"82529298-efbb-45fc-8fd1-24d3fb4fcb93",
                                    "availableBalanceAsOfDateTime":"2021-08-12T01:08:58.000Z",
                                    "purseType":"primary"
                                 }
                              ],
                              "transactionAmount":17.56,
                              "transactionIdentifier":"6e287cbd-ec4f-0708-bd7c-286e4fec0807",
                              "currency":"USD",
                              "parentTransactionIdentifier":"67e0455f-1143-02d7-5f66-e0672211d702",
                              "isCredit":false,
                              "bin":"424067",
                              "transactionStatus":"pending",
                              "paymentIdentifier":"af0b729a-9957-4c7d-96f0-9a7057e44e79",
                              "accountIdentifier":"b7c54dfc-225a-40e4-ac89-c65beb699d07",
                              "transactionType":"purchase",
                              "networkTransactionData":{
                                 "cashBackAmount":0.01,
                                 "cardAcceptor":{
                                    "merchantIndustryCode":"6011",
                                    "merchantIndustryDescription":"Financial institutions-automated cash disbursements",
                                    "stateProvReg":"CA",
                                    "merchantName":"PTS MTF TEST",
                                    "city":"Pasadena",
                                    "merchantIndustryCategory":"Service Providers"
                                 },
                                 "authorizationDateTime":"2021-08-12T01:08:58.000Z",
                                 "authorizedTransactionData":{
                                    "eci":"none",
                                    "isPartialAuth":false,
                                    "holdExpirationDate":"2021-08-25",
                                    "authStatusIndicator":"I",
                                    "requestAuthorizationAmount":17.56,
                                    "approvalCode":"373087"
                                 }
                              },
                              "userIdentifier":"e10e3cba-bfea-403c-8be9-dc0cd8fd6ca2",
                              "fees":[
                                 {
                                    "currency":"USD",
                                    "amount":0.01,
                                    "feeType":"bankOtcFee",
                                    "description":"Bank OTC Fee"
                                 },
                                 {
                                    "currency":"USD",
                                    "amount":0.03,
                                    "feeType":"bankOtcFee",
                                    "description":"Bank OTC Fee"
                                 },
                                 {
                                    "currency":"USD",
                                    "amount":0.05,
                                    "feeType":"bankOtcFee",
                                    "description":"Bank OTC Fee"
                                 },
                                 {
                                    "currency":"USD",
                                    "amount":0.08,
                                    "feeType":"bankOtcFee",
                                    "description":"Bank OTC Fee"
                                 },
                                 {
                                    "currency":"USD",
                                    "amount":0.13,
                                    "feeType":"bankOtcFee",
                                    "description":"Bank OTC Fee"
                                 }
                              ]
                           }
                        ],
                        "eventDateTime":"2021-08-11T19:08:59.683Z"
                     }
                  ],
                  "accountIdentifier":"b7c54dfc-225a-40e4-ac89-c65beb699d07"
               }
            ]
         },
         "RequestMessage":{
            "transactions":[
               {
                  "transactionTypeDescription":"Purchase",
                  "accountCurrency":"USD",
                  "last4Pan":"5648",
                  "postedDateTime":"2021-08-12T01:08:58.000Z",
                  "purses":[
                     {
                        "availableBalance":8,
                        "ledgerBalanceAsOfDateTime":"2021-08-12T01:08:58.000Z",
                        "ledgerBalance":488.98,
                        "purseIdentifier":"82529298-efbb-45fc-8fd1-24d3fb4fcb93",
                        "availableBalanceAsOfDateTime":"2021-08-12T01:08:58.000Z",
                        "purseType":"primary"
                     }
                  ],
                  "transactionAmount":17.56,
                  "description":"PTS MTF TEST\\Pasadena",
                  "userIdentifier":"e10e3cba-bfea-403c-8be9-dc0cd8fd6ca2",
                  "parentTransactionIdentifier":"67e0695f-1143-02d7-5f44-e0444311d702",
                  "isCredit":false,
                  "bin":"424067",
                  "transactionStatus":"pending",
                  "statusChangedTimestamp":"2021-08-12T01:08:58.000Z",
                  "accountIdentifier":"b7c54dfc-225a-40e4-ac89-c65beb699d07",
                  "programCode":"stash",
                  "transactionType":"purchase",
                  "networkTransactionData":{
                     "cashBackAmount":0.01,
                     "cardAcceptor":{
                        "merchantIndustryCode":"6011",
                        "merchantIndustryDescription":"Financial institutions -automated cash disbursements",
                        "stateProvReg":"CA",
                        "merchantName":"PTS MTF TEST",
                        "city":"Pasadena",
                        "merchantIndustryCategory":"Service Providers"
                     },
                     "authorizationDateTime":"2021-08-12T01:08:58.000Z",
                     "authorizedTransactionData":{
                        "eci":"none",
                        "isPartialAuth":false,
                        "holdExpirationDate":"2021-08-25",
                        "authStatusIndicator":"I",
                        "requestAuthorizationAmount":17.56,
                        "approvalCode":"373087"
                     }
                  },
                  "transactionIdentifier":"6e287cbd-ec4f-0708-bd7c-286e4fec0807",
                  "userProfileId":"fd3f8b5c-8048-46f4-88c5-ec9a4adad024",
                  "fees":[
                     {
                        "currencyCode":"USD",
                        "amount":0.01,
                        "feeType":"bankOtcFee",
                        "description":"Bank OTC Fee"
                     },
                     {
                        "currencyCode":"USD",
                        "amount":0.03,
                        "feeType":"bankOtcFee",
                        "description":"Bank OTC Fee"
                     },
                     {
                        "currencyCode":"USD",
                        "amount":0.05,
                        "feeType":"bankOtcFee",
                        "description":"Bank OTC Fee"
                     },
                     {
                        "currencyCode":"USD",
                        "amount":0.08,
                        "feeType":"bankOtcFee",
                        "description":"Bank OTC Fee"
                     },
                     {
                        "currencyCode":"USD",
                        "amount":0.13,
                        "feeType":"bankOtcFee",
                        "description":"Bank OTC Fee"
                     }
                  ],
                  "paymentIdentifier":"af0b729a-9957-4c7d-96f0-9a7057e44e79"
               }
            ],
            "account":{
               "state":"normal",
               "identifier":"b7c54dfc-225a-40e4-ac89-c65beb699d07",
               "ConsumerProfileKey":1125060,
               "balance":{
                  "currentBalanceAsOfDate":"2021-08-12T01:08:58.000Z",
                  "availableBalance":8,
                  "availableBalanceAsOfDate":"2021-08-12T01:08:58.000Z",
                  "currentBalance":488.98
               },
               "ConsumerProfileIdentifier":"e10e3cba-bfea-403c-8be9-dc0cd8fd6ca2"
            }
         },
         "message":"Publish notification post sent successfully.",
         "PostBackUrl":"https://tsa-webhook.staging.checking.com/events/transactions/tsa",
         "ResponseHttpStatusCode":200,
         "X-GD-RequestId":"11215c52-0e09-45cc-aca2-e319797e32ca",
         "EventType":"transaction"
      }
   ]
}

IDV Document Upload Webhook

Event Types with Sample Payload

"eventType":"idvDocumentUpload"

{
	"accounts": [
		{
			"accountIdentifier": "583e8eac-32e0-4d89-8091-ad4126c9e0c1",
			"events": [
				{
					"eventIdentifier": "907ce0b4-214a-4d94-9cc1-425860aa3122",
					"eventType": "idvDocumentUpload",
					"eventDateTime": "2025-06-20T20:55:01.400Z",
					"documentUpload": {
						"registrationToken": "583e8eac-32e0-4d89-8091-ad4126c9e0c1",
						"eventType": "DOCUMENT_FRONT_UPLOADED",
						"docVTransactionToken": "c44f1f00-bbae-49e6-a6d2-2ec0c164d6d5"
					}
				}
			]
		}
	]
}

Joint Account Webhooks

For joint accounts, there will be one more property userIdentifier added to the webhooks request payload for following scenarios:

Event Types with Sample Payload

accountUpdated

{
  "accounts": [
    {
      "accountIdentifier": "1891e86e-034c-4759-81eb-7ff0ee580dd8",
      "events": [
        {
          "eventIdentifier": "7512ba14-3828-466b-96a4-2ff15c3a0ff9",
          "eventType": "accountUpdated",
          "eventDateTime": "2025-02-04T07:33:59.790Z",
          "account": {
            "accountIdentifier": "1891e86e-034c-4759-81eb-7ff0ee580dd8",
            "status": "normal",
            "accountStatusChangedDateTime": "2025-02-04T07:33:59.720Z",
            "statusReasons": [
              "registrationNotComplete"
            ],
            "accountCycleDay": 3,
            "accountHolders": [
              {
                "user": {
                  "firstName": "***********pf",
                  "lastName": "***********CV",
                  "dobStatus": "matched",
                  "last4Identity": "1837",
                  "identityType": "iTIN",
                  "userIdentifier": "2c8a4470-ab4c-45c3-8e43-67be7d14e8b9", // Updated
                  "isPrimaryAccountHolder": false,
                  "status": "pending",
                  "kycStateData": {
                    "ofacStatus": "passed",
                    "kycStatus": "failed",
                    "kycPendingGate": "idv"
                  }
                }
              }
            ]
          }
        }
      ]
    }
  ]
}

achTransfer

{
  "accounts": [
    {
      "accountIdentifier": "3771ec35-5a68-41ec-b059-66706767ab26",
      "events": [
        {
          "eventIdentifier": "88f6cca8-69d8-42bc-9e57-a506af3c6fa4",
          "eventType": "achTransfer",
          "eventDateTime": "2024-07-12T04:14:36.359Z",
          "transfer": {
            "achTransferType": "achPull",
            "transferIdentifier": "32dadc93-b9b4-46e1-a8ac-5a666667db91",
            "accountIdentifier": "3771ec35-5a68-41ec-b059-66706767ab26",
            "submissionDateTime": "2024-07-12T04:14:36Z",
            "effectiveDeliveryDateTime": "2024-07-17T04:00:00Z",
            "transactionAmount": 1.2,
            "achTransferStatus": "pending",
            "userIdentifier": "8182b7e1-d303-491e-922c-28ee0552aeea" // Updated
          }
        }
      ]
    }
  ]
}

billPayTransfer

{
  "accounts": [
    {
      "accountIdentifier": "b87de573-33cc-4081-8a80-f4ec2539d715",
      "events": [
        {
          "eventIdentifier": "17cf2780-11df-4b4b-ab79-afc0b67abaac",
          "eventType": "billPayTransfer",
          "eventDateTime": "2025-01-16T08:59:05.069Z",
          "billPayTransfer": {
            "paymentIdentifier": "796f01e1-f220-4d75-9a94-6228e73eafea",
            "transferIdentifier": "7ce84de5-200e-45aa-8441-01358b6cfa5d",
            "transferStatus": "completed",
            "payeeIdentifier": "4b156ff7-7b1c-457c-adb4-887cfa4bb121",
            "paymentStatus": "scheduled",
            "amount": 1,
            "paymentDate": "2025-01-17",
            "deliveryDate": "2025-01-24",
            "paymentMemo": "testPayment",
            "note": "test",
            "confirmationNumber": "X08PK-6S3NJ",
            "payeeName": "lYjKGLcG",
            "frequencyType": "oneTime",
            "userIdentifier": "8FC507C2-E21E-471A-905F-734AAEECFCAF" // Updated
          }
        }
      ]
    }
  ]
}

cardUpdate

{
   "accounts":[
      {
         "accountIdentifier":"360298b6-ce42-41aa-b24a-cc045bbb2fb3",
         "events":[
            {
               "eventIdentifier":"48ddecfc-0338-4b93-b117-0ae89adec73c",
               "eventType":"cardUpdate",
               "eventDateTime":"2025-02-04T13:12:25.120Z",
               "paymentInstrument":{
                  "userIdentifier":"c31a99f5-7370-4a59-90cb-3b0b9b2e1042", // Existing behaviour
                  "paymentInstrumentIdentifier":"13fb49c6-0838-4e87-ba55-47ecce4cf8af",
                  "accountIdentifier":"360298b6-ce42-41aa-b24a-cc045bbb2fb3",
                  "paymentInstrumentType":"emv",
                  "status":"notActivated",
                  "isPinSet":false,
                  "last4Pan":"3645",
                  "issuedDateTime":"2025-02-04T13:12:25Z",
                  "embossedName":"F First 7pUiLuQ"
               }
            }
         ]
      }
   ]
}

transaction

{
   "accounts":[
      {
         "accountIdentifier":"6bf61e55-7d5d-4be8-bf60-ebcc622cea57",
         "events":[
            {
               "eventIdentifier":"d7157016-f2af-434b-883b-81047e4c57a9",
               "eventType":"transaction",
               "eventDateTime":"2025-02-04T14:12:42.85Z",
               "transactions":[
                  {
                     "parentTransactionIdentifier":"b888095b-cfbe-a5b4-5b09-88b8becfb4a5",
                     "retrievalReferenceNumber":"465035511534867",
                     "transactionIdentifier":"b888095b-cfbe-a5b4-5b09-88b8becfb4a5",
                     "transactionType":"purchase",
                     "transactionStatus":"pending",
                     "transactionTypeDescription":"Purchase",
                     "accountIdentifier":"6bf61e55-7d5d-4be8-bf60-ebcc622cea57",
                     "bin":"424067",
                     "last4Pan":"9847",
                     "currency":"USD",
                     "postedDateTime":"2025-02-04T14:12:32Z",
                     "transactionAmount":175.13,
                     "isCredit":false,
                     "userIdentifier":"88e2c2f3-6fd4-4159-80dd-d6fdcd7d7ee4", // Existing
                     "paymentIdentifier":"1de27cb5-feca-4030-8e12-47a2e5f04513", // Exisiting 
                     "purses":[
                        {
                           "purseIdentifier":"f0dc0516-ddc4-47d7-a410-0c823e7ec84b",
                           "purseType":"primary",
                           "availableBalance":981.22,
                           "ledgerBalance":1156.35,
                           "availableBalanceAsOfDateTime":"2025-02-04T14:12:32Z",
                           "ledgerBalanceAsOfDateTime":"2025-02-04T14:12:32Z"
                        }
                     ],
                     "networkTransactionData":{
                        "authorizationDateTime":"2025-02-04T14:12:33Z",
                        "cardAcceptor":{
                           "merchantName":"GEICO  *AUTO          ",
                           "merchantIndustryCode":"6300",
                           "merchantIndustryCategory":"Service Providers",
                           "city":"800-841-3000",
                           "stateProvReg":"DC ",
                           "merchantIndustryDescription":"Insurance sales, underwriting and premiums"
                        },
                        "authorizedTransactionData":{
                           "holdExpirationDate":"2025-02-09",
                           "requestAuthorizationAmount":175.13,
                           "approvalCode":"300830",
                           "eci":"recurring",
                           "isPartialAuth":false
                        }
                     }
                  }
               ]
            }
         ]
      }
   ]
}

Mail Tracking Webhook

API Call Reference

POST https://yourendpoint.yourcompany.com/events/mailTracking

After a Physical Card has been Shipped to the Customer

  • A payment identifier is included in the Mail Tracking webhook.
  • The Mail Tracking webhook will publish event notifications during the following delivery stages:
    • TMM card status of “shipped” will be set upon receipt of a confirmation file from the vendor.
    • TMM card status will be unchanged upon receipt of an in-process file from the vendor.
    • TMM card status of “delivered” will be set upon receipt of an in-home file from the vendor.
    • TMM card status of “returned’ will be set upon receipt of a returned file from the vendor
  • The PN will contain the following delivery status information:
    • Last 4 digits of the payment instrument (card)
    • deliveryMethod
    • deliveryMethodCode
      • Note: Allows the processing of mail tracking updates based on delivery method.
    • deliveryStatus
    • deliveryStatusCode containing one of the following:
      • shipped
      • delivered
      • returned
    • trackingNumber (internal only – not intended for release to accountholders)
    • shippedDate
    • estimatedArrivalDate
    • productMaterialType

Delivery Methods and Delivery Method Codes

Delivery MethodDelivery Method Code
Regularreg
Over Night Deliveryonn
Postal Service Expeditedpse
Rushrush
Otherother

Sample MailTracking Webhook & Webhook Notification

Sample MailTracking Webhook

{[-]
"AccountIdentifier:19185555-aa32-476e-96ac-025d7de9c7af
CallerFilePath:C:\\BuildAgent\\work\\ddd132195e437bb8\\PN\\Services\\PublishNotification\\PublishNotification.Logic\\Publishers\\PublisherBase.cs
 CallerLineNumber:422
 CallerMemberName:ProcessResponseMessage
 ElapsedTimeToPost:668 ms
 EventType:mailTracking
 PostBackUrl:https"::"partnerpc
 RequestMessage":
 {
  "deliveryStatus":
  {
	 "programCode:partnerpc",
	 "accountIdentifier:19185555-aa32-476e-96ed025d7de9e7bf",
	 "last4Pan:7141",
	 "deliveryMethod:Regular",
	 "deliveryMethodCode:reg",
	 "deliveryStatus:Card At Local Post Office",
	 "deliveryStatusCode:delivered",
	 "trackingNumber:0031029826605107792160634369611",
	 "shippedDate:2021-05-03T07:00:00Z",
	 "estimatedArrivalDate:2021-05-07T07:00:00Z",
	 "productMaterialType:moneyvcard",
	 "bin:499998",
	 "cardHolderName:* JOHN***DE JO***DOE",
	 "paymentIdentifier:c3f2b774-7c3x4b15-95db-e0c0f785c122""RequestMessageToPartner":
	 {
	   "accounts":
	   [{
	      "accountIdentifier:19185555-aa32-476e-96ac-025d7de9c7af",
	      "events":
	      [{
	       "eventIdentifier:bc21c571-a6b0-4837-90c2-9f61d51cf269",
	       "eventType:mailTracking",
	       "eventDateTime:2021-05-07T17:06:36.168Z",
	       "deliveryStatus":
	       {
	        "last4Pan:7141",
	        "deliveryMethod:Regular",
	        "deliveryMethodCode:reg",
	        "deliveryStatus:Card At Local Post Office",
	        "trackingNumber:0039999825505106543360637469611",
	        "shippedDate:2021-05-03T07:00:00Z",
	        "estimatedArrivalDate:2021-05-07T07:00:00Z",
	        "productMaterialType:moneyvcard",
	        "deliveryStatusCode:delivered",
	        "bin:499998 ",
	        "cardHolderName:* PE***NS GI***RE",
	        "paymentIdentifier:c3f2b934-7c3a-4b15-95db-e0c0f785c122"
	       }
	      }]
	   ]}
	   ResponseHttpStatusCode:200 
	   ResponseMessage:{
		"success":"true",
		"error":"",
		"tid":"1-6095739c-506beecd3759b01f166e730d"
	 }	 
	SkipPublish:false
	TimeoutOccurred:false
	X-GD-RequestId:5a1dda4f-f8a1-47b1-b3c4-340f876338ae
	level:INFO
	logger:PublishNotificationService
	machineName:PDIN-PN-C3B52
	message:Publish notification post sent successfully.
	threadId:69
	time:2021-05-07 10:06":36.8376
}
Show as raw text
host = pdin-pn-c3b52source = L":\GDC\Logs\PublishNotification\Log2021-05-07.json
sourcetype = bos_publish_notification

Mail Tracking Webhook Event Sample

"eventType":"mailTracking"

{
	"accounts": [
		{
			"accountIdentifier": "d57e51b8-8fe3-4e8a-b5c8-ae3d5c4dffd5",
			"events": [
				{
					"eventIdentifier": "726ce90a-970c-479a-9342-ce6c0c7e25f0",
					"eventType": "mailTracking",
					"eventDateTime": "2025-06-25T10:45:03.744Z",
					"deliveryStatus": {
						"last4Pan": "6285",
						"deliveryMethod": "Postal Service Expedited",
						"deliveryMethodCode": "pse",
						"deliveryStatus": "Card Mailed",
						"trackingNumber": "00310298255639290477",
						"shippedDate": "2025-06-25T07:00:00Z",
						"estimatedArrivalDate": "2025-07-04T07:00:00Z",
						"productMaterialType": "moneyemv",
						"deliveryStatusCode": "shipped",
						"bin": "499998    ",
						"cardHolderName": "Customer Name",
						"paymentIdentifier": "b8e65a5f-6e3c-4567-8a3f-1e02cf47546a"
					}
				}
			]
		}
	]
}

MRDC Check Deposit Webhook

API Call Reference

POST https://yourendpoint.yourcompany.com/events/checkDeposit

Event Types with Sample Payload

Webhook - Failed MRDC Transfer:-

{
  "accounts":[
    {
      "events":[
        {
          "eventDateTime":"2019-08-21T21:32:22.303Z",
          "eventIdentifier":"0b284cf9-b33e-4ebd-81b1-844aaee9eb10",
          "transfer":{
            "checkDeposit":{
              "lastChangedDateTime":"2019-08-21T21:32:22Z",
              "checkSubmitDate":"2019-08-21T18:22:01.285Z",
              "checkDepositStatus":"failed",
              "transactionAmount":50.0,
              "checkDepositSubStatus":"failed"
            },
            "transferIdentifier":"06fa213b-bebe-42c3-ba9b-d06a296e66a8"
          },
          "eventType":"checkDeposit"
        }
      ],
      "accountIdentifier":"7eea52f1-5439-4462-93d8-5e291d67dcf6"
    }
  ]
}

MRDC Check Under Review Process - Sample Webhook - Submit Check that is placed under review:-

{
  "accounts":[
    {
      "accountIdentifier":"bbb85a67-8122-4322-829f-f019204c4aaa",
      "events":[
        {
          "eventIdentifier":"444552ba-d029-49a1-895d-55d89cfc8111",
          "eventType":"checkDeposit",
          "eventDateTime":"2019-09-03T20:26:13.007Z",
          "transfer":{
            "transferIdentifier":"555a3fab-5593-4ca7-b008-57feb399f111",
            "checkDeposit":{
              "checkDepositStatus":"review",
              "checkDepositSubStatus":"pendingUserAcceptance",
              "transactionAmount":2800.0,
              "checkSubmitDate":"2019-09-03T18:22:01.285Z"
            }
          }
        }
      ]
    }
  ]
}

Sample Webhook - Update Check when the customer cancels the review:-

{
  "accounts":[
    {
      "accountIdentifier":"bbb85a67-8122-4322-829f-f019204c4aaa",
      "events":[
        {
          "eventIdentifier":"4444e68d-0b0c-49b9-9076-e3ae06fd9111",
          "eventType":"checkDeposit",
          "eventDateTime":"2019-09-03T20:26:28.088Z",
          "transfer":{
            "transferIdentifier":"555a3fab-5593-4ca7-b008-57feb399f111",
            "checkDeposit":{
              "checkDepositStatus":"canceled",
              "checkDepositSubStatus":"canceledByCustomer",
              "transactionAmount":2800.0,
              "checkSubmitDate":"2019-09-03",
              "lastChangedDateTime":"2019-09-03T20:26:28Z"
            }
          }
        }
      ]
    }
  ]
}

Sample Webhook - Update Check when user accepts the review:-

{
  "accounts":[
    {
      "accountIdentifier":"4449e061-b3bb-4582-94a5-43b64de56111",
      "events":[
        {
          "eventIdentifier":"444e036e-6234-42f1-8947-68a62c242111",
          "eventType":"checkDeposit",
          "eventDateTime":"2019-09-03T20:40:01.823Z",
          "transfer":{
            "transferIdentifier":"5550c3a5-ee54-4cbf-878d-b24c6fb0c111",
            "checkDeposit":{
              "checkDepositStatus":"review",
              "checkDepositSubStatus":"pendingAgentReview",
              "transactionAmount":2800.0,
              "checkSubmitDate":"2019-09-03",
              "lastChangedDateTime":"2019-09-03T20:40:01Z"
            }
          }
        }
      ]
    }
  ]
}

Sample Webhook - Update Check when agent accepts the review:-

{
  "accounts":[
    {
      "accountIdentifier":"4449e061-b3bb-4582-94a5-43b64de56111",
      "events":[
        {
          "eventIdentifier":"4441f7e4-b1e9-4af6-83f9-442227dd7111",
          "eventType":"checkDeposit",
          "eventDateTime":"2019-09-03T20:41:36.370Z",
          "transfer":{
            "transferIdentifier":"5550c3a5-ee54-4cbf-878d-b24c6fb0c111",
            "checkDeposit":{
              "checkDepositStatus":"approved",
              "checkDepositSubStatus":"fundsScheduled",
              "fundsAvailableDate":"2019-09-03T18:22:01.285Z",
              "transactionAmount":2800.0,
              "checkSubmitDate":"2019-09-03T18:22:01.285Z",
              "lastChangedDateTime":"2019-09-03T20:41:36Z"
            }
          }
        }
      ]
    }
  ]
}

Sample Webhook - Update Check when agent declines the check:-

{
  "accounts":[
    {
      "accountIdentifier":"1a09d887-6c53-44e3-8180-8e4a7f51ccc7",
      "events":[
        {
          "eventIdentifier":"0ea2cd36-e2fc-440b-a3ca-ade557490a6a",
          "eventType":"checkDeposit",
          "eventDateTime":"2021-03-16T23:00:04.303Z",
          "transfer":{
            "transferIdentifier":"e79a0ff2-8db9-4a81-a7ca-1ca8c87f865c",
            "checkDeposit":{
              "checkDepositStatus":"declined",
              "checkDepositSubStatus":"declinedByAgent",
              "transactionAmount":1111.7,
              "checkSubmitDate":"2021-03-16",
              "lastChangedDateTime":"2021-03-16T23:00:04Z",
              "checkDeclinedDate":"2021-03-16",
              "discardReason":"Third party check"
            }
          }
        }
      ]
    }
  ]
}

Sample Webhook – Returned Checks:-

{
  "accounts":[
    {
      "accountIdentifier":"4f205a81-0d9c-47fa-b47d-71e3f0d2b108",
      "events":[
        {
          "eventIdentifier":"fbb869a4-3799-4389-b3e2-56e8278441d8",
          "eventType":"checkDeposit",
          "eventDateTime":"2020-08-10T18:53:34.886Z",
          "transfer":{
            "transferIdentifier":"20c0cb2a-af75-497f-97e7-afbfc534888d",
            "checkDeposit":{
              "checkDepositStatus":"returned",
              "checkDepositSubStatus":"fundsReversed",
              "transactionAmount":10.0,
              "checkSubmitDate":"2020-08-10T18:22:01.285Z",
              "lastChangedDateTime":"2020-08-10T18:53:34Z",
              "checkReturnedDate":"2020-08-10T18:22:01.285Z",
              "rejectReason":"R01"
            }
          }
        }
      ]
    }
  ]
}

OCT Webhook

Event Types with Sample Payload

OCT Initialization

"eventType":"oCTA2AOutTransfer"

"transferType": "a2aout"

"transferStatus": "pending"

{
	"accounts": [
		{
			"accountIdentifier": "fb200737-142e-4c56-b63a-055eed214043",
			"events": [
				{
					"eventIdentifier": "37a4b3d8-7351-442a-a944-870f19712b9b",
					"eventType": "oCTA2AOutTransfer",
					"eventDateTime": "2025-06-16T10:12:05.095Z",
					"gftTransfer": {
						"transferType": "a2aout",
						"transferIdentifier": "a550da20-df83-4bf7-8d97-0c86b26a7b99",
						"accountIdentifier": "fb200737-142e-4c56-b63a-055eed214043",
						"submissionDateTime": "2025-06-16T10:12:04Z",
						"transactionAmount": 6.99,
						"transactionType": "InstantFundsTransfer",
						"transferStatus": "pending",
						"description": "Instant Transfer to card ending 2774"
					}
				}
			]
		}
	]
}

📘

Some partners may not use this event type.

OCT Post Transaction

"eventType": "transaction"

"transactionType":"InstantFundsTransfer"

"transactionStatus": "completed"

{
	"accounts": [
		{
			"accountIdentifier": "fb200737-142e-4c56-b63a-055eed214043",
			"events": [
				{
					"eventIdentifier": "78a52f79-5437-4a87-8246-2232ca077c02",
					"eventType": "transaction",
					"eventDateTime": "2025-06-16T10:12:11.665Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "a550da20-df83-4bf7-8d97-0c86b26a7b99",
							"transactionIdentifier": "cfa44406-be85-ca98-0644-a4cf85be98ca",
							"transactionType": "InstantFundsTransfer",
							"transactionStatus": "completed",
							"transactionTypeDescription": "Instant Funds Transfer",
							"accountIdentifier": "fb200737-142e-4c56-b63a-055eed214043",
							"currency": "USD",
							"postedDateTime": "2025-06-16T10:12:06.401Z",
							"transactionAmount": 6.99,
							"isCredit": false,
							"purses": [
								{
									"purseIdentifier": "5510bf66-1bbb-458d-9964-8aaef80181db",
									"purseType": "primary",
									"availableBalance": 12.91,
									"ledgerBalance": 12.91,
									"availableBalanceAsOfDateTime": "2025-06-16T10:12:06.400Z",
									"ledgerBalanceAsOfDateTime": "2025-06-16T10:12:06.400Z"
								}
							],
							"postedInternalTransactionData": {
								"adjustmentIdentifier": "a550da20-df83-4bf7-8d97-0c86b26a7b99",
								"partnerAdjustmentType": "anyDebitOut",
								"description": "Instant Transfer to card ending 2774",
								"transferType": "None"
							}
						}
					]
				}
			]
		}
	]
}

OCT Post Transaction Fee

"eventType": "transaction"

"transactionType": "InstantTransferFee",

"transactionStatus": "completed"

{
	"accounts": [
		{
			"accountIdentifier": "fb200737-142e-4c56-b63a-055eed214043",
			"events": [
				{
					"eventIdentifier": "933f894d-6d3b-4e92-81cb-fbe6049c5b58",
					"eventType": "transaction",
					"eventDateTime": "2025-06-16T10:12:11.675Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "a550da20-df83-4bf7-8d97-0c86b26a7b99",
							"transactionIdentifier": "4d50a82b-12db-d17d-2ba8-504ddb127dd1",
							"transactionType": "InstantTransferFee",
							"transactionStatus": "completed",
							"transactionTypeDescription": "Instant Transfer Fee",
							"accountIdentifier": "fb200737-142e-4c56-b63a-055eed214043",
							"currency": "USD",
							"postedDateTime": "2025-06-16T10:12:05.161Z",
							"transactionAmount": 0.1,
							"isCredit": false,
							"purses": [
								{
									"purseIdentifier": "5510bf66-1bbb-458d-9964-8aaef80181db",
									"purseType": "primary",
									"availableBalance": 12.91,
									"ledgerBalance": 12.91,
									"availableBalanceAsOfDateTime": "2025-06-16T10:12:06.400Z",
									"ledgerBalanceAsOfDateTime": "2025-06-16T10:12:06.400Z"
								}
							],
							"fees": [
								{
									"feeType": "partnerFee",
									"amount": 0.1,
									"currency": "USD",
									"description": "Instant Transfer Fee"
								}
							]
						}
					]
				}
			]
		}
	]
}

Overdraft Notification Webhook

Event Types with Sample Payload

"eventType": "overdraftNotification"

{
	"accounts": [
		{
			"accountIdentifier": "a9fa161b-d9c1-4f1e-8140-8dceca24b334",
			"events": [
				{
					"eventIdentifier": "e5d23742-204f-46ca-b8fe-41424c4e350f",
					"eventType": "overdraftNotification",
					"eventDateTime": "2025-06-24T09:38:31.073Z",
					"overdraftNotification": {
						"userIdentifier": "40971ce5-d0ac-4d87-a858-c284b8d2c494",
						"enrolled": true,
						"overdraftCushionLimit": 200.0,
						"odTier": "OD3",
						"notificationTypeDescription": "Overdraft - GD Suspend of Overdraft",
						"notificationTypeKey": "99",
						"notificationMandatory": true,
						"extensionAttributes": {
							"cardEnding": "1975"
						}
					}
				}
			]
		}
	]
}

P2P Events

Event Types with Sample Payload

"eventType": "p2p"

{
	"accounts": [
		{
			"accountIdentifier": "4f7b9538-d9eb-45ad-b0ca-d94ba07916f8",
			"events": [
				{
					"eventIdentifier": "62aec46b-cefa-4579-a804-2625eaa770c5",
					"eventType": "p2p",
					"eventDateTime": "2025-06-24T14:10:46.122Z",
					"transfer": {
						"transferIdentifier": "c869253d-89bc-4bac-94dd-a519d097b46e",
						"transferStatus": "Declined"
					},
					"source": {
						"identifier": "b467023d-f775-4c0e-b721-57b1c5a8bb84",
						"linkId": "4f7b9538-d9eb-45ad-b0ca-d94ba07916f8"
					},
					"target": {
						"identifier": "e431d290-d9b7-431d-9213-6a40596e95f7",
						"linkId": "1c975a1c-9d4a-41e7-a5d4-55d3c00488aa"
					}
				}
			]
		}
	]
}

"eventType": "p2pTransfer"

{
	"accounts": [
		{
			"accountIdentifier": "a48476a0-9ae0-4c17-bd41-9406bcf7cd21",
			"events": [
				{
					"eventIdentifier": "e358ae5e-5726-48c4-bb1e-5fec065e7a52",
					"eventType": "p2pTransfer",
					"eventDateTime": "2025-06-21T08:37:07.021Z",
					"transfer": {
						"p2pEventType": "recipientAuto",
						"transferIdentifier": "d83087c3-ba88-4b0d-b9be-7ba511c01628",
						"transferStatus": "Completed",
						"transferStatusReason": "None",
						"initiator": "a48476a0-9ae0-4c17-bd41-9406bcf7cd21",
						"amount": 19.55,
						"currency": "USD",
						"memo": "Happy Birthday!!",
						"initiatedDateTime": "2025-06-21T08:37:06Z",
						"expirationDateTime": "2025-06-28T08:37:06Z"
					},
					"source": {
						"accountIdentifier": "a48476a0-9ae0-4c17-bd41-9406bcf7cd21",
						"firstName": "bWgUiQdt",
						"lastName": "rhuRuhup"
					},
					"target": {
						"accountIdentifier": "b20762e9-cd26-4fbd-b1cd-1209719fe399",
						"firstName": "Bob",
						"lastName": "Robert"
					}
				}
			]
		}
	]
}

Paper Check Webhook

Paper check Webhooks are sent to notify Partners of paper check clearing statuses.

📘

This Webhook is available only to programs that are configured for Bill Pay. Please contact your Green Dot Liaison to request Bill Pay configuration.

API Call Reference

POST https://yourendpoint.yourcompany.com/events/paperCheck

Event Types with Sample Payload

"eventType": "paperCheck"

{
	"accounts": [
		{
			"accountIdentifier": "94db040e-dabb-44dc-8a50-e45ec4135d4f",
			"events": [
				{
					"eventIdentifier": "a6b0349e-0107-49c3-be5a-c5910cf2e62a",
					"eventType": "paperCheck",
					"eventDateTime": "2025-06-24T06:53:01.111Z",
					"transfer": {
						"accountIdentifier": "94db040e-dabb-44dc-8a50-e45ec4135d4f",
						"transactionDescription": "string",
						"eventDateTime": "2025-06-24T06:53:01Z",
						"status": "Completed",
						"statusReason": "Success",
						"associatedTransactionID": "1811bd81-e758-4733-8669-8025199c02c0",
						"transactionAmount": 1.0,
						"transactionType": "paperCheck"
					}
				}
			]
		}
	]
}

Promotional Webhook

API Call Reference

POST https://yourendpoint.yourcompany.com/events/promotionalTransactions

Event Types with Sample Payload

Promotional:-

{
  "accounts":[
    {
      "events":[
        {
          "eventType":"transaction",
          "eventDateTime":"2019-08-27T18:52:21.303Z",
          "transactions":[
            {
              "postedDateTime":"2019-08-27T16:52:20.000Z",
              "isCredit":true,
              "currency":"USD",
              "transactionTypeDescription":"Promotional Credit",
              "parentTransactionIdentifier":"8fd50a5c-cf94-c8d6-5c0a-d58f94cfd6c8",
              "accountIdentifier":"36c90bd4-5cd9-44d2-a591-073c4bc15c29",
              "transactionIdentifier":"8fd50a5c-cf94-c8d6-5c0a-d58f94cfd6c8",
              "transactionType":"promo",
              "purses":[
                {
                  "purseType":"primary",
                  "purseIdentifier":"1809d35f-ad81-4c59-9716-f4a1db8ab66b",
                  "availableBalanceAsOfDateTime":"2019-08-27T16:52:20.000Z",
                  "ledgerBalanceAsOfDateTime":"2019-08-27T16:52:20.000Z",
                  "availableBalance":87.59,
                  "ledgerBalance":971.35
                }
              ],
              "postedInternalTransactionData":{
                "description":"Promotional Credit"
              },
              "transactionAmount":15.35,
              "transactionStatus":"completed"
            }
          ],
          "eventIdentifier":"5b093a1b-45ab-4211-b61a-fdc4ddde69b4"
        }
      ],
      "accountIdentifier":"36c90bd4-5cd9-44d2-a591-073c4bc15c29"
    }
  ]

Unknown Adjustment:-

 {
    "accounts":[
      {
        "events":[
          {
            "transactions":[
              {
                "transactionIdentifier":"ca455764-cb89-1680-6457-45ca89cb8016",
                "transactionStatus":"completed",
                "postedDateTime":"2019-08-26T19:59:31.000Z",
                "accountIdentifier":"067425cd-f4d5-48cd-a55b-f7725d423ba3",
                "purses":[
                  {
                    "purseIdentifier":"a453f5c2-aeb9-40b3-a607-c293747dc08b",
                    "availableBalanceAsOfDateTime":"2019-08-26T19:59:31.000Z",
                    "purseType":"primary",
                    "ledgerBalance":264.38,
                    "availableBalance":25.48,
                    "ledgerBalanceAsOfDateTime":"2019-08-26T19:59:31.000Z"
                  }
                ],
                "currency":"USD",
                "parentTransactionIdentifier":"ca455764-cb89-1680-6457-45ca89cb8016",
                "isCredit":true,
                "transactionTypeDescription":"Adjustment",
                "postedInternalTransactionData":{
                  "transferType":"adjustment",
                  "adjustmentType":"unknown",
                  "description":"Merchant Chargeback"
                },
                "transactionType":"adjustment",
                "transactionAmount":36.15
              }
            ],
            "eventIdentifier":"c91fff86-3d5c-4342-838d-651a5d5035f2",
            "eventType":"transaction",
            "eventDateTime":"2019-08-26T21:59:31.907Z"
          }
        ],
        "accountIdentifier":"067425cd-f4d5-48cd-a55b-f7725d423ba3"
      }
    ]
  }

Provisioning Webhook

Event Types with Sample Payload

"eventType": "provisioning"

{
	"accounts": [
		{
			"accountIdentifier": "34b790de-a4d8-426a-bf29-e69853dd3fc7",
			"events": [
				{
					"eventIdentifier": "87a2daae-e478-4ad5-ba47-30bfdbffe4f5",
					"eventType": "provisioning",
					"eventDateTime": "2025-06-24T02:08:20.784Z",
					"transactions": [
						{
							"transactionIdentifier": "3948b7cc-254d-4c38-b384-0dd99962f9e6",
							"transactionType": "tokenActivation",
							"transactionStatus": "completed",
							"accountIdentifier": "34b790de-a4d8-426a-bf29-e69853dd3fc7",
							"bin": "526412",
							"last4Pan": "9276",
							"paymentIdentifier": "eecee9fc-9127-4d02-9424-3c24dc39b229",
							"paymentInstrumentIdentifier": "647cc88f-0543-41c7-9783-81eaa58a61e1",
							"activationData": {
								"activationCodeExpiry": "2023-11-22T21:29:02.332Z",
								"activationCode": "12345"
							}
						}
					]
				}
			]
		}
	]
}

Single Phase Transfer Webhook

Event Types with Sample Payload

Statement Ready

"eventType": "singlePhaseTransfer"

{
	"accounts": [
		{
			"accountIdentifier": "05ff446b-514c-4081-a467-5faef6a0c03b",
			"events": [
				{
					"eventIdentifier": "087366c0-ddd3-44a8-8042-4de4919937fc",
					"eventType": "singlePhaseTransfer",
					"eventDateTime": "2025-06-24T10:43:54.906Z",
					"singlePhaseTransfer": [
						{
							"transferIdentifier": "aa84e81f-0837-47ef-86bc-5b2f11be534a",
							"transactionAmount": 0.51,
							"transferStatus": "Declined",
							"transferDateTime": "2025-06-24T10:43:54Z",
							"response": {
								"code": "4229",
								"subCode": "1529",
								"description": "Card declined",
								"processorCode": "130001",
								"networkStatusCode": "05",
								"networkStatusDescription": "Do not honor"
							}
						}
					]
				}
			]
		}
	]
}

Statement Ready Events

Event Types with Sample Payload

Statement Ready

"eventType": "statementReady"

{
	"accounts": [
		{
			"accountIdentifier": "a58ea726-80ae-4f3a-8019-b801b2651aab",
			"events": [
				{
					"eventIdentifier": "7256254f-800b-4946-b2e7-a96d369cab31",
					"eventType": "statementReady",
					"eventDateTime": "2025-06-24T07:31:14.716Z",
					"statement": {
						"accountIdentifier": "a58ea726-80ae-4f3a-8019-b801b2651aab",
						"statementPeriod": "202506",
						"statementPeriodStartDate": "2025-05-21",
						"statementPeriodEndDate": "2025-06-20"
					}
				}
			]
		}
	]
}

Transaction Webhook

Event Types with Sample Payload

Purchase

"eventType": "transaction",

"transactionType": "purchase",

"transactionStatus": "pending

{
	"accounts": [
		{
			"accountIdentifier": "ebca2752-a700-41f5-9320-3dbd62af0510",
			"events": [
				{
					"eventIdentifier": "c2348b82-0fd8-42dd-bcdb-706f43f4edda",
					"eventType": "transaction",
					"eventDateTime": "2019-09-17T05:41:10.756Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "2d7d6c09-b572-4316-b1de-d2819b8f26f8",
							"transactionIdentifier": "e156d7a9-6963-47b1-a5fb-03c070e77157",
							"transactionType": "purchase",
							"transactionStatus": "pending",
							"transactionTypeDescription": "Purchase",
							"accountIdentifier": "ebca2752-a700-41f5-9320-3dbd62af0510",
							"bin": "123456",
							"last4Pan": "6789",
							"currency": "USD",
							"postedDateTime": "2019-09-17T05:41:07.830Z",
							"transactionAmount": 14.06,
							"isCredit": false,
							"purses": [
								{
									"purseIdentifier": "89ac8909-af40-409e-93fa-62bd51218ccd",
									"purseType": "primary",
									"availableBalance": 145.41,
									"ledgerBalance": 159.47,
									"availableBalanceAsOfDateTime": "2019-09-17T05:41:07.830Z",
									"ledgerBalanceAsOfDateTime": "2019-09-17T02:35:49.160Z"
								}
							],
							"networkTransactionData": {
								"authorizationDateTime": "2019-09-17T05:41:07.000Z",
								"cashBackAmount": 0,
								"cardAcceptor": {
									"merchantName": "Amazon Prime",
									"merchantIndustryCode": "5968",
									"merchantIndustryCategory": "Mail Order/Telephone Order Providers",
									"city": "Amzn.com/bill",
									"stateProvReg": "WA",
									"merchantIndustryDescription": "Direct marketing — continuity/subscription merchants"
								},
								"authorizedTransactionData": {
									"holdExpirationDate": "2019-09-27",
									"requestAuthorizationAmount": 14.06,
									"approvalCode": "170296",
									"eci": "recurring",
									"isPartialAuth": false
								}
							}
						}
					]
				}
			]
		}
	]
}

"eventType": "transaction",

"transactionType": "purchase",

"transactionStatus": "declined

{
	"accounts": [
		{
			"accountIdentifier": "66370507-d2d6-4ec5-9aa7-36bf36501801",
			"events": [
				{
					"eventIdentifier": "d37065fa-3caa-4efd-94be-1aa11c8fd6a9",
					"eventType": "transaction",
					"eventDateTime": "2025-06-24T07:02:59.037Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "46ec5dea-d48d-caa9-ea5d-ec468dd4a9ca",
							"retrievalReferenceNumber": "918482595746",
							"transactionIdentifier": "46ec5dea-d48d-caa9-ea5d-ec468dd4a9ca",
							"transactionType": "purchase",
							"transactionStatus": "declined",
							"transactionTypeDescription": "Purchase",
							"accountIdentifier": "66370507-d2d6-4ec5-9aa7-36bf36501801",
							"bin": "800101",
							"last4Pan": "3392",
							"currency": "USD",
							"postedDateTime": "2025-06-24T07:01:03.000Z",
							"transactionAmount": 2000.0,
							"isCredit": false,
							"userIdentifier": "8d427057-6ec3-4026-a421-5f865dcbc225",
							"paymentIdentifier": "0563cf0b-d7e2-4b4c-9e8f-b249aae7bd0e",
							"purses": [
								{
									"purseIdentifier": "6d70e9f6-6656-4abb-8c50-d381e3c415d1",
									"purseType": "primary",
									"availableBalance": 1000.0,
									"ledgerBalance": 1000.0,
									"availableBalanceAsOfDateTime": "2025-06-24T07:01:02.910Z",
									"ledgerBalanceAsOfDateTime": "2025-06-24T07:01:02.910Z"
								}
							],
							"networkTransactionData": {
								"authorizationDateTime": "2025-06-24T07:01:04.000Z",
								"cardAcceptor": {
									"merchantName": "name                  ",
									"merchantIndustryCode": "5999",
									"merchantIndustryCategory": "Miscellaneous Stores",
									"city": "PA",
									"merchantIndustryDescription": "Miscellaneous and speciality retail outlets"
								},
								"authorizedTransactionData": {
									"requestAuthorizationAmount": 2000.0,
									"declineReason": "velocityLimitExceeded",
									"authStatusIndicator": "I",
									"eci": "none",
									"isPartialAuth": false
								}
							}
						}
					]
				}
			]
		}
	]
}

"eventType": "transaction",

"transactionType": "purchase",

"transactionStatus": "expired

{
	"accounts": [
		{
			"accountIdentifier": "a2c6bdd2-900c-4e4e-be17-752122d8e5d0",
			"events": [
				{
					"eventIdentifier": "5aa23c89-702d-4834-bd72-95168b592af3",
					"eventType": "transaction",
					"eventDateTime": "2019-09-17T04:55:37.605Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "32137df1-4c83-4c3f-bbe6-e9c10e71b24e",
							"transactionIdentifier": "da9b0cfa-baa1-4217-a652-f86f083653b3",
							"transactionType": "purchase",
							"transactionStatus": "expired",
							"transactionTypeDescription": "Purchase",
							"accountIdentifier": "a2c6bdd2-900c-4e4e-be17-752122d8e5d0",
							"bin": "123456",
							"last4Pan": "6789",
							"currency": "USD",
							"postedDateTime": "2019-09-12T12:40:16.597Z",
							"transactionAmount": 0.79,
							"isCredit": false,
							"purses": [
								{
									"purseIdentifier": "c9213d47-8226-46b6-abbc-1c7018becc8e",
									"purseType": "primary",
									"availableBalance": 12.88,
									"ledgerBalance": 12.88,
									"availableBalanceAsOfDateTime": "2019-09-15T00:35:39.283Z",
									"ledgerBalanceAsOfDateTime": "2019-09-15T00:35:39.283Z"
								}
							],
							"networkTransactionData": {
								"authorizationDateTime": "2019-09-12T12:40:16.000Z",
								"cashBackAmount": 0,
								"cardAcceptor": {
									"merchantName": "ORDER WISH COM",
									"merchantIndustryCode": "5311",
									"merchantIndustryCategory": "Retail Stores",
									"city": "SAN FRANCISCO",
									"stateProvReg": "CA",
									"merchantIndustryDescription": "Department stores"
								},
								"authorizedTransactionData": {
									"holdExpirationDate": "2019-09-16",
									"requestAuthorizationAmount": 0.79,
									"authStatusIndicator": "I",
									"approvalCode": "123123",
									"eci": "eCommerce",
									"isPartialAuth": false
								}
							}
						}
					]
				}
			]
		}
	]
}

"eventType": "transaction",

"transactionType": "purchase",

"transactionStatus": "completed

{
	"accounts": [
		{
			"accountIdentifier": "e233251d-6223-40bb-a21c-999805e6f5f3",
			"events": [
				{
					"eventIdentifier": "3885f54b-f98c-4020-a697-5efe328225fb",
					"eventType": "transaction",
					"eventDateTime": "2019-09-17T02:50:31.956Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "ff238239-4b16-43ae-9a5e-6c264d10148c",
							"transactionIdentifier": "a14d25c8-8daf-4086-88f0-5654b98768df",
							"transactionType": "purchase",
							"transactionStatus": "completed",
							"transactionTypeDescription": "Purchase",
							"accountIdentifier": "e233251d-6223-40bb-a21c-999805e6f5f3",
							"bin": "123456",
							"last4Pan": "6789",
							"currency": "USD",
							"postedDateTime": "2019-09-17T02:35:42.280Z",
							"transactionAmount": 14.12,
							"isCredit": false,
							"purses": [
								{
									"purseIdentifier": "3f71663f-862f-405c-940b-9193f9fe58df",
									"purseType": "primary",
									"availableBalance": 10.64,
									"ledgerBalance": 44.06,
									"availableBalanceAsOfDateTime": "2019-09-17T02:35:42.280Z",
									"ledgerBalanceAsOfDateTime": "2019-09-17T02:35:42.280Z"
								}
							],
							"networkTransactionData": {
								"authorizationDateTime": "2019-09-17T01:09:24.000Z",
								"cashBackAmount": 0,
								"cardAcceptor": {
									"merchantName": "SAFEWAY STORE 9999",
									"merchantIndustryCode": "5411",
									"merchantIndustryCategory": "Retail Stores",
									"city": "Boise",
									"stateProvReg": "ID",
									"merchantIndustryDescription": "Groceries and supermarkets"
								},
								"postTransactionData": {
									"localDateTime": "2019-09-16T18:09:23.000",
									"postingDateTime": "2019-09-17T02:35:42.280Z"
								}
							}
						}
					]
				}
			]
		}
	]
}

"eventType": "transaction",

"transactionType": "purchase",

"transactionStatus": "cleared

{
	"accounts": [
		{
			"accountIdentifier": "ee717eca-6beb-45b2-8066-40536bde66e3",
			"events": [
				{
					"eventIdentifier": "908f880a-7b39-4b1e-9aa5-16ebed8647d0",
					"eventType": "transaction",
					"eventDateTime": "2019-09-16T02:37:57.304Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "6e483515-44d5-4c2f-a2b5-a78288a2805c",
							"transactionIdentifier": "111af62e-d3a7-4f6d-9cbe-ab28ba4c3ee3",
							"transactionType": "purchase",
							"transactionStatus": "cleared",
							"transactionTypeDescription": "Purchase",
							"accountIdentifier": "ee717eca-6beb-45b2-8066-40536bde66e3",
							"bin": "123456",
							"last4Pan": "6789",
							"currency": "USD",
							"postedDateTime": "2019-09-16T02:37:55.970Z",
							"transactionAmount": 16,
							"isCredit": false,
							"purses": [
								{
									"purseIdentifier": "424f35e3-b4c1-41ba-8fa0-a42d8adc2b74",
									"purseType": "primary",
									"availableBalance": 740,
									"ledgerBalance": 740,
									"availableBalanceAsOfDateTime": "2019-09-16T02:37:55.970Z",
									"ledgerBalanceAsOfDateTime": "2019-09-16T02:37:55.970Z"
								}
							],
							"networkTransactionData": {
								"authorizationDateTime": "2019-09-13T19:35:28.000Z",
								"cashBackAmount": 0,
								"cardAcceptor": {
									"merchantName": "GOOGLE*GOOGLE MUSIC",
									"merchantIndustryCode": "5817",
									"merchantIndustryCategory": "Miscellaneous Stores",
									"city": "G.CO HELPPAY#",
									"stateProvReg": "CA",
									"merchantIndustryDescription": "Digital Goods - Software Applications (Excluding Games)"
								},
								"authorizedTransactionData": {
									"holdExpirationDate": "2019-09-17",
									"requestAuthorizationAmount": 16,
									"approvalCode": "123123",
									"eci": "recurring",
									"isPartialAuth": false
								}
							}
						}
					]
				}
			]
		}
	]
}

Network Card Load

"eventType": "transaction",

"transactionType": "networkCardLoad",

"transactionStatus": "pending

{
	"accounts": [
		{
			"accountIdentifier": "b8263708-60fe-4b3c-b4ee-a9ef9158acab",
			"events": [
				{
					"eventIdentifier": "4e5183aa-8fa6-46af-a633-380ce8aea9ca",
					"eventType": "transaction",
					"eventDateTime": "2019-09-17T06:00:41.619Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "e2538e8c-88f0-4e04-8309-c6b04ef387c4",
							"transactionIdentifier": "cb714d99-4093-4af7-b385-a959d30de7fc",
							"transactionType": "networkCardLoad",
							"transactionStatus": "pending",
							"transactionTypeDescription": "Deposit",
							"accountIdentifier": "b8263708-60fe-4b3c-b4ee-a9ef9158acab",
							"bin": "123456",
							"last4Pan": "6789",
							"currency": "USD",
							"postedDateTime": "2019-09-17T06:00:40.683Z",
							"transactionAmount": 106.94,
							"isCredit": true,
							"purses": [
								{
									"purseIdentifier": "baf7c66a-b7be-4e42-977c-5eebe48a6cfd",
									"purseType": "primary",
									"availableBalance": 106.94,
									"ledgerBalance": 8.73,
									"availableBalanceAsOfDateTime": "2019-09-17T06:00:40.683Z",
									"ledgerBalanceAsOfDateTime": "2019-09-16T20:48:00.490Z"
								}
							],
							"networkTransactionData": {
								"authorizationDateTime": "2019-09-17T06:00:40.000Z",
								"cardAcceptor": {
									"merchantName": "Lyft, Inc.",
									"merchantIndustryCode": "8899",
									"merchantIndustryCategory": "Transportation",
									"city": "Visa Direct",
									"stateProvReg": "CA",
									"merchantIndustryDescription": "Taxi-cabs and limousines"
								},
								"authorizedTransactionData": {
									"holdExpirationDate": "2019-09-21",
									"requestAuthorizationAmount": 106.94,
									"approvalCode": "123123",
									"eci": "eCommerce",
									"isPartialAuth": false
								}
							}
						}
					]
				}
			]
		}
	]
}

"eventType": "transaction",

"transactionType": "networkCardLoad",

"transactionStatus": "declined

{
	"accounts": [
		{
			"accountIdentifier": "4fd89f2b-beb9-4072-a025-ce6b60fca19c",
			"events": [
				{
					"eventIdentifier": "c33a5f8e-c213-455c-a0cd-a5c9ba6c3e1c",
					"eventType": "transaction",
					"eventDateTime": "2019-09-17T01:32:10.894Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "c6465a75-d137-4da7-a1ab-cfbdbf3684ad",
							"transactionIdentifier": "056f3b5f-ff07-4cd2-ad0d-d843b7a6385d",
							"transactionType": "networkCardLoad",
							"transactionStatus": "declined",
							"transactionTypeDescription": "Deposit",
							"accountIdentifier": "4fd89f2b-beb9-4072-a025-ce6b60fca19c",
							"bin": "123456",
							"last4Pan": "6789",
							"currency": "USD",
							"postedDateTime": "2019-09-17T01:32:10.190Z",
							"transactionAmount": 10,
							"isCredit": true,
							"purses": [
								{
									"purseIdentifier": "6f10398f-a84f-478e-843e-cb14c10d556a",
									"purseType": "primary",
									"availableBalance": 2.14,
									"ledgerBalance": 5.41,
									"availableBalanceAsOfDateTime": "2019-09-17T01:32:10.190Z",
									"ledgerBalanceAsOfDateTime": "2019-08-27T17:49:31.970Z"
								}
							],
							"networkTransactionData": {
								"authorizationDateTime": "2019-09-17T01:32:10.000Z",
								"cardAcceptor": {
									"merchantName": "Merchant Name",
									"merchantIndustryCode": "6012",
									"merchantIndustryCategory": "Service Providers",
									"city": "Visa Direct",
									"stateProvReg": "AZ",
									"merchantIndustryDescription": "Financial institutions — merchandise and services"
								},
								"authorizedTransactionData": {
									"requestAuthorizationAmount": 10,
									"declineReason": "closedCard",
									"eci": "eCommerce",
									"isPartialAuth": false
								}
							}
						}
					]
				}
			]
		}
	]
}

"eventType": "transaction",

"transactionType": "networkCardLoad",

"transactionStatus": "completed

{
	"accounts": [
		{
			"accountIdentifier": "4e6ca262-fc44-427a-9382-baac1f0eac6af",
			"events": [
				{
					"eventIdentifier": "5e69e6cb-c0ce-4a64-9462-106a3ee93ca6",
					"eventType": "transaction",
					"eventDateTime": "2019-09-17T00:52:37.204Z",
					"transactions": [
						{
							"parentTransactionIdentifier": "a28030d4-37d7-4602-8c0f-0a536d78a604",
							"transactionIdentifier": "a28030d4-37d7-4602-8c0f-0a536d78a604",
							"transactionType": "networkCardLoad",
							"transactionStatus": "completed",
							"transactionTypeDescription": "Deposit",
							"accountIdentifier": "4e6ca262-fc44-427a-9382-baac1f0eac6a",
							"bin": "123456",
							"last4Pan": "6789",
							"currency": "USD",
							"postedDateTime": "2019-09-17T00:43:45.801Z",
							"transactionAmount": 3.75,
							"isCredit": true,
							"purses": [
								{
									"purseIdentifier": "c5aaa5de-c186-423f-a4e3-1132004c6ca7",
									"purseType": "primary",
									"availableBalance": 227.97,
									"ledgerBalance": 227.97,
									"availableBalanceAsOfDateTime": "2019-09-17T00:43:45.817Z",
									"ledgerBalanceAsOfDateTime": "2019-09-17T00:43:45.817Z"
								}
							],
							"networkTransactionData": {
								"authorizationDateTime": "2019-09-16T22:58:36.000Z",
								"cardAcceptor": {
									"merchantName": "Lyft, Inc.",
									"merchantIndustryCode": "4121",
									"merchantIndustryCategory": "Transportation",
									"city": "VISA DIRECT",
									"stateProvReg": "CA",
									"merchantIndustryDescription": "Taxi-cabs and limousines"
								},
								"postTransactionData": {
									"localDateTime": "2019-09-16T22:58:36.000",
									"postingDateTime": "2019-09-17T00:43:45.801Z"
								}
							}
						}
					]
				}
			]
		}
	]
}

User Updated Events

Event Types with Sample Payload

Update User Status Change

"eventType":"UserUpdate"

{
    "accounts": [
        {
            "accountIdentifier": "40dd7a3e-cf5a-4faf-9491-eef139e50112",
            "events": [
                {
                    "eventIdentifier": "ead3332d-64f7-4d76-ae33-809b10cbc793",
                    "eventType": "userUpdate",
                    "eventDateTime": "2025-06-18T06:54:28.519Z",
                    "user": {
                        "userIdentifier": "6671ae1c-f47e-4938-9974-2d555db6ffaf",
                        "profileData": {
                            "addresses": [
                                {
                                    "addressLine1": "21825 Cornell Rd",
                                    "addressLine2": "SUITE 524",
                                    "city": "Arcadia",
                                    "state": "CA",
                                    "zipCode": "91106",
                                    "countryCode": "USA",
                                    "type": "home",
                                    "isDefault": true,
                                    "isReturned": false,
                                    "lastUpdatedDateTime": "2025-06-18T06:54:28.509Z"
                                }
                            ]
                        },
                        "email": {
                            "emailAddress": "[email protected]",
                            "isVerified": false,
                            "isDefault": false,
                            "lastUpdatedDateTime": "2025-06-18T06:54:28.509Z"
                        },
                        "phoneNumbers": [
                            {
                                "number": "1005933140",
                                "type": "mobile",
                                "isDefault": false,
                                "isVerified": false,
                                "lastUpdatedDateTime": "2025-06-18T06:54:28.509Z"
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

"eventType":"AccountUpdated”

{
    "accounts": [
        {
            "accountIdentifier": "40dd7a3e-cf5a-4faf-9491-eef139e50112",
            "events": [
                {
                    "eventIdentifier": "bd9bff81-8b0d-4a05-a51f-2543c106ec7e",
                    "eventType": "accountUpdated",
                    "eventDateTime": "2025-06-18T06:53:58.899Z",
                    "account": {
                        "accountIdentifier": "40dd7a3e-cf5a-4faf-9491-eef139e50112",
                        "status": "normal",
                        "accountStatusChangedDateTime": "2025-06-18T06:53:58.827Z",
                        "statusReasons": [
                            "healthy"
                        ],
                        "accountCycleDay": 17,
                        "accountHolders": [
                            {
                                "user": {
                                    "firstName": "qbIZXDjY",
                                    "lastName": "MgUmXieq",
                                    "dobStatus": "matched",
                                    "last4Identity": "8796",
                                    "identityType": "ssn",
                                    "userIdentifier": "6671ae1c-f47e-4938-9974-2d555db6ffaf",
                                    "isPrimaryAccountHolder": true,
                                    "status": "active",
                                    "kycStateData": {
                                        "ofacStatus": "passed",
                                        "kycStatus": "passed",
                                        "kycPendingGate": "healthy"
                                    }
                                },
                                "paymentInstruments": [
                                    {
                                        "paymentInstrumentIdentifier": "98e9bcd2-c7a9-48d8-a742-ee4ccb1f674b",
                                        "paymentIdentifier": "f1262848-1e40-4349-89e4-ff71313926bf",
                                        "paymentInstrumentType": "virtual",
                                        "status": "activated",
                                        "isPinSet": false,
                                        "last4Pan": "8781",
                                        "activatedDateTime": "2025-06-18T06:53:58.257Z",
                                        "issuedDateTime": "2025-06-18T06:53:58.257Z"
                                    }
                                ]
                            }
                        ]
                    }
                }
            ]
        }
    ]
}