3️⃣Gross_settlement_by_id

The GET/gross_settlement_by_id method retrieves detailed information about a specific gross settlement register. The id of the register must be provided in the request.

Endpoint

https://{bank-gateway-address.dcmapis.com}:443/api/v1/counterparty/{counterparty_guid}/gross-settlement/{gs_register_id}

Response

{
   "id": "string", - Register identifier
   "debtor_name": "string", - Name of the paying bank
   "debtor_bic": "string", - BIC of the paying bank
   "creditor_name": "string", - Name of the receiving bank
   "creditor_bic": "string", - BIC of the receiving bank
   "creditor_code": "string", - EDRPOU 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 Transparent Network
           "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 Transparent Network
           "debtor_iban": "string", - Payer's IBAN
           "debtor_agent_id": "string", - Payer bank identifier in Transparent Network
           "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
}

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.