API de Pagamentos

O serviço de Pagamentos permite consultar métodos de pagamento disponíveis para processar pedidos, proporcionando uma experiência transparente e flexível no processo de compra.

Overview

credit-card

Endpoint Principal

POST /v4/payments

Consulta métodos de pagamento disponíveis baseado nos dados da viagem selecionada.

shield-alt

Autenticação

Bearer Token

Todas as requisições requerem autenticação via token Bearer no header.

Como Funciona

routeFluxo Completo

Seleção: Cliente seleciona viagem e assentos desejados
Consulta: Aplicação chama /v4/payments com dados da viagem
Resposta: API retorna métodos de pagamento disponíveis com taxas
Escolha: Cliente escolhe o método de pagamento preferido
Processamento: Pagamento é processado via endpoint específico

Estrutura da Requisição

Campo	Tipo	Descrição	Exemplo
`trips.departures.parts[].items[].id`	string	ID do assento selecionado	`4rzrstemhmmyupzjkhliezv2v`
`trips.departures.parts[].tripId`	string	ID da viagem	`e6f3f59b-5298-3cb1-8489-ed8e9a169f31`
`trips.departures.parts[].items[].price`	number	Preço do assento	`90.00`

Campo	Tipo	Descrição	Exemplo
`trips.departures.parts[].items[].type`	string	Tipo do item	`seat`
`trips.departures.type`	string	Tipo da viagem	`direct`

Resposta da API

codeEstrutura da Resposta

A API retorna um array de métodos de pagamento disponíveis:

Campo	Tipo	Descrição	Exemplo
`paymentMethods[].method`	string	Método de pagamento	`direct`
`paymentMethods[].totalAmount`	string	Valor total	`90.00`
`paymentMethods[].fee`	string	Taxa fixa	`0.0`
`paymentMethods[].percentageFee`	string	Taxa percentual	`0.0`
`paymentMethods[].discountedFee`	string	Taxa com desconto	`0.0`
`paymentMethods[].status`	string	Disponibilidade	`AVAILABLE`

Características Principais

Consulta Não-Transacional

Apenas consulta opções disponíveis sem processar pagamento

sync-alt

Métodos Dinâmicos

Disponibilidade baseada na rota, data e outros fatores

calculator

Taxas Transparentes

Cálculo automático de taxas por método com valores claros

clock

Status em Tempo Real

Informações de disponibilidade sempre atualizadas

Tipos de Pagamento

credit-card

Pagamento Direto

Sem intermediários, taxas mínimas e processamento rápido

list

Pagamento com cartão de crédito

Opções de outros métodos de pagamento, taxas e flexibilidade para o cliente

Benefícios

starVantagens da API

🔍 Transparência Total: Todas as taxas e valores são apresentados claramente antes da compra
- 🚀 Experiência Aprimorada: Consulta prévia permite melhor decisão do cliente
- 💳 Múltiplas Opções: Diversos métodos de pagamento para diferentes necessidades
- ⚡ Integração Simples: API REST padrão com autenticação Bearer token
- 🎯 Cálculos Automáticos: Sistema calcula automaticamente descontos e taxas aplicáveis

💡 Dica: Esta API é apenas para consulta de métodos. O processamento do pagamento é realizado através de endpoints específicos após a escolha do método pelo cliente.