Sign in
latestOpenAPI 3.1.02026-07-2440101174.2 KB

e20afa10cd0e

Pix automático

Consulta de detalhes de autorizações

Realize a consulta de uma ou mais autorizações de recorrência de Pix automático.

get/pix/recurring-payments

Query parameters

initialDatestring date nullable

Data de início do período para a busca das solicitações de autorização de recorrêcia.

finalDatestring date nullable

Data fim do período para a busca das das solicitações de autorização de recorrêcia.

idRecurrencestring nullable

Identificador da recorrência. Caso o campo seja enviado, todos os demais filtros informados serão ignorados, com exceção do <code>contractNumber</code>.

contractNumberstring nullable

Número do contrato associado à autorização de recorrência. Caso o campo seja informado, todos os demais serão ignorados, com exceção do <code>idRecurrence</code>.

status'PENDING' | 'APPROVED' | 'CANCELED' | 'EXPIRED' | 'REJECTED' | 'ERROR' | 'COMPLETED'

Status da recorrência de pagamento.

<i>Status</i> da recorrêcia.

pageinteger

Número da página que deseja consultar.

pageSizeinteger

Quantidade de registros retornados por página.

Headers

x-correlation-idSchema required— unresolved $ref

Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID.

Parameters

#/paths/~1pix~1claims/get/parameters/0 — unresolved $ref
#/paths/~1pix~1claims/get/parameters/2 — unresolved $ref
#/paths/~1pix~1claims/get/parameters/3 — unresolved $ref

Response

Consulta realizada com sucesso.

Example response

{
  "pagination": {
    "page": 1,
    "pageSize": 10,
    "totalPages": 5,
    "totalItems": 50
  },
  "items": [
    {
      "idRecurrence": "RN1314008820250415BXAXE8JG9UJ",
      "agents": {
        "debtor": {
          "accountIdentification": "10319867",
          "accountIssuer": "0001",
          "agentMemberIdentification": "59588111",
          "cityCode": "4314902",
          "name": "João da Silva",
          "privateIdentification": "12312312387"
        },
        "originalDebtor": {
          "name": "Maria de Souza",
          "privateIdentification": "18297267067"
        },
        "creditor": {
          "agentMemberIdentification": "60701190",
          "name": "Empresa Exemplo LTDA",
          "privateIdentification": "15550258000139"
        }
      },
      "amount": {
        "fixedValue": "150.00",
        "minimumValue": "100.00",
        "maximumValue": "200.00",
        "currency": "BRL"
      },
      "calendar": {
        "initialDate": "2025-02-05T00:00:00",
        "finalDate": "2025-05-05T00:00:00"
      },
      "contractNumber": "561238008",
      "authorization": {
        "authorizationDateTime": "2025-02-05T14:30:00Z"
      },
      "endToEndId": "E5958811120250311134402888PD0GYR",
      "expirationDateTime": "2025-12-31T23:59:59Z",
      "recurrenceCreationDateTime": "2025-04-15T12:45:02.903Z"
    }
  ]
}