Criar cobrança avulsa

POST /charges

Para utilizar esse método, o access_token deve conter o scope charges.write

Método utilizado para criar cobrança avulsa dentro do sistema. A cobrança avulsa acontece apenas uma vez e dá a opção de parcelamento (caso seja cartão
de crédito).

Dados da requisição

Nome

Tipo

Obrigatório

Explicação

myId

string 255 caracteres

Sim

Id referente no seu sistema, para salvar no cel_cash.

value

int 11 dígitos

Sim

Preço em centavos.

additionalInfo

text

Não

Texto livre dedicado a informações adicionais internas.

payday

date

Sim

Data de vencimento do pagamento.

payedOutsideGalaxPay

bool

Não

Define se a cobrança foi paga fora do sistema do cel_cash. Exemplo: dinheiro, transferência.
Use esse campo para que o cel_cash não cobre esse pagamento do seu cliente, já que este já foi pago de outra forma.

mainPaymentMethodId

string 30 caracteres

Sim

PaymentMethod.id
Id do pagamento principal. Ou seja, quando forem cadastradas novas transações, irá considerar esse pagamento.

Valor	Explicação
creditcard	Cartão de Crédito
boleto	Boleto Bancário
pix	Pix

Customer

Sim

Informações do cliente.
Para usar um cliente previamente cadastrado, informe o galaxPayId, myId ou document. Fazendo isso, se você passar mais algum dado no json, você irá atualizar a informação no cadastro do cliente também.
Se desejar, pode cadastrar um cliente na hora, informando todos os campos obrigatórios pelo menos.
Clique para ver os campos.

myId

string 255 caracteres

Id referente no seu sistema, para salvar no cel_cash.
Para utilizar um existente preencha apenas este campo.
Caso queira atualizar algum dado, informe apenas os campos que deseja.

galaxPayId

int 11 dígitos

ID do cliente no cel_cash.
Para utilizar um cliente existente preencha este campo.
Para cadastrar um cliente novo, esse campo NÃO pode ser passado, pois é gerado pelo cel_cash.

name

string 255 caracteres

Sim

Nome ou razão social do cliente.

document

string 14 caracteres

Sim

CPF OU CNPJ do cliente. Apenas números.

emails

array de string 255 caracteres

Sim

Emails do cliente. Separe cada email por vírgula.

phones

array de int 11 dígitos

Não

Telefones do cliente. Separe cada telefone por vírgula.

Address

Não

Endereço de cobrança do cliente.
Caso deseja utilizar o cliente para realizar cobranças de boleto, o endereço se torna obrigatório.
Clique para ver os campos.

zipCode

string 8 caracteres

Sim

CEP. Informe apenas números.

street

string 255 caracteres

Sim

Logradouro.

number

string 255 caracteres

Sim

Número.

complement

string 255 caracteres

Não

Complemento.

neighborhood

string 255 caracteres

Sim

Bairro.

city

string 255 caracteres

Sim

Cidade.

state

string 2 caracteres

Sim

Estado.

PaymentMethodCreditCard

Sim para pagamento com cartão de crédito

Configurações do meio de pagamento de cartão.
Obrigatório se o mainPaymentMethodId for creditcard.
Caso queira gerar um link para pagamento, não informe o nó Card
Clique para ver os campos.

Link

Não

Informações do link de pagamento.
Clique para ver os campos.

minInstallment

int 11 dígitos

Não

Mínimo de vezes que pode ser parcelado.

maxInstallment

int 11 dígitos

Sim

Máximo de vezes que pode ser parcelado.

Card

Não

Cartão.
Caso queira gerar um link para pagamento, não informe o nó Card.
Clique para ver os campos.

myId

string 255 caracteres

Id referente no seu sistema, para salvar no cel_cash.
Para utilizar um existente preencha apenas este campo.

galaxPayId

int 11 dígitos

Id do cartão no cel_cash.
Para utilizar um existente preencha apenas este campo.

number

string 30 caracteres

Sim

Número do cartão.
Para APROVAR: 4111 1111 1111 1111
Para NEGAR: 4242 4242 4242 4242

holder

string 30 caracteres

Sim

Nome do portador.

expiresAt

string 7 caracteres

Sim

Mês e ano da expiração do cartão.
String contendo ano e mês de expiração do cartão.
YYYY-MM

cvv

string 4 caracteres

Sim

Código de segurança.

3DS

Não

Validação 3DS
Clique para ver os campos.

ExternalEMV

Não

Nó de 3DS externo
Clique para ver os campos.

embedded

bool

Não

Informa se o serviço MPI utilizado será da Rede ou terceiro. true: utiliza o serviço MPI da Rede | false: utiliza serviço MPI terceiro O não envio desse campo será considerado o uso do MPI da Rede.

cavv

string 32 caracteres

Sim

Código do criptograma utilizado na autenticação da transação e enviado pelo MPI do estabelecimento (pode conter caracteres especiais).

eci

string 2 caracteres

Sim

O parâmetro ECI (Eletronic Commerce Indicator) se baseia no valor retornado ao MPI pelas Bandeiras que indica o resultado da autenticação do portador junto ao Emissor.

xid

string 28 caracteres

Sim Obrigatório apenas para bandeira Visa.

ID da transação de autenticação enviado pelo MPI ao estabelecimento (pode conter caracteres especiais). Deve ser enviado apenas para a utilização do serviço de autenticação 3DS. Campo utilizado somente para bandeira ***Visa.

threeDIndicator

string 1 caracteres

Sim

Versão do 3DS usado no processo de autenticação pelo MPI.

directoryServerTransactionId

string 36 caracteres

Sim

ID da transação de autenticação incluída pelo MPI ao estabelecimento (pode conter caracteres especiais). Deve ser enviado apenas para a utilização do serviço de autenticação 3DS.

InternalEMV

Não

Informações da validação 3ds interna
Clique para ver os campos.

userAgent

text

Não

Identificador do browser utilizado pelo comprador no momento da compra.

text

Sim

Suporta informações somente em iPv4

Device

Sim

Informações do dispositivo
Clique para ver os campos.

colorDepth

text

Sim

Campo que representa a estimativa da paleta de cores usada para a exibição de imagens, em bits por pixel. Obtido no navegador do cliente através da propriedade.

deviceType3ds

text

Sim

Campo que indica tipo de dispositivo no qual a autenticação ocorre.

javaEnabled

bool

Sim

Campo booleano que representa a capacidade do navegador para executar Java. O valor é aquele retornado pela propriedade navigator.javaEnabled, true ou false.

language

text

Sim

Idioma do navegador no formato IETF BCP47, contendo entre 1 e 8 caracteres.

screenHeight

text

Sim

A altura total da tela do cliente em pixels. O valor é aquele retornado pela propriedade screen.height.

screenWidth

text

Sim

A largura total da tela do cliente em pixels. O valor é aquele retornado pela propriedade screen.width.

timeZoneOffset

text

Sim

Diferença de horário, em horas, entre o UTC e a hora local do navegador do titular do cartão.

qtdInstallments

int 11 dígitos

Não

Quantidade de parcelas.

isRetry

bool

Não

Caso enviado como true, será considerado como uma retentativa de cobrança na operadora. Atualmente válido nas seguintes operadoras: cel_cash, Rede e Cielo.

useBackupCard

bool

Não

Informa se o cliente autorizou a utilização do cartão reserva, em caso de retentativa (disponível apenas para cobranças na subadquirente).

PaymentMethodBoleto

Não

Configurações do meio de pagamento de boleto.
Clique para ver os campos.

fine

int 11 dígitos

Não

Percentual de multa, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.

interest

int 11 dígitos

Não

Percentual de juros, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.

instructions

string 255 caracteres

Não

Instruções do boleto.
Irá ser acrescentado na área "Referente a" do boleto. Para quebrar linha utilize "\n", sendo que será exibido no máximo 3 linhas.
Caso não informado será utilizado o padrão definido no sistema.

deadlineDays

int 11 dígitos

Não

Quantidade de dias que o boleto pode ser pago após o vencimento.
Caso não informado será utilizado o padrão definido no sistema.
Valores válidos de 0 a 59.

documentNumber

string 10 caracteres

Não

Irá ser acrescentado na área "Nº Documento" do boleto. Caso não informado será utilizado o padrão definido no sistema.

Agreement

Não

Convênio próprio no banco emissor
Clique para ver os campos.

name

string 255 caracteres

Não

Nome do beneficiário final/sacador avalista

document

string 14 caracteres

Não

Documento do beneficiário final/sacador avalista

PaymentMethodPix

Não

Configurações do meio de pagamento de Pix.
Clique para ver os campos.

fine

int 11 dígitos

Não

Percentual de multa, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.
Por norma do BACEN, será aceito somente quando o parâmetro Deadline.type for informado "days".

interest

int 11 dígitos

Não

Percentual de juros, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.
Por norma do BACEN, será aceito somente quando o parâmetro Deadline.type for informado "days".

instructions

string 255 caracteres

Não

Instruções do QR Code Pix.
Informação exibida nos detalhes do QR Code.
Caso não informado será utilizado o padrão definido na plataforma.

Deadline

Não

Expiração do QR Code.
Caso não informado, será utilizado o padrão definido no sistema.
Clique para ver os campos.

type

string 255 caracteres

Não

Tipo da expiração do QR Code.

Valor	Explicação
minutes	Minutos
days	Dias

value

int 11 dígitos

Não

Valor da expiração do QR Code (em dias ou minutos).

URL da Requisição

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

Body da requisição

{
    "myId": "pay-66edf4729c2272.29218223",
    "value": 12999,
    "additionalInfo": "Lorem ipsum dolor sit amet.",
    "payday": "2024-09-20",
    "payedOutsideGalaxPay": false,
    "mainPaymentMethodId": "creditcard",
    "Customer": {
        "myId": "pay-66edf472ca6c57.21640168",
        "galaxPayId": 1,
        "name": "Lorem ipsum dolor sit amet.",
        "document": "80544772792",
        "emails": [
            "teste1921email464@galaxpay.com.br",
            "teste6802email2027@galaxpay.com.br"
        ],
        "phones": [
            3140201512,
            31983890110
        ],
        "Address": {
            "zipCode": "30411330",
            "street": "Rua platina",
            "number": "1330",
            "complement": "2º andar",
            "neighborhood": "Prado",
            "city": "Belo Horizonte",
            "state": "MG"
        }
    },
    "PaymentMethodCreditCard": {
        "Link": {
            "minInstallment": 4,
            "maxInstallment": 12
        },
        "Card": {
            "myId": "pay-66edf473385c34.99751684",
            "galaxPayId": 1,
            "number": "4111 1111 1111 1111",
            "holder": "JOAO J J DA SILVA",
            "expiresAt": "2024-09",
            "cvv": "363"
        },
        "3DS": {
            "ExternalEMV": {
                "embedded": true,
                "cavv": "BwABBylVaQAAAAFwllVpAAAAAAA=",
                "eci": "05",
                "xid": "Nmp3VFdWMlEwZ05pWGN3SGo4TDA=",
                "threeDIndicator": "2",
                "directoryServerTransactionId": "f38e6948-5388-41a6-bca4-b49723c19437"
            },
            "InternalEMV": {
                "userAgent": "Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405",
                "ip": "80.177.223.20",
                "Device": {
                    "colorDepth": "1",
                    "deviceType3ds": "BROWSER",
                    "javaEnabled": false,
                    "language": "BR",
                    "screenHeight": "500",
                    "screenWidth": "500",
                    "timeZoneOffset": "3"
                }
            }
        },
        "qtdInstallments": 12,
        "isRetry": false,
        "useBackupCard": false
    },
    "PaymentMethodBoleto": {
        "fine": 100,
        "interest": 200,
        "instructions": "Lorem ipsum dolor sit amet.",
        "deadlineDays": 1,
        "documentNumber": "numero123"
    },
    "PaymentMethodPix": {
        "fine": 100,
        "interest": 200,
        "instructions": "Lorem ipsum dolor sit amet.",
        "Deadline": {
            "type": "days",
            "value": 60
        }
    }
}

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "type": true,
    "Charge": {
        "galaxPayId": 1,
        "myId": "pay-66edf4740c1b70.53406015",
        "planMyId": "pay-66edf474136492.70264512",
        "planGalaxPayId": 1,
        "mainPaymentMethodId": "creditcard",
        "paymentLink": "https://app.celcoin.com.br/link-payment",
        "value": 12999,
        "additionalInfo": "Lorem ipsum dolor sit amet.",
        "status": "active",
        "payedOutsideGalaxPay": false,
        "Customer": {
            "galaxPayId": 1,
            "myId": "pay-66edf4742f28a0.60829737",
            "name": "Lorem ipsum dolor sit amet.",
            "document": "09647593147",
            "emails": [
                "[email protected]",
                "[email protected]"
            ],
            "phones": [
                3140201512,
                31983890110
            ],
            "createdAt": "2020-06-02 10:10:00",
            "updatedAt": "2020-06-02 10:10:00",
            "Address": {
                "zipCode": "30411330",
                "street": "Rua platina",
                "number": "1330",
                "complement": "2º andar",
                "neighborhood": "Prado",
                "city": "Belo Horizonte",
                "state": "MG"
            }
        },
        "Transactions": [
            {
                "galaxPayId": 1,
                "value": 12999,
                "payday": "2024-09-20",
                "installment": 3,
                "statusDate": "2024-09-20 19:17:24",
                "status": "captured",
                "datetimeLastSentToOperator": "2024-09-20 19:17:24",
                "statusDescription": "Capturada na Operadora",
                "reasonDenied": "Limite do cartão insuficiente.",
                "authorizationCode": "pay-66edf4747d4c28.91342306",
                "tid": "pay-66edf4747fda90.12426192",
                "fee": 300,
                "AbecsReasonDenied": {
                    "code": "51",
                    "message": "Saldo/limite insuficiente"
                },
                "Pix": {
                    "qrCode": "ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123",
                    "reference": "E20240920191724A5AE55AC3D6360655D5CC8CEA1259C6E",
                    "image": "https://app.celcoin.com.br/link-image-qrcode",
                    "page": "https://app.celcoin.com.br/link-page-qrcode"
                },
                "Boleto": {
                    "pdf": "https://app.celcoin.com.br/link-pdf",
                    "bankLine": "23312323232323232323232323232",
                    "bankAgency": "0001",
                    "bankAccount": "12345"
                },
                "CreditCard": {
                    "Card": {
                        "myId": "pay-66edf474ac2351.27840822",
                        "galaxPayId": 1,
                        "number": "5451*********1515",
                        "createdAt": "2020-06-02 10:10:00",
                        "updatedAt": "2020-06-02 10:10:00",
                        "Brand": {
                            "id": "mastercard",
                            "name": "MasterCard",
                            "maxInstallment": 12,
                            "operatorIds": "cielo,pagseguro"
                        },
                        "expiresAt": "2024-09"
                    }
                },
                "Transaction3DS": {
                    "urlAuthentication": "https://sandbox-erede.useredecloud.com.br/acs/index.html?ref=6b529dec5ee34f568fd68e2729cfd2af"
                }
            }
        ],
        "PaymentMethodCreditCard": {
            "qtdInstallments": 12,
            "Card": {
                "myId": "pay-66edf474dbcfc5.78412103",
                "galaxPayId": 1,
                "number": "5451*********1515",
                "createdAt": "2020-06-02 10:10:00",
                "updatedAt": "2020-06-02 10:10:00",
                "Brand": {
                    "id": "mastercard",
                    "name": "MasterCard",
                    "maxInstallment": 12,
                    "operatorIds": "bin,pagseguro"
                },
                "expiresAt": "2024-09",
                "isBackup": false
            },
            "Link": {
                "minInstallment": 4,
                "maxInstallment": 12
            }
        },
        "PaymentMethodBoleto": {
            "fine": 100,
            "interest": 200,
            "instructions": "Lorem ipsum dolor sit amet.",
            "deadlineDays": 1
        },
        "PaymentMethodPix": {
            "fine": 100,
            "interest": 200,
            "instructions": "Lorem ipsum dolor sit amet.",
            "Deadline": {
                "type": "days",
                "value": 60
            }
        }
    }
}

Nome

Tipo

Explicação

type

bool

Sucesso ou não da ação.

Charge

Cobrança avulsa.
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id no cel_cash

myId

string 255 caracteres

Id referente no seu sistema.

planMyId

string 255 caracteres

Plan.myId
ID do plano no seu sistema.

planGalaxPayId

int 11 dígitos

Plan.galaxPayId
ID do plano no cel_cash.

planMyId

string 255 caracteres

Plan.myId
ID do plano no seu sistema.

planGalaxPayId

int 11 dígitos

Plan.galaxPayId
ID do plano no cel_cash.

mainPaymentMethodId

string 30 caracteres

PaymentMethod.id
Id do pagamento principal. Ou seja, quando forem cadastradas novas transações, irá considerar esse pagamento.

Valor

Explicação

creditcard

Cartão de Crédito

boleto

Boleto Bancário

pix

Pix

paymentLink

string 255 caracteres

Link para pagamento.

value

int 11 dígitos

Preço em centavos.

additionalInfo

text

Texto livre dedicado a informações adicionais internas.

status

string 30 caracteres

Status da cobrança avulsa.

Valor

Explicação

active

Ativa

canceled

Cancelada

closed

Encerrada

waitingPayment

Aguardando pagamento

inactive

Inativa

payedOutsideGalaxPay

bool

Define se a transação foi paga fora do sistema do cel_cash. Exemplo: dinheiro, transferência.

Customer

Informações do cliente.
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id no cel_cash

myId

string 255 caracteres

Id referente no seu sistema.

name

string 255 caracteres

Nome ou razão social do cliente.

document

string 14 caracteres

CPF OU CNPJ do cliente. Apenas números.

emails

array de string 255 caracteres

Emails do cliente.

phones

array de int 11 dígitos

Telefones do cliente.

createdAt

datetime

Data de criação.

updatedAt

datetime

Data de alteração.

Address

Endereço de cobrança do cliente.
Clique para ver os campos.

zipCode

string 8 caracteres

CEP

street

string 255 caracteres

Logradouro.

number

string 255 caracteres

Número.

complement

string 255 caracteres

Complemento.

neighborhood

string 255 caracteres

Bairro.

city

string 255 caracteres

Cidade.

state

string 2 caracteres

Estado.

Transactions

Transações da cobrança avulsa.
Ou seja, cada parcela da cobrança.
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id no cel_cash

value

int 11 dígitos

Preço em centavos.

payday

date

Data de vencimento do pagamento.

installment

int 11 dígitos

Parcela.

statusDate

datetime

Data do status

status

string 30 caracteres

Status da transaçao.

Valor

Explicação

Opções válidas para cartão de crédito:

notSend

Ainda não enviada para operadora de Cartão

authorized

Autorizado

captured

Capturada na Operadora de Cartão

denied

Negada na Operadora de Cartão

reversed

Estornada na Operadora de Cartão

chargeback

Estorno por chargeback

Opções válidas para boleto Bancário:

pendingBoleto

Boleto em aberto

payedBoleto

Boleto compensado

notCompensated

Boleto baixado por decurso de prazo

lessValueBoleto

Pago valor menor que o original

moreValueBoleto

Pago valor maior que o original

paidDuplicityBoleto

Pago em duplicidade

Opções válidas para Pix:

pendingPix

Pix em aberto

payedPix

Pix pago

unavailablePix

Pix indisponível para pagamento

Opções válidas para qualquer forma de pagamento:

cancel

Cancelada manualmente

payExternal

Paga fora do sistema

cancelByContract

Cancelada ao cancelar a cobrança

free

Isento

datetimeLastSentToOperator

datetime

Data de último envio para a operadora

statusDescription

string 255 caracteres

Mais informações sobre o status da transação.

reasonDenied

string 255 caracteres

Motivo de negação da transação (Quando houver).

authorizationCode

string 255 caracteres

Código de autorização da transação na operadora.

tid

string 255 caracteres

TID: Identificador da transação na operadora.

fee

int 30 dígitos

Taxa paga. Valor em centavos, sendo as duas últimas casas decimais.

AbecsReasonDenied

Motivo de negação da transação (Quando houver).
Clique para ver os campos.

code

string 4 caracteres

Código do motivo de negativa da ABECS

message

string 255 caracteres

Mensagem do motivo de negativa da ABECS

Pix

Dados do Pix atrelado.
Clique para ver os campos.

qrCode

string 255 caracteres

Conteúdo do QR Code.

reference

string 255 caracteres

Identificador do QR Code que será exibido no app do banco ao realizar o pagamento.

image

string 255 caracteres

Link da imagem do QR Code.

page

string 255 caracteres

Link da página do QR Code.

Boleto

Dados do boleto atrelado.
Clique para ver os campos.

pdf

string 255 caracteres

URL do PDF

bankLine

string 255 caracteres

Linha digitável do boleto.

bankAgency

string 255 caracteres

Agência do banco emissor do boleto

bankAccount

string 255 caracteres

Conta do banco emissor do boleto

CreditCard

Dados do cartão de crédito da transação.
Clique para ver os campos.

Card

Cartão.
Clique para ver os campos.

myId

string 255 caracteres

Id referente no seu sistema, para salvar no cel_cash.

galaxPayId

int 11 dígitos

Id no cel_cash

number

string 30 caracteres

Número truncado do cartão.

createdAt

datetime

Data de criação.

updatedAt

datetime

Data de alteração.

Brand

Bandeira do cartão da transação.
Clique para ver os campos.

string 255 caracteres

Id da bandeira de cartão.

name

string 255 caracteres

Nome da bandeira.

maxInstallment

int 11 dígitos

Máximo de vezes que pode ser parcelado.

operatorIds

text

Operadoras que aceitam a bandeira, separados por vírgula.
CardOperator.id

expiresAt

string 7 caracteres

Mês e ano da expiração do cartão.
String contendo ano e mês de expiração do cartão.
YYYY-MM

Transaction3DS

Informações da validação 3ds interna
Clique para ver os campos.

urlAuthentication

text

Url de autenticação retornada pelo sistema MPI, referente ao 3ds

PaymentMethodCreditCard

Configurações do meio de pagamento de cartão.
Clique para ver os campos.

qtdInstallments

int 11 dígitos

Quantidade de parcelas.

Card

Cartão
Clique para ver os campos.

myId

string 255 caracteres

Id referente no seu sistema.

galaxPayId

int 11 dígitos

Id no cel_cash

number

string 30 caracteres

Número do cartão truncado.

createdAt

datetime

Data de criação.

updatedAt

datetime

Data de alteração.

Brand

Bandeira do cartão da transação.
Clique para ver os campos.

string 255 caracteres

Id da bandeira de cartão.

name

string 255 caracteres

Nome da bandeira.

maxInstallment

int 11 dígitos

Máximo de vezes que pode ser parcelado.

operatorIds

text

Operadoras que aceitam a bandeira, separados por vírgula.
CardOperator.id

expiresAt

string 7 caracteres

Mês e ano da expiração do cartão.
String contendo ano e mês de expiração do cartão.
YYYY-MM

isBackup

bool

Cartão reserva.

Link

Informações do link de pagamento.
Clique para ver os campos.

minInstallment

int 11 dígitos

Mínimo de vezes que pode ser parcelado.

maxInstallment

int 11 dígitos

Máximo de vezes que pode ser parcelado.

PaymentMethodBoleto

Configurações do meio de pagamento de boleto.
Clique para ver os campos.

fine

int 11 dígitos

Percentual de multa, com dois decimais sem o separador.

interest

int 11 dígitos

Percentual de juros, com dois decimais sem o separador.

instructions

string 255 caracteres

Instruções.

deadlineDays

int 11 dígitos

Quantidade de dias que o boleto pode ser pago após o vencimento.

PaymentMethodPix

Configurações do meio de pagamento de Pix.
Clique para ver os campos.

fine

int 11 dígitos

Percentual de multa, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.

interest

int 11 dígitos

Percentual de juros, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.

instructions

string 255 caracteres

Instruções do QR Code Pix.
Informação exibida nos detalhes do QR Code.
Caso não informado será utilizado o padrão definido na plataforma.

Deadline

Expiração do QR Code.
Caso não informado, será utilizado o padrão definido no sistema.
Clique para ver os campos.

type

string 255 caracteres

Tipo da expiração do QR Code.

Valor

Explicação

minutes

Minutos

days

Dias

value

int 11 dígitos

Valor da expiração do QR Code (em dias ou minutos).

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

Cobrança avulsa cadastrada com sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.

404

Cliente não encontrado.