Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Authorization

Listar Cobranças Agendadas para Pix Automático

API responsável por listar as cobranças agendadas de uma autorização de Pix Automático

get/automatic-pix/authorization/{authorizationId}/scheduling-instruction

Path parameters

authorizationIdstring uuid required

Id da autorização do Pix Automático

Example:611a3814-dc17-4d0b-b7fc-20f98ba618ee

Id da autorização

Query parameters

pageSizeinteger required

Quantidade de cobranças por página

Example:10
pageNumberinteger required

Número da página

Example:1

Response

Sucesso

Example response

{
  "data": [
    {
      "id": "611a3814-dc17-4d0b-b7fc-20f98ba618ee",
      "authorizationId": "611a3814-dc17-4d0b-b7fc-20f98ba618ee",
      "createdAt": "2025-04-15T21:00:44.875Z",
      "installmentNumber": 10,
      "scheduledDate": "2025-04-15",
      "amount": 10.23,
      "additionalInformation": "Descrição do agendamento",
      "updatedAt": "2025-04-15T21:00:44.875Z",
      "status": "SENT_SCHEDULING",
      "periodInitialDate": "2025-04-18",
      "periodFinalDate": "2025-05-17",
      "payee": {
        "document": "00000000000125",
        "fantasyName": "VECHI CONSULTORIA E PROJETOS LTDA",
        "socialName": "VECHI CONSULTORIA E PROJETOS LTDA",
        "bankCode": "208",
        "bankName": "VECHI CONSULTORIA E PROJETOS LTDA"
      },
      "origin": "WEB",
      "canceledAt": "2025-04-15T21:00:44.875Z",
      "cancellationCode": "ACCT",
      "cancellationDescription": "Descrição do cancelamento",
      "settledAt": "2025-04-16T21:00:44.875Z",
      "paidAt": "2025-04-16T21:00:44.875Z",
      "rejectedAt": "2025-04-15T21:00:44.875Z",
      "rejectionCode": "AB10",
      "rejectionDescription": "Descrição da rejeição"
    }
  ],
  "_links": {
    "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"
    }
  }
}