Obter carnê

Para utilizar esse método, o access_token deve conter o scope carnes.read

Retorna informações sobre até 20 carnês por assinatura ou 100 transações/cobranças avulsas.

Teste e Dados da requisição

Dados da Resposta

Códigos de resposta

Parâmetros da URL:

1. {typePDF}: Tipo do PDF que irá ser gerado. Opções:
   • onePDFSubscription: Um pdf com todos os boletos de todas as assinaturas da requisição. Limite de 20 assinaturas.
   • onePDFCharge: Um pdf com todos os boletos de todas as cobranças avulsas da requisição.
   • onePDFTransaction: Um pdf com todos os boletos de todas as transações da requisição.
   • onePDFBySubscription: Um pdf para cada assinatura. Limite de 20 assinaturas.
2. {typeCover}: Tipo da capa do carnê que será gerado Opções:
   • none: Nenhuma capa
   • customer: Capa por cliente
   • subscription-or-charge: Capa por assinatura ou venda

URL da Requisição

https://api.sandbox.cel.cash/v2/carnes/

onePDFSubscription onePDFCharge onePDFTransaction onePDFBySubscription Tipo do PDF que irá ser gerado.

/

none customer subscription-or-charge Tipo da capa do carnê que será gerado

URL da Requisição

https://api.sandbox.cel.cash/v2/carnes/onePDF/none

Testar

Código da resposta

---

Tempo de resposta

---

Body da Resposta

[]

Nome

Tipo

Explicação

Código

Explicação

200

Sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.

404

Assinatura não encontrada.