Direct debit payouts

Subscribe to webhook events for direct debit payout status changes.

The following webhook events are available for your Payouts integration.

Event	Description
direct_debit.created	Direct debit payout instruction received.
direct_debit.in_review	Direct debit payout is on hold for review.
direct_debit.pending	Direct debit payout is pending for settlement.
direct_debit.rejected	Direct debit payout was rejected after being reviewed.
direct_debit.settled	Direct debit payout has been debited from your Wallet balance.
direct_debit.returned	The request to dispute the payout was successful. The funds will be credited back to your Wallet balance.

Payload examples

Relevant webhook events:

direct_debit.created
direct_debit.in_review
direct_debit.pending
direct_debit.rejected
direct_debit.settled
direct_debit.returned

Payload example:

JSON

1{
2    "accountId": "acct_E2ANppfgNTyskSBvI0Nlvw",
3    "createdAt": "2022-05-30T03:51:06:500 UTC"
4    "data":Object{...},
5    "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",
6    "name":"deposit.settled"
7}

data

JSON

1{
2    "accountId": "04c252c8-fe03-46ca-9927-794d6e79e3e8",
3    "directDebitId": "14b6baf0-255e-463f-868f-c1024aff155b",
4    "transactionType": "Direct Debit",
5    "debtorAccount": {
6      "id": "81d452f6-8f83-4183-88a1-6691aeff457f",
7      "name": "bobeibi lian",
8      "type": "GA",
9      "number": "4002902285"
10    },
11    "creditorAccount": {
12      "id": null,
13      "name": "NYU  balabala",
14      "type": null,
15      "number": "0139851"
16    },
17    "amount": 666.22,
18    "currency": "USD",
19    "reference": "strange transaction ref 2022-05-30T03:51:05.906Z",
20    "status": "NEW",
21    "rejectReason": null,
22    "createdAt": "2022-05-30T03:51:06:246 UTC",
23    "lastUpdatedAt": "2022-05-30T03:51:06:246 UTC"
24}
25

Was this page helpful?