v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Pix Cobrança

Obter lista de cobraças

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

Path parameters

companyIdstring required

CNPJ da empresa

Example:1234124210002

Query parameters

locationIdstring

Example:b226b648-9410-42d3-88f3-497c23608a3d

initialDatestring

Data inicial para a listagem

Example:2024-10-23

finalDatestring

Data final para a listagem

Example:2024-10-24

onlyActivestring

Mostrar apenas as cobranças ativas. Não aceita o valor como false

Response

Instant Collections

Example response

{
  "data": [
    {
      "id": "5d4b6d6f-2912-420d-8914-bec4a28dd959",
      "txId": "58816103c8b44bafbd751c2d679bdad1",
      "status": "PAID",
      "displayText": "Pix de Teste",
      "pixKey": "13a066bc-1d02-464a-bed9-c98211a00934",
      "paymentInfo": {
        "endToEndId": "E123412343245345s1242",
        "paymentDate": "2024-04-22T21:54:46.3877001Z",
        "paidAmount": 1.1
      },
      "amount": {
        "value": 1.1
      },
      "location": {
        "id": "6fe0cd21-2a47-4b82-9188-b4dbfc271e89",
        "type": "cob",
        "url": "https://static.uat.com/pix/dynamic/qrcode/37297902000141/4c972de4-3842-4b89-a2de-99f749a78950.png",
        "path": "123454797000125/a1129999-6b6f-4a82-8371-302d2fd4e2fb.png",
        "integrationUrl": "api.developer.btgpactual.com/v1/p/v2/exemplo_de_integration"
      }
    }
  ]
}