Pular para o conteúdo

Update recurring payment

Updates an automatic payment leg — typically to cancel or supply cancellation metadata. Requires subTenantId.

PATCH/api/v1/automatic-payments/recurring-payments/{recurringPaymentId}

Update recurring payment

Updates a recurring payment, typically to cancel or modify payment status.

Auth: Bearer Token

Parâmetros de path

1 campo
recurringPaymentId●
pathstring

Automatic payment id returned by create payment or list endpoints.

Cabeçalhos

1 campo
subTenantId●
headerstring

Subtenant that owns the payment.

Corpo da requisição

3 campos
cpfCancelledBy
bodystring

CPF (digits only) of the user who cancelled — listed as required in strict OpenAPI; omit if your backend follows the `base` example instead.

status
bodystring

Example field from OpenAPI `base` sample (for example `CANC`).

cancellation
bodyobject

Structured cancellation data from the `base` example.

cancelledBy
bodyobject
document
bodyobject
identification●
bodystring
rel●
bodystring
curl --request PATCH \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/recurring-payments/payment-123' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'subTenantId: subtenant_abc123' \
  --data '{
  "cpfCancelledBy": "11111111111",
  "status": "CANC",
  "cancellation": {
    "cancelledBy": {
      "document": {
        "identification": "11111111111",
        "rel": "CPF"
      }
    }
  }
}'

Response

200Payment updated successfully.
Response body
object
  • dataobjectrequired

    Updated AutomaticPayment — see OpenAPI.

    • idstringrequired

      Payment id.

  • messagestring

    Response message.

  • typestring

    Envelope type.

200 · Payment updated successfully.
{
  "data": {
    "id": "payment-123",
    "status": "CANCELADO"
  },
  "message": "",
  "type": "success"
}

Next steps