v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBCriar uma transação pix.
Pagamento - Criar uma transação pix<br/>Permite que usuários autorizados iniciem e executem pagamentos Pix diretamente do sistema de pagamentos. Essa API otimiza o processo de envio e recebimento de pagamentos instantâneos, promovendo eficiência, transparência e segurança nas transações financeiras.<br/><br/>Funcionalidades Essenciais:<br/>- Iniciação de Transações: Os usuários podem iniciar novas transações Pix fornecendo detalhes essenciais, incluindo:<br/>- Chave Pix do destinatário: O identificador único da conta Pix do destinatário.<br/>- Valor da transação: O valor exato a ser transferido na transação.<br/>- Descrição (opcional): Uma breve descrição ou referência para a transação.<br/>- Reversão de Transação (opcional): Em caso de erros ou disputas, os usuários autorizados podem iniciar reversões de transações para devolver fundos à conta do remetente.<br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>cpfOperador</td><td>Texto</td><td>CPF do usuário cadastrado na plataforma </td><td>Sim</td></tr><tr><td>contaOrigem</td><td>Texto</td><td>Conta da qual se origina o pagamento com o digito verificador.</td><td>Sim</td></tr><tr><td>senhaMovimentacao</td><td>Texto</td><td>Senha de movimentação utilizada pelo operador dentro da plataforma </td><td>Sim</td></tr><tr><td>amount</td><td>Texto</td><td>Valor do pix a ser enviado </td><td>Sim</td></tr><tr><td>date</td><td>Texto</td><td>Data de agendamento do pix </td><td>Não</td></tr><tr><td>description</td><td>Texto</td><td>Descrição do pix </td><td>Não</td></tr><tr><td>type</td><td>Texto</td><td>Tipo da chave pix </td><td>Sim</td></tr><tr><td>phoneNumber</td><td>Texto</td><td>Número de telefone </td><td>Não</td></tr><tr><td>email</td><td>Texto</td><td>Email da chave pix </td><td>Não</td></tr><tr><td>randomKey</td><td>Texto</td><td>Chave aleatória </td><td>Não</td></tr><tr><td>code</td><td>Texto</td><td>Código pix cópia e cola </td><td>Não</td></tr><tr><td>documentNumber</td><td>Texto</td><td>Número de documento CPF ou CNPJ </td><td>Não</td></tr><tr><td>bank</td><td>Texto</td><td>Código do banco </td><td>Não</td></tr><tr><td>bankName</td><td>Texto</td><td>Nome do banco </td><td>Não</td></tr><tr><td>agency</td><td>Texto</td><td>Número da agência </td><td>Não</td></tr><tr><td>account</td><td>Texto</td><td>Número da conta </td><td>Não</td></tr><tr><td>name</td><td>Texto</td><td>Nome do destinatário </td><td>Não</td></tr></tbody></table><br/><br/>Resposta<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem para comprovação da transação </td></tr><tr><td>Data - transaction</td><td>Texto</td><td>Código da transação </td></tr></tbody></table>
Headers
Client ID enviado no Header
Request body
Example request
{
"cpfOperador": "00000000000",
"contaOrigem": "0550000000",
"senhaMovimentacao": "8*****",
"amount": "1.000,00",
"date": "YYYY-MM-DD",
"description": "Descrição",
"type": "phone/cpf/cnpj/email/random/code/bank",
"phoneNumber": "(00)00000-0000",
"email": "test@email.com",
"randomKey": "bd9a5c8f-3e2d-467b-b401-5f1e4a7d2e78",
"code": "00020126480014BR.GOV.BCB.PIX0114bd9a5c8f3e2d467b5204000053039865802BR5913Fulano de Tal6009Sao Paulo62070503***6304ABCD",
"documentNumber": "000.000.000-00",
"bank": "001",
"bankName": "Banco do Brasil",
"agency": "1234",
"account": "1234567",
"name": "Fulano de Tal"
}Response
Sucesso na criação.
Example response
{
"message": "Trasação criada com sucesso.",
"data": [
{
"transaction": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
]
}