Docs

Gift Cards · Get started

Gift Cards

Sell digital gift cards (eGift) from your app with Monato.

Sell digital gift cards (eGift) directly from your app. Pick a gift card from the Billpay catalog, choose an amount and receive the redeem link. Every successful purchase is saved as a payment.

What you can do

  • Discover gift cards. Available gift cards come from the Billpay payee list, filtered by category Giftcard.
  • Purchase gift cards. Generate an eGift for a gift card and an amount, and get its redeem link.

Key features

  • Checks before anything is generated. The purchase validates the input, the product, the amount and, for Prepay clients, the balance. It stops at the first failure, so you only get a gift card when every check passes.
  • No duplicate purchases. Every purchase requires an idempotency_key. A repeated key is rejected with DUPLICATED_PAYMENT_ERROR.
  • Automatic reversal on timeout. If the provider times out, you get PAYEE_TIMEOUT and Monato queues an automatic reversal.
  • One error envelope. Every error has the same machine-readable shape.
Inputmatches schemafailProductavailablefailAmountin allowed rangefailUnique keyidempotency_keyfailPayeeexists, availablefailBalancePrepay onlyfail eGift generatedfinalized · redeem link provider timeout: PAYEE_TIMEOUTand automatic reversal Error responseno eGift generated
The purchase checks run in order and short-circuit: the first failed check returns an error and no eGift is generated. After the checks, the eGift is generated and the payment is finalized (for Prepay clients, the balance is deducted). If the provider times out, the API returns PAYEE_TIMEOUT and enqueues an automatic reversal.

How it works

  1. Authenticate. Send your Bearer token in the Authorization header of every request.
  2. Discover gift cards. List the Billpay payees with category Giftcard and cache the list.
  3. Purchase. Send the payee, the amount and a unique idempotency key.
  4. Handle the response. Store the gift card ID and the redeem link, and handle any errors.

Start building

Need help?

Write to engineering@monato.com for credentials, integration questions or technical support. You can also schedule a call with our technical team. We are WhatsApp and Slack friendly.