Incremento de Créditos

API responsável por incrementar os limites de créditos de um usuário do varejo no billing.

A autenticação deve ser feita via external client credentials

Incremento de créditos varejo

POST /event-increment-limits

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

username *

string

Username do usuário a receber o incremento de créditos.

allowedTypes *

Array

Lista com os tipos de usuário permitidos na operação. Verifica o tipo gravado para o usuário está dentre os informados.

credits *

Object

Objeto contendo os parâmetros de créditos a inputar ao usuário.

credits.days

Number

Dias a serem adicionados na data de vencimento do usuário.

credits.dueDate

Date

Data do vencimento do plano. Quando informado, desconsidera o parâmetro credits.days.

credits.signature

Number

Quantidade de assinaturas digitais a incrementar aos créditos do usuário.

credits.login

Number

Quantidade de autenticações a incrementar aos créditos do usuário.

* Campo obrigatório

Exemplo de um Body JSON:

{
    "username": "12345678901",
    "allowedTypes": ["normal"],
    "credits": {
        "days": 30,
        "signature": 5,
        "login": 5
    }
}

Response

Exemplo

curl -X POST \
  http://url_billing/event-increment-limits \
  -H 'Authorization: Bearer df496b06454204849ffe677ef96292085c209464' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -d '{
    "username": "12345678901",
    "allowedTypes": ["normal"],
    "credits": {
        "days": 30,
        "signature": 5,
        "login": 5
    }
}'

Last updated

Was this helpful?