Skip to main content
POST
Criar cupom

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

api-key
string
header
required

Obrigatório. Sua chave API.

Body

application/json
gerador_cupom_id
integer
required

ID do gerador de cupons de que deve seguir o padrão.

codigo
string
required

Código do cupom.

data_hora_inicio
string<date-time>
required

Data hora do início da validade do cupom.

data_hora_final
string<date-time>
required

Data hora do fim da validade do cupom.

limite_de_uso
enum<string>
required

Quantidade de vezes que o cupom poderá ser utilizado, podendo ser: sem_limite, apenas_uma_vez, apenas_primeira_corrida, ate_n_vezes_por_passageiro.

Available options:
sem_limite,
apenas_uma_vez,
apenas_primeira_corrida,
ate_n_vezes_por_passageiro
limite_de_uso_individual
integer
required

Quantidade de vezes que o cupom pode ser utilizado, caso limite_de_uso seja ate_n_vezes_por_passageiro.

tipo_desconto
enum<string>
required

Tipo de desconto como percentual (percentual) ou valor fixo (valor_fixo).

Available options:
percentual,
valor_fixo
desconto
string
required

Valor do desconto que será aplicado no cupom.

tipos_pagamentos
enum<string>[]
required

Tipos de pagamento em que o cupom irá se aplicar, valores aceitos: Dinheiro (D), Débito (máquina) (B), Crédito máquina (C), eTicket (T), Voucher (V), Pix (X), Picpay (P), Whatsapp (H), Cartão via app (A), Faturado (F), Picpay (P), Pix via app (I) e Carteira de Créditos (R).

Available options:
D,
B,
C,
T,
V,
X,
P,
H,
A,
F,
I,
R

Response

200 - application/json

Sucesso

The response is of type object.