Pagamento
Nesta sesção, disponibilizamos operações para realizar pagamentos e acompanhar sua efetivação.
Pagamento - Consultar
Funcionalidade permite consultar os pagamentos realizados em um período e apresenta o status e demais dados do pagamento.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| Inicio | Início do período desejado de pesquisa | date-time | Sim |
| Fim | Fim do período desejado de pesquisa | date-time | Sim |
| Status | Status do pagamento que desejado | string | Não |
| Tipo | Tipo de iniciação do pagamento, que podem ser: CHAVE_DICT, MANUAL ou QR_CODE | string | Não |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| pagamentoId | Identificador do pagamento | string | Não |
| endToEndId | Identificador da transação Pix | string | Sim |
| dataHoraCriacao | Data e hora da iniciação do pagamento | date-time | Não |
| pagador | Dados do pagador da transação Pix (banco, agência, conta, documento) | object | Sim |
| recebedor | Dados do recebedor da transação Pix (banco, agência, conta, documento) | object | Sim |
| informacoesEntreUsuarios | Informação incluída pelo pagador, se desejar, no momento do pagamento | string | Sim |
| status | Status da transação, conforme tabela [Status Pagamento] | string | Não |
| valor | Valor da transação Pix | number | Não |
Pagamento - Consultar - PagamentoId
Funcionalidade permite consultar um pagamento específico pelo identificador interno do pagamento em questão e apresenta status e demais dados do pagamento.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| pagamentoId | Identificador do pagamento | string | Sim |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| endToEndId | Identificador da transação Pix | string | Sim |
| status | Status da transação, conforme tabela [Status Pagamento] | string | Não |
| qrCode | Dados do QR CODE (categoria, moeda, pais, cidade e txId) | object | Sim |
| cobranca | Dados da cobrança (id, pagador, data de validade, valor, chave etc.) | object | Sim |
| recebedor | Dados do recebedor da transação Pix | object | Sim |
| valor | Valor da transação Pix | number | Sim |
| numeroContaPagador | Número da conta utilizada na validação de pagamento | string | Sim |
Pagamento - Consultar - PagamentoId
Pagamento - Iniciar - QrCodes
Funcionalidade realiza a validação das propriedades de um QR Code. A partir da iniciação com sucesso, será possível confirmar o pagamento na operação Pagamento - Confirmar.
Como pré-requisito, o QR Code não pode ter sido gerado pela própria conta do cliente.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| qrCode | Dados obtidos por meio da leitura do qrcode ou também conhecido como código "Copia e Cola" | string | Sim |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| pagamentoId | Identificador do pagamento | string | Não |
| endToEndId | Identificador da transação Pix | string | Sim |
| pagador | Dados do pagador do Pix (banco, agência, conta, documento) | object | Sim |
| recebedor | Dados do recebedor do Pix (banco, agência, conta, documento) | object | Sim |
| valor | Valor da transação Pix | number | Sim |
| tipo | Tipo do QR CODE, sendo "Estatico" ou "Dinâmico" | string | Não |
| cobranca | Dados da cobrança (id, pagador, data de validade, valor, chave etc.) | object | Sim |
| txId | Identificador informado pelo cliente que identifica a transação | string | Sim |
Pagamento - Iniciar - Chaves
Funcionalidade realiza a validação de uma chave PIX no DICT* e, caso esteja de acordo, permite que o pagamento prossiga. A partir da iniciação com sucesso, será possível confirmar o pagamento na operação Pagamento - Confirmar.
Como pré-requisito, a chave Pix não pode ser da conta do cliente.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| chave | Chave DICT do recebedor, conforme tabela [Tipos de chaves] | object | Sim |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| pagamentoId | Identificador do pagamento | string | Não |
| endToEndId | Identificador da transação Pix | string | Sim |
| pagador | Dados do pagador do Pix (banco, agência, conta, documento) | object | Sim |
| recebedor | Dados do recebedor do Pix (banco, agência, conta, documento) | object | Sim |
*Diretório de Identificadores de Contas Transacionais
Importante:
O Banco Central regula por meio de políticas de limitação de requisições o acesso ao DICT para verificação de chaves.
Sendo assim, é importante preservar o processo de iniciação de pagamentos via chaves para que não haja uma conduta que aparente varredura de chaves.
Veja mais em Balde de Fichas.
Pagamento - Iniciar - Manual
Funcionalidade realiza a validação dos dados bancários do recebedor. A partir da iniciação com sucesso, será possível confirmar o pagamento na operação Pagamento - Confirmar.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| recebedor | Solicita os dados do recebedor do Pix (banco, agência, conta, documento) | object | Sim |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| pagamentoId | Identificador do pagamento | string | Não |
| endToEndId | Identificador da transação Pix | string | Sim |
| pagador | Dados do pagador do Pix (banco, agência, conta, documento) | object | Sim |
| recebedor | Dados do recebedor do Pix (banco, agência, conta, documento) | object | Sim |
Pagamento - Confirmar
Essa funcionalidade confirma o pagamento iniciado por meio das operações de iniciação manual, por QR CODE ou chaves. Se a requisição ocorrer com sucesso, um webhook do evento "Pagamento" será disparado.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| pagamentoId | Identificador do pagamento | string | Sim |
| recebedor | Dados do recebedor do Pix (banco, agência, conta, documento) | object | Sim |
| valor | Valor do pagamento | number | Sim |
| campoLivre | Mensagem destinada ao recebedor | string | Não |
| efetuarEm | Data em que o pagamento será efetuado | date-time | Não |
Resposta: HTTP 202 accepted.
Pagamento - Solicitação de pagamento
Funcionalidade realiza a validação e verificação no DICT de uma lista de chaves Pix para o pagamento. E as chaves válidas têm os pagamentos iniciados e confirmados automaticamente.
As operações poderão ser consultadas individualmente na funcionalidade Pagamento - Consultar solicitacao por SolicitacaoId.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| solicitacoes | Chave Pix e valor a pagar | object | Sim |
Resposta:
| Campo | Descrição | Formato | Nullablle |
|---|---|---|---|
| identificador | Identificador individualizado para cada pagamento realizado na Solicitação | string | Não |
| solicitacaoId | Identificador da solicitação de pagamento | string | Sim |
| chave | Dados da chave do Pix | object | Sim |
| valor | Valor do pagamento | object | Sim |
Pagamento - Solicitar pagamento por chave
Pagamento - Consultar solicitação por SolicitacaoId
Funcionalidade permite consultar um pagamento específico pelo identificador da solicitação de pagamento em questão.
Solicitamos o campo:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| solicitacaoId | Identificador da solicitação de pagamento | string | Não |
Resposta:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| solicitacaoId | Identificador da solicitação | string | Não |
| pagamentoId | Identificador do pagamento | string | Não |
| endToEndId | Identificador da transação Pix | string | Não |
| status | Status da transação Pix conforme tabela [Status do Pagamento] | string | Não |
| agencia | Agência do recebedor | string | Não |
| numero | Número da conta do recebedor | string | Não |
| chave | Chave PIX do recebedor | string | Não |
| valor | Valor da transação Pix | string | Não |
| campoLivre | Mensagem que o pagador envia para o recebedor, se desejar | string | Não |
| rejeitadoDescricao | Motivo da rejeição, em caso de busca por pagamentos rejeitados | string | Não |
| erroDescricao | Motivo de erro, em caso de erro no pagamento | string | Não |
Pagamento - Consultar solicitacao por SolicitacaoId
Status do pagamento
A tabela abaixo apresenta os status que os pagamentos podem apresentar:
| Campo | Descrição |
|---|---|
| INICIADO | Pagamento foi iniciado, porém ainda não foi confirmado pelo consumidor da API |
| CONFIRMADO | Confirmação ocorreu com sucesso e a solicitação do pagamento foi enviada para o BACEN |
| EFETIVADO | Pagamento foi realizado com sucesso e o valor foi debitado da conta |
| REJEITADO | A contraparte do pagamento o rejeitou. Os motivos podem variar desde indisponibilidade na contraparte ou conta do destinatário encerrada/bloqueada |
| ERRO | Ocorreu algum erro durante o fluxo de pagamento |
| EXPIRADO | O tempo entre a iniciação e a confirmação do pagamento excedeu 12 horas |
Tipos de chaves
A seguir, a tabela com os tipos de chaves Pix e sua formatação:
| Tipo | Exp. regular | Exemplo | Comentário |
|---|---|---|---|
| CPF | ^[0-9]{11}$ | 12345678901 | |
| CNPJ | ^[0-9]{14}$ | 12345678901234 | |
| CNPJ | ^+[1-9][0-9]\d{1,14}$ | +5510998765432 | |
| E-mails válidos W3C HTML5 | [email protected] | Máximo 77 caracteres e em minúsculo | |
| EVP | [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} | 123e4567-e89b-12d3-a456-426655440000 | Endereço Virtual de Pagamento é um tipo de chave pelo DICT |
Updated 3 months ago