Skip to main content
POST
Criar transação na carteira de cashback

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

Body

application/json
customer_email
string<email>
required

E-mail do cliente. Deve pertencer a um cliente cadastrado na loja.

Example:

"cliente@example.com"

transaction_type
enum<string>
required

Tipo da transação: credit para adicionar saldo, debit para subtrair.

Available options:
credit,
debit
Example:

"credit"

amount
number<float>
required

Valor da transação.

Required range: x >= 0
Example:

15.5

expires_at
string<date>
required

Data de expiração do crédito no formato Y-m-d. Deve ser igual ou posterior a hoje.

Example:

"2026-12-31"

description
string
required

Descrição da transação (máximo 140 caracteres, pois o sufixo ' (via API)' é adicionado automaticamente).

Maximum string length: 150
Example:

"Bonificação por indicação"

Response

Transação criada com sucesso

data
object

Representa uma transacao de cashback na carteira do cliente.