Sign in
CobR

Criar cobrança recorrente.

Endpoint para criar uma cobrança recorrente.

put/cobr/{txid}

Request body

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.”
infoAdicionalstring

Informações adicionais da fatura.

ajusteDiaUtilboolean required

Campo de ativação do ajuste da data prevista para liquidação para próximo dia útil caso o vencimento corrente seja um dia não útil. O PSP Recebedor deverá considerar os feriados locais com base no código município do usuário pagador.

Example request

{
  "idRec": "RR1234567820240115abcdefghijk",
  "calendario": {
    "dataDeVencimento": "2023-04-01"
  }
}

Response

Cobrança imediata recorrente.

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.”
txidstring required

Identificador da transação

O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.

Na pacs.008, é referenciado como TransactionIdentification <txId> ou idConciliacaoRecebedor.

Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.

O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.

infoAdicionalstring

Informações adicionais da fatura.

ajusteDiaUtilboolean required

Campo de ativação do ajuste da data prevista para liquidação para próximo dia útil caso o vencimento corrente seja um dia não útil. O PSP Recebedor deverá considerar os feriados locais com base no código município do usuário pagador.

status'CRIADA' | 'ATIVA' | 'CONCLUIDA' | 'EXPIRADA' | 'REJEITADA' | 'CANCELADA' required

Example response

{
  "idRec": "RR1234567820240115abcdefghijk",
  "calendario": {
    "dataDeVencimento": "2023-04-01",
    "criacao": "2023-04-01"
  }
}

Changes

Changed in 4 of the 35 revisions of this API.7514

  • 4047ae07a6392See the full diff
    • ○

      added subschema #1 subschema #5 to the response body allOf list for the response status 201

      response-body-all-of-added

    • ○

      removed subschema #1 subschema #5 from the response body allOf list for the response status 201

      response-body-all-of-removed

  • 1a3df62a72866511See the full diff
    • ▲

      added the new required request property allOf[subschema #2: Cobrança Recorrente Base]/calendario/dataDeVencimento

      new-required-request-property

    • ▲

      added the new required request property allOf[subschema #2: Cobrança Recorrente Base]/valor/original

      new-required-request-property

    • ▲

      the allOf[subschema #2: Cobrança Recorrente Base]/valor request property type/format changed from string/ to object/

      request-property-type-changed

    • ▲

      the allOf[subschema #3: Cobrança Recorrente Base]/valor response's property type/format changed from string/ to object/ for status 201

      response-property-type-changed

    • ▲

      removed the required property allOf[subschema #3: Cobrança Recorrente Base]/calendario/dataVencimento from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property allOf[subschema #4]/calendario/dataCriacao from the response with the 201 status

      response-required-property-removed

    • ●

      removed the request property allOf[DadosDevedorRecorrencia]/dadosDevedor

      request-property-removed

    • ●

      removed the request property allOf[subschema #2: Cobrança Recorrente Base]/calendario/dataVencimento

      request-property-removed

    • ●

      removed the request property allOf[subschema #2: Cobrança Recorrente Base]/contaRecebedor

      request-property-removed

    • ●

      removed the optional property allOf[DadosDevedorRecorrencia]/dadosDevedor from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #3: Cobrança Recorrente Base]/contaRecebedor from the response with the 201 status

      response-optional-property-removed

    • ○

      added the new optional request property allOf[DadosDevedorRecorrencia]/devedor

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #2: Cobrança Recorrente Base]/recebedor

      new-optional-request-property

    • ○

      the ajusteDiaUtil request property default value changed from false to true

      request-property-default-value-changed

    • ○

      removed the pattern \d{1,10}\.\d{2} from the request property allOf[subschema #2: Cobrança Recorrente Base]/valor

      request-property-pattern-removed

    • ○

      added the optional property allOf[DadosDevedorRecorrencia]/devedor to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #3: Cobrança Recorrente Base]/recebedor to the response with the 201 status

      response-optional-property-added

    • ○

      the ajusteDiaUtil response's property default value changed from false to true for the status 201

      response-property-default-value-changed

    • ○

      the allOf[subschema #3: Cobrança Recorrente Base]/valor response's property pattern \d{1,10}\.\d{2} was removed for the status 201

      response-property-pattern-removed

    • ○

      added the required property allOf[subschema #3: Cobrança Recorrente Base]/calendario/dataDeVencimento to the response with the 201 status

      response-required-property-added

    • ○

      added the required property allOf[subschema #3: Cobrança Recorrente Base]/valor/original to the response with the 201 status

      response-required-property-added

    • ○

      added the required property allOf[subschema #4]/calendario/criacao to the response with the 201 status

      response-required-property-added

  • e60160879b891See the full diff
    • ○

      endpoint added

      endpoint-added

  • 5967a4b6f9341See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 128 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog