Pular para o conteúdo

Update recurring consent

Updates or revokes a single recurring consent. Requires subTenantId, orgId, and asId headers (organisation and authorisation server context).

PATCH/api/v1/automatic-payments/recurring-consents/{recurringConsentId}

Update or revoke recurring consent

Updates or revokes a recurring consent for automatic payments.

Auth: Bearer Token

Parâmetros de path

1 campo
recurringConsentId●
pathstring

Consent identifier (`consentId` from create consent or payment request payload).

Cabeçalhos

3 campos
subTenantId●
headerstring

Subtenant owning the consent.

orgId●
headerstring

Organisation id (must match the institution context).

asId●
headerstring

Authorisation server id.

Corpo da requisição

4 campos
status
bodystring

Set to `REVOKED` in the revoke example.

revocation
bodyobject

Structured revocation metadata from the OpenAPI `revoke` sample.

revokedBy●
bodystring
revokedFrom●
bodystring
reason●
bodyobject
code●
bodystring
detail●
bodystring
riskSignals
bodyobject

Required by strict schema (may be `{}` when unused).

recurringConfiguration
bodyobject

Required by strict schema (may be `{}` when unused).

curl --request PATCH \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/recurring-consents/consent-123' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'subTenantId: subtenant_abc123' \
  --header 'orgId: 74e929d9-33b6-4d85-8ba7-c146c867a817' \
  --header 'asId: c8f0bf49-4744-4933-8960-7add6e590841' \
  --data '{
  "status": "REVOKED",
  "revocation": {
    "revokedBy": "USUARIO",
    "revokedFrom": "INICIADORA",
    "reason": {
      "code": "REVOGADO_USUARIO",
      "detail": "The payer revoked the recurrence at the initiator."
    }
  },
  "riskSignals": {},
  "recurringConfiguration": {}
}'

Response

200Consent updated successfully.
Response body
object
  • typestringrequired
  • messagestringrequired
  • dataobjectrequired

    AutomaticPaymentRequest after update — see OpenAPI.

  • statusCodenumberrequired
200 · Consent updated successfully.
{
  "type": "success",
  "message": "",
  "data": {
    "id": "f3b4e8c2-2c1d-4f6a-9c1e-5a92f3a7d8a1",
    "consentStatus": "REVOKED"
  },
  "statusCode": 200
}

Next steps