Pix

Detalhes da cobrança

GET/v1/charges/:chargeId

Base URL Produção:https://api.validapay.com.br

Base URL Sandbox:https://sandbox.validapay.com.br

Authorizations

bearer

Authorization

string obrigatório

Cabeçalho de autenticação Bearer no formato Bearer {{token}} onde {{token}} é o seu token OAuth2.

Escopos requeridos

charges/read

Path Parameters

chargeIdstringobrigatório

Identificador devolvido na criação da cobrança

Devolve a cobrança inteira: situação, valor, comprador, endereço e os dados de pagamento do meio usado.

Os blocos pix e boleto são excludentes — vem preenchido o do paymentType da cobrança, e o outro chega como null. O mesmo vale para address, que é null quando o comprador não tem endereço cadastrado.

Para acompanhar um pagamento em aberto, prefira GET /v1/charges/{chargeId}/status: devolve o essencial e evita carregar comprador e endereço a cada consulta.

← Anterior

Autenticação

Cobrança imediata

const url = 'https://sandbox.validapay.com.br/v1/charges/:chargeId';

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {{token}}'
  },
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200200▾

JSON

{
  "chargeId": "cha_1771453171013_fp6iocaxb",
  "status": "PAID",
  "amount": 10.0,
  "paymentType": "PIX",
  "productName": "Plano Premium",
  "createdAt": "2026-02-18T22:19:31.013Z",
  "paidAt": "2026-02-18T22:22:50.031Z",
  "dueDate": "2026-03-20",
  "expiresAt": "2026-03-20T23:59:59.000Z",
  "transactionId": "7f1c9d2e-4a55-4c91-9a0d-1e2f3a4b5c6d",
  "endToEndId": "E1234567820260218222250abcdef123",
  "externalTxid": "loja-01-caixa-03",
  "customer": {
    "name": "Joao da Silva",
    "document": "12345678901",
    "email": "joao@email.com",
    "phone": "+5511999998888"
  },
  "address": {
    "street": "Av. Paulista",
    "number": "1000",
    "complement": "Apto 52",
    "neighborhood": "Bela Vista",
    "city": "Sao Paulo",
    "cityCode": 3550308,
    "state": "SP",
    "zipCode": "01310100",
    "country": "BR"
  },
  "pix": {
    "emv": "00020101021226910014br.gov.bcb.pix…",
    "dueDate": "2026-03-20"
  },
  "boleto": null
}

← Anterior

Autenticação

Cobrança imediata