Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Webhook Endpoints

account/webhooks

This endpoint can be used to fetch a list of sent webhook notifications. Maximum date range is 1 month. If no date range is provided, it will default to the past 30 days.

get/account/webhooks

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Typestring

The type of webhook notification you wish to fetch. Options are: transaction, paylink, bankaccount, debitcard, creditcard, batchrequest, batchdetail, accountonboarding, accountonboardingapplication, scheduledtransactions, accountverifications, virtualtransaction.

WebhookIDstring

The ID of webhook notifications you wish to fetch.

NotificationStatusstring

Filter webhook notification by status. Possible values are: new, processed, failed, deprecated.

StartDatestring

The start date of the date range you wish to fetch. Format: YYYY-MM-DD

EndDatestring

The end date of the date range you wish to fetch. Format: YYYY-MM-DD

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Example response

{
  "Webhooks": {
    "0": {
      "Event": "transaction",
      "Module": "achfunding",
      "WebhookID": "12314",
      "Status": "in progress",
      "NotificationStatus": "new",
      "DateSent": "2024-01-01 12:34:56",
      "WebhookUrl": "https://example.com/webhook",
      "ResponseText": "request caught",
      "ResponseStatusCode": "200"
    }
  }
}