Webhooks
Webhooks provide you with asynchronous status updates on various types of transactions performed. We ask that you provide a single webhook-receiver endpoint. Currently, all webhook events and their payload are sent to this single endpoint.
Each webhook payload will have a “payload description” that will provide the context for the payload included. You will be able to parse the “payload description” and the accompanying payload for further processing.
IBAN created
“payload”: {
“payloadDescription”: “IBAN created”,
“accountId”: “a52c5dda-3e19-41cf-a75d-999999999”,
“IBAN”: “GB50CLRB010101122345678”,
“feeDepositAccountIBAN”: “GB81CLRB99887712345678”,
“feeDepositAccountNo”: “12345678”,
“webhookURL”: “<<YOUR-WEBHOOK-ENDPOINT-URL>>“
}
Outgoing debit payment complete
“payload”: {
“payloadDescription”: “Outgoing Debit”,
“correlationId”: “abcded-cd62-4fa2-9dd8-999999ad3dfa”,
“userTransactionId”: “d7f162d2-8333-4159-9b8d-abcdefghitj”,
“reference”: “Test”,
“amount”: 1,
“paymentMethod”: “FPS”,
“notes”: “”,
“transactionState”: “complete”,
“transactionStatus”: “complete”,
“debitCredit”: “Debit”,
“webhookURL”: “<<YOUR-WEBHOOK-ENDPOINT-URL>>“
}
Incoming credit payment complete
“payload”: {
“payloadDescription”: “Incoming Credit”,
“status”: “Settled”,
“scheme”: “Transfer”,
“end_to_end_txn_id”: “7d2d815d-a105-4b52-95b0-abcdefgh”,
“amount”: 1,
“timestampcreated”: “2022-12-22 15:29:01.867+00”,
“timestampsettled”: “2022-12-22 15:29:02.197+00”,
“timestamprecorded”: “2022-12-22 15:29:08.171468”,
“currency_code”: “GBP”,
“debitCredit”: “Credit”,
“reference”: “refdec”,
“isReturn”: “false”,
“IBAN”: “GB44CLRB1234567890”,
“ownerName”: “REDMI”,
“institutionName”: “ABC Limited”,
“benIBAN”: “GB76CLRB04045299887766”,
“benOwnerName”: “REDMI”,
“benInstitutionName”: “XYZ Corp”,
“webhookURL”: “<<YOUR-WEBHOOK-ENDPOINT-URL>>“
}
Transaction approval declined
{
“payloadDescription”: “Outgoing Debit”,
“correlationId”: ”,
“userTransactionId”: “160bf648-f030-447a-84c5-f50fffdef321”,
“reference”: “Ref 1”, “amount”: 1,
“paymentMethod”: “FPS”,
“notes”: ”,
“transactionState”: “approval declined”,
“transactionStatus”: “complete”,
“debitCredit”: “Debit”,
“webhookURL”: “<<YOUR-WEBHOOK-ENDPOINT-URL>>“
}
