Registering a webhook via API call involves configuring a client application to receive notifications and updates from our ACH API. To enable notification related to transaction, you need to register webhook with sets of predefined Events.

Once registered, the webhook will be triggered by the ACH API whenever a relevant event occurs, such as a transaction started, completed or failed. The webhook will then send a notification to the configured endpoint, which can be processed by the client application to perform additional actions or update relevant data.

This route is secured with processor and vendor token authentication.

Note: Our webhooks are not specific to any particular entity in our ACH Application. So for example, you would not want to register an individual webhook for every merchant that you onboard. Each of those webhooks urls will get the same data each time an event is triggered. The approach we recommend is to register a single webhook url to the events you wish to subscribe to. Then you can use the event data to determine which entity the event is related to.

Warning: You are restricted to 10 unique webhook urls per API token. Any attempts to register a webhook url after you have reached your maximum will result in an error. Additionally, if our application detects consistent errors from any registered webhook url, we will automatically deregister that webhook url.

​
Endpoint

POST   /3p/api/v1/webhook

​
Request Payload

{
    "webhook_url": [
      "https://example.com/webhook/transaction"
    ],
    "event_names": [
      "TransactionCompleted",
      "TransactionFailed"
    ]
}
FieldsTypeIs RequiredDescription
webhook_urlstring arrayYesHTTPS url with support to receive post requests
event_namesstring arrayYesPossible Values: TransactionStarted TransactionCaptureStarted TransactionCompleted TransactionFailed TransactionCanceled PayoutFailed PayoutCompleted ClawbackStarted ClawbackFailed ClawbackCompleted BankLinkedSuccessfully BankLinkFailed BankAccountRemoved BusinessCreated BusinessUpdated BatchPayout (only by processor token) RefundPending RefundCaptureStarted RefundCaptureCompleted RefundCaptureFailed RefundPayoutPending RefundPayoutCompleted RefundPayoutFailed BatchRefund (only by processor token) ReversePayoutStarted ReversePayoutCompleted ReversePayoutFailed

​
Response Object

{
    "status": true,
    "message": "Webhook registered successfully!",
    "data": null,
    "errors": []
}

​
Errors & Warnings

CodeMessage
401
422