Sign in
CobR

Solicitar retentativa de cobrança.

Endpoint para solicitar retentativa de uma cobrança recorrente.

post/cobr/{txid}/retentativa/{data}

Response

Cobrança 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
politicaRetentativa'NAO_PERMITE' | 'PERMITE_3R_7D' required

Example response

{
  "idRec": "RR1234567820240115abcdefghijk",
  "calendario": {
    "dataDeVencimento": "2023-04-01",
    "criacao": "2023-04-01"
  },
  "tentativas": [
    {
      "dataLiquidacao": "2023-04-01"
    }
  ]
}

Changes

Changed in 6 of the 35 revisions of this API.6617

  • 5c39d71167452See the full diff
    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      removed from the ///// response property anyOf list for the response status

      response-property-any-of-removed

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

  • c1461275c67b21See the full diff
    • ▲

      the ///// response property's maxLength was increased from 105 to 400 for the response status

      response-property-max-length-increased

    • ▲

      added subschema #1 subschema #2 to the // response property oneOf list for the response status

      response-property-one-of-added

    • ○

      removed subschema #1 subschema #2 from the // response property oneOf list for the response status

      response-property-one-of-removed

  • 918a1c8477242See the full diff
    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      removed the AG12 enum value from the ///// response property for the response status

      response-property-enum-value-removed

  • 1a3df62a72863611See the full diff
    • ▲

      the // response's property type changed from string to object for status

      response-property-type-changed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ●

      removed the optional property ///// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      added the new PSP_PAGADOR enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new PSP_RECEBEDOR enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new USUARIO_PAGADOR enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new USUARIO_RECEBEDOR enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

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

      response-property-default-value-changed

    • ○

      removed the CANCELADA_PELO_PSP_PAGADOR enum value from the ///// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CANCELADA_PELO_PSP_RECEBEDOR enum value from the ///// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CANCELADA_PELO_USUARIO_PAGADOR enum value from the ///// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CANCELADA_PELO_USUARIO_RECEBEDOR enum value from the ///// response property for the response status

      response-property-enum-value-removed

    • ○

      the // response's property pattern \d{1,10}\.\d{2} was removed for the status

      response-property-pattern-removed

    • ○

      added the required property /// to the response with the status

      response-required-property-added

    • ○

      added the required property /// to the response with the status

      response-required-property-added

    • ○

      added the required property /// to the response with the 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