v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Busca de dados de uma cobrança imediata

Essa API possibilita a busca de dados de uma cobrança imediata (COB) a partir do transctionId, transactionIdentification ou clientRequestId.

get/pix/v1/collection/pi/immediate

Query parameters

transactionIdstring

Identificador de transação fornecido ao criar a cobrança imediata.

transactionIdentificationstring

Identificador do QRCode gerado

clientRequestIdstring

Identificador único da transação fornecida pelo do cliente.

Response

200

transactionIdinteger

statusstring

lastUpdatestring

{"stackTrail":"paths:/pix/v1/collection/pi/immediate:get:responses:200:content:application/json:schema:properties:payerQuestion","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/pix/v1/collection/pi/immediate:get:responses:200:content:application/json:schema:properties:additionalInformation","oasType":"schema","type":"unknown"}

keystring

{"stackTrail":"paths:/pix/v1/collection/pi/immediate:get:responses:200:content:application/json:schema:properties:revision","oasType":"schema","type":"unknown"}

createAtstring

clientRequestIdstring

transactionIdentificationstring

transactionIdPaymentinteger

Example response

{
  "transactionId": 9191695,
  "status": "ACTIVE",
  "lastUpdate": "2022-03-22T12:36:36.4797746+00:00",
  "debtor": {
    "name": "valdir",
    "cpf": "35514846817"
  },
  "amount": {
    "original": 15.01
  },
  "key": "testepix@celcoin.com.br",
  "location": {
    "merchant": {
      "postalCode": "01201005",
      "city": "Barueri",
      "merchantCategoryCode": "0000",
      "name": "Celcoin Pagamentos"
    },
    "url": "https://sandbox.openfinance.celcoin.dev/pix/v1/collection/pi/immediate",
    "emv": "00020101021226930014br.gov.bcb.pix2571api-h.developer.btgpactual.com/v1/p/v2/c74aceb336a44c4d9c6b4615d3c35c0b5204000053039865802BR5918Celcoin Pagamentos6007Barueri61080120100562070503***6304C203",
    "type": "COB"
  },
  "calendar": {
    "expiration": 86400
  },
  "createAt": "2022-03-22T12:36:36.4797746+00:00",
  "clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
  "transactionIdentification": "kk6g232xel65a0daee4dd13kk9191695"
}