Ficha técnica

Alcances necesarios

El token para consumir la API de Pix Dinámico debe generarse usando el Authorization Code.

El alcance openid es obligatorio. Permite consultar el perfil del usuario BTG con acceso a la cuenta.

Es necesario elegir uno de los siguientes alcances:

Alcance	Descripción
empresas.btgpactual.com/pix-cash-in	Permite la creación y consulta de Pix Cobrança y la recepción de webhooks.
empresas.btgpactual.com/pix-cash-in.readonly	Permite la consulta de Pix Cobrança y la recepción de webhooks.

Diccionario de Términos

Términos	Descripción
location	QR Code
locationId	Id del QR Code
taxId	CPF/CNPJ
txId	Id del cobro vinculado a un QR Code
emv	Código correspondiente al pix copia y pega

Eventos de webhook

Los payloads disponibles a continuación representan el contenido del campo data.

Evento	Descripción
instant-collection.paid	Cobro de pix dinámico pagado
instant-collection.unlinked	QR desvinculado del cobro de pix dinámico

instant-collection.paid

{
  "id": "488f99ff-15d5-4694-ba6a-bcea811935b5",
  "txId": "f35eb3fa37904cff8cdbb5cca30f7bad",
  "status": "PAID",
  "pixKey": "b1e00008-0005-4a9c-ab05-70003ed62452",
  "displayText": "Fatura 000000008",
  "amount": {
    "value": 720,
    "allowCustomerChangeValue": false
  },
  "location": {
    "id": "9c14c560-7a8b-47ec-a77f-00e94b5cc0ec",
    "integrationId": "3047031029004432472",
    "type": "cob",
    "path": "00000000000001/9c14c560-7a8b-47ec-a77f-00e94b5cc0ec.png",
    "description": "Fatura 000000008",
    "url": "https://static.empresas.btgpactual.com/pix/dynamic/qrcode/00000000000000/9c14c560-7a8b-47ec-a77f-00e94b5cc0ec.png",
    "integrationUrl": "api.developer.btgpactual.com/v1/p/v2/b1f11f2b088e497995e7c4090185814a"
  },
  "paidAt": "2023-05-04T14:41:06.0530057Z",
  "paidAmount": 720,
  "payee": {
    "taxId": "00000000000001",
    "currency": "BRL",
    "branchCode": "00",
    "number": "000000006"
  },
  "paidBy": {
    "taxId": "000000000000002",
    "name": "JUBIABA LTDA",
    "currency": "BRL",
    "branchCode": "50000",
    "number": "10000"
  }
}

instant-collection.unlinked

{
  "id": "343e5732-5c76-490e-9b66-9869c0669813",
  "txId": "8f452f7ad1ad4d51ba391db932fadb8b",
  "taxId": "0000000000001",
  "status": "UNLINKED",
  "pixKey": "email@gmail.com",
  "displayText": "",
  "amount": {
    "value": 1,
    "allowCustomerChangeValue": false
  },
  "location": {
    "id": "b649febc-9711-4c83-bfc5-b16a335370f2",
    "type": "cob",
    "description": ""
  },
  "tags": {
    "order": "dev1",
    "venda": "281862"
  }
}