Webhook Samples for Purchase ACH Events
Webhook Samples
While every webhook notification will pass a set of common fields, the data object will have specific details based on the type of event that has occurred. Below you will find these definitions and samples.
Purchase ACH Event Samples
The data fields you will find for Purchase ACH events along with sample messages are as follows:
Field | Type | Description |
---|---|---|
paymentID | integer | A unique identifier of the ACH payment. |
paymentGuid | string | Globally unique identifier (GUID) of the ACH payment. |
isCredit | Boolean | Returns a "true" or "false" string based on whether the ACH Purchase is a credit or debit. |
description | string | Client created identifier that may be displayed on the bank account holder's statement. |
lastFour | string | Last four numbers of the bank account number to be credited. |
scheduleDate | string | Date/time that the ACH payment is scheduled to process. |
receiptDate | string (date/time) | Date/time that the ACH payment was received by the processor. |
processingDate | string (date/time) | Date/time that the ACH payment was processed. |
orderNumber | string | Client identifier that may be input during the Create Sale or IssueLite process which can comprise of multiple sales and purchases. |
customerId | string | Secondary client identifier that may be input during the Create Sale or IssueLite process which can comprise of multiple sales and purchases. |
incomingTransactionCode | string | Unique token that links a sale to an associated purchase. |
amount | decimal | Amount of the ACH payment. |
merchantIdentifier | string | Unique GUID assigned to your ConnexPay merchant record. |
merchantName | integer | Unique Client/Merchant name assigned to your ConnexPay merchant record. |
nocCode | string | For a Notice of Change, the Code of the change. |
nocDescription | string | For a Notice of Change notification, the Description of the change. |
nocCorrectData | string | For a Notice of Change notification, the Corrective Data that should be supplied in future requests. |
nocEffectiveDate | string (date/time | For a Notice of Change notification, Date and Time of when the change took effect. |
purchase.ach.pending
[{
"id": "0d35289b-4fb4-49a1-806f-adb98462ce6a",
"subject": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
"data": {
"paymentId": 42412,
"paymentGuid": "8e9de236-b255-4e47-8c47-cedf5a99dbb1",
"isCredit": true,
"description": "DESC12",
"lastFour": "1234",
"scheduleDate": "2022-03-03T00:00:00Z",
"receiptDate": "2022-03-03T00:00:00Z",
"processingDate": "2022-03-03T00:00:00Z",
"orderNumber": "Dan-20230225M94217",
"customerId": "Joe Doe",
"incomingTransactionCode": "907F7A1637814005390830075",
"amount": 10.01,
"merchantIdentifier": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
"merchantName": "ClientName"
},
"eventType": "purchase.ach.pending",
"eventTime": "2022-03-03T23:05:18.0494148Z",
"dataVersion": "1"
}]
purchase.ach.notyetprocessed
[{
"id": "0d35289b-4fb4-49a1-806f-adb98462ce6a",
"subject": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
"data": {
"paymentId": 42412,
"paymentGuid": "8e9de236-b255-4e47-8c47-cedf5a99dbb1",
"isCredit": true,
"description": "DESC12",
"lastFour": "1234",
"scheduleDate": "2022-03-03T00:00:00Z",
"receiptDate": "2022-03-03T00:00:00Z",
"processingDate": "2022-03-03T00:00:00Z",
"orderNumber": "Dan-20230225M94217",
"customerId": "Joe Doe",
"incomingTransactionCode": "907F7A1637814005390830075",
"amount": 10.01,
"merchantIdentifier": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
"merchantName": "ClientName"
},
"eventType": "purchase.ach.notyetprocessed",
"eventTime": "2022-03-03T23:06:18.0494148Z",
"dataVersion": "1"
}]
purchase.ach.processing
[{
"id": "0d35289b-4fb4-49a1-806f-adb98462ce6a",
"subject": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
"data": {
"paymentId": 42412,
"paymentGuid": "8e9de236-b255-4e47-8c47-cedf5a99dbb1",
"isCredit": true,
"description": "DESC12",
"lastFour": "1234",
"scheduleDate": "2022-03-03T00:00:00Z",
"receiptDate": "2022-03-03T00:00:00Z",
"processingDate": "2022-03-03T00:00:00Z",
"orderNumber": "Dan-20230225M94217",
"customerId": "Joe Doe",
"incomingTransactionCode": "907F7A1637814005390830075",
"amount": 10.01,
"merchantIdentifier": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
"merchantName": "ClientName"
},
"eventType": "purchase.ach.processing",
"eventTime": "2022-03-03T23:07:18.0494148Z",
"dataVersion": "1"
}]
purchase.ach.processed
[{
"id": "0d35289b-4fb4-49a1-806f-adb98462ce6a",
"subject": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
"data": {
"paymentId": 42412,
"paymentGuid": "8e9de236-b255-4e47-8c47-cedf5a99dbb1",
"isCredit": true,
"description": "DESC12",
"lastFour": "1234",
"scheduleDate": "2022-03-03T00:00:00Z",
"receiptDate": "2022-03-03T00:00:00Z",
"processingDate": "2022-03-03T00:00:00Z",
"orderNumber": "Dan-20230225M94217",
"customerId": "Joe Doe",
"incomingTransactionCode": "907F7A1637814005390830075",
"amount": 10.01,
"merchantIdentifier": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
"merchantName": "ClientName"
},
"eventType": "purchase.ach.processed",
"eventTime": "2022-03-03T23:08:18.0494148Z",
"dataVersion": "1"
}]
purchase.ach.cancelled
[{
"id": "0d35289b-4fb4-49a1-806f-adb98462ce6a",
"subject": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
"data": {
"paymentId": 42412,
"paymentGuid": "8e9de236-b255-4e47-8c47-cedf5a99dbb1",
"isCredit": true,
"description": "DESC12",
"lastFour": "1234",
"scheduleDate": "2022-03-03T00:00:00Z",
"receiptDate": "2022-03-03T00:00:00Z",
"processingDate": "2022-03-03T00:00:00Z",
"orderNumber": "Dan-20230225M94217",
"customerId": "Joe Doe",
"incomingTransactionCode": "907F7A1637814005390830075",
"amount": 10.01,
"merchantIdentifier": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
"merchantName": "ClientName"
},
"eventType": "purchase.ach.cancelled",
"eventTime": "2022-03-03T23:07:18.0494148Z",
"dataVersion": "1"
}]
purchase.ach.noc
[{
"id": "0d35289b-4fb4-49a1-806f-adb98462ce6a",
"subject": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
"data": {
"paymentId": 42412,
"paymentGuid": "8e9de236-b255-4e47-8c47-cedf5a99dbb1",
"isCredit": true,
"description": "DESC12",
"lastFour": "1234",
"scheduleDate": "2022-03-03T00:00:00Z",
"receiptDate": "2022-03-03T00:00:00Z",
"processingDate": "2022-03-03T00:00:00Z",
"orderNumber": "Dan-20230225M94217",
"customerId": "Joe Doe",
"incomingTransactionCode": "907F7A1637814005390830075",
"amount": 10.01,
"merchantIdentifier": "e454dc78-e8b9-4b7f-8568-8bf6246d94a9",
"merchantName": "ClientName",
"nocCode": "C03",
"nocDescription": "Incorrect Routing and DFI Number",
"nocCorrectData": "1111***** ******9999",
"nocEffectiveDate": "2023-10-11T00:00:00Z"
},
"eventType": "purchase.ach.noc",
"eventTime": "2022-10-30T23:07:18.0494148Z",
"dataVersion": "1"
}]
Updated 4 months ago