Debit Request Created
This chapter provides an in-depth overview of the DebitRequestCreated notification message, which is published when a Debit Request is created in the system.
Notification Overview
Headers of the DebitRequestCreated Notification
The following table lists the headers in the DebitRequestCreated notification:
| Header | Description | Value |
|---|---|---|
X-Ocs-Io-transaction-id |
ID of the transaction. |
|
X-Ocs-Io-notification-code |
Code of the Notification. |
|
X-Ocs-Io-notification-payload |
Name (JAVA’s Simple Name) of the Notification’s Payload. |
|
Fields of the DebitRequestCreated Notification Payload
The following table lists and describes the fields in the DebitRequestCreated notification payload:
| Field | Description |
|---|---|
effectiveDate |
Effective Date/Time of the Notification. |
account |
ID (Ref ID / External ID) of the Account. |
documentNo |
Number of the document (generated by RM module). |
externalDocumentNo |
External number of the document (generated by external system, e.g. OCS). |
documentSource |
Source of the Document |
documentType |
Type of the Document.. |
currency |
Currency of the Document. |
amount |
Amount of the Debit Request |
requestDueDate |
Due date of the due amount. |
requestPlannedDate |
Date/Time when Debit Request is planned for processing. |
paymentRef1 |
Payment Reference No.1 associated with the Payment. |
paymentRef2 |
Payment Reference No.2 associated with the Payment. |
paymentRef3 |
Payment Reference No.3 associated with the Payment. |
channelType |
Type of channel (e.g. card, direct debit, etc.). |
bankAccountNumberDirectDebit |
Payer’s (Billing Account) bank account number, including prefix, without bank number code for Direct debit. |
bankNumberCodeDirectDebit |
Payer’s (Billing Account) bank number code for Direct Debit. |
| Detailed API documentation and endpoint specifics are available here. |