Pular para o conteúdo principal

Conciliação

Essa rota é utilizada quando se deseja retornar os dados referente a Conciliação Bancária em uma data específica. O response conterá os dados relacionados a transferências realizadas, bem como o resumo das transações (Pagas e Estornadas). Se o parâmetro date_created não for passado na request, o response será da última operação de conciliação gravada no nosso sistema.

É possível retornar somente os dados da transferência bancária ou também as transações utilizando o parâmetro opcional with_transactions.

POSTv3/conciliation

Request Body Params​

AtributoTipoDescrição
date_createddateTimeData da conciliação no formato ISODateTime. Se não informado, retorna a última conciliação.
with_transactionsbooleanParâmetro opcional para retornar também os dados das transações, além dos dados bancários.
pageint32Parâmetro opcional para paginação das transações.
Default: 1
countint32Parâmetro opcional para definir a quantidade de transações por página.
Default: 10
Máximo: 1000
Atenção

O formato ISODateTime que a Marlim espera é: YYYY-MM-DDTHH:mm:ssZ, por exemplo: 2025-01-01T00:00:000Z. Algo similar ao método toISOString() do Javascript (new Date().toISOString()).

Response Object​

PropriedadeTipoDescrição
paid_transactions_amountint32Valor total em centavos das transações pagas.
refunded_transactions_amountint32Valor total em centavos das transações estornadas.
transfer_estimated_amountint32Valor estimado em centavos da transferência.
transfer_reference_datedateData de referência da transferência no formato YYYY-MM-DD.
transfersarrayArray de objetos com as transferências realizadas.
transfers[][transfer_id]int32ID 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_chargedback_owner_type]stringDefine quem será responsável pelo chargeback. Valores possíveis: marlim ou seller
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 da transferência no formato ISODateTime.
paid_transactionsarrayArray de objetos com as transações pagas.
paid_transactions[][transaction_id]stringNúmero identificador da transação.
paid_transactions[][date_created]dateTimeData de criação da transação no formato ISODateTime.
paid_transactions[][date_updated]dateTimeData de atualização do status da transação no formato ISODateTime.
paid_transactions[][paid_amount]int32Valor em centavos capturado na transação.
paid_transactions[][net_value]int32Valor em centavos a ser cobrado sem as taxas de adquirência.
paid_transactions[][installments]stringNúmero de parcelas em que o cliente pagou.
paid_transactions[][authorization_code]stringCódigo de autorização retornado pelo banco emissor.
paid_transactions[][nsu]stringCódigo que identifica a transação na adquirente.
paid_transactions[][item_id]stringID da transação na sua plataforma.
paid_transactions[][customer_name]stringNome do cliente.
paid_transactions[][customer_document_number]stringNúmero do documento do cliente.
paid_transactions[][customer_email]stringE-mail do cliente.
paid_transactions[][customer_phone_number]stringNúmero do telefone do cliente.
paid_transactions[][card_brand]stringBandeira do cartão utilizado no pagamento. Valores possíveis: visa, mastercard, amex, hipercard e elo.
paid_transactions[][card_first_digits]stringPrimeiros 6 dígitos do cartão utilizado no pagamento.
paid_transactions[][card_last_digits]stringÚltimos 4 dígitos do cartão utilizado no pagamento.
paid_transactions[][card_expiration_date]stringData de validade do cartão. Somente números no formato MMAA.
paid_transactions[][payable_details]objectCampo opcional
Detalhes da parcela somente para não antecipação.
paid_transactions[][payable_details][installment]stringParcela atual referente à data da transferência.
paid_transactions[][payable_details][installment_value]stringValor que será transferido para a conta bancária referente ao montante da transação.
paid_transactions[][payable_details][total_already_transferred]int32Total que já foi transferido para a conta bancária referente ao montante da transação.
refunded_transactionsarrayArray de objetos com as transações estornadas.
refunded_transactions[][transaction_id]stringNúmero identificador da transação.
refunded_transactions[][date_created]dateTimeData de criação da transação no formato ISODateTime.
refunded_transactions[][date_updated]dateTimeData de atualização do status da transação no formato ISODateTime.
refunded_transactions[][refunded_amount]int32Valor em centavos estornado na transação.
refunded_transactions[][net_value]int32Valor em centavos a ser cobrado sem as taxas de adquirência.
refunded_transactions[][installments]stringNúmero de parcelas em que o cliente pagou.
refunded_transactions[][authorization_code]stringCódigo de autorização retornado pelo banco emissor.
refunded_transactions[][nsu]stringCódigo que identifica a transação na adquirente.
refunded_transactions[][item_id]stringID da transação na sua plataforma.
refunded_transactions[][customer_name]stringNome do cliente.
refunded_transactions[][customer_document_number]stringNúmero do documento do cliente.
refunded_transactions[][customer_email]stringE-mail do cliente.
refunded_transactions[][customer_phone_number]stringNúmero do telefone do cliente.
refunded_transactions[][card_brand]stringBandeira do cartão utilizado no pagamento. Valores possíveis: visa, mastercard, amex, hipercard e elo.
refunded_transactions[][card_first_digits]stringPrimeiros 6 dígitos do cartão utilizado no pagamento.
refunded_transactions[][card_last_digits]stringÚltimos 4 dígitos do cartão utilizado no pagamento.
refunded_transactions[][card_expiration_date]stringData de validade do cartão. Somente números no formato MMAA.
paginationobjectObjeto com informações de paginação das transações.
pagination[page]int32Página atual da consulta.
pagination[count]int32Quantidade de transações por página.
pagination[paid_transactions]objectInformações de paginação das transações pagas.
pagination[paid_transactions][total]int32Total de transações pagas encontradas.
pagination[paid_transactions][page]int32Página atual das transações pagas.
pagination[paid_transactions][offset]int32Número do total de páginas das transações pagas.
pagination[refunded_transactions]objectInformações de paginação das transações estornadas.
pagination[refunded_transactions][total]int32Total de transações estornadas encontradas.
pagination[refunded_transactions][page]int32Página atual das transações estornadas.
pagination[refunded_transactions][offset]int32Número do total de páginas das transações estornadas.

Exemplos​

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": "Confirmado",
      "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
    }
  }
}