Overview

This section covers the webhook requests and responses triggered in the account lifecycle.

When webhook URLs are updated, the system will trigger notifications to the newly specified endpoints. These notifications will contain relevant messages for each updated endpoint in the sandbox environment.

Webhook Types

The following table lists the different types of webhooks available in our system.

Webhook	Description
Account Created	Triggered when a new account is created
Account Request Approved	Triggered when an account request is approved
Account Request Rejected	Triggered when an account request is rejected
Account Balance Updated	Triggered when an account's balance changes
Transaction Confirmed	Triggered when a transaction is successfully confirmed
Transaction Rejected	Triggered when a transaction is rejected
Account Credited	Triggered when funds are added to an account
Deposit Balance Update	Triggered when a deposit affects the account balance
Account Debited	Triggered when funds are withdrawn from an account

Payload Attributes

The following is a collection of attributes present in webhooks.

Name	Type	Description
message	string	A descriptive message about the event
code	integer	A numeric code associated with the event
accountNumber	string	The account number related to the event
accountName	string	The name associated with the account
requestId	string	A unique identifier for the request
identifier	string	A specific identifier for the event type
amount	number	The transaction amount (if applicable)
balance	number	The account balance after the event (if applicable)
iban	string	The International Bank Account Number (if applicable)

Payload Examples

This section provides examples of webhook payloads that you may receive for various events related to account management and transactions.

Account Created

{
	"message": "Account Update",
	"identifier": "ACCOUNT_CREATED",
	"code": 1143,
	"accountNumber": "GB1204550505050568",
	"accountName": "James Roque"
}

Account Request Approved

{
	"message": "Account Request Update",
	"identifier": "ACCOUNT_REQUEST_APPROVED",
	"code": 2196,
	"requestId": "96b40127-aca7-4ad7-b9a4-e62b19b78aff",
	"accountNumber": "GB1204550505050568",
	"accountName": "James Roque"
}

Account Request Rejected

{
	"message": "Account Request Update",
	"identifier": "ACCOUNT_REQUEST_REJECTED",
	"code": 2198,
	"requestId": "96b40127-aca7-4ad7-b9a4-e62b19b78aff",
}

Account Balance Update

{
	"message": "Balance Update",
	"identifier": "BALANCE_UPDATE",
	"code": 3019,
	"accountNumber": "GB1204550505050568",
	"balance": 500,
}

Transaction Confirmed

{
	"message": "Transaction Update",
	"identifier": "TRANSACTION_CONFIRMED",
	"code": 3021,
	"accountNumber": "GB1204550505050568",
	"amount": 300,
	"transactionId": "TRX-265457850",
	"transactionRef": "XFER-98709678756",
}

Transaction Rejected

{
	"message": "Transaction Update",
	"identifier": "TRANSACTION_REJECTED",
	"code": 3022,
	"accountNumber": "GB1204550505050568",
	"amount": 300,
	"transactionId": "TRX-472387234",
	"transactionRef": "XFER-92253678358",
}

Account Credited

{
	"message": "Account Credited",
	"identifier": "ACCOUNT_CREDITED",
	"code": 3023,
	"accountNumber": "GB1204550505050568",
	"balance": 500,
}

Deposit Balance Update

{
	"message": "Deposit balance update",
	"identifier": "DEPOSIT_BALANCE_UPDATE",
	"code": 3020,
	"accountNumber": "GB1204550505050568",
	"balance": 500,
}

Account Debited

{
	"message": "Account Debited",
	"identifier": "ACCOUNT_DEBITED",
	"code": 3024,
	"accountNumber": "GB1204550505050568",
	"balance": 500,
}

Endpoints

The following are the endpoints used for managing webhooks in our API:

Get Webhook URLs : This endpoint retrieves the webhook URLs associated with the user's account.

Update Webhook URL : This endpoint allows for updating the webhook's configuration.