Skip to main content
POST

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 cupom ao qual o cupom será vinculado. Obtenha os geradores disponíveis em GET /cupons/geradores.

​
data_hora_inicio
string<date-time>
required

Data e hora de início da validade do cupom em formato ISO 8601

Example:

"2026-05-01T00:00:00Z"

​
data_hora_final
string<date-time>
required

Data e hora de término da validade do cupom em formato ISO 8601

Example:

"2026-06-01T23:59:59Z"

​
limite_de_uso
enum<string>
required

Define a regra de limite de utilização do cupom.

Available options:
sem_limite,
apenas_uma_vez,
apenas_primeira_corrida,
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
Example:

"percentual"

​
desconto
string
required

Valor do desconto. Para valor_fixo, use o valor monetário (ex: "10.00"). Para porcentagem, use o percentual (ex: "15").

Example:

"10.00"

​
tipos_pagamentos
enum<string>[]
required

Lista de formas de pagamento aceitas pelo cupom. Tipos de pagamento em que o cupom irá se aplicar separados por vírgula, 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), Pix via app (I) e Carteira de Créditos (R).

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

Código do cupom que o passageiro utilizará. Obrigatório se codigo_pattern não for informado.

Example:

"DESCONTO10"

​
codigo_pattern
string

Padrão para geração automática de códigos de cupom. Obrigatório se codigo não for informado.

Example:

"DESCONTO10"

​
limite_de_uso_individual
integer

Número máximo de vezes que cada passageiro pode usar o cupom. Obrigatório quando limite_de_uso é ate_n_vezes_por_passageiro.

Example:

3

​
cliente_ids
integer[]

Opcional. Lista de ids dos clientes que poderão usar o cupom criado.

Example:
​
area_id
integer

Opcional. Indica a área a qual o cupom será restrito.

Example:

239

Response

Cupom criado com sucesso

The response is of type object.