Reconciliation

In internal transfers, reconciliation refers to the systematic process of matching and comparing transactions between different counterparties or financial institutions to ensure accuracy and consistency in recorded data. This process involves identifying discrepancies, errors, or missing information in transaction records, and then taking corrective actions to align the records and accounts, ultimately ensuring the smooth flow of funds and maintaining financial integrity between the participating entities.

Status model

Get reconciliation table

You can see all reconciliations for the counterparty that you need, you can also filter the table by using the parameters.

Get recons's table for bank.

get

Get recons's table for bank.

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Query parameters
counterparty_rolestring · enumRequired

Counterparty's role in recon

Possible values:
participant_counterparty_guidstringOptional

Participant's counterparty guid. If counterparty_role is one_of, then this param is ignored

guidstring[]Optional

recon's GUIDs

start_dateintegerOptional

Start date

end_dateintegerOptional

End date

asset_guidstringOptional

asset's guid

limitintegerOptional

Limit

offsetintegerOptional

Offset

orderstring · enumOptional

list order (string)

Possible values:
Responses
200
OK
application/json
get
GET /api/v1/counterparty/{counterparty_guid}/recons?counterparty_role=creditor HTTP/1.1
Host: your_host
Accept: */*

{
  "recons": [
    {
      "asset": {
        "asset_code": "text",
        "asset_guid": "text",
        "issuer": "text"
      },
      "calculations": {
        "amount_reserve_account": 1,
        "reserve_acc_currency": "text",
        "saldo": 1,
        "total_in": 1,
        "total_out": 1
      },
      "created_at": "text",
      "creditor": {
        "balance_after": 1,
        "balance_before": 1,
        "central_reserve": 1,
        "guid": "text",
        "is_blocked": true,
        "name": "text",
        "saldo": 1,
        "total_in": 1,
        "total_out": 1
      },
      "debtor": {
        "balance_after": 1,
        "balance_before": 1,
        "central_reserve": 1,
        "guid": "text",
        "is_blocked": true,
        "name": "text",
        "saldo": 1,
        "total_in": 1,
        "total_out": 1
      },
      "end_date": "text",
      "guid": "text",
      "overdue_days": 1,
      "start_date": "text",
      "status": "awaiting_payment",
      "updated_at": "text"
    }
  ],
  "total": 1
}

The parameter counterparty_role accepts the values:

  • debtor

  • creditor

Response example

Example of response with filter counterparty = creditor, status = calculated, order = created_at:

{
    "recons": [
        {
            "guid": "ab5767d9-1db8-445c-b48a-d1633ba85cda",
            "created_at": "2023-08-08T12:09:39.089306Z",
            "updated_at": "2023-08-08T12:09:42.986984Z",
            "start_date": "2023-08-08T00:00:00Z",
            "end_date": "2023-08-09T00:00:00Z",
            "overdue_days": 0,
            "status": "calculated",
            "creditor": {
                "guid": "7a0c6eef-b8f9-4049-affc-9c995a1bf993",
                "name": "Chok 1",
                "is_blocked": false,
                "participant_type": "",
                "central_reserve": 0,
                "balance_before": 0,
                "balance_after": 0
            },
            "debtor": {
                "guid": "01aec264-658c-4246-8afd-486f8878c3ee",
                "name": "",
                "is_blocked": false,
                "participant_type": "",
                "central_reserve": 0,
                "balance_before": 0,
                "balance_after": 0
            },
            "asset": {
                "asset_guid": "7170180d-11f3-4f92-942b-34a9ad4394d3",
                "asset_code": "UAH",
                "issuer": "GBWUVXEBXYAJITVDD6PEZAY4SBBEAOQFVPFJC4PKTWBNIZXSTSAH7LML"
            },
            "calculations": {
                "total_in": 10,
                "total_out": 40,
                "saldo": -30,
                "amount_reserve_account": 0,
                "reserve_acc_currency": ""
            }
        }
    ],
    "total": 1
}

Get Counterparty participants

To get the participants of reconciliation use this endpoint.

Get counterparty's participants

get

Get counterparty's participants

Path parameters
counterparty_guidstringRequired

Counterparty GUID of bank

Query parameters
counterparty_rolestring · enumRequired

Counterparty role

Possible values:
start_dateintegerOptional

Start date

end_dateintegerOptional

End date

asset_guidstringOptional

asset's guid

limitintegerOptional

Limit

offsetintegerOptional

Offset

orderstring · enumOptional

list order (string)

Possible values:
Responses
200
OK
application/json
get
GET /api/v1/counterparty/{counterparty_guid}/recons/participants?counterparty_role=creditor HTTP/1.1
Host: your_host
Accept: */*

{
  "participants": [
    {
      "balance_after": 1,
      "balance_before": 1,
      "central_reserve": 1,
      "guid": "text",
      "is_blocked": true,
      "name": "text",
      "saldo": 1,
      "total_in": 1,
      "total_out": 1
    }
  ],
  "total": 1
}

Update reconciliation status

Doing the reconciliation first of all you should get reconciliations's table for the counterparty with the filter status = calculated to see the reconciliations that you should confirm. If you are ready to confirm use this endpoint with parameterstatus = confirmed, and the status of reconciliation will change.

Update recon, only status update is allowed

put

Update recon, only status update is allowed

Path parameters
counterparty_guidstringRequired

Counterparty GUID

recon_guidstringRequired

Counterparty GUID

Body
statusstringOptional
Responses
200
OK
put
PUT /api/v1/counterparty/{counterparty_guid}/recons/{recon_guid} HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "status": "text"
}
No content
PreviousLimitsNext[optional] Branch

Last updated