Skip to main content
PATCH
Atualizar configurações do cliente

Authorizations

X-Client-Id
string
header
required
X-Api-Key
string
header
required

Body

application/json
retryRules
object[]

Régua de retentativas para ciclos com cobrança recusada. De 1 a 6 itens, sem valores repetidos, com soma de daysAfterLastAttempt até 30. O serviço salva a régua em ordem crescente. Lista vazia devolve 400. A régua padrão é 1, 3, 5, 7 (D+1, D+4, D+9 e D+16 depois da primeira tentativa)

Required array length: 1 - 6 elements
Example:
statementDescriptor
string

Texto que aparece na fatura do cartão de crédito. O Motor de Assinaturas não valida o tamanho. Sem este campo, a cobrança usa o nome da assinatura

Example:

"MINHA EMPRESA"

cancelAfterAllRetries
boolean

Se a assinatura deve ser cancelada após todas as retentativas falharem

Example:

false

Response

Success

retryRules
object[]
required

Régua de retentativas configurada, em ordem crescente. Os dias são relativos à tentativa anterior

Example:
cancelAfterAllRetries
boolean
required

Se a assinatura deve ser cancelada após todas as retentativas falharem

Example:

false

statementDescriptor
string

Texto que aparece na fatura do cartão de crédito. Não vem quando não foi configurado; nesse caso, a cobrança usa o nome da assinatura

Example:

"MINHA EMPRESA"