Order GiftCards

This Payshiga API allows you to order a new gift card. It can be used to generate and send a gift card to a specified recipient.

{{baseurl}}/giftcards/order

This is a POST request and these are the parameters of the request body:

Field	Data Type	Description
`amount`	Number >=1	Required. This specifies the amount of money to be loaded onto the virtual card. It must be a number greater than or equal to 1.
`currency`	String: Default `USD`. Enum `NGN` `USD` `EUR` `GBP` `KES` `TZS` `GHS` `RWF` `XAF` `XOF` `ZAR` `UGX` `AUD` `CAD` `ETB` `EGP` `MAD` `MWK` `ZMW` `SLL` `MUR`	Required. This defines the currency used for the transaction. It defaults to “USD” (US Dollar) but allows other listed options.
`email`	String	Required. User’s email address.
`productId`	Number	Required. This is a number assigned to the specific product or service being purchased.
`quantity`	Number	Required. The number of units being purchased
`note`	String: `/^[a-zA-Z0-9]$/`	Optional note associated with the transaction. It can only contain alphanumeric characters (letters and numbers) and has a maximum length of 200 characters.
`reference`	String	Optional reference code or identifier related to the transaction.

This is what a request payload should look like:

{
  "currency": "NGN",
  "productId": 0,
  "amount": 1,
  "email": "string",
  "quantity": 0,
  "note": "/^a$/",
  "reference": "string"
}

On this page

Order giftcards