The GET/gross_settlement_list method retrieves a list of all gross settlement registers where the bank acts as the Initiating Bank. The response can be customized using query parameters.
Endpoint:
Query parameters:
offset: The starting position in the list of registers for the response.
limit: The number of registers to include in the response.
period: The time range during which the registers were created. If this parameter is not provided, the information for the last 7 calendar days is displayed.
Dates and times are transmitted in the RFC3339 ISO 8601 standard, including the time zone.
Example: 2024-09-03T23:59:59Z03:00
For URL encoding purposes, the plus sign (+) is noted as %2B.
role: The role of the requesting bank with the following options:
All - Includes registers where the requesting bank is both the Initiating Bank and the Receiving Bank.
Debtor - Includes registers where the requesting bank is the Initiating Bank.
Response
{
"id": "STRING REGISTER_ID ddmmyy+increment_id", - Register ID
"debtor_bic": "string", - code of the paying bank
"debtor_name": "string", - Name of the paying bank
"creditor_bic": "string", - code of the receiving bank
"creditor_name": "string", - Name 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", - Total amount to be paid
"total_fee_amount": "string", - Total fee amount
"currency": "string", - Register currency
"status": "enum", - Register status
"created_at": "date", - Register creation date and time
"updated_at": "date", - Register update date and time
"deleted_at": "date" - Register deletion date and time
}
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.