Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Pix Cobrança

Criar cobrança

post/companies/{companyId}/pix-cash-in/instant-collections

Path parameters

companyIdstring required

CNPJ da empresa

Example:1234124210002

Request body

pixKeystring required

Chave pix

locationIdstring
expiresInnumber

Tempo para expiração

displayTextstring

Texto de display

tagsobject

Tag de identificação para a transação

Example request

{
  "pixKey": "13a066bc-1d02-464a-bed9-c98211a00934",
  "locationId": "b226b648-9410-42d3-88f3-497c23608a3d",
  "amount": {
    "original": 12.45
  },
  "displayText": "Pix de Teste",
  "payer": {
    "name": "Fulano de Tal"
  },
  "tags": {
    "id": "9ee39748ab664c1390e004470e19facf",
    "order": 123456,
    "customerId": 9482392
  }
}

Response

Location Created

idstring
txIdstring
taxIdstring
statusstring
pixKeystring
displayTextstring
emvstring

Example response

{
  "id": "40cf72f6-2d21-4894-bed6-ac123412432134",
  "txId": "1854785e7c5a12341243213404d9735e",
  "taxId": "221342342145",
  "status": "ACTIVE",
  "pixKey": "2123412421345",
  "amount": {
    "value": 1.1
  },
  "emv": "00022342342346910014br.gov.bcb.pix2569api.developer.btgpactual.com/v1/p/v2/97af8952d010409eb71ef7bdac06815d2134234214214802BR5924NOMEFICTICIO6009SAO PAULO61080293000062070503***63045937",
  "location": {
    "id": "fdb111111-8046-4e06-bb63-ed11111b651",
    "integrationId": "12878318123421342434324",
    "type": "cob",
    "path": "28123421421435/fd1234214324-8046-4e06-bb63-ed257511b651.png",
    "url": "https://static.empresas.btgpactual.com/pix/dynamic/qrcode/12341234123446-4e06-bb63-e12431234412.png",
    "integrationUrl": "url-mockada"
  }
}