Visão Geral

Os endpoints de consulta permitem listar aplicações registradas, contas vinculadas e detalhar o estado de uma payment initiation específica. São úteis para auditoria, suporte ao cliente e exibição de histórico de pagamentos.


Listar Contas de uma Aplicação

GET /baas/v1/open/itp/applications/:applicationId/accounts

Retorna as contas de crédito (contas recebedoras) vinculadas a uma aplicação ITP.

Autenticação: Bearer Token (application_token)

Path Parameters

ParâmetroTipoObrigatórioDescrição
applicationIdstringID da aplicação, obtido em Listar Aplicações

Request

GET {{base_url}}/baas/v1/open/itp/applications/{{applicationId}}/accounts
Authorization: Bearer {{application_token}}
Accept: application/json

Response — HTTP 200

{
  "accounts": [
    {
      "id": "acc-uuid-5678",
      "ispb": "12345678",
      "issuer": "0001",
      "number": "123456789",
      "accountType": "CACC",
      "status": "ACTIVE"
    }
  ]
}
CampoTipoDescrição
accounts[].idstringID da conta vinculada
accounts[].ispbstringISPB da instituição
accounts[].numberstringNúmero da conta
accounts[].accountTypestringTipo: CACC, SVGS, SLRY, TRAN
accounts[].statusstringACTIVE ou INACTIVE

Códigos de Retorno

HTTPDescrição
200 OKContas retornadas com sucesso
401 UnauthorizedToken inválido ou expirado
404 Not FoundapplicationId não encontrado

Detalhar Payment Initiation

GET /baas/v1/open/itp/payment-initiation/:paymentInitiationId

Retorna o estado atual de uma payment initiation, incluindo os dados do consentimento e status do pagamento associado.

Autenticação: Bearer Token (application_token)

Path Parameters

ParâmetroTipoObrigatórioDescrição
paymentInitiationIdstringID da payment initiation

Request

GET {{base_url}}/baas/v1/open/itp/payment-initiation/{{itp_payment_id}}
Authorization: Bearer {{application_token}}

Response — HTTP 200

{
  "id": "ZVjnvOXJSlgth9MVDS4HmdvyhBlHt_s1MPhMNMBhGSU",
  "status": "AUTHORISED",
  "brandId": "6900de69dfdf118e980e10ec",
  "brandName": "Banco Exemplo",
  "createdAt": "2026-05-31T10:00:00Z",
  "consentId": "urn:celcoin:ZVjnvOXJ...",
  "payment": {
    "paymentId": "pix-abc123def456",
    "endToEndId": "E1234567820260531000012345ABCDE",
    "status": "ACSC",
    "amount": "1.15",
    "currency": "BRL",
    "date": "2026-05-31"
  },
  "creditor": {
    "name": "Marco Antonio de Brito",
    "cpfCnpj": "58764789000137",
    "personType": "PESSOA_JURIDICA"
  }
}
CampoTipoDescrição
statusstringStatus do consentimento. Ver Máquina de Estados
payment.statusstringStatus do pagamento Pix: PDNG, ACSP, ACSC, RJCT
consentIdstringURN do consentimento na detentora

Códigos de Retorno

HTTPDescrição
200 OKDetalhes retornados com sucesso
401 UnauthorizedToken inválido ou expirado
404 Not FoundPayment initiation não encontrada

Pontos de Atenção

⚠️

Polling de status: O endpoint de detalhe é a forma de fazer polling quando webhooks não estão configurados. Monitore o campo payment.status até atingir ACSC ou RJCT.

⚠️

applicationId vs. paymentInitiationId: São identificadores distintos. O applicationId identifica a aplicação ITP; o paymentInitiationId identifica um consentimento específico de pagamento.