IUiugu

Solicitar Cancelamento Pix Automatico

Solicita o cancelamento de um pagamento agendado.

post/automatic_pix/scheduled_payments/{id}/cancel

Request

  • Base URL
    https://api.iugu.com/v1
  • URL
    https://api.iugu.com/v1/automatic_pix/scheduled_payments/{id}/cancel
  • Auth
    API key in query parameter api_token

Path parameters

idstring required

ID do pagamento agendado.

Request body

cancellationstring required

Bloco de cancelamento.

cancellation.cancellation_requesterinteger required

PSP que solicitou o cancelamento (0 = PSP pagador, 1 = PSP recebedor).

cancellation.requester_ispbstring required

ISPB do PSP que solicitou o cancelamento.

cancellation.recipient_ispbstring required

ISPB do PSP que recebe a solicitação de cancelamento.

cancellation.receiver_reconciliation_idstring required

Identificador único para conciliação do recebedor.

cancellation.person_typeinteger required

Tipo de pessoa do solicitante (0 = física, 1 = jurídica).

cancellation.cpf_cnpj_requesterstring required

CPF/CNPJ do solicitante do cancelamento.

cancellation.reason_for_cancellationinteger required

Motivo do cancelamento (domínio 0–6; ex.: 5 = solicitado pelo usuário pagador).

cancellation.end_to_end_idstring required

Identificador único da transação de pagamento.

Changes

No recorded changes to this operation across all 1 revision of this API.