Pular para o conteúdo

Cancel consent payments

Cancels all future payments linked to a consent. Pending installments that have not yet settled are removed; use this when the payer or your business ends the entire schedule at once.

The response body is the same payment-request envelope as Get payment request, reflecting the updated state after cancellation.

PATCH/api/v1/open-integration/consents/{consentId}/payments/cancel

Cancel the future payments of consent

Cancels every future payment associated with the given consent.

Auth: Bearer Token

Parâmetros de path

1 campo
consentId●
pathstring

Consent identifier returned on the payment request (`consentId` field).

Corpo da requisição

1 campo
cpfCancelledBy●
bodystring

CPF (digits only) of the person responsible for the cancellation.

curl --request PATCH \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/open-integration/consents/consent123/payments/cancel' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --data '{
  "cpfCancelledBy": "11111111111"
}'

Response

200Cancellation applied; payment request returned in its updated state.
Response body
object
  • dataobjectrequired

    Payment request details (same shape as Get payment request).

    • idstringrequired

      ID of the payment request.

    • createDateTimestringrequired· date-time

      Creation date and time.

    • lastChangedDateTimestringrequired· date-time

      Last modification date and time.

    • externalCommentstringrequired· nullable

      External comment.

    • externalIdstringrequired· nullable

      External ID you sent at consent creation.

    • cpfCnpjstringrequired· nullable

      Payer CPF or CNPJ.

    • redirectUristringrequired· nullable

      Redirect URI used for the flow.

    • tenantIdstringrequired

      Tenant ID.

    • consentIdstringrequired· nullable

      Consent ID.

    • valuenumberrequired

      Total value in BRL.

    • statusstringrequired

      Request-level status. One of `PENDENTE`, `EM_PROCESSAMENTO`, `CONSUMIDO`, `EXPIRADO`, `CANCELADO`, `ERRO_NA_DETENTORA`, `ERRO`.

    • creditorobjectrequired

      Creditor details.

    • debitorobjectrequired· nullable

      Debtor account details or null.

    • typestringrequired· nullable

      One of `NOW`, `SINGLE`, `DAILY`, `WEEKLY`, `MONTHLY`, `CUSTOM`.

    • paymentsarray of objectsrequired

      Payments under this request.

  • messagestring

    Response message.

  • typestring

    Response type.

  • statusCodeinteger· nullable

    HTTP status inside envelope.

Sem exemplo para este status.

Next steps