The gift card API solution provided by Gate Pay is designed to facilitate the instant creation and value checking of gift cards.

# 2.1 Create Gift Card

• Data Type：JSON （content-type：application/json）

• Method：POST

• Path: /v1/pay/gift/create

• Verification Method: Signature Verification

• Request Content:

  Field Name	Type	Is Required	Description
  title	string	Y	Gift card title
  templateId	string	Y	Gift card template ID
  currency	string	Y	Currency of gift card
  amount	string	Y	Amount of gift card

• Response Content

  Field Name	Type	Is Required	Description
  card_num	string	Y	Card number
  card_key	string	Y	Redemption code of gift card
  amount	string	Y	Amount of gift card
  currency	string	Y	Currency of gift card
  status	string	Y	Gift card status 0 Unknown Status 1 Gift Card Pending Payment 2 Not Redeemed 3 Redeemed 4 Frozen 5 Payment Failed 6 Manual Review 7 Review Rejected 8 Review Payment Failed
  card_temp_id	string	Y	Gift card template ID
  creator_name	string	Y	Name of the gift card creator
  create_time	string	Y	Create time

# 2.2 Get Gift Card Template List

• Data Type：JSON （content-type：application/json）

• Method：GET

• Path: /v1/pay/gift/temp/list

• Verification Method: Signature Verification

• Response Content

• CURL

curl --location 'https://openplatform.gateapi.io/v1/pay/temp/list' \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Certificate-ClientId: mZ96D37oKk-HrWJc' \
--header 'X-GatePay-Timestamp: 1737950081280' \
--header 'x-GatePay-Nonce: 3100797950' \
--header 'x-GatePay-Signature: d698f8fbe812a0b9142c774ccb894b8eeb8dbcce223272a32165a57c6b6c41547def66c52ea73213d98be53a5f5875377aaa8abc90be51672a57a1602bbef552'

• Response

{
    "status": "SUCCESS",
    "code": "000000",
    "errorMessage": "",
    "data": [
        {
            "card_temp_id": "293389550603997184",
            "image_url": "https://test-gateio-nft.s3.ap-northeast-1.amazonaws.com/image/688c908c72b1cb9b78039de44003b4f8de4009f5.jpg",
            "title_en": "anlitest",
            "title_cn": "anlitest常用",
            "cover_type": "theme"
        }
    ]
}

# 2.3 Query Available Currency Balance

• Data Type：JSON （content-type：application/json）

• Method：GET

• Path: /v1/pay/balance

• Verification Method: Signature Verification

• CURL

curl --location 'https://openplatform.gateapi.io/v1/pay/balance' \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Certificate-ClientId: mZ96D37oKk-HrWJc' \
--header 'X-GatePay-Timestamp: 1737951293198' \
--header 'x-GatePay-Nonce: 5609469415' \
--header 'x-GatePay-Signature: bda8607f683f39f987f52d644738b551b7d29be5663d7c997cb7d2240e49eb1aba7b031f7bae712f6643992585705afe1ce7b4a16440b98ac13aa004a6be6499'

• Response

{
    "status": "SUCCESS",
    "code": "000000",
    "errorMessage": "",
    "data": {
        "ADA": "313.99963295",
        "ALGO": "0",
        "APT": "0",
        "ARB": "0",
        "ATOM": "0",
        "AVAX": "0",
        "BCH": "0",
    }
}

# 2.4 Query Gift Card

• Data Type：JSON （content-type：application/json）

• Method：POST

• Path: /v1/pay/gift/query

• Verification Method: Signature Verification

• Request

  Field Name	Type	Is Required	Description
  card_number	string	N (one of two)	Gift card number
  key	string	N (one of two)	Redemption code

• Response Parameters

  Field Name	Type	Is Required	Description
  card_num	string	Y	Gift card number
  amount	string	Y	Gift card amount
  currency	string	Y	Gift card currency
  status	string	Y	Gift card status 0 Unknown Status 1 Gift Card Pending Payment 2 Not Redeemed 3 Redeemed 4 Frozen 5 Payment Failed 6 Manual Review 7 Review Rejected 8 Review Payment Failed
  card_temp_id	string	Y	Gift card cover ID
  creator_name	string	Y	Gift card creator's name
  create_time	string	Y	Create time
  exchange_uid	int	Y	Redeemer
  key	string	Y	Redemption code
  title	string	Y	Title
  exchange_time	int	Y	Exchange time in standard timestamp format, measured in milliseconds

• CURL

curl --location 'https://openplatform.gateapi.io/v1/pay/create/query' \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Certificate-ClientId: mZ96D37oKk-HrWJc' \
--header 'X-GatePay-Timestamp: 1737951293198' \
--header 'x-GatePay-Nonce: 5609469415' \
--header 'x-GatePay-Signature: bda8607f683f39f987f52d644738b551b7d29be5663d7c997cb7d2240e49eb1aba7b031f7bae712f6643992585705afe1ce7b4a16440b98ac13aa004a6be6499' \
--data '{
    "card_number":"2002356433468640",
    "key":""
}'

• Resonse

{
    {
    "status": "SUCCESS",
    "code": "000000",
    "errorMessage": "",
    "data": {
        "card_num": "6712561472330044",
        "key": "r81T4rg3FKjt2+BYUgIn0CFqwtxp9CUSHGBFYDDJ608=",
        "title": "",
        "creator_name": "GateUser-8118f6f8",
        "amount": "0.99",
        "status": 2,
        "currency": "USDT",
        "create_time": 1737971259259,
        "exchange_uid": 0,
        "exchange_time": 1737971259259
    }
    }
}