Skip to main content
POST
Criar cobrança recorrente (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
ajusteDiaUtil
boolean
obrigatório

Ajusta a liquidação para o próximo dia útil quando o vencimento cai em dia não-útil.

calendario
object
obrigatório

Controle de tempo da cobrança.

idRec
string
obrigatório

Recorrência a que a cobrança pertence.

Pattern: ^[a-zA-Z0-9]{29}$
Exemplo:

"RR1234567820240115abcdefghijk"

recebedor
object
obrigatório

Conta bancária do recebedor.

valor
object
obrigatório

Valor da cobrança.

devedor
object

Contato do devedor (sem identidade; a identidade está na Rec).

infoAdicional
string

Informação adicional (campo único, não array).

Maximum string length: 140

Resposta

Created

ajusteDiaUtil
boolean
obrigatório
calendario
object
obrigatório
idRec
string
obrigatório
Pattern: ^[a-zA-Z0-9]{29}$
recebedor
object
obrigatório
revisao
integer<int64>
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
CRIADA,
ATIVA,
CONCLUIDA,
EXPIRADA,
REJEITADA,
CANCELADA
txid
string
obrigatório
Pattern: ^[a-zA-Z0-9]{26,35}$
valor
object
obrigatório
atualizacao
object[] | null
devedor
object
encerramento
object
infoAdicional
string
Maximum string length: 140