Docs

Gift Cards · Get started

Gift Cards concepts

Gift card payees, purchases, idempotency, Prepay clients and reversals.

Gift card (payee)

A gift card is a payee of type EGift in the category Giftcard. You “pay” it by generating an eGift. The payee’s payee_id is the ID you send to purchase that gift card.

Gift card payees come from the same payee list as Billpay. See List available gift cards.

Field Description
payee_id The ID you use to purchase the gift card
name Display name
category Giftcard
type EGift
currency Currency of the gift card
reference_config.regex null for gift cards
images.small, images.large Product images, each with an id and a url
redemption_info Instructions or information for redeeming the gift card
price Gift card value amount

Purchase

A purchase generates an eGift for a gift card and an amount. It is saved as a payment. The response includes:

Field Description
gift_card_id The payment ID
amount The purchased amount
payee_id The gift card that was purchased
status completed, failed or pending
created_at When the purchase was made
redeem_link The eGift redemption URL

All amounts are in MXN. The amount must be greater than 0 and within the gift card’s allowed range.

Idempotency key

Every purchase requires an idempotency_key. Use a unique key per purchase. If you send a key that was already used, the purchase is rejected with DUPLICATED_PAYMENT_ERROR.

Prepay clients

For Prepay clients, the purchase checks that you have enough prepaid balance before the eGift is generated, and deducts the amount from your balance when the payment is finalized. If the balance is not enough, you get AMOUNT_INSUFFICIENT.

Reversal

If the provider times out during a purchase, you get PAYEE_TIMEOUT and Monato queues an automatic reversal so the transaction is not left in an inconsistent state. See Timeouts and reversals.