Criar cobrança - PIX

post

https://pagamentos.grafeno.be/api/v2/charges

Este recurso permite a criação de um PIX cobrança.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Importante!
A funcionalidade PIX Cobrança ainda não está disponível para contas Vórtx.

Body Params

paymentMethod

string

required

Defaults to pix

Método de pagamento da cobrança.

dueDate

date

required

Data de vencimento da cobrança.
Formato: YYYY-MM-DD.

value

double

required

Valor da cobrança precisão 2.

abatementValue

double

Valor do Abatimento. precisão 2.

interestType

string

enum

Tipo de juros aplicado a cobrança.
Valores permitidos fixed_value ou percentage.

Allowed:

interestValue

double

Valor dos juros por mês. Valores inteiros ou decimais com precisão 2.

applicableFine

double

Multa por atraso em valor percentual. precisão 2.

clientControlNumber

string

Identificador próprio de uso da empresa.
Alfanumérico - 25 caracteres

expiresAfter

int32

Dias para baixa após o vencimento.

discount

object

Desconto aplicado na cobrança.

payer

object

required

Dados do pagador da cobrança.
Caso o pagador já esteja cadastrado, é possível enviar apenas o documentNumber que a API completará os demais dados

receiptNumber

string

Número da nota fiscal vinculada a cobrança.

grantor

object

Dados do Sacador / Avalista. Obrigatório para abertura de protesto.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

🚧Importante!

200200

400400

401401

422422

🚧
Importante!