Consultar cobrança

A situação atual de uma cobrança, com quem pagou quando já estiver paga.

GET /v1/payments/{id}

cURL

curl https://bukio-backend-production.up.railway.app/v1/payments/BKY-7KQ2M9XP4RZT \
  -H "Authorization: Bearer bk_live_..."

200

{
  "id": "BKY-7KQ2M9XP4RZT",
  "status": "paid",
  "statusTitle": "Pix recebido",
  "amount": 15000,
  "fee": 50,
  "refundedAmount": 0,
  "description": "Pedido 1842",
  "txid": "7kq2m9xp4rzt1a2b3c4d5e6f",
  "copyPaste": "00020126580014br.gov.bcb.pix...6304ABCD",
  "expiresAt": "2026-10-08T15:30:00.000Z",
  "paidAt": "2026-10-08T15:04:11.000Z",
  "customer": null,
  "payer": { "name": "Ana Souza", "document": "***.456.789-**", "institution": "Banco Exemplo" },
  "subaccountId": null,
  "split": [
    { "subaccountId": "sacc_9f1c2d3e4a5b6c7d8e9f0a1b2c3d4e5f", "name": "Ateliê da Ana", "amount": 10000 },
    { "subaccountId": "sacc_1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e", "name": "Bruno Doces", "amount": 4000 }
  ],
  "createdAt": "2026-10-08T15:00:00.000Z"
}

Escopo transactions:read. Cobrança de outra conta responde 404 NOT_FOUND, como se não existisse.

id · string · required

Código da cobrança, BKY- + 12 caracteres.

​

Resposta

O mesmo formato de Criar cobrança, com o status atual. Depois de paga, fee, paidAt e payer vêm preenchidos; depois de um estorno, refundedAmount (e status: "refunded" quando devolvida por inteiro). Com subconta, subaccountId ou split mostram para quem a venda foi creditada.

Numa tela de “aguardando pagamento”, consulte a cada 2 segundos ou mais. O jeito mais barato continua sendo o webhook payment.paid.

cURL

curl https://bukio-backend-production.up.railway.app/v1/payments/BKY-7KQ2M9XP4RZT \
  -H "Authorization: Bearer bk_live_..."

200

{
  "id": "BKY-7KQ2M9XP4RZT",
  "status": "paid",
  "statusTitle": "Pix recebido",
  "amount": 15000,
  "fee": 50,
  "refundedAmount": 0,
  "description": "Pedido 1842",
  "txid": "7kq2m9xp4rzt1a2b3c4d5e6f",
  "copyPaste": "00020126580014br.gov.bcb.pix...6304ABCD",
  "expiresAt": "2026-10-08T15:30:00.000Z",
  "paidAt": "2026-10-08T15:04:11.000Z",
  "customer": null,
  "payer": { "name": "Ana Souza", "document": "***.456.789-**", "institution": "Banco Exemplo" },
  "subaccountId": null,
  "split": [
    { "subaccountId": "sacc_9f1c2d3e4a5b6c7d8e9f0a1b2c3d4e5f", "name": "Ateliê da Ana", "amount": 10000 },
    { "subaccountId": "sacc_1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e", "name": "Bruno Doces", "amount": 4000 }
  ],
  "createdAt": "2026-10-08T15:00:00.000Z"
}