Gerar pagamento via Proxy

Endpoint para gerar pagamento no Detentor de Contas via Proxy.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 256
Query Params
string
required
Body Params
data
array of objects
required
length ≥ 1
data*
string
required

Especifica a forma de iniciação do pagamento:

MANU - Inserção manual de dados da conta transacional

DICT - Inserção manual de chave Pix

QRDN - QR code dinâmico

QRES - QR code estático

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.

payment
object
required

Objeto contendo dados do pagameto como moeda e valor.

creditorAccount
object
required

Objeto que contém a identificação da conta de destino do recebedor.

string
length ≤ 140

Deve ser preenchido sempre que o usuário pagador inserir alguma informação adicional em um pagamento, a ser enviada ao recebedor.

string
length ≤ 512

Sequência de caracteres que corresponde ao QR Code disponibilizado para o pagador. É a sequência de caracteres que seria lida pelo leitor de QR Code, e deve propiciar o retorno dos dados do pagador após consulta na DICT. Essa funcionalidade é possível tanto para QR Code estático quanto para QR Code dinâmico. No arranjo do Pix esta é a mesma sequência gerada e/ou lida pela funcionalidade Pix Copia e Cola. Este campo deverá ser no formato UTF-8. [Restrição] Preenchimento obrigatório para pagamentos por QR Code, observado o tamanho máximo de 512 bytes.

string
required
length ≤ 14

CNPJ do Iniciador de Pagamento devidamente habilitado para a prestação de Serviço de Iniciação no Pix.

string
length ≤ 35

Trata-se de um identificador de transação que deve ser retransmitido intacto pelo PSP do pagador ao gerar a ordem de pagamento. Essa informação permitirá ao recebedor identificar e correlacionar a transferência, quando recebida, com a apresentação das instruções ao pagador. Os caracteres permitidos no contexto do Pix para o campo txid (EMV 62-05) são:

Letras minúsculas, de ‘a’ a ‘z’

Letras maiúsculas, de ‘A’ a ‘z’

Dígitos decimais, de ‘0’ a ‘9’

string
length between 7 and 7

O campo ibgetowncode no arranjo PIX, tem o mesmo comportamento que o campo codMun descrito no item 1.6.6 do manual do PIX, conforme:

Caso a informação referente ao município não seja enviada; o PSP do recebedor assumirá que não existem feriados estaduais e municipais no período em questão.

Restrição: deve ser enviado apenas em cenários de consentimento de pagamentos recorrentes com ou sem informações de debtorAccount.

string
length ≤ 77

Chave cadastrada no DICT pertencente ao recebedor. Os tipos de chaves podem ser: telefone, e-mail, cpf/cnpj ou chave aleatória.
No caso de telefone celular deve ser informado no padrão E.1641.
Para e-mail deve ter o formato xxxxxxxx@xxxxxxx.xxx(.xx) e no máximo 77 caracteres.
No caso de CPF deverá ser informado com 11 números, sem pontos ou traços.
Para o caso de CNPJ deverá ser informado com 14 números, sem pontos ou traços.
No caso de chave aleatória deve ser informado o UUID gerado pelo DICT, conforme formato especificado na RFC41223.
Se informado, a detentora da conta deve validar o proxy no DICT quando localInstrument for igual a DICT, QRDN ou QRES e validar o campo creditorAccount.
Esta validação é opcional caso o localInstrument for igual a INIC.
[Restrição] Se localInstrument for igual a MANU, o campo proxy não deve ser preenchido. Se localInstrument for igual INIC, DICT, QRDN ou QRES, o campo proxy deve ser sempre preenchido com a chave Pix.

string
length between 32 and 32

Trata-se de um identificador único, gerado na instituição iniciadora de pagamento e recebido na instituição detentora de conta, permeando toda a jornada do pagamento Pix.

[Restrição] A detentora deve obrigatoriamente retornar o campo com o mesmo valor recebido da iniciadora.

string

Campo condicional utilizado para identificar o fluxo de autorização em que o pagamento foi solicitado.

[Restrição] Se CIBA ou FIDO, preenchimento obrigatório. Caso o campo não esteja presente no payload, subentende-se que o fluxo de autorização utilizado é o HYBRID_FLOW.

Enum: [ HYBRID_FLOW, CIBA_FLOW, FIDO_FLOW ]

string
length ≤ 256

Identificador único do consentimento criado para a iniciação de pagamento solicitada.

[Restrição] Este campo é de preenchimento obrigatório quando o valor do campo authorisationFlow for igual a FIDO_FLOW.

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json
EnglishEspañol
Powered by Localize
Português (Brasil)