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
Atributo | Tipo | Descrição |
---|---|---|
date_created | dateTime | Data da conciliação no formato ISODateTime. Se não informado, retorna a última conciliação. |
with_transactions | boolean | Parâmetro opcional para retornar também os dados das transações, além dos dados bancários. |
page | int32 | Parâmetro opcional para paginação dos resultados. |
count | int32 | Parâmetro opcional para definir a quantidade de registros por página. Máximo: 100. |
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
Propriedade | Tipo | Descrição |
---|---|---|
paid_transactions_amount | int32 | Valor total em centavos das transações pagas. |
refunded_transactions_amount | int32 | Valor total em centavos das transações estornadas. |
transfer_estimated_amount | int32 | Valor estimado em centavos da transferência. |
transfer_reference_date | date | Data de referência da transferência no formato YYYY-MM-DD. |
transfers | array | Array de objetos com as transferências realizadas. |
transfers[][transfer_id] | int32 | ID da transferência. |
transfers[][transfer_amount] | int32 | Valor em centavos da transferência. |
transfers[][transfer_type] | string | Tipo da transferência (ex: ted). |
transfers[][transfer_status] | string | Status da transferência. |
transfers[][transfer_bank_response] | string | Resposta do banco sobre a transferência. |
transfers[][transfer_date_created] | dateTime | Data de criação da transferência no formato ISODateTime. |
transfers[][transfer_date_updated] | dateTime | Data de atualização da transferência no formato ISODateTime. |
transfers[][transfer_funding_date] | dateTime | Data de liquidação da transferência no formato ISODateTime. |
transfers[][transfer_funding_estimated_date] | dateTime | Data estimada de liquidação da transferência no formato ISODateTime. |
paid_transactions | array | Array de objetos com as transações pagas. |
paid_transactions[][transaction_id] | string | Número identificador da transação. |
paid_transactions[][date_created] | dateTime | Data de criação da transação no formato ISODateTime. |
paid_transactions[][date_updated] | dateTime | Data de atualização do status da transação no formato ISODateTime. |
paid_transactions[][paid_amount] | int32 | Valor em centavos capturado na transação. |
paid_transactions[][net_value] | int32 | Valor em centavos a ser cobrado sem as taxas de adquirência. |
paid_transactions[][installments] | string | Número de parcelas em que o cliente pagou. |
paid_transactions[][authorization_code] | string | Código de autorização retornado pelo banco emissor. |
paid_transactions[][nsu] | string | Código que identifica a transação na adquirente. |
paid_transactions[][item_id] | string | ID da transação na sua plataforma. |
paid_transactions[][customer_name] | string | Nome do cliente. |
paid_transactions[][customer_document_number] | string | Número do documento do cliente. |
paid_transactions[][customer_email] | string | E-mail do cliente. |
paid_transactions[][customer_phone_number] | string | Número do telefone do cliente. |
paid_transactions[][card_brand] | string | Bandeira do cartão utilizado no pagamento. Valores possíveis: visa , mastercard , amex , hipercard e elo . |
paid_transactions[][card_first_digits] | string | Primeiros 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] | string | Data de validade do cartão. Somente números no formato MMAA. |
refunded_transactions | array | Array de objetos com as transações estornadas. |
refunded_transactions[][transaction_id] | string | Número identificador da transação. |
refunded_transactions[][date_created] | dateTime | Data de criação da transação no formato ISODateTime. |
refunded_transactions[][date_updated] | dateTime | Data de atualização do status da transação no formato ISODateTime. |
refunded_transactions[][refunded_amount] | int32 | Valor em centavos estornado na transação. |
refunded_transactions[][net_value] | int32 | Valor em centavos a ser cobrado sem as taxas de adquirência. |
refunded_transactions[][installments] | string | Número de parcelas em que o cliente pagou. |
refunded_transactions[][authorization_code] | string | Código de autorização retornado pelo banco emissor. |
refunded_transactions[][nsu] | string | Código que identifica a transação na adquirente. |
refunded_transactions[][item_id] | string | ID da transação na sua plataforma. |
refunded_transactions[][customer_name] | string | Nome do cliente. |
refunded_transactions[][customer_document_number] | string | Número do documento do cliente. |
refunded_transactions[][customer_email] | string | E-mail do cliente. |
refunded_transactions[][customer_phone_number] | string | Número do telefone do cliente. |
refunded_transactions[][card_brand] | string | Bandeira do cartão utilizado no pagamento. Valores possíveis: visa , mastercard , amex , hipercard e elo . |
refunded_transactions[][card_first_digits] | string | Primeiros 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] | string | Data de validade do cartão. Somente números no formato MMAA. |
Exemplos
- Sem Data
- Com Data
- Com Transações Pagas
- Com Transações Pagas e Estornadas
curl -X POST "https://api.marlim.co/v3/conciliation" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
{
"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_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
}
]
}
curl -X POST "https://api.marlim.co/v3/conciliation" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
"date_created": "2023-06-22T00:00:00Z"
}'
{
"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_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
}
]
}
curl -X POST "https://api.marlim.co/v3/conciliation" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
"date_created": "2023-06-22T00:00:00Z",
"with_transactions": true
}'
{
"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_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": [
{
"transaction_id": "999777666",
"date_created": "2023-06-21T14:29:07.334Z",
"date_updated": "2023-06-21T14:31:07.334Z",
"paid_amount": 1100000,
"net_value": 1000000,
"installments": "3",
"authorization_code": "SW001",
"nsu": "123456789",
"item_id": "item_123",
"customer_name": "LUKE SKYWALKER",
"customer_document_number": "12345678900",
"customer_email": "luke@skywalker.com",
"customer_phone_number": "+5511999999999",
"card_brand": "visa",
"card_first_digits": "123456",
"card_last_digits": "2122",
"card_expiration_date": "1225"
},
{
"transaction_id": "999777667",
"date_created": "2023-06-21T15:29:07.334Z",
"date_updated": "2023-06-21T15:31:07.334Z",
"paid_amount": 1650000,
"net_value": 1500000,
"installments": "1",
"authorization_code": "SW002",
"nsu": "123456790",
"item_id": "item_456",
"customer_name": "HAN SOLO",
"customer_document_number": "98765432100",
"customer_email": "han@solo.com",
"customer_phone_number": "+5511888888888",
"card_brand": "mastercard",
"card_first_digits": "654321",
"card_last_digits": "8888",
"card_expiration_date": "0326"
},
{
"transaction_id": "999777668",
"date_created": "2023-06-21T16:29:07.334Z",
"date_updated": "2023-06-21T16:31:07.334Z",
"paid_amount": 880000,
"net_value": 800000,
"installments": "2",
"authorization_code": "SW003",
"nsu": "123456791",
"item_id": "item_789",
"customer_name": "LEIA ORGANA",
"customer_document_number": "45678912300",
"customer_email": "leia@organa.com",
"customer_phone_number": "+5511777777777",
"card_brand": "elo",
"card_first_digits": "987654",
"card_last_digits": "4444",
"card_expiration_date": "0625"
},
{
"+N": "..."
}
],
"refunded_transactions": []
}
curl -X POST "https://api.marlim.co/v3/conciliation" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
"date_created": "2023-06-22T00:00:00Z",
"with_transactions": true
}'
{
"paid_transactions_amount": 3300000,
"refunded_transactions_amount": 1100000,
"transfer_estimated_amount": 2200000,
"transfer_reference_date": "2023-06-22",
"transfers": [
{
"transfer_amount": 2200000,
"transfer_type": "ted",
"transfer_status": "transferred",
"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": [
{
"transaction_id": "999777666",
"date_created": "2023-06-21T14:29:07.334Z",
"date_updated": "2023-06-21T14:31:07.334Z",
"paid_amount": 1100000,
"net_value": 1000000,
"installments": "3",
"authorization_code": "SW001",
"nsu": "123456789",
"item_id": "item_123",
"customer_name": "LUKE SKYWALKER",
"customer_document_number": "12345678900",
"customer_email": "luke@skywalker.com",
"customer_phone_number": "+5511999999999",
"card_brand": "visa",
"card_first_digits": "123456",
"card_last_digits": "2122",
"card_expiration_date": "1225"
},
{
"transaction_id": "999777667",
"date_created": "2023-06-21T15:29:07.334Z",
"date_updated": "2023-06-21T15:31:07.334Z",
"paid_amount": 1650000,
"net_value": 1500000,
"installments": "1",
"authorization_code": "SW002",
"nsu": "123456790",
"item_id": "item_456",
"customer_name": "HAN SOLO",
"customer_document_number": "98765432100",
"customer_email": "han@solo.com",
"customer_phone_number": "+5511888888888",
"card_brand": "mastercard",
"card_first_digits": "654321",
"card_last_digits": "8888",
"card_expiration_date": "0326"
},
{
"+N": "..."
}
],
"refunded_transactions": [
{
"transaction_id": "999777668",
"date_created": "2023-06-21T15:29:07.334Z",
"date_updated": "2023-06-21T15:31:07.334Z",
"refunded_amount": 1100000,
"net_value": 1000000,
"installments": "3",
"authorization_code": "SW003",
"nsu": "987654321",
"item_id": "item_789",
"customer_name": "DARTH VADER",
"customer_document_number": "45678912300",
"customer_email": "darth@vader.com",
"customer_phone_number": "+5511777777777",
"card_brand": "visa",
"card_first_digits": "123456",
"card_last_digits": "2122",
"card_expiration_date": "1225"
},
{
"transaction_id": "999777669",
"date_created": "2023-06-21T16:29:07.334Z",
"date_updated": "2023-06-21T16:31:07.334Z",
"refunded_amount": 880000,
"net_value": 800000,
"installments": "2",
"authorization_code": "SW004",
"nsu": "987654322",
"item_id": "item_101",
"customer_name": "BOBA FETT",
"customer_document_number": "78912345600",
"customer_email": "boba@fett.com",
"customer_phone_number": "+5511666666666",
"card_brand": "mastercard",
"card_first_digits": "654321",
"card_last_digits": "8888",
"card_expiration_date": "0326"
},
{
"+N": "..."
}
]
}