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

Dados da requisição apagar valores

Nome

Valor Preencha os dados para testar

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.

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

Body da requisição

{ "galaxPayIds": [ 49, 50 ], "myIds": [ "2A", "RFA-22" ] }

Testar

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "Carnes": [
        {
            "pdf": "https://app.galaxpay.com.br/galaxpay/1a2d12as1d2a1d",
            "subscriptionGalaxPayId": 1,
            "subscriptionMyId": "2A"
        }
    ]
}

Nome

Tipo

Explicação

Carnes

Array de carnês.
Clique para ver os campos.

pdf

string 255 caracteres

URL do PDF gerado.

subscriptionGalaxPayId

int 11 dígitos

Subscription.galaxPayId.
Id da assinatura no cel_cash.
Só será retornado quando for enviada a opção onePDFBySubscription.

subscriptionMyId

string 255 caracteres

Subscription.myId
Id referente da assinatura no seu sistema.
Só será retornado quando for enviada a opção onePDFBySubscription.

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

Assinatura não encontrada.