Cappta Documentação

Suggest Edits

Introdução

 

Bem vindo a documentação oficial da API Conciliação.

O Endereço da api é:

https://conciliacao-api.cappta.com.br/api/v1/

Com ele você consegue consultar todas as vendas e recebimentos de uma loja sem precisar manipular arquivos ultrapassados com diversos layouts e outras complexidades, já fazemos esse trabalho para você! :)

Através dele, você consegue responder:

1) Quando a loja irá receber o que foi vendido?
2) Quanto a loja irá receber?
3) A adquirente está pagando tudo que é devido?
4) A adquirente está pagando na taxa acordada?

Entre em contato conosco através do homologacao@cappta.com.br para obter a sua chave de autenticação!

Suggest Edits

Autenticação

 

Todas as requisições que forem feitas, é necessário adicionar o header Api-Key com o valor da sua chave de autenticação.
Exemplo:

Api-Key : minhaApiKey
Suggest Edits

Parâmetros de Busca

 

Os parâmetros de busca disponíveis são:

Nome Descrição
initialDate data inicial das vendas
finalDate data final das vendas
saleDate data da venda
receiptDate data do recebimento
NSU número do NSU da venda
initialUpdateDate data inicial da atualização das vendas
finalUpdateDate data final da atualização das vendas

Ex:

/sales/00000000000000?NSU=001517&saleDate=01-05-2017
Suggest Edits

Parcelas de Vendas

 

O endpoint de vendas é o :

/sales

Nele você consegue buscar todas as parcelas de vendas de um CNPJ, já com a previsão de quando cada parcela irá ser paga.

Suggest Edits

Buscando Parcelas de Vendas

 

Para realizar uma consulta, é só consultar o endpoint de vendas, passando o CNPJ e filtrando através de queryString conforme desejado.

Exemplo:

/sales/0000000000000?initialDate=20/05/2017&finalDate=20/06/2017

Ao realizar a consulta acima, será retornado todas as vendas do CNPJ 000000000000 que a data da venda esteja entre os dias 20/05/2017 até 20/06/2017.

Suggest Edits

Resposta Vendas

 

O objeto de retorno de uma venda é:

Nome Descrição
Acquirer nome da adquirente
AcquirerAuthorizationCode código de autorização da adquirente
CardBrand nome da bandeira
CaptureWay meio de captura do pagamento. ex: TEF, POS, E-COMMERCE e etc.
EstimatedGrossAmount valor bruto estimado que irá ser pago
EstimatedNetAmount valor líquido estimado que irá ser pago
EstimatedCardBrandTax valor estimado da taxa que irá ser paga
InstallmentNumber número da parcela
NSU nsu da transação
MaturityDate previsão de quando a parcela irá ser paga
MerchantCnpj CNPJ da loja que capturou a transação
Product modalidade de pagamento da transação. Ex: Crédito, Débito e etc.
SaleDate data que foi realizado a venda
Status status da venda
TransactionAmount valor da transação
TransactionInstallments número de parcelas das transações
UpdateDate a data da última atualização da parcela

Exemplo:

{
    "acquirer": "Stone",
    "acquirerAuthorizationCode": "232115398",
    "cardBrand": "BANRICOMPRAS",
    "captureWay": "TEF",
    "estimatedGrossAmount": 136,
    "estimatedNetAmount": 134.49,
    "estimatedCardBrandTax": 1.11,
    "installmentNumber": 1,
    "nsu": "003972",
    "maturityDate": "2017-02-06T00:00:00",
    "merchantCnpj": "88888888888888",
    "product": "Débito Pré-Datado",
    "saleDate": "02/02/2017",
    "status": "Conciliada",
    "transactionAmount": 136,
    "transactionInstallments": 1,
    "updateDate": "24/05/2017"
  }
Suggest Edits

Buscando Parcelas de Recebimentos

 

Para realizar uma consulta, é só consultar o endpoint de vendas, passando o CNPJ e filtrando através de queryString conforme desejado.

Exemplo:

/receipts/0000000000000?initialDate=20/05/2017&finalDate=20/06/2017

Ao realizar a consulta acima, será retornado todas os recebimentos do CNPJ 000000000000 que a data do recebimento esteja entre os dias 20/05/2017 até 20/06/2017.

Suggest Edits

Resposta Recebimentos

 

Respostas de Recebimentos

Nome Descrição
Acquirer nome da adquirente
AcquirerAuthorizationCode código de autorização da adquirente
BankAccount número da conta em que foi pago
BankBranch número da agência em que foi pago
BankCode código do banco em que foi pago
BankName nome do banco em que foi pago
CardBrand nome da bandeira
CaptureWay meio de captura do pagamento. ex: TEF, POS, E-COMMERCE e etc.
GrossAmount valor bruto do recebimento
NetAmount valor líquido do recebimento
CardBrandTax valor da taxa do recebimento
InstallmentNumber número da parcela
NSU nsu da transação
MaturityDate previsão de quando a parcela irá ser paga
MerchantCnpj CNPJ da loja que capturou a transação
Product modalidade de pagamento da transação. Ex: Crédito, Débito e etc.
ReceivingDate data que foi recebido
Status status do recebimento
TransactionAmount valor da transação
TransactionInstallments número de parcelas das transações
UpdateDate a data da última atualização da parcela

Exemplo:

{
    **"acquirer": "Stone",
    "acquirerAuthorizationCode": "232115398",
    "bankAccount": "0000543210",
    "bankBranch": "09876",
    "bankCode": **"104",
    "bankName": "Caixa Econômica Federal",
    "cardBrand": "BANRICOMPRAS",
    "cardBrandTax": 1.11,
    "captureWay": "TEF",
    "installmentNumber": 1,
    "grossAmount": 136,
    "merchantCnpj": "88888888888888",
    "maturityDate": "06/02/2017",
    "netAmount": 134.49,
    "nsu": "003972",
    "product": "Débito Pré-Datado",
    "receivingDate": "06/02/2017",
    "saleDate": "02/02/2017",
    "status": "Recebida",
    "transactionAmount": 136,
    "transactionInstallments": 1,
    "updateDate": "24/05/2017"
  }