DCM Platform Guide
  • 🌐DCM platform
  • ⚙️Specifics of working with the API
    • 🔐Security stack
    • 🔑Key Generation
    • 🔐Data encrypting
    • 🪃Retry policy
  • 🎨Design guide
  • 🗂️DCM platform's artifacts
  • 🏦Bank
    • 📋Preparing for integration
    • 🏪E-commerce
      • 📦Order and payment
      • 📨Payment message
        • 1️⃣Validation
        • 2️⃣Сallback 1 “Pay-in”
        • 3️⃣Callback 3 “Pay-out”
        • 4️⃣Callback 4 "Credit callback"
      • 🎯Testing
      • 🖇️Merchant Onboarding
      • ⛔Error reference guide
    • 🗃️Alias database
      • 🗝️Adding alias
      • ↕️"Сallback "Alias updated"
      • ☑️Get alias status
    • 💸p2p transfers
      • 📲p2p by phone number
        • ⏺️p2p order (to pay)
        • 🔍Receiver search
        • 🗂️Get receiver's data
        • ⏪Callback "Pay request"
      • 🖇️p2p by deeplink or QR code
        • ⏺️p2p order (to request)
        • Pay request initiation
      • 📨Payment message
        • 1️⃣Validation
        • 2️⃣Сallback “Pay-in”
        • 3️⃣Callback "Pay-out"
    • 💲Gross settlement
      • 1️⃣Callback “Gross_Settlement”
      • 2️⃣Gross_settlement_list
      • 3️⃣Gross_settlement_by_id
      • 4️⃣Gross_settlement_pay
      • 5️⃣Gross_settlement_confirm
      • 6️⃣Gross_settlement_confirm_internal
      • 📧Email notification
    • ✔️Reconciliation
  • 🏢Merchant
    • 🏫DCM platform for Merchants
      • 🔠Integration options
    • 👨‍🏫Preparing for integration
      • ⚙️Working with the API
      • 🔑Key Generation
      • 🖥️Updating interfaces
    • 🏪E-commerce
      • 📦Order
        • 💵Payment through the DCM platform
        • 💳Payment on the Merchant's website
        • 📋Emitters
        • 📬Order status
      • 1️⃣Сallback "Pay-in"
  • 📑Document data
    • 🆕Version history
    • 📃Change log
Powered by GitBook
On this page
  1. Bank
  2. Gross settlement

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.

PreviousGross settlementNextGross_settlement_list

Last updated 3 months ago

🏦
💲
1️⃣