Iniciar pagamento Pix

Essa API permite que seja realizada a iniciação de um pagamento Pix a partir das regras populadas em seu payload.

📘

Criamos um artigo que explica, detalhadamente, como usar essa API.

Regras de preenchimento e validação conforme o 'TransactionType':

TRANSFER:
• 'vlcpAmount', 'vldnAmount', 'withdrawalAgentMode' e 'withdrawalServiceProvider' não devem ser preenchidos.

WITHDRAWAL:
• 'vlcpAmount' não deve ser preenchido, 'vldnAmount', 'withdrawalAgentMode' e 'withdrawalServiceProvider' devem ser preenchidos.

CHANGE:
• 'vlcpAmount', 'vldnAmount', 'withdrawalAgentMode' e 'withdrawalServiceProvider' devem ser preenchidos.

Regras de preenchimento e validação conforme o 'InitiationType':

MANUAL:
• 'transactionIdentification' deve ser nulo
• 'creditParty.key' deve ser nulo
'endToEndId' deve ser preenchido com o identificador gerado peloPOST /payment/endToEnd .

DICT:
• 'transactionIdentification' deve ser nulo
• 'creditParty.key' deve ser preenchido
'endToEndId' deve ser preenchido com o mesmo endToEndId da consulta ao DICT.

STATIC_QRCODE:
• 'transactionIdentification' deve ser preenchido com o identificador do QR Code contendo até 25 caracteres
• 'creditParty.key' deve ser preenchido
'endToEndId' deve ser preenchido com o mesmo endToEndId da consulta ao DICT.

DYNAMIC_QRCODE:
• 'transactionIdentification' deve ser preenchido com o identificador do QR Code contendo de 26 até 35 caracteres
• 'creditParty.key' deve ser preenchido
'endToEndId' deve ser preenchido com o mesmo endToEndId da consulta ao DICT.

PAYMENT_INITIATOR:
• 'transactionIdentification' deve ser preenchido de acordo com a regra de pagamento de STATIC_QRCODE
• 'creditParty.key' deve ser preenchido caso exista uma consulta DICT pré-pagamento
• 'taxIdPaymentInitiator' deve ser preenchido com um CNPJ (14 caracteres)
'endToEndId' deve ser preenchido com o mesmo endToEndId da consulta ao DICT.

Regras de preenchimento e validação conforme o 'PaymentType':

IMMEDIATE: pagamentos que deverão ser efetuados imediatamente, no ato da solicitação pelo usuário pagador
• 'urgency' deve ser preenchido com HIGH.

FRAUD: usado para pagamento por suspeita de fraude
• 'urgency' deve ser preenchido com NORMAL.

SCHEDULED: transações que não serão realizadas imediatamente, como no caso de pagamentos agendados.
• 'urgency' deve ser preenchido com NORMAL.

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!