Obter PDF de vários boletos

POST /boletos/{entityType}

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

Retorna um arquivo PDF com as informações sobre até 100 boletos solicitados.

Dados da requisição

Nome

Tipo

Obrigatório

Explicação

galaxPayIds

array de int 11 dígitos

Não

GalaxPayIds do tipo escolhido na URL.

myIds

array de string 255 caracteres

Não

MyIds do tipo escolhido na URL.

order

string 255 caracteres

Não

Ordenação dos boletos que virão no PDF.

Valor	Explicação
transactionPayday.asc	Vencimento da transação - Ordem crescente
transactionPayday.desc	Vencimento da transação - Ordem decrescente
customerId.asc	ID do Cliente - Ordem crescente
customerId.desc	ID do Cliente - Ordem decrescente
billId.asc	ID da Cobrança Avulsa/Assinatura - Ordem crescente
billId.desc	ID da Cobrança Avulsa/Assinatura - Ordem decrescente

Parâmetros da URL:

{entityType}: Tipo dos ids. Opções:
- transactions: Transações
- charges: Um pdf com todos os boletos de todas as transações da requisição. Limite de 100 transações.

URL da Requisição

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

URL da Requisição

https://api.sandbox.cel.cash/v2/boletos/charges

Body da requisição

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "Boleto": {
        "pdf": "https://app.galaxpay.com.br/galaxpay/1a2d12as1d2a1d"
    }
}

Nome

Tipo

Explicação

Boleto

Dados do boleto atrelado.
Clique para ver os campos.

pdf

string 255 caracteres

URL do PDF gerado.

error

Nó de erros, caso haja.
Clique para ver os campos.

message

string 255 caracteres

Mensagem que indica qual o erro.

details

Objeto com detalhes sobre o erro, mostrando qual o campo referente e qual o erro.
Clique para ver os campos.

Entity.field

array de string

Array cuja chave é Entidade.campo onde deu o erro e cada valor é uma descrição sobre o problema.

Código

Explicação

200

Sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.

404

Transação não encontrada.