v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB

Promoções - Carteira

Criar transação na carteira de cashback

Cria uma transação de crédito ou débito na carteira de cashback do cliente. O sufixo ' (via API)' é adicionado automaticamente à descrição. Rate limit: 5 requisições por minuto.

post/{alias}/pricing/wallet/transaction

Path parameters

aliasstring required

Alias da loja

Request body

customer_emailstring email required

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

transaction_type'credit' | 'debit' required

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

amountnumber float required

Valor da transação.

expires_atstring date required

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

descriptionstring required

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

Example request

{
  "customer_email": "cliente@example.com",
  "transaction_type": "credit",
  "amount": 15.5,
  "expires_at": "2026-12-31",
  "description": "Bonificação por indicação"
}

Response

Transação criada com sucesso

Example response

{
  "data": {
    "id": 10001,
    "transaction_type": "credit",
    "amount": 9.9,
    "accumulated_amount": 9.9,
    "status": "approved",
    "expires_at": "2026-01-31",
    "expired": 1,
    "customer": {
      "id": 200001,
      "name": "Cliente Exemplo",
      "email": "cliente@example.com",
      "phone": "5500000000000"
    },
    "order": {
      "id": 300001,
      "number": 123456789012
    },
    "created_at": {
      "date": "2000-08-17 10:24:24",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "updated_at": {
      "date": "2000-08-17 10:24:24",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    }
  }
}