Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Link de pagamento

Listar cobranças de um link de pagamento

API responsável por listar as cobranças um link de pagamento

get/{companyId}/banking/payment-link/{paymentLinkId}/collection

Path parameters

paymentLinkIdstring required

Identificador do Link de Pagamento

Example:97c8ac0a-89cb-4bbe-842b-d4e79a685c39
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
status'CANCELED' | 'CANCELING' | 'CREATED' | 'EXPIRED' | 'FAILED' | 'UPDATING' | 'PAID' | 'PROCESSING' | 'UPDATED'

Status da cobrança

Example:PAID
type'IMMEDIATE_QRCODE' | 'BANKSLIP' | 'CREDIT_CARD'

Tipo da cobrança

Example:IMMEDIATE_QRCODE
minCreatedAtstring

Data

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

Data

Example:2024-06-18T00:00:00.000Z
payer.namestring

Nome do pagador

Example:João da Silva
payer.taxIdstring

Documento do pagador

Example:99261911005

Response

Sucesso

Example response

{
  "data": [
    {
      "amount": 10.23,
      "collectionId": "0300e0fe-2ea4-4b01-bddf-7b23604e00c0",
      "createdAt": "2024-06-18T00:00:00.000Z",
      "description": "ATENÇÃO: Esta cobrança está sendo paga para Vechi Consultoria.",
      "dueDate": "2024-06-18T00:00:00.000Z",
      "paidAt": "2024-06-18T00:00:00.000Z",
      "payee": {
        "name": "VECHI CONSULTORIA E PROJETOS LTDA",
        "email": "exemplo@btgpactual.com",
        "personType": "J",
        "phoneNumber": "11912345678",
        "taxId": "99261911005"
      },
      "payer": {
        "name": "João da Silva",
        "email": "exemplo@btgpactual.com",
        "personType": "F",
        "phoneNumber": "11912345678",
        "taxId": "00000000000125"
      },
      "status": "PAID",
      "type": "IMMEDIATE_QRCODE",
      "updatedAt": "2024-06-18T00:00:00.000Z",
      "detail": {
        "emv": "copiaecola",
        "pixKey": "teste@hotmail.com",
        "txId": "3214"
      }
    }
  ],
  "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"
    }
  }
}