Docs
APIReferênciaGift cards

Criar gift card

Cria um gift card com saldo e, se quiser, manda por e-mail.

Permissão da chave: Catálogo › escrever.

Autenticação

bearer
headerAuthorizationBearer <chave de API>

Chave de API da loja (Painel › Integrações › Chaves de API)

Headers

Idempotency-Key?string

Chave única por operação (ex.: o id do pedido no seu sistema). Repetir a chamada com a mesma chave devolve a mesma resposta, sem duplicar.

Padrão (regex)^[A-Za-z0-9._:-]+$
Tamanho8 <= length <= 255

Corpo da requisição

application/json
  1. body
amountCents*number
Intervalo100 <= value <= 1000000
expiresAt?string
note?string
Tamanholength <= 200
recipientEmail?string
Formatoemail
Tamanholength <= 254
recipientName?string
Tamanho1 <= length <= 80
message?string
Tamanho1 <= length <= 200

Corpo da resposta

Exemplo de requisição
curl -X POST "https://api.rivoo.gg/v1/gift-cards" \  -H "Authorization: Bearer $RIVOO_API_KEY" \  -H "Idempotency-Key: pedido_123" \  -H "Content-Type: application/json" \  -d '{"amountCents":100}'
Exemplo de resposta
Vazio

Alterar gift card PATCH

Altera validade ou desativa o gift card. **Permissão da chave:** Catálogo › escrever.

Criar gift cards em lote POST

Cria vários gift cards de uma vez. **Permissão da chave:** Catálogo › escrever.