Webhook Payloads
Customer Account Webhook
{
"id": "2bde2e5a-7606-49c2-b28e-253792258e34",
"accountId": "2bde2e5a-7606-49c2-b28e-253792258e34",
"status": "active",
"externalReference": "2bde2e5a-7606-49c2-b28e-253792258e34",
"updatedAt": "2024-02-09T13:30:00Z"
}id | string [uuid] | Unique identifier of the webhook | Required |
accountId | string [uuid] | Unique identifier of the customer account | Required |
status | enum | Status of the Customer Account | Required |
externalReference | string | An optional value that can be passed in to later reference a related resource in the partner system. | Optional |
updatedAt | string [stimestamp] | The timestamp with timezone for date when Payment Address was updated | Required |
Status enum:
CustomerAccountStatus {
submitted,
pending,
active,
inactive,
rejected
}Wallet Webhook
{ "id": "18b455af-9f60-43de-8f4b-b94f8e1b6e8b", "walletId": "18b455af-9f60-43de-8f4b-b94f8e1b6e8b", "accountId": "bfdb26af-655a-4ee2-9328-a480f4c204d7", "currency": "NZD", "status": "active", "availableBalance": 0, "cashBalance": 0, "committedBalance": 0, "updatedAt": "2024-02-14T00:01:08Z"}id | string [uuid] | Unique identifier of the webhook |
walletId | string [uuid] | Unique identifier of the wallet object |
accountId | string [uuid] | Unique identifier of attached account |
currency | string | 3-letter Currency in what currency this wallet is denominated |
status | enum | Status of the wallet |
availableBalance | integer | wallet available balance |
cashBalance | integer | wallet cash balance |
committedBalance | integer | wallet receivable balance |
updatedAt | string [stimestamp] | The timestamp with timezone for when the record was updated. |
Status enum:
WalletStatus { pending, active, inactive}Pay-In Address Webhook
{ "id": "18b455af-9f60-43de-8f4b-b94f8e1b6e8b", "payInAddressId": "18b455af-9f60-43de-8f4b-b94f8e1b6e8b", "status": "active", "updatedAt": "2024-02-14T00:01:08Z"}id | string [uuid] | Unique identifier of the webhook | Required |
payInAddressId | string [uuid] | Unique identifier of the Pay-In address object | Required |
status | enum: active, pending, inactive | Status of the pay-in address | Required |
updatedAt | string [stimestamp] | The timestamp with timezone for date when Payment Address was updated | Required |
Status enum:
Pay-InAddressStatus { pending, active, inactive}Pay-In Transaction Webhook
{ "id": "9757e4bc-f9ba-49f0-beb8-1557f308b0ee", "payInTransactionId": "9757e4bc-f9ba-49f0-beb8-1557f308b0ee", "accountId": "bfdb26af-655a-4ee2-9328-a480f4c204d7", "payInAddressId": "987654321", "walletId": "9757e4bc-f9ba-49f0-beb8-1557f308b0ee", "amount": 1000, "currency": "USD", "status": "pending", "source": "BSB=944-600,ACC NO=016043596", "remitterDetails": "M J & L J L HATT", "reference": "2697D", "type": "local_bank_transfer", "updatedAt": "2024-03-21T10:05:00Z",}id | string [uuid] | Unique identifier of the webhook | Required |
payInTransactionId | string [uuid] | Unique identifier of the Pay-In transaction | Required |
accountId | string [uuid] | Unique identifier of attached account | Required |
payInAddressId | string [uuid] | Unique identifier of the Pay-In address object | Required |
walletId | string [uuid] | Unique identifier of the wallet object | Required |
amount | integer | Transaction Amount | Required |
currency | string | 3-letter Currency of the pay-In | Required |
status | enum | Pay-in transaction status | Required |
source | string | The source response includes information about 'where' the Pay-In originated from. | Required |
remitterDetails | string | The remitter response includes information about 'who' the Pay-In originated from. | Required |
reference | string | This is reference that the sender of the Pay-In would put on their bank transfer. | Optional |
type | enum | Pay-In transaction type | Required |
updatedAt | string [stimestamp] | The timestamp with timezone for when the record was updated. | Required |
Status enum:
Pay-Intransaction { new, pending, credited, rejected}Trade Webhook
{ "id": "9757e4bc-f9ba-49f0-beb8-1557f308b0ee", "tradeId": "uuid", "accountId": "uuid", "status": "pending", "externalReference": "2bde2e5a-7606-49c2-b28e-253792258e34", "updatedAt": "2019-08-24T14:15:22Z",}id | string [uuid] | Unique identifier of the webhook | Required |
tradeId | string [uuid] | Internal unique identifier of the Trade | Required |
accountId | string [uuid] | Unique identifier of attached account | Required |
status | enum | Status of the trade | Required |
externalReference | string | An optional value that can be passed in to later reference a related resource in the partner system. | Optional |
updatedAt | string [stimestamp] | The timestamp with timezone for date when Payment Address was updated | Required |
Status enum:
TradeStatus { submitted, processing, pending_settlement, pending_payout_processing, awaiting_funds, settled, rejected}Batch Trades Webhook
{ "id": "2a705afd-d75c-4806-ac5e-92aa18b19312", "batchId": "9757e4bc-f9ba-49f0-beb8-1557f308b0ee", "externalReference": "2bde2e5a-7606-49c2-b28e-253792258e34", "status": "completed", "itemsCount": 1000, "completed": 500, "failed": 500, "updatedAt": "2019-08-24T14:15:22Z",}id | string [uuid] | Unique identifier of the webhook | Required |
batchId | string [uuid] | Internal unique identifier of the Batch | Required |
externalReference | string | An optional value that can be passed in to later reference a related resource in the partner system. | Required |
status | enum | Status of the trade | Required |
itemsCount | number | The total count of trade entries submitted in the batch. | Required |
completed | number | The count of entries in the batch that were successfully processed. | Required |
failed | number | The count of trade entries in the batch that failed to process. | Required |
updatedAt | string [timestamp] | The timestamp with timezone for date when Payment Address was updated | Required |
Status enum:
BatchStatus { created, processing, failed, completed, completed_with_errors}Payment Address Webhook
{ "id": "9757e4bc-f9ba-49f0-beb8-1557f308b0ee", "paymentAddressId": "uuid", "accountId": "uuid", "status": "pending", "externalReference": "2bde2e5a-7606-49c2-b28e-253792258e34", "updatedAt": "2019-08-24T14:15:22Z",}id | string [uuid] | Unique identifier of the webhook | Required |
paymentAddressId | string [uuid] | Internal unique identifier of the payment address | Required |
recipientId | string [uuid] | Id of the recipient | Required |
accountId | string [uuid] | Unique identifier of attached account | Required |
status | enum | Status of the payment address | Required |
externalReference | string | An optional value that can be passed in to later reference a related resource in the partner system. | Optional |
updatedAt | string [stimestamp] | The timestamp with timezone for date when Payment Address was updated | Required |
Status enum:
PaymentAddressStatus { submitted, processing, rejected, active, inactive}Payout Transaction Webhook
{ "id": "9757e4bc-f9ba-49f0-beb8-1557f308b0ee", "payoutId": "4f8fcf90-fad4-d319-0cb7-0b6f0dc323bb", "accountId": "72a9356c-7362-8dd9-ed9f-585274ec147f", "status": "released", "externalReference": "2bde2e5a-7606-49c2-b28e-253792258e34", "endToEndId": "1736980931724", “returnAmount”: 123123, “returnWalletId”: "2bde2e5a-7606-49c2-b28e-253792258e34", "updatedAt": "2023-08-24T14:15:22Z",}id | string [uuid] | Unique identifier of the webhook | Required |
payoutId | string [uuid] | Internal unique identifier of the payment transaction | Required |
accountId | string [uuid] | Unique identifier of attached account | Required |
status | enum | Status of the payment Transaction | Required |
externalReference | string | An optional value that can be passed in to later reference a related resource in the partner system. | Optional |
endToEndId | string | Back-office reference ID for bank tracking of the end-to-end payment. Only available when a payment reaches released status. | Optional |
returnAmount | int | The amount of funds being returned for the payment if the payment has been returned. Denominated in the currency of the returnWalletId so may not be in the same currency as the payout. | Optional |
returnWalletId | string [uuid] | The ID of the wallet the payout is being returned to. Only used if the payment is in the returned status. | Optional |
updatedAt | string [stimestamp] | The timestamp with timezone for date when Payment Address was updated | Required |
Status enum:
PayoutTransactionStatus { submitted, processing, awaiting_funds, pending_trade_settlement, pending_release, released, returned, rejected }Transfer Transaction Webhook
{ "id": "9757e4bc-f9ba-49f0-beb8-1557f308b0ee", "transferId": "4f8fcf90-fad4-d319-0cb7-0b6f0dc323bb", "accountId": "72a9356c-7362-8dd9-ed9f-585274ec147f", "status": "compliance pending", "externalReference": "2bde2e5a-7606-49c2-b28e-253792258e34", "updatedAt": "2023-08-24T14:15:22Z",}id | string [uuid] | Unique identifier of the webhook | Required |
transferId | string [uuid] | Internal unique identifier of the payment transaction | Required |
accountId | string [uuid] | Unique identifier of attached account | Required |
status | enum | Status of the payment Transaction | Required |
externalReference | string | An optional value that can be passed in to later reference a related resource in the partner system. | Optional |
updatedAt | string [stimestamp] | The timestamp with timezone for date when Payment Address was updated | Required |
Status enum:
TransferTransactionStatus { submitted, processing, awaiting_funds, pending_trade_settlement, pending_release, released, returned, rejected }Payment Recipient Webhook
{"id": "string","accountId": "string","status": "pending","externalReference": "2bde2e5a-7606-49c2-b28e-253792258e34","updatedAt": "2019-08-24T14:15:22Z",}id | string [uuid] | Unique identifier of the webhook | Required |
recipientId | string [uuid] | Internal unique identifier of the recipient | Required |
accountId | string [uuid] | Unique identifier of attached account | Required |
status | enum | Status of the recipient | Required |
externalReference | string | An optional value that can be passed in to later reference a related resource in the partner system. | Optional |
updatedAt | string [stimestamp] | The timestamp with timezone for date when Payment Address was updated | Required |
Status enum:
RecipientStatus { submitted, processing, rejected, active, inactive}How to get Webhooks information and delete Webhook
Fetching the information about the Webhooks
To request the information about all the Webhooks for the Enterprise User you can send a signed GET /webhook request.
In response to your request you will receive either a SUCCESS 200 response or one or the error responses (400, 401, 500) See Status Codes & Error Messages.
Given a valid accessToken a SUCCESS response will return the details for all the previously created Webhooks.
Deleting the existing Webhook
To remove up the Webhooks for the Enterprise User you can send a signed DEL /webhooks/{webhookId} request.
In response to your request you will receive either a SUCCESS 204 response or one or the error responses (400, 401, 500) See Status Codes & Error messages.
On this page
- Webhook Payloads