Skip to main content
POST
/
uvvi
/
v1
/
payment
Efetuar Pagamento
curl --request POST \
  --url https://api.uvvipague.com.br/uvvi/v1/payment \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "checkoutId": "chk_abc123xyz",
  "cardToken": "tok_abc123xyz",
  "installments": 3,
  "customer": {
    "name": "João da Silva",
    "email": "joao@example.com",
    "cpfCnpj": "12345678900"
  }
}
'
{
  "success": true,
  "data": {
    "paymentId": "pay_abc123xyz",
    "status": "paid",
    "amount": 1315.89,
    "installments": 3,
    "transactionId": "txn_abc123xyz"
  }
}

Descrição

Processa o pagamento de débitos veiculares utilizando um cartão tokenizado. Este é o último passo do fluxo de pagamento.
Antifraude Integrado: Todos os pagamentos passam pelo sistema antifraude da Uvvipague antes de serem aprovados.

Pré-requisitos

Antes de processar o pagamento, você deve:
  1. Ter criado um checkout válido (checkoutId)
  2. Ter tokenizado o cartão do cliente (cardToken)
  3. Ter simulado as parcelas (opcional, mas recomendado)

Status de Pagamento

O pagamento pode retornar os seguintes status:
  • paid: Pagamento aprovado e processado com sucesso
  • in_analysis: Transação em análise pelo antifraude (aguardar webhook)
  • refused: Transação recusada pela operadora ou antifraude
  • processing: Transação sendo processada
  • awaiting_payment: Aguardando confirmação de pagamento
  • cancelled: Pagamento cancelado
  • refunded: Pagamento estornado
  • chargeback: Contestação de pagamento
Consulte a documentação de ENUMs para detalhes completos sobre cada status.

Webhooks

Após o processamento, você receberá webhooks sobre:
  • Confirmação do pagamento
  • Atualização de status
  • Liquidação dos débitos nos órgãos
Configure seus webhooks na documentação de webhooks para receber notificações automáticas.

Códigos de Resposta HTTP

200 - Sucesso

Pagamento processado com sucesso. Verifique o campo status para o resultado.

400 - Bad Request

Dados inválidos ou incompletos na requisição.

402 - Payment Required

Pagamento recusado pela operadora. Possíveis motivos:
  • PAYMENT_REJECTED: Recusado pela operadora
  • INVALID_CARD: Cartão inválido
  • INSUFFICIENT_FUNDS: Saldo insuficiente
  • FRAUD_DETECTED: Fraude detectada
  • CARD_EXPIRED: Cartão expirado
  • INVALID_CVV: CVV inválido

422 - Unprocessable Entity

Dados válidos mas não podem ser processados (ex: checkout expirado).

Segurança

  • Nunca armazene dados completos de cartão
  • Use sempre tokenização
  • Valide o CVV em cada transação
  • Implemente 3DS quando disponível

Authorizations

x-api-key
string
header
required

API Key fornecida no painel administrativo da Uvvipague

Body

application/json
checkoutId
string
required

ID do checkout criado

Example:

"chk_abc123xyz"

cardToken
string
required

Token do cartão tokenizado

Example:

"tok_abc123xyz"

installments
integer
required

Número de parcelas

Example:

3

customer
object

Response

Pagamento processado com sucesso

success
boolean
Example:

true

data
object