Idea+Cash Developers
Login
COB

Consultar cobrança imediata Pix (COB)

Retorna o estado atual da cobrança imediata Pix identificada por `txId`.

GET/integration/v1/pix/cob/{txId}

Exemplo de requisição

curl -X GET https://apiapp.dev.ideabank.com.br/integration/v1/pix/cob/{txId} \
  -H "Authorization: Bearer $TOKEN" \
  -H "tenantid: $TENANT_ID" -H "hostdevelop: apiapp.dev.ideabank.com.br"

Exemplo de resposta (200)

{
  "payer": {
    "name": "João da Silva",
    "taxIdentifier": "12345678909"
  },
  "payee": null,
  "description": "Cobrança Pix referente ao pedido 12345",
  "expirationDate": "2026-06-30T18:00:00Z",
  "expiration": 3600,
  "pixKey": "+5511999999999",
  "payment": {
    "amount": 150.25,
    "fixedAmount": true
  },
  "txId": "TX1234567890ABCDEF1234567890",
  "ref": "cob-12345",
  "copyPasteCode": "0002010102122680...",
  "metadata": "object",
  "additionalInformation": [
    {
      "key": "pedido",
      "value": "12345"
    }
  ]
}

Códigos de resposta

HTTPDescrição
200COB encontrada
401
403
404
500
Fonte
Esta página é gerada a partir do Swagger oficial. Para o payload autoritativo, consulte também a especificação viva.

← Voltar para o índice