Atualizar Pix Automatic Configuration

patch

https://api.trytoku.com/brazil/pix_automatic_configuration

Atualiza a configuração de cobrança do Pix Automático de uma Subscription.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Configuração de cobrança do Pix Automático de uma Subscription.

O que for informado aqui tem prioridade sobre a configuração da Account e sobre os padrões do serviço, sempre que a configuração é aplicada.

allow_retries

boolean

Política de retentativas com que a recorrência é cadastrada: com true, até 3 retentativas em 7 dias. Alguns provedores cadastram sempre com retentativas, independentemente deste campo.

business_day_only_collection

boolean

Quando true, a cobrança é enviada com o ajuste para dia útil, nos provedores que aceitam esse ajuste.

collection_day

integer

Dia do mês registrado na configuração. Hoje não é enviado ao banco nem usado no cálculo das cobranças.

collection_frequency

string

enum

Periodicidade da recorrência enviada ao banco.

Allowed:

days_between_retries

integer

Dias entre retentativas registrados na configuração. Hoje não é enviado ao banco nem usado no cálculo das cobranças.

final_date

string

Data a partir da qual a recorrência deixa de valer, no formato YYYY-MM-DD. Quando ausente, a recorrência é cadastrada sem data de término.

first_payment_date

string

Data da primeira cobrança, no formato YYYY-MM-DD. Quando ausente, o cadastro da recorrência usa a data do dia.

fixed_value

number

Valor fixo de cada cobrança, em reais, enviado ao banco como valor da recorrência.

id_subscription

string

required

Identificador da Subscription cuja cobrança está sendo configurada.

maximum_value

number

Valor máximo registrado na configuração. Hoje não é enviado ao banco nem usado no cálculo das cobranças.

minimum_value

number

Valor mínimo autorizado para cada cobrança, em reais.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Configuração de cobrança atualizada.

401As credenciais estão ausentes ou são inválidas.

403As credenciais não dão acesso a este recurso.

404A Subscription não tem configuração de cobrança registrada.

422O corpo da requisição não passou na validação.

429O limite de requisições permitidas foi excedido.