Gift Card
Display supported countries
GET https://sandbox.encryptus.co/v1/payout/giftcard/filters
Path Parameters
country
String
deliveryType
String
currencyCode
String
Name
Type
Description
countryName
string
supported country identified by full name
brand
string
name of the company offering the gift card
productId
number
unique product ID
vouchersImg
string
displays brand logo or voucher image as link
productName
string
name of the product
valueDenominations
string
value of denomination for products with fixed denomination
valueType
string
declared values or variable values eg open_value or fixed_denomination
exchangeRate
number
exchange rate from base currency USD to local fiat currency - reference to deliveryCurencyCode
minValue
number
option 1: product allows variable amount within range set in delivery currency and system expects gift card amount equal or higher than minimum;
option 2: product is restricted to a fixed amount and minimum value is set to 0 .
maxValue
number
option 1: product allows variable amount within range set in delivery currency and system expects gift card amount equal or lower than maximum;
option 2: product is restricted to a fixed amount and maximum value is set to 0.
fee
number
fee amount charged by brand for transaction
deliveryCurrencyCode
string
three letters ISO currency code that represent the local fiat currency
Submit details for gift card quote
POST https://sandbox.encryptus.co/v1/payout/giftcard/quote
Request Body
country*
String
selected country
productId*
Number
unique product ID listed in gift card catalogue
brand*
String
brand that offers the product
denominator*
String
amount of fiat currency / value in local currency that gift card is issued
cryptoCoin*
String
selected cryptocurrency from supported cryptocurrency list
selectedFiat*
String
local fiat currency to convert to
partner_userID
String
partner ID referencing quote to partner - clientID
encryptus_userID*
String
unique user ID referenced by Encryptus
quantity*
Number
quantity of selected gift card - default is 1
Name
Type
Description
quoteAmount
number
amount in selected cryptocurrency
quoteCurrency
string
crypto currency for quote amount
quoteID
string
unique ID generated for the quote
validUntil
string
date and time when the quote expires
productId
number
unique ID of selected product
brand
string
name of company offering the selected gift card
partner_userID
string
user ID referenced by partner during user creation
deliveryAmount
number
gift card value in local fiat currency
deliveryCurrency
string
three letters ISO currency code that represent the local fiat currency where gift card is delivered
Accept quote and submit order
POST https://sandbox.encryptus.co/v1/payout/giftcard/order
Request Body
quoteID*
String
ID generated for the requested quote
Name
Type
Description
orderID
string
system generated unique order number for the executed quote
status
string
current status of the order
Possible return values:
“submitted”, “processing”, “complete”
voucher_code
string
voucher code or url based on the type parameter
voucher_pin
string
pin for the voucher if applicable
voucher_validity
string
validity of the voucher (format YYYY-MM-DD)
type
string
type of voucher: code | codePin | url | URL + Pin
Display details for particular order
GET https://sandbox.encryptus.co/v1/payout/giftcard/order/{orderId}
Path Parameters
orderID*
String
unique ID generated for the order
Name
Type
Description
orderAmount
number
amount in cryptocurrency
orderCurrency
string
selected cryptocurrency
orderID
string
unique ID generated for the submitted order
transactionDate
string
date and time when the order was submitted
orderStatus
string
current status of the order
Possible return values:
“submitted”, “processing”, “complete” or “failed”
productId
number
unique ID of selected product
brand
string
name of company offering the selected gift card
partner_userID
string
user ID referenced by partner during user creation
deliveryAmount
number
gift card value in local fiat currency
deliveryCurrency
string
three letters ISO currency code that represent the local fiat currency where gift card is delivered
Display all orders submitted from partner
GET https://sandbox.encryptus.co/v1/payout/giftcard/orders
Last updated