API Reference

Introdução a API de Pedidos

::A API de Pedidos do PagBank, também conhecida como API Order, engloba todas as operações relacionadas ao processo de cobrança após a definição do pedido.

Serviços disponíveis

Tratando-se de uma API de Pedidos, um dos pontos mais importantes é a gama de meios de pagamento disponíveis. Atualmente, a API de Pedidos do PagBank proporciona as seguintes opções para a realização de pagamentos:

  • Cartão de Crédito
  • Cartão de Débito (Obrigatório 3DS)
  • PIX
  • Boleto Bancário

Além da criação de pagamentos, a API de Pedidos disponibiliza outros recursos, como:

  • Tokenização
  • Repasse de juros
  • Autenticação 3DS
  • Divisão do pagamento

Fluxos de utilização da API

O fluxo convencional para a realização de um pagamento envolve a utilização de três endpoints para a criação de um pedido, realização do pagamento pelo cliente e captura desse pagamento. Entretanto, dependendo do meio de pagamento ou dos recursos incorporados, como tokenização, esse fluxo e o número de passos que você deve realizar pode ser alterado. Por esse motivo, disponibilizamos a página de Casos de uso para você entender melhor todas as possibilidades disponibilizadas pela API de Pedidos do PagBank.

👍

Explore os casos de uso

Na página de Casos de uso listamos todas as variações do processo de criação e pagamento de um pedido. Se você está incerto em relação ao que você precisa para o seu negócio, recomendamos fortemente que verifique os guias passo a passo disponíveis.

Endpoints e webhooks

A utilização da API de Pedidos é feita através dos 8 endpoints principais relacionados a criação e consulta de pedidos. Esses endpoints são apresentados a seguir:

  • Criar pedido: possibilita a criação de um pedido, incluindo a opção de efetuar o pagamento.. Dependendo do método de pagamento selecionado, você pode criar e pagar o pedido utilizando apenas este endpoint.
  • Consultar pedido: permite a consulta de pedidos anteriormente criados, utilizando um identificador único associado ao pedido.
  • Consultar pedido através de parâmetros: possibilita a consulta de pedidos já existentes através de parâmetros específicos, como o identificador da cobrança.
  • Consultar divisão do pagamento: permite recuperar os dados relacionados à divisão de um pagamento, oferecendo insights sobre a distribuição dos valores envolvidos.
  • Pagar pedido: este endpoint viabiliza o processo de pagamento para um pedido previamente criado.
  • Consultar pagamento: oferece a funcionalidade de consultar o status de um pagamento, proporcionando informações atualizadas sobre a transação.
  • Capturar pagamento: permite a capture transações pré-autorizadas.
  • Cancelar pagamento: possibilita a devolução do valor pago ao comprador, sendo aplicável tanto para desfazer uma pré-autorização quanto para reembolsar um pagamento já capturado.

Além desses endpoints, existem outros 3 que oferecem funcionalidades complementares aos processos de criação de pedido e pagamento. Esses serviços são cobertos pelos seguintes endpoints:

O PagBank também disponibiliza webhooks para notificação em tempo real sobre eventos relacionados à alteração de status em pedidos e pagamentos criados. Acesse a página de Webhooks para maiores informações sobre as notificações cobertas e meios de integração.

Objetos

A API de Pedidos utiliza dois objetos principais nos processos de criação de pedidos (objeto Order) e criação de pagamentos (objeto Charge). Para identificar todos os parâmetros, seus respectivos tipos e exemplos de cada parâmetro do objeto, acesse as páginas do Objeto Order e do Objeto Charge.

Erros e bloqueios de pagamento

Ao utilizar os endpoints da API de Pagamentos, você pode se deparar com dois tipos de problemas. O primeiro diz respeito aos erros associados à realização de requisições e o segundo se relaciona à não autorização dos pagamentos.

Os erros relacionados à requisição aos endpoints normalmente estão associados ao fornecimento de parâmetros incorretos ou falta de autenticação. Para te auxiliar a entender os problemas ao executar as requisições, você pode acessar a página Códigos de erro, que lista os códigos que você pode receber e provê detalhes adicionais para cada erro.

A realização de um pagamento pode ser efetuada com sucesso ou ser bloqueada. No caso de um pagamento bloqueado, um erro não será necessariamente gerado. Para identificar o status da operação, você deverá checar o código da resposta da operação e a mensagem associada. A página Motivos de compra negada disponibiliza a lista de códigos que você pode receber ao tentar realizar um pagamento e descrições complementares.