Iniciar pagamento

Cria o consentimento para realização do pagamento e retorna a URL de redirecionamento para a detentora de conta.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Identificador da organização associada à marca selecionada pelo usuário iniciador da transação.

string
required

Identificador da marca selecionada pelo usuário iniciador da transação.

string
required

Destino para o qual o usuário iniciador da transação será redirecionado após retornar da detentora de conta.

string
required

Montante a ser debitado da conta do usuário iniciador da transação.

string
required

Nome do usuário iniciador da transação.

string
required

Número do documento CPF do usuário iniciador da transação.

string
required

Código ISPB do beneficiário.

string
required

Agência do beneficiário.

string
required

Número de conta do beneficiário.

string | null

Chave Pix do beneficiário.

string
enum
required

Tipo de conta do beneficiário.
Os possíveis tipos são:

  1. CACC - Conta Corrente;
  2. SLRY - Conta-Salário;
  3. SVGS - Conta de Poupança; e
  4. TRAN - Conta de Pagamento pré-paga.
Allowed:
string
enum
required

Especifica se o beneficiário é pessoa física (NATURAL_PERSON) ou jurídica (LEGAL_PERSON).

Allowed:
string
required

Nome do beneficiário.

string
required

Número do documento do beneficiário (CPF ou CNPJ).

string | null

QrCode de pagamento.

string
enum
required

Tipos de pix.
Os possíveis tipos são:

  1. MANU - Inserção manual de dados da conta transacional;
  2. DICT - Inserção manual de chave Pix;
  3. QRDN - QR code dinâmico;
  4. QRES - QR code estático;
  5. INIC - Indica que o recebedor (creditor) contratou o Iniciador de Pagamentos especificamente para realizar iniciações de pagamento em que o beneficiário é previamente conhecido.
Allowed:
string
required

Identificação da transação que será retransmitida ao gerar a ordem de pagamento. Utilize para relacionar a transação de pagamento às suas operações internas.

Esse campo é obrigatório.
Esse campo possui tamanho máximo de 25 posições e aceita apenas caracteres alfanuméricos.

string | null

Número do documento CNPJ do usuário iniciador da transação. Em caso de transação de conta juridica.

string | null

Pode ser utilizada sempre que o usuário iniciador do pagamento necessitar enviar alguma informação adicional ao beneficiário.
Esse campo é opcional, possui tamanho máximo de 140 posições e aceita qualquer tipo de caractere (exceto especiais).

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json