Pular para o conteúdo principal

Conciliação do Parceiro

Use esta rota para consultar a conciliação de um parceiro em uma data específica: TEDs do dia, totais de transações pagas e estornadas e, opcionalmente, a lista dessas transações.

GETv3/financial/conciliation

Request Query Params​

AtributoTipoDescrição
sub_seller_idstringID do parceiro. Campo obrigatório.
date_createddateData da conciliação no formato YYYY-MM-DD. Campo obrigatório.
with_transactionsbooleanQuando true, inclui as listas paid_transactions e refunded_transactions. Padrão: false.
pageint32Página das listas de transações. Padrão: 1. Mínimo: 1.
countint32Quantidade de transações por página. Padrão: 10. Máximo: 1000.

Response Object​

AtributoTipoDescrição
paid_transactions_amountint32Soma em centavos de amount_to_receive das transações pagas do dia.
refunded_transactions_amountint32Soma em centavos de paid_amount das transações estornadas do dia.
transfer_estimated_amountint32Valor total transferido no dia, em centavos.
transfer_reference_datedateData de referência da conciliação no formato YYYY-MM-DD.
transfersarrayTransferências (TED) do dia.
transfers[][transfer_id]stringID da transferência.
transfers[][transfer_amount]int32Valor em centavos da transferência.
transfers[][transfer_type]stringTipo da transferência (ex: ted).
transfers[][transfer_status]stringStatus da transferência.
transfers[][transfer_bank_response]stringResposta do banco sobre a transferência.
transfers[][transfer_date_created]dateTimeData de criação da transferência no formato ISODateTime.
transfers[][transfer_date_updated]dateTimeData de atualização da transferência no formato ISODateTime.
transfers[][transfer_funding_date]dateTimeData de liquidação da transferência no formato ISODateTime.
transfers[][transfer_funding_estimated_date]dateTimeData estimada de liquidação no formato ISODateTime.
paid_transactionsarrayTransações pagas da página. Vazio quando with_transactions for false.
refunded_transactionsarrayTransações estornadas da página. Vazio quando with_transactions for false.
paginationobjectPaginação das listas de transações.
pagination[page]int32Página atual.
pagination[count]int32Quantidade de transações por página.
pagination[paid_transactions]objectPaginação das transações pagas.
pagination[paid_transactions][total]int32Total de transações pagas do dia.
pagination[paid_transactions][page]int32Página atual das transações pagas.
pagination[paid_transactions][offset]int32Total de páginas das transações pagas.
pagination[refunded_transactions]objectPaginação das transações estornadas.
pagination[refunded_transactions][total]int32Total de transações estornadas do dia.
pagination[refunded_transactions][page]int32Página atual das transações estornadas.
pagination[refunded_transactions][offset]int32Total de páginas das transações estornadas.

Objeto de transação​

Cada item de paid_transactions ou refunded_transactions contém:

AtributoTipoDescrição
transaction_idstringID Marlim da transação.
amount_to_receiveint32Valor a receber do parceiro naquela TED, em centavos.
date_createddateTimeData de criação da transação no formato ISODateTime.
date_updateddateTimeData de atualização da transação no formato ISODateTime.
installmentsstringNúmero de parcelas.
authorization_codestringCódigo de autorização da transação.
nsustringNúmero Sequencial Único da transação.
item_idstringIdentificador da transação na sua plataforma.
customer_namestringNome do cliente.
customer_document_numberstringDocumento do cliente.
customer_emailstringE-mail do cliente.
customer_phone_numberstringTelefone do cliente.
card_brandstringBandeira do cartão.
card_first_digitsstringPrimeiros dígitos do cartão.
card_last_digitsstringÚltimos dígitos do cartão.
card_expiration_datestringData de validade do cartão.
remaining_amountint32Campo opcional. Saldo remanescente da transação em centavos após alocações parciais em saques. Omitido quando a transação foi totalmente alocada ou ainda não participou de saque parcial.
paid_amountint32Valor pago em centavos. Presente em transações pagas.
refunded_amountint32Valor estornado em centavos. Presente em transações estornadas.
Exemplo de Response (sem transações)
{
  "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​

AtributoTipoDescrição
errorsarrayArray com todos os erros encontrados ao processar a requisição.
errors[][type]stringTipo de erro ocorrido.
errors[][message]stringMensagem detalhada do erro ocorrido.
Exemplo de erro
{
  "errors": [
    {
      "type": "sub_seller_id",
      "message": "The parameter [ sub_seller_id ] is missing."
    }
  ]
}

Exemplos​

ATENÇÃO

Os valores utilizados nos exemplos abaixo são apenas para ilustração e não devem ser usados para fazer requests nas APIs da Marlim.

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
    }
  }
}