LYNX UPBANK
DocsReferência da APIUso único · consultar
1 min de leitura

Consultar cobrança de uso único

GET/v1/billing/single-use/check

Retorna o status atual da cobrança de uso único (PENDING, PAID ou EXPIRED) com dados do pagador real quando paga.

Permissão necessária: BILLING:READ

Parâmetros

ParâmetroTipoDescrição
idobrig.stringID da cobrança (chk_single_…).

Boas práticas

  • Use como retaguarda do webhook (reconciliação periódica), a fonte primária de confirmação deve ser o billing.paid.
  • status EXPIRED é definitivo: gere uma nova cobrança para o cliente pagar.

Requisição

bash
curl -X GET https://lynxpix.cc/api/v1/billing/single-use/check?id=chk_single_1a2b3c \
  -H "Authorization: Bearer lynx_test_sua_chave"

Resposta

json
{
  "data": {
    "id": "chk_single_1a2b3c",
    "status": "PAID",
    "singleUse": true,
    "amount": 5000,
    "netAmount": 4950,
    "externalReference": "fatura_123456",
    "paidAt": "2026-07-22T15:05:20Z",
    "payer": {
      "name": "João Silva",
      "document": "12345678900",
      "bank": "NU PAGAMENTOS"
    },
    "endToEndId": "E18935924202607221505apiv1x1a2b3",
    "expiresAt": "2026-08-21T15:00:00Z",
    "url": "https://lynx.app/pay/fatura-123456-9f8a2c"
  },
  "error": null
}