Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Authorization

Listar Autorizações de Pix Automático

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

get/automatic-pix/authorization

Query parameters

pageSizeinteger required

Quantidade de cobranças por página

Example:10
pageNumberinteger required

Número da página

Example:1
contractstring

Identificador do contrato (deve ser gerenciado pelo recebedor e não pode ser reutilizado caso esteja associado a uma autorização pendente ou aprovada)

Example:54872120205AASS12

Identificador único do contrato

Response

Sucesso

Example response

{
  "data": {
    "id": "611a3814-dc17-4d0b-b7fc-20f98ba618ee",
    "createdAt": "2025-04-15T21:00:44.875Z",
    "initialDate": "2025-04-18",
    "approvedAt": "2025-04-15T21:00:44.875Z",
    "canceledAt": "2025-04-15T21:00:44.875Z",
    "cancellationCode": "ACCL",
    "cancellationDescription": "Descrição do cancelamento",
    "rejectedAt": "2025-04-15T21:00:44.875Z",
    "rejectionCode": "AC01",
    "rejectionDescription": "Descrição da rejeição",
    "finalDate": "2026-04-18",
    "link": {
      "rel": "self",
      "href": "/direct-debits/d2627834-dd84-4094-9dcf-ca784460b352",
      "method": "DELETE",
      "type": "application/json"
    },
    "amount": 10.23,
    "retryPolicy": "ACCEPT_3R_7D",
    "period": "ANNUALLY",
    "updatedAt": "2025-04-15T21:00:44.875Z",
    "requests": [
      {
        "requestId": "c6184dae-3f92-42ed-8b47-d9f4593ee0a5",
        "authorizationId": "611a3814-dc17-4d0b-b7fc-20f98ba618ee",
        "createdAt": "2025-04-15T21:00:44.875Z",
        "expirationDate": "2025-04-15T23:23:59.547Z",
        "origin": "WEB",
        "recipient": {
          "taxId": "37297902000141",
          "name": "W A PRODUTOS DIGITAIS LTDA",
          "personType": "J",
          "account": {
            "ispbParticipant": "00000000",
            "number": "003886850",
            "branch": "50"
          }
        },
        "status": "CREATED"
      }
    ],
    "status": "CREATED",
    "totalInstallments": 10,
    "payee": {
      "document": "00000000000125",
      "fantasyName": "VECHI CONSULTORIA E PROJETOS LTDA",
      "socialName": "VECHI CONSULTORIA E PROJETOS LTDA",
      "bankCode": "208",
      "bankName": "VECHI CONSULTORIA E PROJETOS LTDA"
    },
    "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"
      ]
    },
    "activation": {
      "journeyType": "JOURNEY_1",
      "txId": "3214"
    },
    "origin": "WEB",
    "location": {
      "id": "b226b648-9410-42d3-88f3-497c23608a3d",
      "type": "cob",
      "taxId": "30306294000145",
      "url": "https://static.uat.com/pix/dynamic/qrcode/37297902000141/4c972de4-3842-4b89-a2de-99f749a78950.png"
    },
    "qrCodeInfo": {
      "emv": "copiaecola",
      "journeyType": "JOURNEY_1"
    },
    "externalId": "8725b04c-1354-4ad7-91db-4bbb2138e390"
  },
  "_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"
    }
  }
}