ACH Webhook

WEBHOOK ach

Example

{
  "id": "<string>",
  "url": "<string>",
  "data": {
    "account_id": "<string>",
    "addenda": [
      "<string>"
    ],
    "amount": "<string>",
    "bank_id": "<string>",
    "batch_key": "<string>",
    "counterparty_id": "<string>",
    "description": "<string>",
    "direction": "<string>",
    "effective_date": "<string>",
    "error": "<string>",
    "id": "<string>",
    "noc_change_code": "<string>",
    "noc_corrected_data": "<string>",
    "org_id": "<string>",
    "originator_name": "<string>",
    "scheduled_settlement": "<string>",
    "sec_code": "<string>",
    "sec_details": {
      "check_serial_number": "<string>",
      "individual_id_number": "<string>",
      "individual_name": "<string>",
      "payment_type": "<string>"
    },
    "service": "<string>",
    "status": "<string>",
    "trace_number": "<string>",
    "trace_suffix": 123,
    "userdata": {}
  }
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

event · enum<string> · required

Available options: ach.create, ach.update

id · string · required

ID of the object the event is about

op · enum<string> · required

Available options: create, update

url · string · required

URL to fetch the object

data · object

Snapshot of the object as of the event. Omitted when the organization does not receive full-object webhooks, or when the object cannot be rendered.

Show child attributes

Response

200

Return a 200 or 202 status code to acknowledge receipt.