Pular para o conteúdo

Sync recurring consents

Triggers a bulk synchronisation of recurring consent states for the tenant resolved from subTenantId. Use after operational incidents or batch reconciliation — not on the payer hot path.

POST/api/v1/automatic-payments/recurring-consents/update-consents

Update consents (sync)

Updates all recurring consents for the specified tenant context, synchronising with the external payment system.

Auth: Bearer Token

Cabeçalhos

1 campo
subTenantId
headerstring

Subtenant whose parent tenant consents should be refreshed.

curl --request POST \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/recurring-consents/update-consents' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'subTenantId: subtenant_abc123'

Response

200Consents processed successfully.
Response body
object
  • dataobjectrequired

    Envelope references AutomaticPayment in OpenAPI (`FuturePaymentsProcessResponse`).

  • messagestring

    Response message.

  • typestring

    Envelope type.

200 · Consents processed successfully.
{
  "data": {
    "id": "sync-job"
  },
  "message": "",
  "type": "success"
}

Next steps