Pedido de Pagamento
Crie um pedido
A criação de pedido é a primeira etapa e necessária para que se realize o registro do pedido e com isso ocorra a geração das cobranças relacionadas a ele. Dessa forma, um pedido terá uma ou mais cobranças associadas.
Você criará um pedido de pagamento utilizando o criar pedido. É possível realizar a criação de pagamentos com múltiplos meios de pagamento, pagamentos parcelados ou 3DS, dependendo da necessidade do usuário.
Meios de pagamento disponíveis
Aqui você pode saber mais sobre os meios de pagamento disponíveis e suas características.
Após a criação do pedido de pagamento você receberá como retorno apenas um order_id que é um identificador único do pedido de pagamento. Toda mudança no status do pedido será encaminhada via webhook que você cadastrou anteriormente.
Alterações no pedido
Você poderá realizar alterações em um pedido, enquanto o mesmo estiver com o status aberto mantendo o mesmo
order_ide realizando as alterações através dele.
Desta forma, caso seja necessário realizar alterações, como por exemplo: substituição do meio de pagamento, inclusão e alteração dos itens do pedido, entre outros; será possível.
Forneça os campos necessários
É essencial fornecer informações relacionadas ao cliente, incluindo o objeto customer, que identifica o cliente dentro do sistema Zapay. Adicionalmente, inclua a seção items contendo os detalhes do produto no pedido para registro. Além disso, é necessário especificar pelo menos um meio de pagamento, podendo ser credit_card, bank_slip , pix.
Itens do pedido
Os itens do pedido são utilizados para encapsular informações essenciais relacionadas aos débitos que serão pagos, proporcionando uma estrutura organizada e clara para o processamento de pagamentos.
Cada item do pedido deve ser devidamente classificado como Vehicle Debt (débito veicular), Other (outros débitos), ou Batch Payment (pagamento em lote).
- Vehicle Debt Esta classificação é reservada para representar um débito veicular individual, proporcionando uma categorização específica para transações relacionadas a veículos.
- Other A categoria "Other" é designada para débitos que não possuem vínculo direto com uma placa veicular específica, abrangendo todas as transações que não se enquadram na classificação de débito veicular.
- Batch Payment Quando um item do pedido representa uma consulta veicular que envolve múltiplos débitos, utiliza-se a classificação "Batch Payment". Porém é crucial fornecer informações adicionais sobre quais débitos contidos nessa consulta serão efetivamente pagos.
A inclusão de certos campos não é estritamente obrigatória ao criar um pedido de pagamento. No entanto, ao fornecer essas informações, é possível aprimorar a experiência do usuário no processo de pagamento. Recomenda-se prestar atenção especial aos campos obrigatórios caso opte por incluir esses detalhes.
Campos adicionais
Para a requisição de pagamentos em lote, é necessário especificar o objeto "metadata" e nele deve conter o array "items", onde deve ser informado o código dos débitos a serem pagos.
Verifique aqui os campos essenciais necessários para a criação de um pedido de pagamento.
Recursos Adicionais
Oferecemos a possibilidade de utilizar recursos adicionais compatíveis durante o processo básico de criação do pedido de pagamento:
Campos adicionais: Detalhes Importantes
Oferecemos recursos que elevam a segurança e a conveniência para seus clientes. Isso inclui a opção de transações mais seguras com cartões tokenizados, proporcionando maior confiança durante as operações. Além disso, proporcionamos uma visão mais abrangente das opções de parcelamento, incluindo informações detalhadas sobre taxas associadas.
Para saber mais sobre tokenização, clique aqui.
- tokenize_on_success: Caso seu cliente opte por efetuar o pagamento com um cartão de crédito, permitimos que você registre esse método de pagamento para o cliente, facilitando futuras compras na mesma etapa.
- installments: Se você oferece parcelamento para os pagamentos dos seus clientes e o processador escolhido aceita essa funcionalidade, é possível nos enviar o valor das parcelas dentro do objeto
credit_cardempaymentspara criar o pagamento de acordo com as condições escolhidas. - external_id: Representa um identificador externo do pedido, sendo um meio para rastreamento do pagamento.
Eventos disponíveis para o Pedido de Pagamento
Possuímos uma lista de eventos significativos que podem ocorrer em nossa API em relação ao pedido de pagamento. Confira abaixo:
| Evento | Descrição |
|---|---|
order.created | Ocorre sempre que um pedido é criado. |
order.updated | Ocorre sempre que um pedido é atualizado. |
order.paid | Ocorre sempre que um pedido é efetivamente pago. |
order.canceled | Ocorre sempre que um pedido é cancelado. |
order.payment_failed | Ocorre sempre que o pagamento de um pedido falha. |
order.closed | Ocorre sempre que um pedido é fechado. |
Status de um Pedido de Pagamento
O ciclo de vida de um Pedido de Pagamento compreende várias etapas, contendo diferentes status associados a ele. Esses status proporcionam uma visão sucinta de um pedido, desde sua criação até a conclusão ou eventual cancelamento, refletindo as diversas situações e estados possíveis ao longo desse processo.
| Status | Descrição |
|---|---|
pending | O pedido está ativo, aguardando processamento adicional ou confirmação. |
processing | O pedido está em fase de processamento e ainda não foi finalizada. |
paid | O pedido foi pago com sucesso e está concluído. |
canceled | O pedido foi cancelado, indicando que não será processado. |
failed | O pedido falhou, indicando que não foi bem-sucedido no processamento. |
Atenção
Independentemente do status, é importante lembrar que um pedido sempre gera pelo menos uma cobrança.
Funcionalidades relacionadas ao Pedido de Pagamento:
Explore detalhadamente os pedidos por meio de nossa API Reference!
Updated 11 months ago