Documentation V3
  • Localpayment documentation V3
  • INTRODUCTION TO OUR SOLUTION
    • Intro to our Documentation
    • Intro to Payment Methods in Emerging Markets
    • Merchant Dashboard
      • Dashboard Navigation
      • Login
      • User Roles
      • Roles
      • Users
      • Whitelist your IPs
      • Whitelist your BINs
      • Setup your Webhooks
      • Reports
        • Balance
        • Projected Balance
        • Activity
        • Transaction Detail
        • FIDES Report
      • Virtual accounts
      • Refunds
        • Refund Bank Transfer
        • Refund Card Capture
        • Refund Cash
      • Chargeback
      • Internal Domestic Transfer
      • Internal Foreign Transfer
      • Currency Exchange
        • Create
      • Wire In
      • Wire Out
    • Intro to FX operations
    • Business definitions
      • Payins
      • Payouts
    • Onboarding & Integration
    • Postman Collection
  • ENVIRONMENTS
    • Environments
  • BEFORE A PAYMENT
    • Access Token
    • Validations
      • Document Validation
      • Bank Account Validation
      • Validate BIN
    • Holidays
    • Search Payment Method
    • Search Bank Codes
    • Cash Agents Geolocalization
    • Installments Plan Quote
    • Currency Exchange Quote
    • Billing Service
      • Create
        • Mexico
      • Check Billing status
      • Download Billing
  • REQUEST A PAYMENT
    • Payins
      • Bank Transfer
        • Direct debit
          • DEBIN (Argentina)
          • Transfiya (Colombia)
          • Wallet Fri (Guatemala)
        • Virtual Account
          • Mexico
            • Request Individual
            • Request Batch
            • Check Virtual account
            • Delete Virtual account
            • Enable or Disable Virtual Account
          • Brazil
            • Request Individual
            • Check Virtual account
            • Alias ​​configuration
          • Argentina
            • Request Individual
            • Request Batch
            • Check virtual account
            • Delete Virtual account
          • Refund Virtual Account
        • Online Reference Code Payments
          • Mexico
        • Refund Bank Transfer
        • Cancel
        • APMs
          • CODI (Mexico)
          • ETPAY (Chile)
          • Fintoc (Chile)
          • Boleto (Brazil)
          • PIX (Brazil)
            • Refund Pix
          • PSE (Colombia)
          • QR (Bolivia)
          • QR (Guatemala)
          • QR (Argentina)
          • QR (Perú)
      • Cash
        • Cash
          • APMs
            • Boleto (Brazil)
        • Cancel
        • Refund Cash
      • Debit Card
        • Capture
        • Refund Capture
      • Credit Card
        • Capture
        • Create Authorization
        • Capture Authorization
        • Cancel Authorization
        • Refund Capture
        • Installments
        • Save Cards
          • Save Card
          • Get Card
          • Delete Card
        • 3D-Secure
        • Validate card
        • Chargebacks
          • Notification
          • Send documentation
          • Close Chargeback
    • Payin Subscriptions
      • Create a subscription
      • Update subscription
      • Cancel
    • Payin Subscriptions Plan
      • Create subscription plan
      • Update subscription plan
      • Get subscription plan
    • Payouts
      • Search available banks
      • Create
        • Argentina
        • Bolivia
        • Brazil
        • Chile
        • Colombia
          • Colombia ACH
          • Colombia Transfiya
        • Costa Rica
        • Dominic Republic
        • Guatemala
        • Honduras
        • Mexico
        • Panama
        • Peru
        • Kenya
      • Manual Upload
        • Create Batch Upload
        • Batch Pending Authorization
        • Cancel Batch Pending Authorization
        • Batch Activity
      • Proof of Payment (POP)
      • Cancel
      • Commit payout
      • Attach documents
      • Ripplenet getway
    • Payouts Double Signature
      • Authorize
    • Checkout
      • Webcheckout
        • Credit Card
        • Debit Card
        • Cash
        • Bank Transfer
      • Link Payment
      • Frequent Items
      • Iframe
      • Smart Checkout/ iframe
      • Virtual Pos
      • Plugins
        • Magento
        • Shopify
        • Google Pay
        • WooCommerce
  • AFTER A PAYMENT
    • Check Status
    • Check Payment
    • Check Payment list
    • Check Subscription
    • Account Balance
      • Balance Reconciliation
      • Current Balance Amount
    • Withholding Certificates
    • Proof of Payment
    • RFI - Documentation
  • SETTLEMENT & EXCHANGE
    • Wire In
    • Wire Out
    • Currency Exchange Bulk
      • Quote
      • Bulk
      • Currency exchange - Front end
    • Internal Transfers
      • Internal Domestic Transfer
      • Internal Foreign Transfer
  • NOTIFICATIONS
    • Callbacks - Webhooks
      • Configurations
      • Payins
        • Payin Bank Transfer
        • PSE Colombia
        • Payin Virtual Account
        • Payin Cash
        • Payin Credit Card
        • Payin Debit Card
      • Payouts
    • SFTP- Email Reports
  • API REFERENCE GUIDE
    • Validation Error Codes
    • Transaction Type & Status
      • Payin
      • Subscriptions
      • Payout
      • Chargeback
      • Credit
      • Currency Exchange
      • Debit
      • Expenses
      • Internal Transfer
      • Recall
      • Refund
      • Return
      • Recurring Fee
      • Wire in
      • Wire out
    • Payout Methods + SLA
      • Latam
    • Payin Methods + SLA
      • Argentina
      • Bolivia
      • Brazil
      • Chile
      • Colombia
      • Dominican Republic
      • Guatemala
      • Mexico
      • Panama
      • Peru
    • Currency Codes
      • Latam
    • Country Codes
      • Latam
    • Bank codes
      • Latam
        • Argentina
        • Bolivia
        • Brazil
        • Chile
        • Colombia
        • Costa Rica
        • Dominican Republic
        • Guatemala
        • Honduras
        • Mexico
        • Panamá
        • Peru
    • Bank account validations
      • Latam
        • Argentina
        • Bolivia
        • Brazil
        • Chile
        • Colombia
        • Costa Rica
        • Dominican Republic
        • Guatemala
        • Mexico
        • Panama
        • Peru
    • Document Validations
      • Argentina
      • Bolivia
      • Brazil
      • Chile
      • Colombia
      • Costa Rica
      • Dominican Republic
      • El Salvador
      • Guatemala
      • Honduras
      • Mexico
      • Panama
      • Peru
    • Concept Codes
  • FLOWS AND CHARACTERISTICS
    • Account Currencies
    • Involved Parties
    • Payin Status Flow
      • Payins
        • Payin Status Flow - Card
        • Payin Status Flow - Bank
        • Payin Status Flow -Cash
      • Refund - Card
      • Refund - Cash & Bank
      • Chargeback
    • Payout Status Flow
      • Payout - Bank
      • Return
      • Recall
    • Payin Subscription Flow
      • Payins Subscription Status Flow - Card
    • Virtual Account Status Flow
    • Settlement Status Flow
      • Wire In
      • Wire Out
    • Payin Methods Flow
      • Argentina
      • Bolivia
      • Brazil
      • Chile
      • Colombia
      • Dominican Republic
      • Guatemala
      • Honduras
      • Mexico
      • Panama
      • Peru
  • HOLIDAYS
    • 2021
    • 2022
    • 2023
    • 2024
    • 2025
  • COMPLIANCE
    • Values
    • Prohibited Countries
    • Prohibited Business
    • Compliance Program Docs
    • Licenses
    • Terms & Conditions
  • GLOSSARY
    • Payments Explained
    • FAQ
  • PLUGINS
    • Magento
    • Shopify
    • Google Pay
    • WooCommerce
    • Ripplenet
Powered by GitBook
On this page
  • Balance Reconciliation
  • Example with date range

Was this helpful?

  1. AFTER A PAYMENT
  2. Account Balance

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
}
{
    "detail": "You do not have permission to perform this action."
}

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}}'
{
    "data": [
        {
            "createdAt": "2024-09-16T03:19:07.313",
            "processedAt": "2024-09-16T14:40:17.110398",
            "settlementDate": "2024-09-16T14:40:17.110398",
            "settlementDays": 0,
            "internalId": "dcc874bd-4d07-484b-a0c1-910e8d45e6d9",
            "externalId": "1726456747",
            "providerId": "3495497",
            "clientCode": "0001",
            "providerCode": null,
            "accountCountry": "CHL",
            "accountNumber": "152.152.00000035",
            "clientName": "Acme Inc.",
            "providerName": null,
            "merchant": "Merchant Name",
            "clientAccountNumber": "152.152.00000035",
            "providerAccountNumber": "921316308",
            "transactionType": "PayOut",
            "paymentMethodType": "BankTransfer",
            "paymentMethodCode": "0050",
            "installments": 1,
            "status": "COMPLETED",
            "statusCode": "200",
            "statusDescription": "The payout was debited",
            "paymentCurrency": "CLP",
            "paymentAmount": 2530.0,
            "fxQuote": 1.0,
            "confirmedCurrency": "CLP",
            "confirmedAmount": -2530.0,
            "financialFeesCurrency": null,
            "financialFeesAmount": null,
            "feesCurrency": "CLP",
            "feesAmount": 14.0,
            "localTaxesCurrency": "CLP",
            "localTaxesAmount": 0.0,
            "withholdingsCurrency": null,
            "withholdingsAmount": null,
            "accountCurrency": "CLP",
            "accountAmount": -2544.0,
            "createdBy": "example@gmail.com",
            "newStatusChangeRequest": null,
            "request": {
                "beneficiary": {
                    "name": "Beneficiary Name ",
                    "lastname": "Beneficary LastName",
                    "type": "INDIVIDUAL",
                    "email": "",
                    "document": {
                        "id": "166033543",
                        "type": "RUT"
                    },
                    "merchant": null,
                    "bank": {
                        "name": "Banco Corpbanca",
                        "code": "028",
                        "account": {
                            "type": "C",
                            "number": "123456789012345",
                            "alias": ""
                        }
                    },
                    "informedName": null
                },
                "merchant": {
                    "name": "Merchant Name",
                    "lastname": null,
                    "type": "COMPANY"
                },
                "paymentMethod": {
                    "code": "0050",
                    "name": null,
                    "type": "BankTransfer",
                    "flow": "direct",
                    "brand": null
                },
                "comment": "",
                "country": "CHL",
                "currency": "CLP",
                "amount": 2530.0,
                "externalId": "1726456747",
                "conceptCode": "0001",
                "accountNumber": "152.152.00000035",
                "transactionType": "PayOut",
                "clientCode": "0001",
                "file": false,
                "internalLoteID": "6510"
            },
            "clientAccountCode": "ACME.CHL.CLP.02",
            "clientAccountDescription": null,
            "closingBalance": 94572477.0,
            "expirationAt": null,
            "loteout": "2199",
            "comment": "",
            "metaData": null,
            "internalLoteID": "6510",
            "pendingStatusChangeRequest": false
        },
        {
            "createdAt": "2024-09-16T04:00:17.897",
            "processedAt": "2024-09-16T14:40:22.825812",
            "settlementDate": "2024-09-16T14:40:22.825812",
            "settlementDays": 0,
            "internalId": "416528dc-66d7-4476-bd9f-f4218f9cee00",
            "externalId": "1726459218",
            "providerId": "3495500",
            "clientCode": "0001",
            "providerCode": null,
            "accountCountry": "CHL",
            "accountNumber": "152.152.00000035",
            "clientName": "Acme Inc.",
            "providerName": null,
            "merchant": "Merchant Name",
            "clientAccountNumber": "152.152.00000035",
            "providerAccountNumber": "921316308",
            "transactionType": "PayOut",
            "paymentMethodType": "BankTransfer",
            "paymentMethodCode": "0050",
            "installments": 1,
            "status": "COMPLETED",
            "statusCode": "200",
            "statusDescription": "The payout was debited",
            "paymentCurrency": "CLP",
            "paymentAmount": 3000.0,
            "fxQuote": 1.0,
            "confirmedCurrency": "CLP",
            "confirmedAmount": -3000.0,
            "financialFeesCurrency": null,
            "financialFeesAmount": null,
            "feesCurrency": "CLP",
            "feesAmount": 16.0,
            "localTaxesCurrency": "CLP",
            "localTaxesAmount": 0.0,
            "withholdingsCurrency": null,
            "withholdingsAmount": null,
            "accountCurrency": "CLP",
            "accountAmount": -3016.0,
            "createdBy": "example@gmail.com",
            "newStatusChangeRequest": null,
            "request": {
                "beneficiary": {
                    "name": "Beneficiary Name ",
                    "lastname": "Beneficary LastName",
                    "type": "INDIVIDUAL",
                    "email": "",
                    "document": {
                        "id": "166033543",
                        "type": "RUT"
                    },
                    "merchant": null,
                    "bank": {
                        "name": "Banco Corpbanca",
                        "code": "028",
                        "account": {
                            "type": "C",
                            "number": "123456789012345",
                            "alias": ""
                        }
                    },
                    "informedName": null
                },
                "merchant": {
                    "name": "Merchant Name",
                    "lastname": null,
                    "type": "COMPANY"
                },
                "paymentMethod": {
                    "code": "0050",
                    "name": null,
                    "type": "BankTransfer",
                    "flow": "direct",
                    "brand": null
                },
                "comment": "",
                "country": "CHL",
                "currency": "CLP",
                "amount": 3000.0,
                "externalId": "1726459218",
                "conceptCode": "0001",
                "accountNumber": "152.152.00000035",
                "transactionType": "PayOut",
                "clientCode": "0001",
                "file": false,
                "internalLoteID": "6515"
            },
            "clientAccountCode": "ACME.CHL.CLP.02",
            "clientAccountDescription": null,
            "closingBalance": 94569461.0,
            "expirationAt": null,
            "loteout": "2199",
            "comment": "",
            "metaData": null,
            "internalLoteID": "6515",
            "pendingStatusChangeRequest": false
        },
        {
            "createdAt": "2024-09-16T04:05:19.551",
            "processedAt": "2024-09-16T14:40:22.858364",
            "settlementDate": "2024-09-16T14:40:22.858364",
            "settlementDays": 0,
            "internalId": "ec73865f-5664-4a3b-8c18-060c85c0a733",
            "externalId": "1726459519",
            "providerId": "3495501",
            "clientCode": "0001",
            "providerCode": null,
            "accountCountry": "CHL",
            "accountNumber": "152.152.00000035",
            "clientName": "Acme Inc.",
            "providerName": null,
            "merchant": "Merchant Name",
            "clientAccountNumber": "152.152.00000035",
            "providerAccountNumber": "921316308",
            "transactionType": "PayOut",
            "paymentMethodType": "BankTransfer",
            "paymentMethodCode": "0050",
            "installments": 1,
            "status": "COMPLETED",
            "statusCode": "200",
            "statusDescription": "The payout was debited",
            "paymentCurrency": "CLP",
            "paymentAmount": 5000.0,
            "fxQuote": 1.0,
            "confirmedCurrency": "CLP",
            "confirmedAmount": -5000.0,
            "financialFeesCurrency": null,
            "financialFeesAmount": null,
            "feesCurrency": "CLP",
            "feesAmount": 959.0,
            "localTaxesCurrency": "CLP",
            "localTaxesAmount": 0.0,
            "withholdingsCurrency": null,
            "withholdingsAmount": null,
            "accountCurrency": "CLP",
            "accountAmount": -5959.0,
            "createdBy": "example@gmail.com",
            "newStatusChangeRequest": null,
            "request": {
                "beneficiary": {
                    "name": "Beneficiary Name ",
                    "lastname": "Beneficary LastName",
                    "type": "INDIVIDUAL",
                    "email": "",
                    "document": {
                        "id": "166033543",
                        "type": "RUT"
                    },
                    "merchant": null,
                    "bank": {
                        "name": "Banco Corpbanca",
                        "code": "028",
                        "account": {
                            "type": "C",
                            "number": "123456789012345",
                            "alias": ""
                        }
                    },
                    "informedName": null
                },
                "merchant": {
                    "name": "Merchant Name",
                    "lastname": null,
                    "type": "COMPANY"
                },
                "paymentMethod": {
                    "code": "0050",
                    "name": null,
                    "type": "BankTransfer",
                    "flow": "direct",
                    "brand": null
                },
                "comment": "",
                "country": "CHL",
                "currency": "CLP",
                "amount": 5000.0,
                "externalId": "1726459519",
                "conceptCode": "0001",
                "accountNumber": "152.152.00000035",
                "transactionType": "PayOut",
                "clientCode": "0001",
                "file": false,
                "internalLoteID": "6517"
            },
            "clientAccountCode": "ACME.CHL.CLP.02",
            "clientAccountDescription": null,
            "closingBalance": 94563502.0,
            "expirationAt": null,
            "loteout": "2199",
            "comment": "",
            "metaData": null,
            "internalLoteID": "6517",
            "pendingStatusChangeRequest": false
        }
    ],
    "total": 3,
    "offset": 0,
    "openingBalance": 94575021.0,
    "closingBalance": 94563502.0
}
{
    "status": 403,
    "reason": "You do not have permission to perform this action."
}
PreviousAccount BalanceNextCurrent Balance Amount

Last updated 4 months ago

Was this helpful?