Transaction Webhook

WEBHOOK transaction

Example

{
  "id": "<string>",
  "url": "<string>",
  "data": {
    "account_id": "<string>",
    "ach_id": "<string>",
    "amount": "<string>",
    "balance": "<string>",
    "billpay_payment_id": "<string>",
    "book_id": "<string>",
    "card_id": "<string>",
    "category": "<string>",
    "check_id": "<string>",
    "check_number": "<string>",
    "date": "<string>",
    "desc": "<string>",
    "extended_timestamp": "<string>",
    "extended_timestamp_precise": "<string>",
    "fednow_id": "<string>",
    "fingerprint": "<string>",
    "greendot_deposit_id": "<string>",
    "human_readable_description": "<string>",
    "id": "<string>",
    "incoming_ach_id": "<string>",
    "incoming_wire": {},
    "incoming_wire_id": "<string>",
    "issued_check_id": "<string>",
    "network_transfer_id": "<string>",
    "summary": "<string>",
    "trace_id": "<string>",
    "type": "<string>",
    "type_source": "<string>",
    "userdata": {},
    "wire": "<string>",
    "wire_id": "<string>"
  }
}

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: transaction.create, transaction.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.