Skip to main content

Partner Conciliation

Use this route to query a partner conciliation for a specific date: TEDs of the day, paid and refunded transaction totals, and optionally those transaction lists.

GETv3/financial/conciliation

Request Query Params​

AttributeTypeDescription
sub_seller_idstringPartner ID. Required field.
date_createddateConciliation date in YYYY-MM-DD. Required field.
with_transactionsbooleanWhen true, includes the paid_transactions and refunded_transactions lists. Default: false.
pageint32Page of the transaction lists. Default: 1. Minimum: 1.
countint32Transactions per page. Default: 10. Maximum: 1000.

Response Object​

AttributeTypeDescription
paid_transactions_amountint32Sum in cents of amount_to_receive for paid transactions of the day.
refunded_transactions_amountint32Sum in cents of paid_amount for refunded transactions of the day.
transfer_estimated_amountint32Total amount transferred on the day, in cents.
transfer_reference_datedateConciliation reference date in YYYY-MM-DD format.
transfersarrayTransfers (TED) of the day.
transfers[][transfer_id]stringTransfer ID.
transfers[][transfer_amount]int32Transfer amount in cents.
transfers[][transfer_type]stringTransfer type (e.g. ted).
transfers[][transfer_status]stringTransfer status.
transfers[][transfer_bank_response]stringBank response for 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 settlement date in ISODateTime format.
paid_transactionsarrayPaid transactions on this page. Empty when with_transactions is false.
refunded_transactionsarrayRefunded transactions on this page. Empty when with_transactions is false.
paginationobjectPagination of the transaction lists.
pagination[page]int32Current page.
pagination[count]int32Transactions per page.
pagination[paid_transactions]objectPagination of paid transactions.
pagination[paid_transactions][total]int32Total paid transactions of the day.
pagination[paid_transactions][page]int32Current page of paid transactions.
pagination[paid_transactions][offset]int32Total pages of paid transactions.
pagination[refunded_transactions]objectPagination of refunded transactions.
pagination[refunded_transactions][total]int32Total refunded transactions of the day.
pagination[refunded_transactions][page]int32Current page of refunded transactions.
pagination[refunded_transactions][offset]int32Total pages of refunded transactions.

Transaction object​

Each item in paid_transactions or refunded_transactions contains:

AttributeTypeDescription
transaction_idstringMarlim transaction ID.
amount_to_receiveint32Amount the partner receives on that TED, in cents.
date_createddateTimeTransaction creation date in ISODateTime format.
date_updateddateTimeTransaction update date in ISODateTime format.
installmentsstringNumber of installments.
authorization_codestringTransaction authorization code.
nsustringUnique Sequential Number of the transaction.
item_idstringTransaction identifier on your platform.
customer_namestringCustomer name.
customer_document_numberstringCustomer document.
customer_emailstringCustomer email.
customer_phone_numberstringCustomer phone number.
card_brandstringCard brand.
card_first_digitsstringFirst digits of the card.
card_last_digitsstringLast digits of the card.
card_expiration_datestringCard expiration date.
remaining_amountint32Optional field. Remaining transaction balance in cents after partial allocations in withdrawals. Omitted when the transaction was fully allocated or has not yet participated in a partial withdrawal.
paid_amountint32Paid amount in cents. Present on paid transactions.
refunded_amountint32Refunded amount in cents. Present on refunded transactions.
Example Response (without transactions)
{
  "paid_transactions_amount": 1650000,
  "refunded_transactions_amount": 0,
  "transfer_estimated_amount": 1650000,
  "transfer_reference_date": "2026-08-26",
  "transfers": [
    {
      "transfer_id": "12345678",
      "transfer_amount": 1650000,
      "transfer_type": "ted",
      "transfer_status": "transferred",
      "transfer_bank_response": "Confirmado",
      "transfer_date_created": "2026-08-26T08:00:00.000Z",
      "transfer_date_updated": "2026-08-26T08:00:00.000Z",
      "transfer_funding_date": "2026-08-26T15:00:00.000Z",
      "transfer_funding_estimated_date": "2026-08-27T00:00:00.000Z"
    }
  ],
  "paid_transactions": [],
  "refunded_transactions": [],
  "pagination": {
    "page": 1,
    "count": 10,
    "paid_transactions": {
      "total": 1,
      "page": 1,
      "offset": 1
    },
    "refunded_transactions": {
      "total": 0,
      "page": 1,
      "offset": 0
    }
  }
}

Error Object​

AttributeTypeDescription
errorsarrayArray with all errors found while processing the request.
errors[][type]stringType of error that occurred.
errors[][message]stringDetailed message of the error that occurred.
Example error
{
  "errors": [
    {
      "type": "sub_seller_id",
      "message": "The parameter [ sub_seller_id ] is missing."
    }
  ]
}

Examples​

ATTENTION

The values used in the examples below are for illustration only and must not be used to make requests to Marlim APIs.

Request
curl -X GET -G "https://api.marlim.co/v3/financial/conciliation" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d sub_seller_id="sub_k4m6Rw5rlQszEY7fiuRe" \ 
-d date_created="2026-08-26"
Response200
{
  "paid_transactions_amount": 1650000,
  "refunded_transactions_amount": 0,
  "transfer_estimated_amount": 1650000,
  "transfer_reference_date": "2026-08-26",
  "transfers": [
    {
      "transfer_id": "12345678",
      "transfer_amount": 1650000,
      "transfer_type": "ted",
      "transfer_status": "transferred",
      "transfer_bank_response": "Confirmado",
      "transfer_date_created": "2026-08-26T08:00:00.000Z",
      "transfer_date_updated": "2026-08-26T08:00:00.000Z",
      "transfer_funding_date": "2026-08-26T15:00:00.000Z",
      "transfer_funding_estimated_date": "2026-08-27T00:00:00.000Z"
    }
  ],
  "paid_transactions": [],
  "refunded_transactions": [],
  "pagination": {
    "page": 1,
    "count": 10,
    "paid_transactions": {
      "total": 1,
      "page": 1,
      "offset": 1
    },
    "refunded_transactions": {
      "total": 0,
      "page": 1,
      "offset": 0
    }
  }
}