Sign in
latestOpenAPI 3.1.02026-07-2440101174.2 KB

e20afa10cd0e

Pix agendado

Consulta detalhada de uma recorrência por identificador.

Utilize este endpoint para consultar os detalhes de uma recorrência.

get/pix/scheduling-payments/recurrences/{requestIdentifier}

Path parameters

requestIdentifierstring required

Identificador único da recorrência.

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
#/paths/~1pix~1claims/get/parameters/1 — unresolved $ref

Response

Retorno da consulta com sucesso.

requestIdentifierstring

Identificador da solicitação da recorrência.

initialDateSchedulestring date

Data inicial do agendamento.

finalDateSchedulestring date

Data final do agendamento.

insertDateTimestring date-time

Data e hora da inclusão recorrencia.

status'PROCESSING' | 'CANCELED' | 'COMPLETED' | 'AWAITING_ENRICHMENT'

Status da solicitação.

repetitioninteger

Número de repetições.

interbankSettlementAmountnumber double

Valor do agendamento interbancário.

recurrenceDescriptionstring

Descrição da recorrência.

invalidDatePayment'ANTICIPATE' | 'POSTPONE'

Indica se o agendamento deve ser antecipado ou postergado em caso de data inexistente (ex. dias 29 e 31).

frequency'WEEKLY' | 'MONTHLY' | 'YEARLY'

Frequência da recorrência.

initiationForm'DICT' | 'MANU'

Forma de iniciação.

Example response

{
  "creditor": {
    "accountIdentification": "10319867",
    "accountIssuer": "0001",
    "agentMemberIdentification": "59588111",
    "name": "Empresa Exemplo LTDA",
    "privateIdentification": "29194244000134"
  },
  "debtor": {
    "accountIdentification": "1031986787",
    "accountIssuer": "0001",
    "name": "João da Silva",
    "privateIdentification": "61949998029"
  }
}