Esta chamada de API permite a listagem das faturas cadastradas no sistema. Permite filtros por ID da Fatura, ID do Cliente, OU status da Fatura.
A chamada dessa API deve ser autenticada por meio de token no header da requisição, token este que deve ser gerado utilizando a API de Autenticação.
Todas as requisições à API devem utilizar o método HTTP POST. A API recusa qualquer outro método que não seja o POST nas requisições.
ENVIO DO TOKEN
O token deve ser enviado no header da requisição, no seguinte formato:
“Authorization” : “Bearer seu_token_gerado_aqui”
Exemplo:
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI5OGYxMzcwODIxMDE5NGM0NzU2ODdiZTYxMDZhM2I4NCIsImVtcHJlc2EiOiI5OGYxMzcwODIxMDE5NGM0NzU2ODdiZTYxMDZhM2I4NCIsImxvZ2luIjoidGVzdGVzQGR1cGF5LmNvbS5iciIsImNsaWVudGUiOm51bGwsImdydXBvIjoiMiIsImV4cCI6MTU2MDE3MTg5MiwiaWF0IjoxNTU5OTk5MDkyfQ.DKycS9HX68c0wDTAoGq2Y3rts-Dqtm_cOugsVKpMq9U
MÉTODO DA API: listInvoice
Parâmetros a serem enviados:
method = “listInvoice”
invoiceId = ID da fatura
customerId = ID do cliente
subscriptionId = ID da assinatura
status = Status desejado da fatura.
limit = Opcional* - Limite máximo de registros a retornar. Padrão em 100, maximo 1000.
offset = Opcional* - Utilizado para paginação
URL DA API
https://painel.dupay.com.br/api_v1/?vkey=5343f84566a14db9f4a8f79c713085c3
Os dados devem ser enviados preferencialmente por JSON e a resposta da API sempre será em JSON.
Exemplo de chamada:
{ "method": "listInvoice", "invoiceId": "20710", "customerId": "", "subscriptionId": "", "status": "", "limit": "", "offset": "" }
Todas as chamadas da API da Dupay respondem em JSON e possui algumas variáveis padrões na resposta. São elas:
status = Retorna 0 para falha e 1 para sucesso na chamada da API
message = Mensagem informativa em caso de falha na chamada da API
data = Dados retornados pela API em caso de sucesso na chamada.
Segue abaixo um exemplo de retorno do JSON:
{ "status": 1, "message": "OK", "data": [ { "invoiceId": "20710", "customerId": 915, "status": "1", "statusName": "Aguard. Pagto", "subTotal": "47.40", "value": null, "dueDate": "2019-06-16", "lastDueDate": "2019-06-28", "createDate": "2019-06-16 07:15:08", "products": "PLANO: MUSCULAÇÃO + DANÇA", "paymentDate": null, "digitableLine": "03399.78686 99500.000007 58008.201012 6 79340000004740", "barcode": "03396793400000047409786899500000005800820101", "paymentAccepted": "C", "lrText": null, "lrCode": null, "pdfInvoice": "https://painel.dupay.com.br/_lib/file/doc/faturas/20/20710.pdf" } ] }