Retrieve recurrence request (Pix Automático)

Retrieves a request by its idSolicRec. Pix API GET /solicrec/. Projects the stored fields verbatim (D-4). The atualizacao[] (status history) and recPayload fields are not included in this response. An unknown idSolicRec returns 404 (canonical Problem envelope).

GET /api/v1/brcode/solicrec/{idSolicRec}

Retrieve recurrence request (Pix Automático)

cURL

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/solicrec/{idSolicRec} \
  --header 'Authorization: Bearer <token>'

200

{
  "calendario": {
    "dataExpiracaoSolicitacao": "2023-11-07T05:31:56Z"
  },
  "destinatario": {
    "conta": "<string>",
    "ispbParticipante": "<string>",
    "agencia": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>"
  },
  "idRec": "<string>",
  "idSolicRec": "<string>"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

idSolicRec · string · required

Identificador da solicitação [a-zA-Z0-9]{29}.

Pattern: ^[a-zA-Z0-9]{29}$

Response

200

application/json

OK

calendario · object · required

Show child attributes

destinatario · object · required

Show child attributes

idRec · string · required

Pattern: ^[a-zA-Z0-9]{29}$

idSolicRec · string · required

Identificador da solicitação.

Pattern: ^[a-zA-Z0-9]{29}$

status · enum<string> · required

Available options: CRIADA, ENVIADA, RECEBIDA, REJEITADA, ACEITA, EXPIRADA, CANCELADA