Por meio desta API é possível fazer o download do arquivo de vendas.
O arquivo de vendas é gerado com os eventos do dia anterior que geraram lançamentos. Utilizado para fazer o batimento de vendas e do sistema do cliente com o Moip e para obter o fluxo de caixa previsto.
Para obter o arquivo, primeiramente será necessário fazer uma request na API de conciliação e baixar o arquivo através do link retornado na response.
IMPORTANTE
Por padrão, a Conciliação está desabilitada em sua conta Moip de produção.
Não é possível usá-la em ambiente sandbox.
O período máximo de consulta é dos últimos 180 dias.
Para ter acesso à Conciliação em sua conta, por favor, entre em contato com [email protected]
Atributos da Response
Nome | Descrição | Detalhes |
|---|---|---|
| Id identificador do arquivo. | string(16) |
| Tipo do arquivo. Valores possíveis: | string(16) |
| Data de referencia do arquivo (mesma data informada na URL da requisição) | date(AAAA-MM-DD) |
| Link do arquivo. | structured |
├─ | Link para download do arquivo | link |
Atributos do Arquivo
Nome | Descrição | Detalhes |
|---|---|---|
| Data e hora da geração do arquivo. | date |
| Estrutura com as autorizações de pagamento | structured |
├─ | Resumo. | structured |
├─├─ | Número de eventos de autorização. | integer |
├─├─ | Valor total dos eventos de autorização. | integer |
└─└─ | Lista com os eventos do tipo | list Resources |
| Estrutura com os reembolsos de pagamento. | structured |
├─ | Resumo. | structured |
├─├─ | Número de eventos de reembolso. | integer |
├─├─ | Valor total dos eventos de reembolso. | integer |
└─└─ | Lista com os eventos do tipo | list Resources |
| Estrutura com os chargebacks. | structured |
├─ | Resumo. | structured |
├─├─ | Número de eventos de reembolso. | integer |
├─├─ | Valor total dos eventos de reembolso. | integer |
└─└─ | Lista com os eventos do tipo | list Resources |
Os atributos contidos dentro do array
resourcesseguem o padrão de response dos GETs do recurso Payments.
Exemplo de Arquivo de Vendas
{
"id":"REC-6THY3VYLJUKI",
"createdAt":"2018-12-15T01:21:17.604-02",
"type":"SALES",
"authorizedPayments":{
"summary":{
"count":7202, //Número de eventos de autorização.
"amount":82612486 //Valor total dos eventos de autorização.
},
"resources":[ //Lista com os eventos do tipo PAYMENT.AUTHORIZED
{
"id":"PAY-Z86PHFZHFYHT",
"status":"AUTHORIZED", //Status do pagamento
"delayCapture":false, //Pagamento pré-autorizado (true/false)
"amount":{
"total":15091,
"gross":15091,
"fees":1507,
"refunds":0, //Reembolso
"liquid":13584,
"currency":"BRL"
},
"installmentCount":2, //Número de parcelas
"statementDescriptor":"Minha Loja",
"fundingInstrument":{
"creditCard":{
"id":"CRC-4UYHH8MLCDB54",
"brand":"MASTERCARD", //Bandeira do cartão
"first6":"548376",
"last4":"1784",
"store":true,
"holder":{ //Dados do portador do cartão
"birthdate":"1991-06-26",
"birthDate":"1991-06-26",
"taxDocument":{
"type":"CPF",
"number":"14887765500"
},
"billingAddress":{ //Endereço de cobrança do cartão
"street":"Rua Maestro Villa Lobos",
"streetNumber":"100",
"complement":"",
"district":"Centro",
"city":"São Paulo",
"state":"RJ",
"country":"BR",
"zipCode":"020050100"
},
"fullname":"Marcus Santos"
}
},
"method":"CREDIT_CARD" //Método de pagamento
},
"acquirerDetails":{ //Dados da adquirente
"authorizationNumber":"004438",
"taxDocument":{
"type":"CNPJ",
"number":"01011119000292"
}
},
"fees":[ //Taxas
{
"type":"TRANSACTION",
"amount":753
},
{
"type":"PRE_PAYMENT",
"amount":754
}
],
"events":[
{
"type":"PAYMENT.AUTHORIZED",
"createdAt":"2018-12-14T00:00:23.000-02"
}
],
"receivers":[ //Recebedores do split
{
"moipAccount":{
"id":"MPA-645E822U822B",
"login":"[email protected]",
"fullname":"Maria Silva"
},
"type":"PRIMARY",
"amount":{
"total":13992,
"currency":"BRL",
"fees":1507,
"refunds":0
},
"feePayor":true //Pagador da tarifa Moip (true/false)
},
{
"moipAccount":{
"id":"MPA-7000YT6K9876",
"login":"vendassa",
"fullname":"Vendas SA"
},
"type":"SECONDARY",
"amount":{
"total":1099,
"currency":"BRL",
"fees":0,
"refunds":0
},
"feePayor":false
}
],
"_links":{
"self":{
"href":"https://api.moip.com.br/v2/payments/PAY-Z86PHFZHFYHT"
},
"order":{
"href":"https://api.moip.com.br/v2/orders/ORD-JUHJEFTFEE0U",
"title":"ORD-JUHJEFTFEE0U"
}
},
"createdAt":"2018-12-14T00:00:13.000-02",
"updatedAt":"2018-12-14T00:00:23.000-02"
}
]
}
}