Cartão · Pagamentos
Visão Geral
Endpoints para criar, tokenizar e cancelar pagamentos com cartão
A API de Pagamentos autoriza transações com cartão — enviando o número do cartão diretamente ou um token previamente gerado (ver Cartões).
Endpoints
| Operação | Método e rota |
|---|---|
| Criar pagamento | POST /api/v1/payments |
| Criar pagamento com tokenização | POST /api/v1/payments/tokenize |
| Listar pagamentos | GET /api/v1/payments |
| Consultar pagamento por ID | GET /api/v1/payments/{id} |
| Cancelar pagamento | PUT /api/v1/payments/{paymentId}/cancel |
Status de transação
O campo status das respostas de pagamento, cancelamento e cartão usa os seguintes
valores:
| Valor | Valor | Valor |
|---|---|---|
NOV | INV | PPC |
PPN | PEN | CON |
Negada | ERR | BLQ |
EXP | EST | AGU |
ABA | CAN | RET |
As descrições detalhadas de cada status são fornecidas pelo time de Crédito. De forma
geral, CON indica transação confirmada e qualquer codigo de resposta diferente de
0 indica falha.
Caminho típico de uma transação
Em recusas, consulte merchantAdviceCode antes de retentar a cobrança — ver
Criar pagamento.