Skip to main content
POST
Criar cobrança imediata (txid gerado pelo PSP)

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

Idempotency-Key
string

Idempotency key, max 255 characters.

Corpo

application/json
calendario
object
obrigatório

Controle de tempo da cobrança.

chave
string
obrigatório

Chave DICT do recebedor.

Maximum string length: 77
Exemplo:

"pix@lerian.studio"

valor
object
obrigatório

Valores monetários da cobrança.

devedor
object

Devedor da cobrança (PF/PJ, opcional).

infoAdicionais
object[] | null

Informações adicionais (máx 50).

loc
object

Referência de location.

solicitacaoPagador
string

Texto livre apresentado ao pagador.

Maximum string length: 140

Resposta

Created

calendario
object
obrigatório
chave
string
obrigatório

Chave DICT do recebedor.

Maximum string length: 77
loc
object
obrigatório
location
string
obrigatório

Localização do payload.

Maximum string length: 77
pixCopiaECola
string
obrigatório

Pix Copia e Cola (BR Code) correspondente à cobrança.

Maximum string length: 512
revisao
integer<int64>
obrigatório

Revisão da cobrança (inicia em 0).

status
enum<string>
obrigatório

Status do registro da cobrança.

Opções disponíveis:
ATIVA,
CONCLUIDA,
REMOVIDA_PELO_USUARIO_RECEBEDOR,
REMOVIDA_PELO_PSP
txid
string
obrigatório

Identificador da transação.

Pattern: [a-zA-Z0-9]{26,35}
valor
object
obrigatório
devedor
object
infoAdicionais
object[] | null
solicitacaoPagador
string
Maximum string length: 140