Skip to main content
POST
Criar recorrência (Pix Automático)

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

Cadência da recorrência.

politicaRetentativa
enum<string>
obrigatório

Política de retentativa.

Opções disponíveis:
NAO_PERMITE,
PERMITE_3R_7D
Exemplo:

"PERMITE_3R_7D"

recebedor
object
obrigatório

Conta bancária do recebedor.

vinculo
object
obrigatório

Vínculo (contrato + devedor).

valor
object

Valor da recorrência (opcional; fixo ou piso).

Resposta

Created

calendario
object
obrigatório
idRec
string
obrigatório

Identificador da recorrência.

Pattern: ^[a-zA-Z0-9]{29}$
politicaRetentativa
enum<string>
obrigatório
Opções disponíveis:
NAO_PERMITE,
PERMITE_3R_7D
recebedor
object
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
CRIADA,
APROVADA,
REJEITADA,
EXPIRADA,
CANCELADA
vinculo
object
obrigatório
atualizacao
object[] | null
solicitacao
object[] | null
valor
object