Pular para o conteúdo

Retry recurring payment

Schedules a retry for a failed automatic payment leg. Pass the originalRecurringPaymentId of the failed attempt in the path.

The body requires a new settlement date. Include endToEndId when the arrangement or your integration requires a fresh identifier (see Open Finance guidance linked from Automatic Pix).

POST/api/v1/automatic-payments/recurring-payments/{originalRecurringPaymentId}/retry

Retry recurring payment

Retries failed recurring payments by original recurring payment id.

Auth: Bearer Token

Parâmetros de path

1 campo
originalRecurringPaymentId●
pathstring

Identifier of the original failed automatic payment leg.

Cabeçalhos

1 campo
subTenantId●
headerstring

Subtenant initiating the retry.

Corpo da requisição

2 campos
date●
bodystring

New settlement date (`YYYY-MM-DD`) for the retry attempt.

endToEndId
bodystring

Optional new EndToEndID when rules require it.

curl --request POST \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/recurring-payments/E9040088820210128000800123873170/retry' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'subTenantId: subtenant_abc123' \
  --data '{
  "date": "2026-05-05",
  "endToEndId": "E9040088820210128000800123873171"
}'

Response

201Retry initiated successfully.
Response body
object
    201 · Retry initiated successfully.
    {}

    Next steps