Wire Event Webhook Response

Our webhooks keep you updated in real-time about important events related to ACH payments processed through our system. By using these webhooks, you can create applications that quickly respond to changes in ACH payment statuses.

The JSON body structure of a Wire Event Webhook call that you will receive, is as follows:

curl -L 'https://example-url.com/ach-payments-api/v1/{your-webhook-url}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+' \
-d '{
  "notificationId": "8cefee42-cb39-4479-b7fd-b8a358aeb002",
  "eventType": "wire.status",
  "eventDateTime": "2017-07-21T17:32:28Z",
  "data": {
    "wireEventInfo": {
      "paymentId": "1998237737364728",
      "status": "Processed",
      "exceptionInfo": [
        {
          "exceptionCode": "Suspect",
          "exceptionDescription": "OFAC Match Suspect"
        }
      ],
      "IMAD": "20250416456FMPBO000137",
      "OMAD": "20250416456FMPBO000135",
      "originalWire": {
        "wireInfo": {
          "paymentAmount": "1.00",
          "referenceId": "124323453243545",
          "endToEndId": "eeaa89d8-a0c8-4e9b-8b9c-ca8103b345cb"
        },
        "originatorInfo": {
          "accountNumber": "2030567898",
          "accountType": "D",
          "name": "John Doe",
          "wireCompanyId": "1234",
          "wireCompanyName": "ABC Comp"
        },
        "beneficiaryInfo": {
          "accountNumber": "2030567898",
          "accountType": "D",
          "name": "Bob Smith",
          "address": {
            "addressLine": "string",
            "city": "string",
            "state": "st",
            "postalCode": "string"
          },
          "institutionInfo": {
            "name": "The Big Bank",
            "routingNumber": "39506009",
            "address": {
              "addressLine": "string",
              "city": "string",
              "state": "st",
              "postalCode": "string"
            }
          }
        },
        "remittanceInformation": "Sender to Receiver Comments"
      }
    }
  }
}

URL

The your-webhook-url will be the full FDNS custom HTTP endpoint that provided during your onboarding.

The sections below describe the parameters and objects present in the request.

Header Parameters

x-timestampstringrequired

The timestamp used to support the message signature. Should contain only numbers.

Expired Request

Requests with a timestamp > 5min will be rejected.

• Default: none

x-signaturestringrequired

Payload signature used by the API Client to validate message authenticity. Signature is calculated via HMAC SHA256 algorithm and is composed by:

• HTTP_VERB + HTTP_URL + PAYLOAD + TIMESTAMP.

The key will be provided to API Consumer.

Possible values: >= 64 characters and <= 64 characters

• Default: none

Body

notificationIdstringrequired

UUID of the generated event.

Possible values: >= 36 characters and <= 36 characters

• Default: 8cefee42-cb39-4479-b7fd-b8a358aeb002

eventTypestringrequired

The ISO Wire Event Type.

• Default: wire.status

eventDateTimedate-timerequired

The date the event occurred.

• Default: 2017-07-21T17:32:28Z

dataobjectrequired

Contains detailed information about the wire event.

• Default: none

data Object

wireEventInfoobjectrequired

Information related to the wire event.

• Default: none

wireEventInfo Object

paymentIdstring

Payment key generated when creating the Wire.

• Default: 1998237737364728

statusstring

Wire transfer status.

Possible values: [Review, Send Ready, Reject, Error, Exception, Complete]

• Default: Processed

exceptionInfoobject[]

Array of exception information.

• Default: none

IMADstring

Input Message Accountability Data.

• Default: 20250416456FMPBO000137

OMADstring

Output Message Accountability Data.

• Default: 20250416456FMPBO000135

originalWireobject

Wire Transfer Payment Detail.

• Default: none

exceptionInfo Array Object

exceptionCodestringrequired

The Wire exception code.

• Default: Suspect

exceptionDescriptionstringrequired

The Wire exception description.

• Default: OFAC Match Suspect

originalWire Object

wireInfoobjectrequired

Wire transfer information.

• Default: none

paymentAmountstringrequired

Transaction amount in N.NN format. For amounts less than 1 Dollar, the 0 is required (0.50).

Possible values: non-empty and <= 12 characters, Value must match regular expression ^[\d]*\.[\d]{2}$

• Default: 1.00

referenceIdstringrequired

Identification provided to a transaction. Please send Not Provided if you don't have one.

Possible values: >= 35 characters and <= 35 characters

• Default: 124323453243545

endToEndIdstring

Unique identification to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.

Possible values: >= 36 characters and <= 36 characters

• Default: eeaa89d8-a0c8-4e9b-8b9c-ca8103b345cb

originatorInfoobjectrequired

Information about the originator.

• Default: none

beneficiaryInfoobjectrequired

Information about the beneficiary.

• Default: none

remittanceInformationstring

Remittance information (140 chars limit).

Possible values: <= 140 characters

• Default: Sender to Receiver Comments

originatorInfo Object

accountNumberstringrequired

The API People Account number associated with the Wire Company.

Possible values: non-empty and <= 16 characters

• Default: 2030567898

accountTypestringrequired

The single letter identifier for the financial account type.

• D = Deposit
• S = Savings If not informed, the default value is D

Possible values: [D, S]

• Default: D

namestringrequired

Name of the account holder.

Possible values: non-empty and <= 35 characters

• Default: John Doe

wireCompanyIdstring

The Wire Company Id tied to the financial account where the funds will be sent from.

Possible values: non-empty and <= 12 characters

• Default: 1234

wireCompanyNamestring

The Wire Company Name tied to the financial account where the funds will be sent from.

Possible values: non-empty and <= 40 characters

• Default: ABC Comp

beneficiaryInfo Object

accountNumberstringrequired

The receiving party account number.

Possible values: non-empty and <= 34 characters

• Default: 2030567898

accountTypestringrequired

The single letter identifier for the financial account type.

• D = Deposit
• S = Savings If not informed, the default value is D

Possible values: [D, S]

• Default: D

namestringrequired

Name of beneficiary account holder.

Possible values: non-empty and <= 35 characters

• Default: Bob Smith

addressobjectrequired

Beneficiary's address.

• Default: none

institutionInfoobjectrequired

Beneficiary's financial institution information.

• Default: none