Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-1751129352.2 KB
Rec

Consultar recorrência.

Consultar recorrência.

get/rec/{idRec}

Query parameters

txidstring

Response

Dados da recorrência.

idRecstring required

Identificador da Recorrência

Regra de formação:

  • RAxxxxxxxxyyyyMMddkkkkkkkkkkk (29 caracteres; "case sensitive", isso é, diferencia letras maiúsculas e minúsculas), sendo:
    • "R": fixo (1 caractere). "R" para a recorrência criada dentro do Pix;
    • "A": identificação da possibilidade de novas tentativas, sendo possíveis os valores "R" ou "N" (1 caractere). "R" caso a recorrência permita novas tentativas de pagamento pós vencimento, ou "N" caso não permita novas tentativas.
    • "xxxxxxxx": identificação do agente que presta serviço para o usuário recebedor que gerou o ID Recorrência, podendo ser: o ISPB do participante direto, o ISPB do participante indireto ou os 8 primeiros caracteres do CNPJ do prestador de serviço de iniciação (8 caracteres alfanuméricos [A-Z|0-9]);
    • "yyyyMMdd": data (8 caracteres) de criação da recorrência;
    • "kkkkkkkkkkk": sequencial criado pelo agente que gerou o ID Recorrência (11 caracteres alfanuméricos [a-z|A-Z|0-9]). Deve ser único dentro de cada "yyyyMMdd".

Dessa forma, o ID da recorrência deve ser formado de acordo com um dos tipos a seguir:

  • "RRxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que permite novas tentativas de pagamento pós vencimento; ou
  • "RNxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que não permite novas tentativas de pagamento pós vencimento.”
status'CRIADA' | 'APROVADA' | 'REJEITADA' | 'EXPIRADA' | 'CANCELADA' required
politicaRetentativa'NAO_PERMITE' | 'PERMITE_3R_7D' required

Example response

{
  "idRec": "RR1234567820240115abcdefghijk",
  "calendario": {
    "dataInicial": "2023-04-01",
    "dataFinal": "2023-04-01"
  },
  "loc": {
    "location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
    "idRec": "RR1234567820240115abcdefghijk"
  },
  "solicitacao": [
    {
      "idSolicRec": "SC1234567820240115abcdefghijk",
      "idRec": "RR1234567820240115abcdefghijk",
      "recPayload": {
        "idRec": "RR1234567820240115abcdefghijk",
        "calendario": {
          "dataInicial": "2023-04-01",
          "dataFinal": "2023-04-01"
        }
      }
    }
  ]
}