Consultar uma cobrança (PIX)

Retorna os dados de uma cobrança PIX previamente criada, vinculada a uma conta escrow específica na Plataforma Celcoin.

Este endpoint permite recuperar todas as informações da cobrança, incluindo:

  • Status atual

  • Valores e encargos

  • Datas de vencimento e expiração

  • Dados do devedor

  • QR Code (EMV)

  • URL de pagamento

  • Metadados associados à cobrança


Descrição

Este endpoint permite consultar uma cobrança PIX específica, identificada pelo pix_charge_id, associada a uma conta escrow identificada pelo account_id.

A operação é exclusivamente de consulta (GET) e não altera o estado da cobrança.


Método HTTP

GET


URL

https://sandbox.platform.credit.celcoin.com.br/escrow/api/v1/accounts/{account_id}/pix-charges/{pix_charge_id}

Path Parameters

NomeTipoObrigatórioDescrição
account_idstringSimIdentificador único da conta escrow na Plataforma Celcoin. Garante que a cobrança consultada pertence à conta correta.
pix_charge_idstringSimIdentificador único da cobrança PIX previamente criada. Permite localizar de forma precisa a cobrança a ser consultada.

Headers

NomeTipoObrigatórioDescrição
AuthorizationstringSimToken de autenticação no formato Bearer {token}.
Content-TypestringSimDeve ser informado como application/json.

Body Parameters

Este endpoint não possui corpo de requisição, pois se trata de uma operação de consulta (GET).


Exemplo de Requisição

GET /escrow/api/v1/accounts/123456/pix-charges/17f78e3e-0064-4231-8b76-c0a33301d797
Authorization: Bearer {token}
Content-Type: application/json

Respostas

Sucesso

Status: 200 OK

Retorna os dados completos da cobrança PIX consultada.

Exemplo de Resposta

{
  "id": "17f78e3e-0064-4231-8b76-c0a33301d797",
  "amount": "5.00",
  "description": null,
  "due_date": "2026-01-15",
  "expiration_after_payment": "5",
  "status": "ACTIVE",
  "pix_key": "eafccd5d-7df7-4aa2-8b98-38561664f092",
  "pre_signed_url": "https://s3.sa-east-1.amazonaws.com/sandbox.api.escrow.temp.uploads/...",
  "interest_amount": 0,
  "interest_type": "PERCENTAGE_PER_MONTH_CALENDAR_DAYS",
  "discount_amount": null,
  "discount_type": null,
  "discount_dates_settings": null,
  "fine_amount": null,
  "fine_type": null,
  "emv": "00020101021226980014br.gov.bcb.pix2576qrcode-h.pix.celcoin.com.br/...",
  "url": "qrcode-h.pix.celcoin.com.br/pixqrcode/v2/cobv/9b737c7eeeead59e0be8b08a99af90",
  "debtor": {
    "taxpayer_id": "32383861820",
    "name": "Não informado",
    "email_address": null,
    "address": null
  },
  "created_at": "2026-01-15T14:14:26.635Z"
}

Códigos de Erro

Status CodeDescriçãoQuando ocorre
400 Bad RequestRequisição inválidaParâmetros malformados ou IDs em formato inválido
401 UnauthorizedNão autorizadoToken ausente, inválido ou expirado
403 ForbiddenAcesso negadoToken válido, porém sem permissão para acessar a conta
404 Not FoundRecurso não encontradoCobrança PIX ou conta escrow não encontrada
409 ConflictConflito de estadoInconsistência no estado atual da cobrança
422 Unprocessable EntityErro de validaçãoDados válidos sintaticamente, mas inconsistentes semanticamente
500 Internal Server ErrorErro internoFalha inesperada no servidor
503 Service UnavailableServiço indisponívelInstabilidade ou manutenção da plataforma
Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!