IUiugu

Efetuar Pagamento Pix Automatico

Efetua o pagamento (transferência Pix) de uma recorrência. Orquestrado por Cmd::AutomaticPix::Pay. Suporta pagamento à vista e agendado (scheduled_date).

post/automatic_pix/recurrences/{id}/pay

Request

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

Path parameters

idstring required

ID da recorrência.

Request body

transfer_typestring required

Deve ser "pix" (único valor aceito).

qrcode_typestring required

Deve ser "compound_qr_code" (único valor aceito).

amount_centsstring required

Valor em centavos.

reasonstring

Motivo.

descriptionstring

Descrição.

external_referencestring

Referência externa. Usada como conciliation_id se reconciliation_id ausente.

reconciliation_idstring

ID de conciliação.

end_to_end_idstring

End-to-end ID. Se ausente, é gerado automaticamente (EndToEndIdGenerator).

scheduled_datestring

Data de agendamento. Se presente, o pagamento é agendado; se ausente, é à vista.

journeystring

Jornada. "3" ativa a criação de recorrência pós-liquidação (exige o bloco qr_code.recurrence).

receiver.namestring required

Nome do recebedor.

receiver.cpf_cnpjstring required

CPF/CNPJ do recebedor.

receiver.bank.compestring

Código COMPE do banco. Usado como bank quando receiver.bank.bank ausente.

receiver.bank.ispbstring required

ISPB do banco.

receiver.bank.branchstring

Agência.

receiver.bank.branch_digitstring

Dígito da agência.

receiver.bank.accountstring required

Conta.

receiver.bank.account_digitstring

Dígito da conta.

receiver.bank.account_typestring required

Tipo da conta.

receiver.bank.bankstring

Código do banco. Se ausente, cai em receiver.bank.compe.

Changes

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