Criar nova recorrência PIX automática

post

https://{apiHost}/v2/charge/automatic_pix/recurrences

Cria uma nova recorrência PIX automática.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Nova Recorrência do Pix Automático.

charge_automatic_pix_account_uid

string

required

UID da conta Pix Automático. A conta financeira e a connection são herdadas desta conta.

pix_uid

string | null

UID do Pix (opcional). Quando informado junto com location_uid: o qrcode gerado será da jornada instant (Jornada 3) para Pix instantâneo ou offer (Jornada 4) para Pix com vencimento.

location_uid

string | null

UID da localização. Quando informado, o QR Code será gerado conforme a jornada (recurrent / instant / offer).

document

string

required

length ≤ 35

Número, identificador, ou código que representa o objeto da autorização (contrato, pedido etc.).

description

string | null

Descrição da recorrência.

start_at

string

required

Data de início da recorrência.

finish_at

string | null

Data de fim da recorrência.

recurrence_term

string

enum

required

Prazo da recorrência.

Allowed:

cycle

string

enum

required

Ciclo da recorrência.

Allowed:

amount_term

string

enum

required

Tipo do valor da recorrência.

Allowed:

amount

float | null

Valor (quando amount_term é fixed).

minimum_amount

float | null

Valor mínimo (quando amount_term é variable).

agreement_code

string | null

Número do Convênio de Pagamento.

retry_policy

string

enum

required

Política de retentativa.

Allowed:

external_id

string | null

ID externo da recorrência.

custom_data

object | null

Dados personalizados.

201Recorrência PIX automática criada com pix_uid e location_uid (JORNADA_3)

401Falha de autenticação. Token inválido

403Falha de permissão. Você não tem o Scope obrigatório para essa chamada.

422External ID já existe