GET/charges/:id

Consultar Cobrança

Status de uma cobrança no cartão ou boleto. Se ainda estiver pendente, a VamPay confere o pagamento na hora da consulta.

Exemplo de Request

curlbash

curl "https://api.vampay.com.br/charges/6ad11c0e5b3f4a0012c9e7a1" \
  -H "X-API-Key: vampay_sua_api_key"

Status

Parâmetro	Tipo	Descrição
`PENDING`	status	Aguardando pagamento
`COMPLETED`	status	Pago. O netAmount já está no seu saldo
`EXPIRED`	status	Cartão sem pagamento em 24 h, ou boleto 5 dias depois do vencimento sem compensar. Se o banco compensar depois, a cobrança ainda vira COMPLETED

Campos da resposta

Parâmetro	Tipo	Descrição
`amount`	number	Quanto o pagador paga
`fee`	number	Taxa da cobrança
`netAmount`	number	Quanto cai no seu saldo
`paymentLink`	string	Página de pagamento pronta da VamPay (mostra cartão ou boleto)
`card.brand / card.last4`	string	Bandeira e final do cartão, depois de pago
`availableAt`	string	Cartão aprovado: data em que o valor fica disponível para saque (aprovação + 30 dias)
`refunded`	boolean	true se o pagamento foi reembolsado ou perdeu uma contestação (o valor saiu do saldo)

GET/charges

Listar Cobranças

Últimas cobranças no cartão e boleto da conta.

Query Params

Parâmetro	Tipo	Descrição
`limit`	number	Quantas trazer (1 a 100, padrão 20)
`method`	string	CARD ou BOLETO
`status`	string	PENDING, COMPLETED ou EXPIRED

GET/charges/methods

Formas, Taxas e Limites

Se cartão e boleto estão disponíveis na sua conta, com a taxa e os limites de cada um.

Resposta

200 OKjson

{
  "success": true,
  "data": {
    "available": true,
    "methods": [
      { "method": "CARD", "label": "Cartão de crédito", "fee": { "percent": 3.5, "fixed": 0.6 }, "limits": { "min": 5, "max": 50000 }, "settlementDays": 30 },
      { "method": "BOLETO", "label": "Boleto", "fee": { "percent": 0, "fixed": 2.5 }, "limits": { "min": 5, "max": 50000 }, "settlementDays": 0 }
    ]
  }
}

Cartão: o valor entra no saldo na hora e fica disponível para saque em 30 dias (recebimento em D+30). Reembolso e contestação (chargeback): se o pagamento for devolvido ao pagador, o valor sai do seu saldo e a cobrança passa a vir com refunded: true. Você recebe uma notificação no painel quando isso acontece.