v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Link de pagamento

Listar links de pagamentos

API responsável por listar os links de pagamento de uma empresa

get/{companyId}/banking/payment-link

Path parameters

companyIdstring required

CNPJ da empresa

Query parameters

pageSizeinteger required

Quantidade de cobranças por página

Example:10

pageNumberinteger required

Número da página

Example:1

minCreatedAtstring

Data

Example:2024-06-18T00:00:00.000Z

maxCreatedAtstring

Data

Example:2024-06-18T00:00:00.000Z

minStartAtstring

Data

Example:2024-06-18T00:00:00.000Z

maxStartAtstring

Data

Example:2024-06-18T00:00:00.000Z

minEndAtstring

Data

Example:2024-06-18T00:00:00.000Z

maxEndAtstring

Data

Example:2024-06-18T00:00:00.000Z

minAmountnumber

Valor

Example:10.23

maxAmountnumber

Valor

Example:10.23

status'ACTIVE' | 'INACTIVE' | 'EXPIRED' | 'CANCELED' | 'PAID'

Status do link de pagamento

Example:ACTIVE

type'SINGLE' | 'MULTIPLE'

Tipo do link de pagamento

Example:SINGLE

namestring

Nome do link de pagamento

Example:Nome do link de pagamento

Response

Sucesso

Example response

{
  "data": [
    {
      "paymentLinkId": "97c8ac0a-89cb-4bbe-842b-d4e79a685c39",
      "name": "Nome do link de pagamento",
      "amount": 10.23,
      "notifications": {
        "deliveryMediums": [
          "Email",
          "Push"
        ],
        "email": "exemplo@btgpactual.com",
        "phone": "55112312312321"
      },
      "paymentMethods": [
        "BANKSLIP",
        "IMMEDIATE_QRCODE",
        "CREDIT_CARD"
      ],
      "status": "ACTIVE",
      "createdAt": "2024-06-18T00:00:00.000Z",
      "updatedAt": "2024-06-18T00:00:00.000Z",
      "schedule": {
        "startAt": "2024-01-01 12:00:00",
        "endAt": "2024-12-31 17:00:00"
      },
      "linkUrl": "link-uat.btgpactual.com/JK9GbsH49HEi69S",
      "description": "Descrição do link de pagamento",
      "payer": {
        "name": "John Due",
        "email": "user@gmail.com",
        "personType": "J",
        "phoneNumber": "123123121231",
        "taxId": "37297902000141",
        "address": {
          "type": "COMERCIAL",
          "zipCode": "00000001",
          "country": "BR",
          "state": "SP",
          "city": "SAO PAULO",
          "street": "RUA SANDBOX",
          "number": "369",
          "neighborhood": "BAIRRO SANDBOX"
        },
        "deliveryMediums": [
          "Email",
          "Push"
        ]
      },
      "payee": {
        "name": "VECHI CONSULTORIA E PROJETOS LTDA",
        "email": "exemplo@btgpactual.com",
        "personType": "J",
        "phoneNumber": "11912345678",
        "taxId": "00000000000125"
      },
      "type": "SINGLE",
      "details": {
        "limits": {
          "maxInstallments": 3
        }
      }
    }
  ],
  "cursor": {
    "previous": {
      "href": "/payment-link/7c17f662-3149-4d4a-b292-c7e00a641d61/collection?cursor=eyJtaW5DcmVhdGVkQXQiOiIyMDI0LTAxLTAxIiwibWF4Q3JlYXRlZEF0IjoiMjAyNS0wMS0wMSIsInBhZ2VOdW1iZXIiOiIyIiwicGFnZVNpemUiOiIxMCIsInR5cGUiOiJCQU5LU0xJUCIsInN0YXR1cyI6IkNSRUFURUQiLCJwYXllci5uYW1lIjoiTHVjYXMiLCJpZCI6IjdjMTdmNjYyLTMxNDktNGQ0YS1iMjkyLWM3ZTAwYTY0MWQ2MSJ9",
      "method": "GET",
      "type": "application/json"
    },
    "next": {
      "href": "/payment-link/7c17f662-3149-4d4a-b292-c7e00a641d61/collection?cursor=eyJtaW5DcmVhdGVkQXQiOiIyMDI0LTAxLTAxIiwibWF4Q3JlYXRlZEF0IjoiMjAyNS0wMS0wMSIsInBhZ2VOdW1iZXIiOiIyIiwicGFnZVNpemUiOiIxMCIsInR5cGUiOiJCQU5LU0xJUCIsInN0YXR1cyI6IkNSRUFURUQiLCJwYXllci5uYW1lIjoiTHVjYXMiLCJpZCI6IjdjMTdmNjYyLTMxNDktNGQ0YS1iMjkyLWM3ZTAwYTY0MWQ2MSJ9",
      "method": "GET",
      "type": "application/json"
    }
  }
}