Webhooks payload examples
You can expect to receive notifications that will include a header and a body.
The body of the payload includes properties that could be sent as part of the notification. Some properties might be omitted or be null. Depending on the notificationType, Classification and Status, the body parameters will change. Please see the examples below for further details.
Payload structure
Flexible parserWe advise on building a flexible parser as properties might change position and new properties might be added. Also note that the property with event specific data is named either payment or payload depending on the type of event.
| Header | Description |
|---|---|
| SubscriptionVersion | The subscription and the related payload we are sending |
| Nonce | It's short for Number used Once and it's an AES-GCM encryption parameter |
| AuthenticationTag | The Authentication Tag is an AES-GCM encryption verification parameter |
| Checksum | Hash of the message body (SHA-256 hash) |
Body (JSON array) | Description |
|---|---|
eventId | UUID. A unique Id given to the individual event notification |
subscriptionId | UUID. A unique Id given to the parent subscription |
subscriptionEventId | UUID. A unique Id of the event configuration associated with the subscription |
notificationType | String. The name of the notification event |
timestamp | Date-time. The time when the notification was triggered |
payment / payload | This object includes properties with information on the specific event. See more in the examples below. The property with event specific data is named payment or payload depending on the event type. See the examples below for further details. |
Returned payments
Returned payments do not have a distinct payment status and are not associated with a dedicated webhook event for returned payments. Instead, they appear as Incoming Processed payments.
In most cases, the remittanceInformation field will contain the text 'RETURN OF PAYMENT', along with a reference to the original Outgoing Processed payment and the reason for the return, such as "Account is closed".
Payload examples
Incoming payment processed
Checksum: omCWli/jqujrbchOIEw18Zkb9hcoJvPtGxMeCd4DvfA=,
Nonce: A/zhOsBsRB/zIf6y, AuthenticationTag: Oe0P37s3DqHROlsvQ8UpDA==
SubscriptionVersion: 1
{
"notifications": [
{
"subscriptionId": "5a7f1e26-2533-48e6-ab6e-b82fbb1173e9",
"subscriptionEventId": "db71b15e-3bd4-489a-9629-e92d5e81633f",
"eventId": "d85349f6-1b39-4245-b9f0-466e95c93cc9",
"notificationType": "IncomingPaymentProcessed",
"timestamp": "2023-09-23T14:53:52.8581798Z",
"payment": {
"paymentId": "24aa06ca-5aed-01e0-bb03-6322d8db9f0f",
"transactionReference": "010F103220030044",
"classification": "Incoming",
"subClassification": "Internal",
"isTraceable": false,
"status": "Processed",
"processedTimestamp": "2023-09-23T15:33:51.0133333+00:00",
"latestStatusChangedTimestamp": "2023-09-23T15:33:51.0133333+00:00",
"booked": null,
"reversalBooked": null,
"return":true,
"paymentRail":"Internal",
"errors": null,
"lastChangedTimestamp": "2021-09-23T14:51:53.095314+00:00",
"debtorInformation": null,
"transfer": {
"debtorAccount": {
"accountNumber": "0000026804",
"accountIban": "DE42700700100000012345",
"account": "DE42700700100000012345",
"financialInstitution": "DEUTDEMMXXX",
"country": null
},
"debtorName": "Funding of test account",
"debtorAddress": {
"line1": "25 Testing Str.",
"line2": null,
"line3": null
},
"amount": {
"currency": "GBP",
"amount": 145.25
},
"valueDate": "2021-09-23T00:00:00+00:00",
"chargeBearer": "Ben",
"remittanceInformation": {
"line1": "Funding of test account",
"line2": null,
"line3": null,
"line4": null
},
"creditorAccount": {
"accountNumber": null,
"accountIban": "DK1089000049910051",
"account": "DK1089000049910051",
"financialInstitution": "SXPYDKKKXXX",
"country": "DK"
},
"creditorName": "Amerika Kaj 38",
"creditorAddress": null
},
"creditorInformation": {
"accountId": "b18c33e1-4e5b-59c9-52b8-fc423236554a",
"account": {
"accountNumber": null,
"accountIban": "DK1089000049910051",
"account": "DK1089000049910051",
"financialInstitution": "SXPYDKKKXXX",
"country": null
},
"vibanId": null,
"viban": null,
"creditAmount": {
"currency": "GBP",
"amount": 145.25
},
"creditValueDate": "2021-09-23T00:00:00+00:00",
"fxRate": null
},
"possibleActions": [],
}
},
{
"subscriptionId": "5a7f1e26-2533-48e6-ab6e-b82fbb1173e9",
"subscriptionEventId": "db71b15e-3bd4-489a-9629-e92d5e81633f",
"eventId": "295b2f7c-6ff7-4067-a755-117f380c8513",
"notificationType": "IncomingPaymentProcessed",
"timestamp": "2021-09-23T14:53:52.8582064Z",
"payment": {
"paymentId": "0ef83209-8477-cb60-df3c-d122a329b8a1",
"transactionReference": "0ef83209-8477-cb60-df3c-d122a329b8a1",
"classification": "Incoming",
"subClassification": "Internal",
"isTraceable": false,
"status": "Processed",
"errors": null,
"lastChangedTimestamp": "2021-09-23T14:52:52.821187+00:00",
"debtorInformation": null,
"transfer": {
"debtorAccount": {
"accountNumber": null,
"accountIban": "DE42700700100000012345",
"account": "DE42700700100000012345",
"financialInstitution": "DEUTDEMMXXX",
"country": null
},
"debtorName": "Funding of test account",
"debtorAddress": {
"line1": "25 Testing Str.",
"line2": null,
"line3": null
},
"amount": {
"currency": "GBP",
"amount": 145.25
},
"valueDate": "2021-09-23T00:00:00+00:00",
"chargeBearer": "Ben",
"remittanceInformation": {
"line1": "Funding of test account",
"line2": null,
"line3": null,
"line4": null
},
"creditorAccount": {
"accountNumber": null,
"accountIban": "DK1089000049910051",
"account": "DK1089000049910051",
"financialInstitution": "SXPYDKKKXXX",
"country": "DK"
},
"creditorName": "Amerika Kaj 38",
"creditorAddress": null
},
"creditorInformation": {
"accountId": "b18c33e1-4e5b-59c9-52b8-fc423236554a",
"account": {
"accountNumber": null,
"accountIban": "DK1089000049910051",
"account": "DK1089000049910051",
"financialInstitution": "SXPYDKKKXXX",
"country": null
},
"vibanId": null,
"viban": null,
"creditAmount": {
"currency": "GBP",
"amount": 145.25
},
"creditValueDate": "2021-09-23T00:00:00+00:00",
"fxRate": null
},
"possibleActions": [],
}
}
]
}Incoming payment booked
Checksum: omCWli/jqujrbchOIEw18Zkb9hcoJvPtGxMeCd4DvfA=,
Nonce: A/zhOsBsRB/zIf6y, AuthenticationTag: Oe0P37s3DqHROlsvQ8UpDA==
SubscriptionVersion: 1
{
"notifications": [
{
"subscriptionId": "8dc3cbdd-68f4-4bf5-95bb-1817d38324c7",
"subscriptionEventId": "1d02c704-c45a-42c8-8340-ebd1426d1f03",
"eventId": "0187f147-6587-4e30-9642-0ad9e1236474",
"notificationType": "IncomingPaymentBooked",
"timestamp": "2024-07-26T06:17:34.0210425Z",
"payment": {
"paymentId": "bcc8c7f1-b7a8-4412-a0ee-cba9e5043ea5", // uuid | null
"transactionReference": "010F102242080001", // string
"TransactionDate": "2024-07-26T00:00:00", // date-time
"valueDate": "2024-07-26T00:00:00", // date-time
"amount": 123.45, // decimal | null
"currency": "GBP", // string | null
"transfer": { // object
"remittanceInformation": { // object
"line1": "Payment details 6749b21" // string
}
}
}
}
]
}Outgoing payment processed
Checksum: omCWli/jqujrbchOIEw18Zkb9hcoJvPtGxMeCd4DvfA=,
Nonce: A/zhOsBsRB/zIf6y, AuthenticationTag: Oe0P37s3DqHROlsvQ8UpDA==
SubscriptionVersion: 1
{
"notifications": [
{
"subscriptionId": "0944149a-5bd3-48b0-a6e2-ebff3108685f",
"subscriptionEventId": "bcfb5826-cc74-4ecd-9a7b-13b3b9498d94",
"eventId": "0252c415-b40e-42a9-ac9c-734e7d0a44b3",
"notificationType": "OutgoingPaymentProcessed",
"timestamp": "2023-05-05T20:34:33.0350148Z",
"payment": {
"paymentId": "1c982897-d96f-f8bf-664f-9ab64dac5e71",
"transactionReference": "010F103220030002",
"classification": "Outgoing",
"subClassification": "External",
"isTraceable": true,
"status": "Processed",
"processedTimestamp": "2023-05-05T21:53:51.0133333+00:00",
"latestStatusChangedTimestamp": "2023-05-05T21:53:51.0133333+00:00",
"booked": true,
"reversalBooked": null,
"return":null,
"paymentRail":"Internal",
"errors": null,
"lastChangedTimestamp": "2021-05-05T20:33:11.861789+00:00",
"debtorInformation": {
"paymentBulkId": null,
"accountId": "40ebe223-7bbd-40d7-fe3e-e583028b3e76",
"account": {
"accountNumber": "0000027804",
"accountIban": "DK5289000049910071",
"account": "DK5289000049910071",
"financialInstitution": "SXPYDKKKXXX",
"country": null
},
"vibanId": null,
"viban": null,
"instructedDate": "2021-05-05T00:00:00+00:00",
"debitAmount": {
"currency": "EUR",
"amount": 15.25
},
"debitValueDate": "2021-05-05T00:00:00+00:00",
"fxRate": null,
"instruction": {
"debtorAccount": {
"accountNumber": null,
"accountIban": "DK5289000049914571",
"account": "DK5289000049914571",
"financialInstitution": null,
"country": null
},
"debtorViban": null,
"debtorReference": "FMC pmt",
"debtorNarrativeToSelf": null,
"currencyOfTransfer": "EUR",
"amount": {
"currency": "EUR",
"amount": 15.25
},
"requestedExecutionDate": "2021-05-05T00:00:00+00:00",
"chargeBearer": "Sha",
"remittanceInformation": {
"line1": "FMC pmt rem1",
"line2": null,
"line3": null,
"line4": null
},
"creditorId": null,
"creditorAccount": {
"accountNumber": null,
"accountIban": "DK3789000049910050",
"account": "DK3789000049910050",
"financialInstitution": null,
"country": "DK"
},
"creditorName": "Payments 1",
"creditorAddress": {
"line1": "25 Oxford Str.",
"line2": "GB - London, SW 5T",
"line3": null
}
}
},
"transfer": {
"debtorAccount": {
"accountNumber": null,
"accountIban": "DK52890000499104571",
"account": "DK52890000499104571",
"financialInstitution": "SXPYDKKKXXX",
"country": null
},
"debtorName": "Payments 2",
"debtorAddress": {
"line1": "26 Oxford Str.",
"line2": "GB - London, SW 5T",
"line3": "United Kingdom"
},
"amount": {
"currency": "EUR",
"amount": 15.25
},
"valueDate": "2021-05-05T00:00:00+00:00",
"chargeBearer": "Sha",
"remittanceInformation": {
"line1": "FMC pmt rem1",
"line2": null,
"line3": null,
"line4": null
},
"creditorAccount": {
"accountNumber": null,
"accountIban": "DK3789000049910050",
"account": "DK3789000049910050",
"financialInstitution": null,
"country": "DK"
},
"creditorName": "Payments 1",
"creditorAddress": {
"line1": "25 Oxford Str.",
"line2": "GB - London, SW 5T",
"line3": null
}
},
"creditorInformation": null
},
"possibleActions": [],
}
]
}Outgoing payment booked
In a Reversal-scenario, two (2) OutgoingPaymentBooked-webhooks will be triggered - a webhook when the outgoing payment is initially processed and booked, and a second webhook when it's later reversed. The _account _and transaction references will be identical, however, the amount will correspond with the effect on the balance.
Checksum: omCWli/jqujrbchOIEw18Zkb9hcoJvPtGxMeCd4DvfA=,
Nonce: A/zhOsBsRB/zIf6y, AuthenticationTag: Oe0P37s3DqHROlsvQ8UpDA==
SubscriptionVersion: 1
{
"notifications": [
{
"subscriptionId": "0944149a-5bd3-48b0-a6e2-ebff3108685f",
"subscriptionEventId": "bcfb5826-cc74-4ecd-9a7b-13b3b9498d94",
"eventId": "0252c415-b40e-42a9-ac9c-734e7d0a44b3",
"notificationType": "OutgoingPaymentBooked",
"timestamp": "2021-05-05T20:34:33.0350148Z",
"payment": {
"paymentId":"7025cd3d-bcaf-756d-662d-e55573317df9", // uuid | null
"transactionReference":"010F342233420485", // string
"valueDate":"2023-12-08T00:00:00", // date-time
"transactionDate": "2025-02-18T00:00:00", // date-time
"amount": -123.45, // decimal | null
"currency": "GBP", // string | null
"debtorInformation": { // object
"instruction": { // object
"debtorReference":"Your reference", // string
"remittanceInformation": { // object
"line1": "Your reference" // string
}
}
}
}
}
]
}Rejected
Checksum: omCWli/jqujrbchOIEw18Zkb9hcoJvPtGxMeCd4DvfA=,
Nonce: A/zhOsBsRB/zIf6y, AuthenticationTag: Oe0P37s3DqHROlsvQ8UpDA==
SubscriptionVersion: 1
{
"notifications": [
{
"subscriptionId": "263fd0d3-f69e-48e4-b868-168c817d537e",
"subscriptionEventId": "db7f9404-2e82-4c49-a958-64cd456256bc",
"eventId": "eb034633-f47e-4af0-9f77-45f3c10de7fd",
"notificationType": "OutgoingPaymentRejected",
"timestamp": "2023-10-11T14:22:05.9063221Z",
"payment": {
"paymentId": "1e037992-b4e3-488f-904f-919a8e31a6d1",
"transactionReference": null,
"classification": "Outgoing",
"subClassification": "Internal",
"isTraceable": false,
"status": "Rejected",
"processedTimestamp": null,
"latestStatusChangedTimestamp": "2023-10-11T14:33:51.0133333+00:00",
"booked": null,
"reversalBooked": null,
"return":null,
"errors": [
{
"errorCode": "ProcessingError",
"errorText": "Error processing the payment",
"propertyName": "",
"lineNumber": 0,
"fieldNumber": 0,
"isOk": false
}
],
"lastChangedTimestamp": "2021-10-11T14:22:05.5233333+00:00",
"debtorInformation": {
"paymentBulkId": null,
"accountId": "0e4b3b85-1f03-8348-055d-78e21916bf21",
"account": {
"accountNumber": "0000027801",
"accountIban": "DK0289009999910138",
"account": "DK0289009999910138",
"financialInstitution": "SXPYDKKKXXX",
"country": null
},
"vibanId": null,
"viban": null,
"instructedDate": "2021-10-11T00:00:00+00:00",
"debitAmount": {
"currency": "GBP",
"amount": 143.50
},
"debitValueDate": "2021-10-11T00:00:00+00:00",
"fxRate": null,
"instruction": {
"debtorAccount": {
"accountNumber": null,
"accountIban": "DK0289009999910138",
"account": "DK0289009999910138",
"financialInstitution": null,
"country": null
},
"debtorViban": null,
"debtorReference": "GBPEUR - Rejected 1633960571",
"debtorNarrativeToSelf": null,
"currencyOfTransfer": "EUR",
"amount": {
"currency": "GBP",
"amount": 143.50
},
"requestedExecutionDate": "2021-10-11T00:00:00+00:00",
"chargeBearer": "Sha",
"remittanceInformation": {
"line1": "Remittance Information",
"line2": "Remittance Information 2",
"line3": "",
"line4": ""
},
"creditorId": null,
"creditorAccount": {
"accountNumber": null,
"accountIban": "DE78512308006504202684",
"account": "DE78512308006504202684",
"financialInstitution": "WIREDEMMXXX",
"country": "DE"
},
"creditorName": "Creditor - EUR",
"creditorAddress": {
"line1": "Address 1",
"line2": "Address 2",
"line3": null
}
}
},
"transfer": null,
"creditorInformation": null
},
"possibleActions": [],
}
]
}Reversed
Checksum: omCWli/jqujrbchOIEw18Zkb9hcoJvPtGxMeCd4DvfA=,
Nonce: A/zhOsBsRB/zIf6y, AuthenticationTag: Oe0P37s3DqHROlsvQ8UpDA==
SubscriptionVersion: 1
{
"notifications": [
{
"subscriptionId": "604ec7dc-8df0-47ab-ad3c-2c49deedca63",
"subscriptionEventId": "10eee91f-6d5a-4f79-93d1-9ea92363f560",
"eventId": "1e4ed0d6-9b59-4518-a730-14e4b6ffd7d3",
"notificationType": "Reversed",
"timestamp": "2022-11-10T14:37:12.6186162Z",
"payment": {
"paymentId": "e4613417-7226-402d-87df-e24281c296b4",
"transactionReference": "010F101223140001",
"classification": "Own",
"subClassification": "Internal",
"isTraceable": false,
"status": "Reversed",
"processedTimestamp": "2022-11-10T14:53:51.0133333+00:00",
"latestStatusChangedTimestamp": "2022-11-11T14:53:51.0133333+00:00",
"booked": true,
"reversalBooked": true,
"return":null,
"errors": null,
"lastChangedTimestamp": "2022-11-10T14:37:10.280905+00:00",
"debtorInformation": {
"paymentBulkId": null,
"accountId": "9bc50077-6b7d-2504-14d1-e52c32063c2c",
"account": {
"accountNumber": "0000027802",
"accountIban": "DK1989000000010276",
"account": "DK1989000000010276",
"financialInstitution": "SXPYDKKKXXX",
"country": null
},
"vibanId": null,
"viban": null,
"instructedDate": "2021-10-11T00:00:00+00:00",
"debitAmount": {
"currency": "EUR",
"amount": 51.25
},
"debitValueDate": "2021-10-11T00:00:00+00:00",
"fxRate": null,
"instruction": {
"debtorAccount": {
"accountNumber": null,
"accountIban": "DK1989000000010276",
"account": "DK1989000000010276",
"financialInstitution": null,
"country": null
},
"debtorViban": null,
"debtorReference": null,
"debtorNarrativeToSelf": null,
"currencyOfTransfer": "EUR",
"amount": {
"currency": "EUR",
"amount": 51.25
},
"requestedExecutionDate": "2021-10-11T00:00:00+00:00",
"chargeBearer": "Sha",
"remittanceInformation": {
"line1": "Remittance Information",
"line2": "Remittance Information 2",
"line3": null,
"line4": null
},
"creditorId": null,
"creditorAccount": {
"accountNumber": null,
"accountIban": "DK0389000000010273",
"account": "DK0389000000010273",
"financialInstitution": "SXPYDKKKXXX",
"country": "DK"
},
"creditorName": "Beneficiary Name - SWIFT",
"creditorAddress": {
"line1": "Address 1",
"line2": "Address 2",
"line3": null
}
}
},
"transfer": {
"debtorAccount": {
"accountNumber": null,
"accountIban": "DK1989000000010276",
"account": "DK1989000000010276",
"financialInstitution": "SXPYDKKKXXX",
"country": null
},
"debtorName": "NAME 000012390",
"debtorAddress": {
"line1": "ADD1 000012390",
"line2": "ADD2 000012390",
"line3": "ADDR3 000012390"
},
"amount": {
"currency": "EUR",
"amount": 51.25
},
"valueDate": "2021-10-11T00:00:00+00:00",
"chargeBearer": "Sha",
"remittanceInformation": {
"line1": "Remittance Information",
"line2": "Remittance Information 2",
"line3": null,
"line4": null
},
"creditorAccount": {
"accountNumber": null,
"accountIban": "DK0389000000010273",
"account": "DK0389000000010273",
"financialInstitution": "SXPYDKKKXXX",
"country": "DK"
},
"creditorName": "Beneficiary Name - SWIFT",
"creditorAddress": {
"line1": "Address 1",
"line2": "Address 2",
"line3": null
}
},
"creditorInformation": null
},
"possibleActions": [],
}
]
}Missing funding
Checksum: omCWli/jqujrbchOIEw18Zkb9hcoJvPtGxMeCd4DvfA=,
Nonce: A/zhOsBsRB/zIf6y, AuthenticationTag: Oe0P37s3DqHROlsvQ8UpDA==
SubscriptionVersion: 1
{
"notifications": [
{
"subscriptionId": "e88fe373-5ec2-4b55-afae-999ddee668d5",
"subscriptionEventId": "b0b3d1f8-29ee-443d-a6e7-36e9ac692dec",
"eventId": "d0156ccc-a088-487a-b4d4-427601c0a817",
"notificationType": "MissingFunding",
"timestamp": "2022-11-08T11:18:05.7616423Z",
"payment": {
"paymentId": "577f164a-8fdb-44e1-939f-79733a0cf4de",
"transactionReference": null,
"classification": "Own",
"subClassification": "Internal",
"isTraceable": false,
"status": "MissingFunding",
"processedTimestamp": null,
"latestStatusChangedTimestamp": "2022-11-08T11:33:51.0133333+00:00",
"booked": null,
"reversalBooked": null,
"return":null,
"errors": [],
"lastChangedTimestamp": "2022-11-08T11:18:05.36+00:00",
"debtorInformation": {
"paymentBulkId": null,
"accountId": "8b72c9f9-4055-6d41-fccd-d3784155baa9",
"account": {
"accountNumber": "0000027806",
"accountIban": "DK5289000000012107",
"account": "DK5289000000012107",
"financialInstitution": "SXPYDKKKXXX",
"country": null
},
"vibanId": null,
"viban": null,
"instructedDate": "2021-05-05T00:00:00+00:00",
"debitAmount": {
"currency": "GBP",
"amount": 13.25
},
"debitValueDate": "2021-05-05T00:00:00+00:00",
"fxRate": null,
"instruction": {
"debtorAccount": {
"accountNumber": null,
"accountIban": "DK5289000000012107",
"account": "DK5289000000012107",
"financialInstitution": null,
"country": null
},
"debtorViban": null,
"debtorReference": "Test1667906279",
"debtorNarrativeToSelf": null,
"currencyOfTransfer": "EUR",
"amount": {
"currency": "GBP",
"amount": 13.25
},
"requestedExecutionDate": "2021-05-05T00:00:00+00:00",
"chargeBearer": "Sha",
"remittanceInformation": {
"line1": "Remittance Information",
"line2": "Remittance Information 2",
"line3": "",
"line4": ""
},
"creditorId": null,
"creditorAccount": {
"accountNumber": null,
"accountIban": "DK9289000000012066",
"account": "DK9289000000012066",
"financialInstitution": "SXPYDKKKXXX",
"country": "DK"
},
"creditorName": "Beneficiary Name - SWIFT",
"creditorAddress": {
"line1": "Address 1",
"line2": "Address 2",
"line3": null
}
}
},
"transfer": null,
"creditorInformation": null
},
"possibleActions": [],
}
]
}Payment Routing
| Routing Reason Code | Routing Reason |
|---|---|
| AB05 | TimeoutCreditorAgent |
| AB06 | TimeoutInstructedAgent |
| AB07 | OfflineAgent |
| AB08 | OfflineCreditorAgent |
| AB09 | ErrorCreditorAgent |
| AB10 | ErrorInstructedAgent |
| AG01 | TransactionForbidden |
| AG02 | InvalidBankOperationCode |
| AG09 | PaymentNotReceived |
| AG10 | AgentSuspended |
| AG11 | CreditorAgentSuspended |
| AM02 | NotAllowedAmount |
| AM14 | AmountExceedsAgreedLimit |
| CNOR | CreditorBankIsNotRegistered |
| DNOR | DebtorBankIsNotRegistered |
| DS0G | NotAllowedPayment |
| FF01 | InvalidFileFormat |
| FF10 | BankSystemProcessingError |
| MS02 | NotSpecifiedReasonCustomerGenerated |
| MS03 | NotSpecifiedReasonAgentGenerated |
| RR01 | MissingDebtorAccountOrIdentification |
| RR02 | MissingDebtorNameOrAddress |
| RR03 | MissingCreditorsNameOrAddress |
| RR04 | RegulatoryReason |
| TM01 | InvalidCutOffTime |
| Field | Possible values |
|---|---|
originalScheme | "SEPAINST" "SEPA" "T2" |
routedScheme | "SEPA" "T2" "CROSS-EUR, or possibly to T2" |
Checksum: omCWli/jqujrbchOIEw18Zkb9hcoJvPtGxMeCd4DvfA=,
Nonce: A/zhOsBsRB/zIf6y, AuthenticationTag: Oe0P37s3DqHROlsvQ8UpDA==
SubscriptionVersion: 1
{
"notifications": [
{
"subscriptionId": "6148eedb-d524-4c07-b5ce-621b61970171",
"subscriptionEventId": "d9d40213-3052-424e-8da5-0399981a1178",
"eventId": "df4319a9-12a1-48ee-ac6d-1a58a5c6b618",
"notificationType": "PaymentRouting",
"timestamp": "2024-12-13T11:39:21.1475064Z",
"payment": {
"paymentId": "84af34c5-ca88-4e4a-a0ed-d01a7f28bbf7", // uuid
"valueDate": "2024-12-13T00:00:00+00:00", // date-time | null
"debtorReference": "Test payment", // string | null
"remittanceInformation": { // object | null
"line1": "Test line1", // string | null
"line2": "Test line2", // string | null
"line3": "Test line3", // string | null
"line4": "Test line4" // string | null
},
"routingStatus": "Rerouted From scheme SEPAINST to scheme SCT due to 'DS0G - NotAllowedPayment'", // string | null
"originalScheme": "SEPAINST", // string | null
"routedScheme": "SCT", // string | null
"routingReasons": [ // array | null
{ // object
"code": "DS0G", // string
"reason": "NotAllowedPayment" // string
}
]
}
}
]
}Outgoing Direct Debit Pending Processing
Checksum: omCWli/jqujrbchOIEw18Zkb9hcoJvPtGxMeCd4DvfA=,
Nonce: A/zhOsBsRB/zIf6y, AuthenticationTag: Oe0P37s3DqHROlsvQ8UpDA==
SubscriptionVersion: 1
{
"notifications": [
{
"subscriptionId": "69468cd7-7998-4c44-863b-b3ef0d976151",
"subscriptionEventId": "199dcc59-4a69-400f-a7a0-0fedf30ce3f5",
"eventId": "0356ed64-b247-4862-9617-79b1a8f5ddc5",
"notificationType": "OutgoingDirectDebitPendingProcessing",
"timestamp": "2025-04-01T10:51:39.7917909Z",
"payment": {
"paymentId": "bdf86f98-3975-005d-46c8-f7e0e679bba5",
"transactionReference": "010F814250910006",
"concurrencyToken": "AAAAAO5vU48=",
"classification": "Outgoing",
"subClassification": "External",
"isTraceable": false,
"status": "PendingProcessing",
"processedTimestamp": null,
"latestStatusChangedTimestamp": "2025-04-01T10:50:05.928482+00:00",
"booked": null,
"reversalBooked": null,
"return": null,
"errors": [],
"lastChangedTimestamp": "2025-04-01T10:51:39.1233333+00:00",
"debtorInformation": {
"paymentBulkId": null,
"accountId": "17845ea8-b131-1d3b-84d7-05c001b2d5d1",
"account": {
"accountNumber": "0000027812",
"accountIban": "DK8089000000010245",
"account": "DK8089000000010245",
"financialInstitution": "SXPYDKKKXXX",
"country": null
},
"vibanId": null,
"viban": null,
"instructedDate": "2025-04-01T00:00:00+00:00",
"debitAmount": {
"currency": "EUR",
"amount": 67.91
},
"debitValueDate": "2025-04-02T00:00:00+00:00",
"fxRate": 0.83616273,
"instruction": {
"debtorAccount": {
"accountNumber": "0000010245",
"accountIban": null,
"account": "0000010245",
"financialInstitution": "SXPYDKKKXXX",
"country": null
},
"debtorViban": null,
"debtorReference": "401250003D397A",
"debtorNarrativeToSelf": "",
"currencyOfTransfer": "GBP",
"amount": {
"currency": "GBP",
"amount": 56.78
},
"requestedExecutionDate": "2025-04-02T00:00:00+00:00",
"chargeBearer": "Sha",
"remittanceInformation": {
"line1": "401250003D397A",
"line2": null,
"line3": null,
"line4": null
},
"creditorId": null,
"creditorAccount": {
"accountNumber": "40317401",
"accountIban": null,
"account": "40317401",
"financialInstitution": "//SC609242",
"country": "GB"
},
"creditorName": "BIRD 509251583",
"creditorAddress": null,
"instructedChargeBearer": "SHA",
"clearingNetwork": null,
"debtorName": null,
"debtorAddress": null,
"ultimateDebtorAccount": null,
"ultimateDebtorName": null,
"ultimateDebtorAddress": null,
"clientCustomerId": null
}
},
"transfer": null,
"creditorInformation": null,
"statusReasons": null,
"purposeCode": null,
"directDebitMandateId": "509251583",
"possibleActions": [
"Reject"
]
}
}
]
}Account Holder Verification
Successful match
{
"notifications": [
{
"subscriptionId": "8dc3cbdd-68f4-4bf5-95bb-1817d38324c7",
"subscriptionEventId": "1d02c704-c45a-42c8-8340-ebd1426d1f03",
"eventId": "0187f147-6587-4e30-9642-0ad9e1236474",
"notificationType": "AccountHolderVerification",
"timestamp": "2025-12-08T10:50:49.9866667Z",
"payment": {
"guid": "85d3bea6-e94f-429b-96e6-c3f54342f220",
"created": "2025-12-03T14:23:04.3833333Z",
"companyNumber": "000012354",
"verificationName": "Maria Silva",
"verificationType": "Personal",
"verificationAccount": {
"account": "PT50000100018763312236976",
"financialInstitution": "BGALPTTGXXX"
},
"userReference": "eTu1RBWXdXXuomF",
"status": "Succeeded",
"lastUpdated": "2025-12-03T14:23:05.5826095Z",
"result": {
"created": "2025-12-03T14:23:05.56Z",
"matchLevel": "Match"
}
}
}
]
}
Match error
{
"notifications": [
{
"subscriptionId": "8dc3cbdd-68f4-4bf5-95bb-1817d38324c7",
"subscriptionEventId": "1d02c704-c45a-42c8-8340-ebd1426d1f03",
"eventId": "0187f147-6587-4e30-9642-0ad9e1236474",
"notificationType": "AccountHolderVerification",
"timestamp": "2025-12-08T10:50:49.9866667Z",
"payment": {
"guid": "19b5c4e1-54e6-4e2a-b2e8-0e5a7f62af1d",
"created": "2025-12-08T10:50:49.9866667Z",
"companyNumber": "000012354",
"verificationName": "Maria Silva",
"verificationType": "Personal",
"verificationAccount": {
"account": "DK0389000000010079",
"financialInstitution": "SXPYDKKKXXX"
},
"userReference": "_Ike_FDc5aLLjwr",
"status": "Failed",
"lastUpdated": "2025-12-08T10:50:53.1229897Z",
"result": {
"created": "2025-12-08T10:50:53.1066667Z",
"matchLevel": "Error",
"reasonCode": "NOAP",
"description": "External_Error",
"detailedDescription": "Verification Check Not Possible or Validation Check is not applicable"
}
}
}
]
}
Agency & Correspondent Banking
AB/CB Outgoing payment processed
Checksum: omCWli/jqujrbchOIEw18Zkb9hcoJvPtGxMeCd4DvfA=,
Nonce: A/zhOsBsRB/zIf6y, AuthenticationTag: Oe0P37s3DqHROlsvQ8UpDA==
SubscriptionVersion: 1
{
"notifications": [
{
"subscriptionId": "0944149a-1234-48b0-a6e2-ebff3108685f",
"subscriptionEventId": "bcfb5826-abcd-4ecd-9a7b-13b3b9498d94",
"eventId": "0252c415-b40e-1234-ac9c-734e7d0a44b3",
"notificationType": "OutgoingPaymentProcessed",
"timestamp": "2024-11-22T11:32:09.1633333+00:00",
"payment": {
"paymentId": "76a809b5-ac8c-4195-8c70-ef8ffc80f0f1",
"transactionReference": "010F722243270001",
"concurrencyToken": "AAAAAJH0SMM=",
"classification": "Outgoing",
"subClassification": "External",
"isTraceable": true,
"status": "Processed",
"processedTimestamp": "2024-11-22T11:32:09.1633333+00:00",
"latestStatusChangedTimestamp": "2024-11-22T11:32:09.1633333+00:00",
"booked": true,
"reversalBooked": null,
"return": null,
"paymentRail": "SEPA (SCT Inst)",
"errors": [],
"lastChangedTimestamp": "2024-11-22T11:32:09.1633333+00:00",
"debtorInformation": {
"paymentBulkId": null,
"accountId": "fd293210-cec1-4110-3e6d-27279f87a983",
"account": {
"accountNumber": "0000027814",
"accountIban": "LU784080000000022101",
"account": "LU784080000000022101",
"financialInstitution": "SXPYDKKKXXX",
"country": null
},
"vibanId": null,
"viban": null,
"instructedDate": "2024-11-22T00:00:00+00:00",
"debitAmount": {
"currency": "EUR",
"amount": 114.00
},
"debitValueDate": "2024-11-22T00:00:00+00:00",
"fxRate": null,
"instruction": {
"debtorAccount": {
"accountNumber": null,
"accountIban": "LU784080000000022101",
"account": "LU784080000000022101",
"financialInstitution": "BPKOPLPWXXX",
"country": null
},
"debtorViban": null,
"debtorReference": "agency_banking_request",
"debtorNarrativeToSelf": null,
"currencyOfTransfer": "EUR",
"amount": {
"currency": "EUR",
"amount": 114.00
},
"requestedExecutionDate": "2024-11-22T00:00:00+00:00",
"chargeBearer": "Sha",
"remittanceInformation": {
"line1": "remittance_Informa+ion-Line/1",
"line2": "remittance_Informa+ion-Line/2",
"line3": "remittance_Informa+ion-Line/3",
"line4": null
},
"creditorId": null,
"creditorAccount": {
"account": "DE94100500006600046463",
"financialInstitution": "BELADEBEXXX",
"country": "DE"
},
"creditorName": "Creditor Beneficiary Name",
"creditorAddress": {
"line1": "creditor-address line/1",
"line2": "creditor-address line/2",
"line3": "creditor-address line/3"
},
"instructedChargeBearer": "SHA",
"clearingNetwork": null,
"debtorName": "Debtor name",
"debtorAddress": {
"line1": "Debtor address line 1",
"line2": "Debtor address line 2",
"line3": "Debtor address line 3"
},
"ultimateDebtorAccount": {
"account": "PL33102010263992000095314670",
"financialInstitution": "BPKOPLPWXXX",
"country": "PL"
},
"ultimateDebtorName": "Test name",
"ultimateDebtorAddress": {
"line1": "Ultimate debtor address line1",
"line2": "Ultimate debtor address line2",
"line3": "Ultimate debtor address line3"
},
"clientCustomerId": null
}
},
"transfer": {
"debtorAccount": {
"accountNumber": null,
"accountIban": "LU784080000000022101",
"account": "LU784080000000022101",
"financialInstitution": "BPKOPLPWXXX",
"country": "PL"
},
"debtorName": "Debtor name",
"debtorAddress": {
"line1": "Debtor address line 1",
"line2": "Debtor address line 2",
"line3": "Debtor address line 3"
},
"amount": {
"currency": "EUR",
"amount": 114.00
},
"valueDate": "2024-11-22T00:00:00+00:00",
"chargeBearer": "Sha",
"remittanceInformation": {
"line1": "remittance_Informa+ion-Line/1",
"line2": "remittance_Informa+ion-Line/2",
"line3": "remittance_Informa+ion-Line/3",
"line4": null
},
"additionalRemittanceInformation": null,
"creditorAccount": {
"accountNumber": null,
"accountIban": "DE94100500006600046463",
"account": "DE94100500006600046463",
"financialInstitution": "BELADEBEXXX",
"country": "DE"
},
"creditorName": "Creditor Beneficiary Name",
"creditorAddress": {
"line1": "creditor-address line/1",
"line2": "creditor-address line/2",
"line3": "creditor-address line/3"
},
"ultimateCreditorAccount": null,
"instructedChargeBearer": "SHA"
},
"creditorInformation": {
"accountId": "89b1b58d-0e35-21ef-3714-78f549b95e07",
"account": {
"accountNumber": "0000020044",
"accountIban": null,
"account": "0000020044",
"financialInstitution": "BELADEBEXXX",
"country": null
},
"vibanId": null,
"viban": null,
"creditAmount": {
"currency": "EUR",
"amount": 114.00
},
"creditValueDate": "2024-11-22T00:00:00+00:00",
"fxRate": null
},
"statusReasons": null,
"purposeCode": null,
"possibleActions": [
"Recall"
]
}
]
}AB/CB Incoming payment processed
Checksum: omCWli/jqujrbchOIEw18Zkb9hcoJvPtGxMeCd4DvfA=,
Nonce: A/zhOsBsRB/zIf6y, AuthenticationTag: Oe0P37s3DqHROlsvQ8UpDA==
SubscriptionVersion: 1
"notifications": [
{
"subscriptionId": "5a7f1e26-2533-1234-ab6e-b82fbb1173e9",
"subscriptionEventId": "db71b15e-3bd4-rfgh-9629-e92d5e81633f",
"eventId": "d85349f6-1b39-1234-b9f0-466e95c93cc9",
"notificationType": "IncomingPaymentProcessed",
"timestamp": "2024-10-29T09:43:02.34+00:00",
"payment": {
"paymentId": "22884374-ab8f-9c42-8caf-63915e014045",
"transactionReference": "010F752243030001",
"concurrencyToken": "AAAAAJHdQks=",
"classification": "Incoming",
"subClassification": "External",
"isTraceable": false,
"status": "Processed",
"processedTimestamp": "2024-10-29T09:43:02.34+00:00",
"latestStatusChangedTimestamp": "2024-10-29T09:43:02.34+00:00",
"booked": null,
"reversalBooked": null,
"return": null,
"paymentRail": "Crossborder",
"errors": [],
"lastChangedTimestamp": "2024-10-29T09:43:02.34+00:00",
"debtorInformation": null,
"transfer": {
"debtorAccount": {
"accountNumber": null,
"accountIban": "GB05REVO00996986465576",
"account": "GB05REVO00996986465576",
"financialInstitution": "REVOGB21XXX",
"country": "GB"
},
"debtorName": "Debtor name",
"debtorAddress": null,
"amount": {
"currency": "GBP",
"amount": 2610.84
},
"valueDate": "2024-10-29T00:00:00+00:00",
"chargeBearer": "Our",
"remittanceInformation": {
"line1": "Line 1",
"line2": null,
"line3": null,
"line4": null
},
"additionalRemittanceInformation": null,
"creditorAccount": {
"accountNumber": null,
"accountIban": "DK1089000000021981",
"account": "DK1089000000021981",
"financialInstitution": "SXPYDKKKXXX",
"country": "DK"
},
"creditorName": "Creditor name",
"creditorAddress": null,
"ultimateCreditorAccount": {
"accountNumber": null,
"accountIban": "CY28902000010000020101000195",
"account": "CY28902000010000020101000195",
"financialInstitution": "CARDCY2L",
"country": "CY"
},
"instructedChargeBearer": "OUR"
},
"creditorInformation": {
"accountId": "0c20f0c4-5393-acd4-16b0-9162820cd455",
"account": {
"accountNumber": null,
"accountIban": "DK1089000000021981",
"account": "DK1089000000021981",
"financialInstitution": "SXPYDKKKXXX",
"country": null
},
"vibanId": null,
"viban": null,
"creditAmount": {
"currency": "GBP",
"amount": 2610.84
},
"creditValueDate": "2024-10-29T00:00:00+00:00",
"fxRate": null
},
"statusReasons": null,
"purposeCode": null,
"possibleActions": []
},
}Agency Banking Whitelist Result
Checksum: omCWli/jqujrbchOIEw18Zkb9hcoJvPtGxMeCd4DvfA=,
Nonce: A/zhOsBsRB/zIf6y, AuthenticationTag: Oe0P37s3DqHROlsvQ8UpDA==
SubscriptionVersion: 1
{
"notifications": [
{
"payload": {
"requestId": "bfd349ea-4e24-4d59-afda-bcc820a82ff4",
"accounts": [
{
"status": "Success",
"errorDetails": null,
"action": "Add",
"scheme": "TIPS",
"ncc": "910001",
"iban": "GB88321591000110090000",
"accountNumber": "",
"accountType": "Personal",
"lei": "529900T8BM49AURSDO55",
"accountHolder": {
"primaryName": "John Doe0",
"secondaryName": "Jane Doe0",
"additionalName": "Jack Doe0"
},
"localId": null
}
]
},
"subscriptionId": "ad5be02e-37f7-48dd-99b2-65a8bdcc05bb",
"subscriptionEventId": "7c11be18-7da0-42ee-bdd9-67a5f5a63487",
"eventId": "bc3349ae-5e55-4b69-8915-4f59edcb214b",
"notificationType": "AgencyBankingWhitelistResult",
"timestamp": "2026-05-21T10:02:39.3170581Z"
}
]
}Cases
Case Events
Checksum: omCWli/jqujrbchOIEw18Zkb9hcoJvPtGxMeCd4DvfA=,
Nonce: A/zhOsBsRB/zIf6y, AuthenticationTag: Oe0P37s3DqHROlsvQ8UpDA==
SubscriptionVersion: 1
{
"notifications": [
{
"subscriptionId": "8dc3cbdd-68f4-4bf5-95bb-1817d38324c7",
"subscriptionEventId": "1d02c704-c45a-42c8-8340-ebd1426d1f03",
"eventId": "0187f147-6587-4e30-9642-0ad9e1236474",
"notificationType": "CasesEvents",
"timestamp": "2025-12-08T10:50:49.9866667Z",
"payment":
{
"eventType": "CASE_CREATED", //CASE_CLOSED
"caseId": "2dc3cbdd-68f4-4bf5-95bb-1817d38324c7",
"caseType": "RFI",
"status": "OPEN", //CLOSED
"deadline": "2025-12-03T14:23:05.5826095Z",
"links": {
"self": "/api/v1/cases/rfi/2dc3cbdd-68f4-4bf5-95bb-1817d38324c7"
}
}
}
]
}Updated 8 days ago