Visão Geral
Chame a API de pagamentos para solicitar métodos de pagamento de host-to-host.
Os parâmetros da API são organizados em objetos distintos para agilizar o processo de pagamento e garantir clareza no tratamento de dados. Cada objeto representa um aspecto específico da transação, facilitando o gerenciamento e a compreensão do fluxo de informações. No entanto, alguns parâmetros são independentes e não fazem parte de nenhum objeto. Abaixo está uma visão geral dos objetos e seus parâmetros correspondentes, bem como os parâmetros autônomos:
Cliente : Representa o indivíduo que faz o pagamento. Este objeto inclui informações críticas sobre o cliente, como seu ID exclusivo, nome, endereço de e-mail e, opcionalmente, seu endereço IP e data de nascimento. O subobjeto customer.document detalha o tipo e o número da identificação oficial do cliente, enquanto o sub objeto customer.address inclui o endereço completo do cliente, que pode ser necessário dependendo do método de pagamento.
Transação : Este objeto contém todos os detalhes essenciais sobre a transação em si, incluindo um ID de transação exclusivo, a moeda usada, o valor total envolvido e, opcionalmente, o tempo até a transação expirar.
Pagamento : Representa o método de pagamento e URLs relacionadas para concluir a transação. Este objeto é crucial para determinar como o cliente pagará e para onde será redirecionado após o pagamento ser concluído.
Valores : Este objeto fornece informações financeiras detalhadas relacionadas à transação. Inclui os valores originais e convertidos, as moedas envolvidas, a taxa de câmbio aplicada e quaisquer taxas associadas à transação.
Parâmetros autônomos, como branch , country , notification_url e redirect_url , não pertencem a nenhum objeto específico. Esses parâmetros fornecem informações adicionais relevantes para a transação, como o local da transação, o código do país, para onde as notificações de pagamento devem ser enviadas e para onde o cliente deve ser redirecionado após concluir o pagamento.
Nossa estrutura de API permanece consistente em diferentes métodos de pagamento e países, facilitando a adaptação à medida que você expande para novas regiões ou integra novos métodos.
Conhecendo os parâmetros utilizados
customer.id
string
Identificador exclusivo para o cliente em seu sistema. Este valor deve permanecer consistente em todas as transações para o mesmo cliente
customer.name
string
O nome completo do cliente que está fazendo o pagamento. Deve corresponder ao nome nos documentos de identificação do cliente
customer.email
string
O endereço de e-mail do cliente. Ele será usado para enviar confirmações de pagamento e notificações
customer.phone
string
O número de telefone do cliente, incluindo o código do país. Este parâmetro pode ser opcional ou obrigatório dependendo do método de pagamento usado
customer.birthdate
string
A data de nascimento do cliente, fornecida no formato mm-dd-yyyy. Este parâmetro pode ser necessário dependendo dos regulamentos do país ou do método de pagamento
customer.document.number
string
O número de identificação oficial do cliente. Normalmente é uma identidade nacional ou outro documento emitido pelo governo
customer.document.type
string
O tipo de documento fornecido pelo cliente. Tipos comuns incluem ID nacional ou carteira de motorista. Lista de documentos permitidos .
customer.address.addres_1
string
O endereço principal do cliente
customer.address.addres_2
string
Informações adicionais de endereço, como número do apartamento ou suíte
customer.address.city
string
A cidade em que o cliente reside
customer.address.country_code
string
O código de país ISO 3166-1 alfa-3 para o endereço do cliente.
customer.address.neightborhood
string
O bairro ou distrito do endereço do cliente
customer.address.number
string
O número da rua do endereço
customer.address.postal_code
string
O código postal ou CEP do endereço do cliente
customer.address.state
string
O estado ou região do endereço do cliente
transaction.id
string
Um identificador exclusivo para a transação. Este ID deve ser gerado pelo seu sistema para rastrear o processo de pagamento específico
transaction.currency
string
A moeda na qual a transação está sendo conduzida. Use códigos de moeda padrão ISO 4217 (por exemplo, USD, BRL).
transaction.amount
decimal (10,2)
O valor total da transação na moeda especificada. Este valor deve ser um valor numérico (use ponto em vez de vírgula) Eg: 300.10
branch
string
O identificador específico da agência ou local onde a transação está sendo processada, se aplicável
country
string
O código do país onde a transação está ocorrendo. O formato é ISO 3166-1 alpha-3 (por exemplo, BRA para o Brasil).
payment_method
string
O método de pagamento utilizado para a transação, como transferência bancária, cartão de crédito...
notification_url
string
A URL para a qual as notificações de pagamento serão enviadas. Certifique-se de que esta URL esteja acessível e configurada para lidar com o formato de notificação
Exemplo de resposta para uma solicitação de método de pagamento pix
{
"requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
"data": {
"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
"status": "pending",
"payment": {
"method": "pix"
},
"values": {
"source_total": "18.00",
"source_currency": "BRL",
"exchanged_total": "18.00",
"exchanged_currency": "PEN",
"exchange": "1.00",
"fee": "0.18000000"
}
}
}Detalhes da resposta
id
Um identificador exclusivo para a resposta gerada pelo sistema de pagamento, usado para rastrear a transação. Pode ser usado para verificar o status do pagamento no endpoint GET /payout/{id}
status
O status atual da transação, como pending, onhold, success, refunded,failed
payment.method
O método de pagamento utilizado para a transação, como bankslip, pix...
values.source_total
O valor total da transação na moeda de origem antes de qualquer troca
values.source_currency
A moeda original da transação conforme especificada na solicitação
values.exchanged_total
O valor total da transação após a conversão de moeda, se aplicável
values.exchanged_currency
A moeda em que o pagamento foi concluído após a conversão
values.exchange
A taxa de câmbio aplicada para converter a moeda de origem para a moeda de destino
values.fee
O valor cobrado pelo nosso serviço para processar a transação
Nossa API foi projetada para ser flexível e adaptável , de modo que, à medida que você expande para novas regiões ou adiciona mais métodos de pagamento, você pode facilmente aplicar esses princípios em diferentes implementações.
Se precisar de mais detalhes sobre outros métodos de pagamento ou países, certifique-se de explorar o restante da nossa documentação. Além disso, temos uma seção dedicada de FAQ e suporte para ajudar com perguntas comuns.
Atualizado
Isto foi útil?