v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Criar nova cobrança imediata

Essa API possibilita que seja criada uma cobrança imediata, vinculada a um QR Code já criado (location).

post/pix/v1/collection/immediate

Request body

clientRequestIdstring

Identificador único da transação fornecida pelo do cliente. Este valor não pode ser repetido.

payerQuestionstring

Uma mensagem a ser mostrada ao pagador no momento do pagamento, com no máximo 140 caracteres.

keystring required

Chave Pix

locationIdinteger required

Identificador do BRCode Location a ser associado a cobrança.

changeobject

Response

200

revisioninteger
transactionIdinteger
clientRequestIdstring
statusstring
lastUpdatestring
{"stackTrail":"paths:/pix/v1/collection/immediate:post:responses:200:content:application/json:schema:properties:payerQuestion","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/pix/v1/collection/immediate:post:responses:200:content:application/json:schema:properties:additionalInformation","oasType":"schema","type":"unknown"}
keystring
createAtstring
transactionIdentificationstring

Example response

{
  "transactionId": 9190596,
  "clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
  "status": "ACTIVE",
  "lastUpdate": "2022-03-21T19:45:32.7719371+00:00",
  "debtor": {
    "name": "valdir",
    "cpf": "35914746817"
  },
  "amount": {
    "original": 15.01
  },
  "location": {
    "merchant": {
      "postalCode": "01201005",
      "city": "Barueri",
      "merchantCategoryCode": "0000",
      "name": "Celcoin Pagamentos"
    },
    "url": "api-h.developer.btgpactual.com/v1/p/v2/de69b65990834cfaa88ec7c6754b9a87",
    "emv": "00020101021226930014br.gov.bcb.pix2571api-h.developer.btgpactual.com/v1/p/v2/de69b65990834cfaa88ec7c6754b9a875204000053039865802BR5918Celcoin Pagamentos6007Barueri61080120100562070503***6304DEFF",
    "type": "COB",
    "locationId": "12731028"
  },
  "key": "testepix@celcoin.com.br",
  "calendar": {
    "expiration": 86400
  },
  "createAt": "2022-03-21T19:45:32.7719371+00:00",
  "transactionIdentification": "kk6g232xel65a0daee4dd13kk9190596"
}