API explorerChangelog
API explorer
Changelog

Theme switcher

Criar Boleto

Esse endpoint cria um boleto para pagamento.

Exemplo de Resposta - Endpoint

{ "id": "123…", "value": 1000, "webhook_url": null, "end_to_end_id": null, "payer_name": null, "payer_national_registration": null, "link_boleto": "https://…", "link_download": "https://…", "status": "created", "qr_code": "00020101021…", "digitable_line": "4359000…", "our_number": "0000056…" }

📝 Descrição dos Campos

Campo

Tipo

Descrição

your_number

string

due_date

string

Data de vencimento YYYY-MM-DD

amount

number

Valor da cobrança em centavos de reais.

payer_name

string

Nome do pagador

payer_document

string

Documento CPF ou CNPJ do pagador

payer_email

string

Email do pagador

payer_phone_prefix

string

Prefixo do telefone do pagador (apenas os dois números do prefixo)

payer_phone_number

string

Número de telefone do pagador

payer_address_zipcode

string

CEP de endereço do pagador

payer_address_public_place

string

Rua do endereço do pagador

payer_address_neighborhood

string

Bairro do endereço do pagador

payer_address_number

string

Número de endereço do pagador

payer_address_complement

string | null

Complemento do endereço do pagador

payer_address_city

string

Cidade do endereço do pagador

payer_address_state

string

UF do estado do endereço do pagador

webhook_url

string

Caso tenha um servidor para receber as informações de pagamento ou estorno informe aqui sua URL, campo pode ser vazio ""

split_rules

[]

Caso queira fazer split envie o seguinte Obj dentro do Array com o valor do split e o ID da conta: { value: number, account_id: string }

Header Parameters

Authorizationstring Required

Colocar no formato Bearer TOKEN

Acceptstring Required

application/json

Content-Typestring Required

application/json

Body Parameters

your_numberstring
due_datestring Required

Data de vencimento YYYY-MM-DD

amountnumber Required

Valor da cobrança em centavos de reais.

payer_namestring Required

Nome do pagador

payer_documentstring Required

Documento CPF ou CNPJ do pagador

payer_emailstring Required

Email do pagador

payer_phone_prefixstring Required

Prefixo do telefone do pagador (apenas os dois números do prefixo)

payer_phone_numberstring Required

Número de telefone do pagador

payer_address_zipcodestring Required

CEP de endereço do pagador

payer_address_public_placestring Required

Rua do endereço do pagador

payer_address_neighborhoodstring Required

Bairro do endereço do pagador

payer_address_numberstring Required

Número de endereço do pagador

payer_address_complementstring

Complemento do endereço do pagador

payer_address_citystring Required

Cidade do endereço do pagador

payer_address_statestring Required

UF do estado do endereço do pagador

webhook_urlstring

Caso tenha um servidor para receber as informações de pagamento ou estorno informe aqui sua URL, campo pode ser vazio ""

split_rulesarray

Utilizado para realizar SPLIT para várias contas já cadastradas na PUSHINPAY { "value": 50, "account_id": "9C3XXXXX3A043" }

Show child attributes

Response

200
Object
{ "id": "123…", "value": 1000, "webhook_url": null, "end_to_end_id": null, "payer_name": null, "payer_national_registration": null, "link_boleto": "https://…", "link_download": "https://…", "status": "created", "qr_code": "00020101021…", "digitable_line": "4359000…", "our_number": "0000056…" }
400
Object
{ "error": "Falha ao gerar boleto" }
401
Object
Unauthorized -- Chave TOKEN inválida
403
Object
Forbidden -- Apenas administradores
404
Object
Not Found -- Pedido não existe
405
Object
Method Not Allowed -- Método não permitido
406
Object
Not Acceptable -- Formato JSON inválido
410
Object
Gone -- Essa requisição não existe mais
418
Object
I'm a teapot.
429
Object
Too Many Requests -- Muitas requisições em um curto espaço de tempo
500
Object
Internal Server Error -- Favor tente mais tarde
503
Object
Service Unavailable -- Estamos temporariamente inativos, favor aguardar.
Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

Sandbox:

Language Box

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?