Criar cobrança recorrente.

POST

/cobr

CobR

Endpoint para criar uma cobrança recorrente, neste caso, o txid deve ser definido pelo PSP.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

cobr.write-Permissão para alteração de cobranças recorrentes

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Cobrança recorrente criada.

Bodyapplication/json

🟠400

🟠403AcessoNegado

🔴503ServicoIndisponivel

Request Example

Shell

JavaScript

Java

Swift

curl --location '/cobr' \
--header 'Content-Type: application/json' \
--data-raw '{
    "idRec": "RR1234567820240115abcdefghijk",
    "infoAdicional": "Serviços de Streamming de Música e Filmes.",
    "ajusteDiaUtil": true,
    "calendario": {
        "dataDeVencimento": "2024-04-15"
    },
    "valor": {
        "original": "106.07"
    },
    "devedor": {
        "cep": "89256-140",
        "cidade": "Uberlândia",
        "email": "sebastiao.tavares@mail.com",
        "logradouro": "Alameda Franco 1056",
        "uf": "MG"
    },
    "recebedor": {
        "agencia": "9708",
        "conta": "012682",
        "tipoConta": "CORRENTE"
    }
}'

Response Example

201 - Exemplo de cobrança recorrente 1

{
    "idRec": "RR1234567820240115abcdefghijk",
    "txid": "3136957d93134f2184b369e8f1c0729d",
    "infoAdicional": "Serviços de Streamming de Música e Filmes.",
    "status": "CRIADA",
    "politicaRetentativa": "PERMITE_3R_7D",
    "ajusteDiaUtil": true,
    "calendario": {
        "criacao": "2024-04-01",
        "dataDeVencimento": "2024-04-15"
    },
    "valor": {
        "original": "106.07"
    },
    "devedor": {
        "cep": "89256-140",
        "cidade": "Uberlândia",
        "email": "sebastiao.tavares@mail.com",
        "logradouro": "Alameda Franco 1056",
        "uf": "MG"
    },
    "recebedor": {
        "agencia": "9708",
        "conta": "012682",
        "tipoConta": "CORRENTE"
    },
    "atualizacao": [
        {
            "data": "2024-04-01T14:47:29.470Z",
            "status": "CRIADA"
        }
    ]
}

Página anterior

Gerenciamento de cobranças associadas a uma recorrência

Próxima página

Consultar lista de cobranças recorrentes.