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 conta bancária 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 sistema da Marlim.

Importante

Esse endpoint só irá retornar dados em PRODUÇÃO, ou seja, se for usado uma API Key de teste, o retorno será sempre o código 404 (Not Found).

GETv1/conciliation

Query Params

PropriedadeTipoDescrição
date_createddate-timeFiltro para a Data da Conciliação Bancária.
Atenção

O parâmetro date_created utiliza unixTimeStamp em milissegundos para representá-lo. Para gerar o unixTimeStamp de uma data, é possível utilizar o console do Google Chrome com o seguinte código em Javascript: new Date("2021-05-04T00:00:00.000Z").getTime() que retornará 1620086400000. Mesmo com o unixTimeStamp contendo data e hora, o importante nesse cenário é apenas a data 2021-05-04, podendo ser passado nesse caso qualquer horário entre 00:00:00 e 23:59:59 que será filtrado apenas o dia em questão.

Response Object

Ao buscar uma conciliação, este é o objeto que você recebe como resposta.

PropriedadeTipoDescrição
transfer_referece_datestringData de criação da conciliação no formato ISODate.
transfer_referece_date_timestampdate-timeData de criação da conciliação no formato Unix timestamp.
transfer_idstringNúmero identificador da conciliação.
typestringTipo da transação. Valores possíveis: ted, doc e credito_em_conta.
paid_transactions_amountint32Valor em centavos do somatório de todas as transações pagas (propriedade gross_amout).
refunded_transactions_amountint32Valor em centavos do somatório de todas as transações estornadas.
transfer_estimated_amountint32Valor em centavos do total a ser transferido para a conta. Resultado da subtração entre paid_transactions_amount e refunded_transactions_amount.
funding_estimated_datestringData e horas previstos para o depósito em conta corrente.
statusstringEstado no qual a transação se encontra. Valores possíveis: pending_transfer, transferred, failed, processing e canceled.
transactionsstringObjeto contendo os arrays de transaçãoes pagas (paid) e estornadas (refunded) referentes a conciliação da data específica.
TIP

O processo de conciliação financeira na Marlim ocorre de segunda-feira à sexta-feira (salvo feriados nacionais), no período das 12h00 às 12h30 (GMT-3). Se a sua aplicação tiver alguma rotina para buscar os dados de conciliação, sugerimos fazer esse processo após às 13h00 (GMT-3).

Exemplo

Request


  curl GET https://api.wu.marlim.co/v1/conciliation
  ?date_created=1620086400000
  --H "Content-Type": "application/json"
  --H "api_key": "api_key_value"
  --data-raw '{}'
Response
{
  "transfer_referece_date": "2021-05-04T00:00:00.000Z",
  "transfer_referece_date_timestamp": 1620086400000,
  "transfer_id": "12345678",
  "type": "ted",
  "paid_transactions_amount": 5000000,
  "refunded_transactions_amount": 0,
  "transfer_estimated_amount": 5000000,
  "funding_estimated_date": "2021-05-04T15:00:00.000Z",
  "status": "transferred",
  "transactions": {
    "refunded": [],
    "paid": [
      {
        "status": "paid",
        "authorization_code": "123456",
        "nsu": "111222333",
        "acquirer_response_code": "0000",
        "marlim_transaction_id": "111222333",
        "date_created": "2021-05-03T00:00:00.000Z",
        "payment_method": "credit",
        "installments": "3",
        "gross_amout": 100000,
        "authorized_amount": 104221,
        "paid_amount": 104221,
        "paid_per_month": 26055,
        "interest_rate": 1.04,
        "interest_rate_per_month": 1407,
        "interest_rate_total": 4221,
        "customer_name": "Luke Skywalker",
        "customer_document_number": "12345678900",
        "customer_email": "luke@jedimaster.sw",
        "customer_phone_number": "+18007770133",
        "card_brand": "visa",
        "card_last_digits": "4444",
        "card_holder_name": "Luke Skywalker",
        "wu_payment_type": "FX",
        "wu_agent_account_number": "EWOKS123",
        "wu_agent_operator_id": "001",
        "wu_agent_terminal_id": "A0BC",
        "wu_agent_pos_user_id": "123ABC"
      },
      {
        "status": "paid",
        "authorization_code": "234567",
        "nsu": "111222444",
        "acquirer_response_code": "0000",
        "marlim_transaction_id": "111222444",
        "date_created": "2021-05-03T01:00:00.000Z",
        "payment_method": "credit",
        "installments": "1",
        "gross_amout": 200000,
        "authorized_amount": 205233,
        "paid_amount": 205233,
        "paid_per_month": 205233,
        "interest_rate": 2.62,
        "interest_rate_per_month": 5233,
        "interest_rate_total": 5233,
        "customer_name": "Leia Skywalker Organa Solo",
        "customer_document_number": "12345678999",
        "customer_email": "leia@jedimaster.sw",
        "customer_phone_number": "+18007770144",
        "card_brand": "mastercard",
        "card_last_digits": "5555",
        "card_holder_name": "Leia S. O. Solo",
        "wu_payment_type": "MT",
        "wu_agent_account_number": "NABOO123",
        "wu_agent_operator_id": "002",
        "wu_agent_terminal_id": "B1CD",
        "wu_mt_transaction_id": "1112223334"
      },
      {
        "status": "paid",
        "authorization_code": "456789",
        "nsu": "111222555",
        "acquirer_response_code": "0000",
        "marlim_transaction_id": "111222555",
        "date_created": "2021-05-03T02:00:00.000Z",
        "payment_method": "credit",
        "installments": "8",
        "gross_amout": 500000,
        "authorized_amount": 544959,
        "paid_amount": 544959,
        "paid_per_month": 68120,
        "interest_rate": 1.08,
        "interest_rate_per_month": 5620,
        "interest_rate_total": 44959,
        "customer_name": "Lord Darth Vader",
        "customer_document_number": "1111222888",
        "customer_email": "vader@darklordofthesith.sw",
        "customer_phone_number": "+18007770555",
        "card_brand": "amex",
        "card_last_digits": "666",
        "card_holder_name": "Lord D. Vader",
        "wu_payment_type": "FX",
        "wu_agent_account_number": "IAMYOURFATHER999",
        "wu_agent_operator_id": "003",
        "wu_agent_terminal_id": "C2DE",
        "wu_agent_pos_user_id": "345DEF"
      },
      {
        "+N": "..."
      }
    ]
  }
}