Skip to main content

Reconciliation

This route is used when you want to return data regarding Bank Reconciliation on a specific date. The response will contain data related to transfers made, as well as a summary of transactions (Paid and Refunded). If the date_created parameter is not passed in the request, the response will be from the last reconciliation operation recorded in our system.

It is possible to return only the bank transfer data or also the transactions using the optional parameter with_transactions.

POSTv3/conciliation

Request Body Params​

AttributeTypeDescription
date_createddateTimeReconciliation date in ISODateTime format. If not provided, returns the last reconciliation.
with_transactionsbooleanOptional parameter to also return transaction data, in addition to bank data.
pageint32Optional parameter for transaction pagination.
Default: 1
countint32Optional parameter to define the number of transactions per page.
Default: 10
Maximum: 1000
Warning

The ISODateTime format that Marlim expects is: YYYY-MM-DDTHH:mm:ssZ, for example: 2025-01-01T00:00:000Z. Something similar to the toISOString() method in Javascript (new Date().toISOString()).

Response Object​

PropertyTypeDescription
paid_transactions_amountint32Total amount in cents of paid transactions.
refunded_transactions_amountint32Total amount in cents of refunded transactions.
transfer_estimated_amountint32Estimated amount in cents of the transfer.
transfer_reference_datedateTransfer reference date in YYYY-MM-DD format.
transfersarrayArray of objects with the transfers made.
transfers[][transfer_id]int32Transfer ID.
transfers[][transfer_amount]int32Transfer amount in cents.
transfers[][transfer_type]stringTransfer type (e.g., ted).
transfers[][transfer_status]stringTransfer status.
transfers[][transfer_chargedback_owner_type]stringDefines who will be responsible for the chargeback. Possible values: marlim or seller
transfers[][transfer_bank_response]stringBank response about the transfer.
transfers[][transfer_date_created]dateTimeTransfer creation date in ISODateTime format.
transfers[][transfer_date_updated]dateTimeTransfer update date in ISODateTime format.
transfers[][transfer_funding_date]dateTimeTransfer settlement date in ISODateTime format.
transfers[][transfer_funding_estimated_date]dateTimeEstimated transfer settlement date in ISODateTime format.
paid_transactionsarrayArray of objects with paid transactions.
paid_transactions[][transaction_id]stringTransaction identifier number.
paid_transactions[][date_created]dateTimeTransaction creation date in ISODateTime format.
paid_transactions[][date_updated]dateTimeTransaction status update date in ISODateTime format.
paid_transactions[][paid_amount]int32Amount in cents captured in the transaction.
paid_transactions[][net_value]int32Amount in cents to be charged without acquiring fees.
paid_transactions[][installments]stringNumber of installments the customer paid in.
paid_transactions[][authorization_code]stringAuthorization code returned by the issuing bank.
paid_transactions[][nsu]stringCode that identifies the transaction in the acquirer.
paid_transactions[][item_id]stringTransaction ID in your platform.
paid_transactions[][customer_name]stringCustomer name.
paid_transactions[][customer_document_number]stringCustomer document number.
paid_transactions[][customer_email]stringCustomer email.
paid_transactions[][customer_phone_number]stringCustomer phone number.
paid_transactions[][card_brand]stringCard brand used in payment. Possible values: visa, mastercard, amex, hipercard and elo.
paid_transactions[][card_first_digits]stringFirst 6 digits of the card used in payment.
paid_transactions[][card_last_digits]stringLast 4 digits of the card used in payment.
paid_transactions[][card_expiration_date]stringCard expiration date. Numbers only in MMYY format.
paid_transactions[][payable_details]objectOptional field
Installment details only for non-anticipation.
paid_transactions[][payable_details][installment]stringCurrent installment referring to the transfer date.
paid_transactions[][payable_details][installment_value]stringAmount to be transferred to the bank account referring to the transaction amount.
paid_transactions[][payable_details][total_already_transferred]int32Total already transferred to the bank account referring to the transaction amount.
refunded_transactionsarrayArray of objects with refunded transactions.
refunded_transactions[][transaction_id]stringTransaction identifier number.
refunded_transactions[][date_created]dateTimeTransaction creation date in ISODateTime format.
refunded_transactions[][date_updated]dateTimeTransaction status update date in ISODateTime format.
refunded_transactions[][refunded_amount]int32Amount in cents refunded in the transaction.
refunded_transactions[][net_value]int32Amount in cents to be charged without acquiring fees.
refunded_transactions[][installments]stringNumber of installments the customer paid in.
refunded_transactions[][authorization_code]stringAuthorization code returned by the issuing bank.
refunded_transactions[][nsu]stringCode that identifies the transaction in the acquirer.
refunded_transactions[][item_id]stringTransaction ID in your platform.
refunded_transactions[][customer_name]stringCustomer name.
refunded_transactions[][customer_document_number]stringCustomer document number.
refunded_transactions[][customer_email]stringCustomer email.
refunded_transactions[][customer_phone_number]stringCustomer phone number.
refunded_transactions[][card_brand]stringCard brand used in payment. Possible values: visa, mastercard, amex, hipercard and elo.
refunded_transactions[][card_first_digits]stringFirst 6 digits of the card used in payment.
refunded_transactions[][card_last_digits]stringLast 4 digits of the card used in payment.
refunded_transactions[][card_expiration_date]stringCard expiration date. Numbers only in MMYY format.
paginationobjectObject with transaction pagination information.
pagination[page]int32Current query page.
pagination[count]int32Number of transactions per page.
pagination[paid_transactions]objectPaid transactions pagination information.
pagination[paid_transactions][total]int32Total paid transactions found.
pagination[paid_transactions][page]int32Current page of paid transactions.
pagination[paid_transactions][offset]int32Total number of pages of paid transactions.
pagination[refunded_transactions]objectRefunded transactions pagination information.
pagination[refunded_transactions][total]int32Total refunded transactions found.
pagination[refunded_transactions][page]int32Current page of refunded transactions.
pagination[refunded_transactions][offset]int32Total number of pages of refunded transactions.

Examples​

Request
curl -X POST "https://api.marlim.co/v3/conciliation" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
Response200
{
  "paid_transactions_amount": 3300000,
  "refunded_transactions_amount": 0,
  "transfer_estimated_amount": 3300000,
  "transfer_reference_date": "2023-06-22",
  "transfers": [
    {
      "transfer_amount": 3300000,
      "transfer_type": "ted",
      "transfer_status": "transferred",
      "transfer_chargedback_owner_type": "marlim",
      "transfer_bank_response": "Confirmed",
      "transfer_date_created": "2023-06-22T08:00:00.000Z",
      "transfer_date_updated": "2023-06-22T08:00:00.000Z",
      "transfer_funding_date": "2023-06-22T15:00:00.000Z",
      "transfer_funding_estimated_date": "2023-06-23T00:00:00.000Z",
      "transfer_id": 12345678
    }
  ],
  "paid_transactions": [],
  "refunded_transactions": [],
  "pagination": {
    "page": 1,
    "count": 10,
    "paid_transactions": {
      "total": 1,
      "page": 1,
      "offset": 1
    },
    "refunded_transactions": {
      "total": 1,
      "page": 1,
      "offset": 1
    }
  }
}