Callback “Gross_Settlement”
The DCM platform regularly sends a callback in JWT format, as per the current schedule—once a day at 00:01 AM. The callback is delivered to both the Initiating Bank and the Receiving Bank.
Endpoint:
https://{bank-callback-route}:443/{gross_settlement_URI}
Payload сallback
{
"id": "string", - Register identifier
"debtor_name": "string", - Name of the paying bank
"debtor_bic": "string", - code of the paying bank
"creditor_name": "string", - Name of the receiving bank
"creditor_bic": "string", - code of the receiving bank
"creditor_code": "string", - tax code of the receiving bank
"charging_account": "string", - IBAN of the receiving bank for gross payments
"purpose": "string", - Payment purpose
"period_start": "date", - Start date of the register period
"period_end": "date", - End date of the register period
"total_amount": "string", - Total register amount
"total_amount_to_pay": "string", - Register amount to be paid
"total_fee_amount": "string",- Total fee amount
"currency": "string", - Currency of the register
"status": "enum", - Status of the register
"payments": [
{
"payment_message_external_id": "string", - Payment identifier in the paying bank's system
"payment_message_guid": "string", - Payment message identifier in DCM platform
"pm_type": "enum", - Type of payment (enum: trade/p2p/return/aid)
"amount": "string", - Payment amount
“fee_amount”: "string" - Commission amount
“amount_to_pay”:"string" - Payment amount minus the commission amount
"issuer_fee":"string" - Commission
"currency": "string", - Payment currency
"purpose": "string", - Payment purpose
"recipient_iban": "string", - Recipient's IBAN
"recipient_agent_id": "string", - Recipient bank identifier in DCM platform
"debtor_iban": "string", - Payer's IBAN
"debtor_agent_id": "string", - Payer bank identifier in DCM platform
"register_id": "string", - Register number containing payment information
"created_at": "date" - Date and time the payment was created
}
],
"created_at": "date", - Date and time the register was created
"updated_at": "date", - Date and time the register was last updated
"deleted_at": "date" - Date and time the register was deleted
}
Response:
<> ok.201json
{
"created": "true"
}
<> error.400.json
{
"error": "ErrorTextId",
"description": "Error description"
}
Status Reference:
Sent: The register has been sent to the bank.
Sent (no PM): An "empty" register (no payment messages) has been sent to the bank.
Sent (Interbank): An "internal" register (where the Initiating Bank and Receiving Bank are the same institution) has been sent to the bank.
Processing: Payment for the gross settlement register has been sent to the local payment rails (pacs.008).
Paid: Payment for the gross settlement register has been successfully processed via local payment rails (pacs.002) or funds have been transferred for internal registers.
Last updated