Balance Reconciliation

This endpoint returns detailed information about all transactions in the completed state, along with their corresponding balances, within a specified time period.

Balance Reconciliation

GET https://api.stage.localpayment.com/api/accounts/:accountNumber/balance-reconciliation?since=:startDate&until=:endDate

Get the balance reconciliation report for a specific account number.

Path Parameters

Name
Type
Description

accountNumber*

string

Mandatory. Your account number.

since*

string

Mandatory. Start date in yyyy-mm-dd format.

until*

string

Mandatory. End date in yyyy-mm-dd format.

Headers

Name
Type
Description

Authorization*

string

Mandatory. BearerJWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication token.

{
    "data": [
        {
            "createdAt": "2024-08-16T15:23:12.425",
            "processedAt": "2024-08-16T16:50:38.253418",
            "settlementDate": "2024-08-16T16:50:38.253418",
            "settlementDays": 0,
            "internalId": "fd541a2b-1890-4631-a33c-843910ea69fu",
            "externalId": "7185e207-1d86-4670-a69f-2541e4c956c1",
            "providerId": "3494597",
            "clientCode": "0001",
            "providerCode": null,
            "accountCountry": "CHL",
            "accountNumber": "152.152.00000037",
            "clientName": "Acme Inc.",
            "providerName": null,
            "merchant": "Vita, null",
            "clientAccountNumber": "152.152.00000035",
            "providerAccountNumber": "example@LP.COM",
            "transactionType": "PayOut",
            "paymentMethodType": "BankTransfer",
            "paymentMethodCode": "0052",
            "installments": 1,
            "status": "COMPLETED",
            "statusCode": "200",
            "statusDescription": "The payout was debited",
            "paymentCurrency": "CLP",
            "paymentAmount": 15000.0,
            "fxQuote": 1.0,
            "confirmedCurrency": "CLP",
            "confirmedAmount": -15000.0,
            "financialFeesCurrency": null,
            "financialFeesAmount": null,
            "feesCurrency": "CLP",
            "feesAmount": 76.0,
            "localTaxesCurrency": "CLP",
            "localTaxesAmount": 0.0,
            "withholdingsCurrency": null,
            "withholdingsAmount": null,
            "accountCurrency": "CLP",
            "accountAmount": -15076.0,
            "createdBy": null,
            "newStatusChangeRequest": null,
            "request": {
                "beneficiary": {
                    "name": "Tati",
                    "lastname": "Aguirre",
                    "type": "INDIVIDUAL",
                    "email": "tatiana@gmail.com",
                    "document": {
                        "id": "8900960-k",
                        "type": "RUT"
                    },
                    "merchant": null,
                    "bank": {
                        "name": "Tati",
                        "code": "001",
                        "account": {
                            "type": "S",
                            "number": "1870282801",
                            "alias": ""
                        }
                    },
                    "informedName": null
                },
                "merchant": {
                    "name": "Netflix01",
                    "lastname": null,
                    "type": "INDIVIDUAL"
                },
                "paymentMethod": {
                    "code": "0052",
                    "name": null,
                    "type": "BankTransfer",
                    "flow": "direct",
                    "brand": null
                },
                "comment": "Example",
                "country": "CHL",
                "currency": "CLP",
                "amount": 15000.0,
                "externalId": "7185e207-1d86-4670-a69f-2541e4c956c0",
                "conceptCode": "0003",
                "accountNumber": "152.152.00000035",
                "transactionType": "PayOut",
                "clientCode": "0001",
                "file": false,
                "internalLoteID": "4337"
            },
            "clientAccountCode": "ACME.CHL.CLP.02",
            "clientAccountDescription": null,
            "closingBalance": 94590097.0,
            "expirationAt": null,
            "loteout": "2075",
            "comment": "Example",
            "metaData": null,
            "internalLoteID": "4337",
            "pendingStatusChangeRequest": false
        }
    ],
    "total": 1,
    "offset": 0,
    "openingBalance": 94605173.0,
    "closingBalance": 94590097.0
}

If a time period is not specified by providing both the since and until parameters, the request will not be processed, as these parameters are mandatory.

Example with date range

curl --location  \
--request GET '{{api_base_url}}/api/accounts/032.032.00000001/balance-reconciliation?since=2024-08-01&until=2024-08-16' \
--header 'Authorization: Bearer {{token}}'
PreviousAccount BalanceNextCurrent Balance Amount

Last updated