Skip to main content
O motor de recorrência permite personalizar o comportamento das assinaturas através da rota de configurações. Essas configurações são aplicadas automaticamente a todas as assinaturas criadas.

Consultar Configurações

Obtendo as suas configurações atuais:
curl --location 'https://api.malga.io/v1/subscriptions/settings' \
--header 'X-Client-Id: YOUR_CLIENT_ID' \
--header 'X-Api-Key: YOUR_API_KEY'

Alterando as configurações

curl --location --request PATCH 'https://api.malga.io/v1/subscriptions/settings' \
--header 'X-Client-Id: YOUR_CLIENT_ID' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "retryPolicy": [
    {"daysAfterLastAttempt": 1},
    {"daysAfterLastAttempt": 3},
    {"daysAfterLastAttempt": 7}
  ],
  "statementDescriptor": "NOVA EMPRESA",
  "cancelAfterAllRetries": true
}'

Conheça os parâmetros

retryPolicy
array
O campo retryPolicy permite personalizar quando as retentativas de pagamento devem acontecer após uma falha inicial.Importante: As retentativas só acontecem quando a transação retorna retryable = true. Se a resposta da transação vier com retryable = false, o cycle falha imediatamente, independentemente da política de retry configurada.
cancelAfterAllRetries
boolean
default:"false"
O campo cancelAfterAllRetries define o comportamento da assinatura quando todas as tentativas de pagamento de um cycle falham.
  • false (padrão): Assinatura vai para status unpaid e continua tentando nos próximos cycles
  • true: Assinatura é automaticamente cancelada após todas as retentativas falharem
statementDescriptor
string
O campo statementDescriptor é o texto que aparece na fatura do cartão de crédito do cliente, ajudando na identificação da cobrança.
  • Prioridade: Se configurado, é usado em todas as cobranças
  • Fallback: Se não configurado, usa o nome da assinatura
  • Limite: Depende das regras do banco/operadora (geralmente 13-25 caracteres)
  • Formatação: Texto em maiúsculas, sem caracteres especiais

Próximos Passos

I