PayloadLocationRec

Recuperar location do payload.

Recupera a location do payload

get/locrec/{id}

Response

Dados da location do Payload.

idinteger required

Identificador da location a ser informada na criação de uma recorrência .

locationstring uri required

Localização do Payload a ser informada na criação da recorrência.

criacaostring date-time required

Data e hora em que a location foi criada. Respeita RFC 3339.

idRecstring

Identificador da Recorrência

ID da recorrência: RRxxxxxxxxyyyyMMddkkkkkkkkkkk (29 caracteres; "case sensitive", isso é, diferencia letras maiúsculas e minúsculas), sendo:

  • "R" ou "C": fixo (1 caractere). "R" caso a recorrência tenha sido criada dentro do Pix, ou "C" caso tenha sido criada pela trilha do Open Finance;
  • "R" ou "N": fixo (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>, podendo ser: o ISPB do participante direto, o ISPB do participante indireto ou os 8 primeiros dígitos do CNPJ do prestador de serviço de iniciação (8 caracteres numéricos [0-9]);
  • "yyyyMMdd": data (8 caracteres) de criação da recorrência;
  • "kkkkkkkkkkk": sequencial criado pelo agente que gerou o <Id> (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; ou
  • "CRxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada pela trilha do Open Finance e que permite novas tentativas de pagamento pós vencimento; ou
  • "CNxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada pela trilha do Open Finance e que não permite novas tentativas de pagamento pós vencimento.”

Example response

{
  "location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
  "idRec": "RR1234567820240115abcdefghijk"
}

Changes