5️⃣Gross_settlement_confirm

After receiving the payment execution status from the local payment rails (pacs.002), the Initiating Bank sends this information to the DCM platform using the POST/gross_settlement_confirm method.

Endpoint

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

Payload

{
    "payment_message_external_id": "string", - Payment identifier in the paying bank's system
    "creditor_iban": "string", - IBAN of the receiving bank
    "amount": 0.00, - Payment amount
    "currency": "string ENUM", - Payment currency
    "purpose": "string", - Payment purpose
    "creation_date": "string ISO-8601", - Payment creation date (in the paying bank's system)
    "status": "string ENUM" - Final status of the payment message from local payment rails provider
}

Response

<> ok.201.json  
{ 
"created": "true" 
}

 <> ok.208.json // payment id already registered 
{
"created": "true" 
}

<> error.408.json // request timeout 

<> wrong_data.409.json // wrong amount/purpose/currency/iban 

<> error.400.json // all another errors
{ 
"error": "ErrorTextId", 
"description": "Some reach description" 
}