Page Integration

Description

Partner is redirected to Alchemy Pay's NFT checkout page. The NFTs parameters are considered in the process.

Test environment

https://nft-sbx.alchemytech.cc

Prod environment

https://nftcheckout.alchemypay.org/

Http method

Redirect
Content-Type: application/json

Parameters

Element	Mandatory	Signature	Data Type	Remarks
appId	Y	Y	string	Partner unique ID, once a merchant has been on-boarded with Alchemy Pay, the merchant will be provided with the credentials with appId and appSecret
token	C	C	string	Fetch from token API. With accessToken, email’s OTP authentication will skip. Processed by URLencode.
email	C	C	string	End user's mail, get from Fetch Token API with token if user want to skip the authentication. Processed by URLencode. Otherwise, just pass the email in plaintext.
id	C	C	string	Session ID from fetch token API, pass with email and token. Processed by URLencode.
timestamp	Y	Y	string	UTC time with 13 digit
timeout	Y	Y	string	time going to expire, UTC,13 digit
fiat	C	Y	string	fiat type, char code with ISO4217 encoding currency unit, USD/EUR/SGD/JPY/GBP, etc. Required parameter for fiat-based🔺
amount	C	Y	string	Total NFT order fiat amount. The payment channel fee that the user needs to pay will be deducted from the amount. Required parameter for fiat-based🔺
crypto	C	Y	string	BTC/ETH.etc ETH default. Required parameter for crypto-based🔺
cryptoAmount	C	Y	string	Total NFT oder crypto amount，Required parameter for crypto-based🔺
targetFiat	C	Y	string	Default fiat payment type for display
type	Y	Y	string	NFT type: MARKET/MINT
uniqueId	C	Y	string	NFT Unique Identity, Required for NFT type MARKET 🔺
quantity	C	Y	string	NFT quantity, Required for NFT type MINT 🔺
name	Y	Y	string	NFT name
picture	Y	Y	string	NFT pic rendering URL, 220px * 220 px，
redirectUrl	Y	Y	string	Redirect URL after buying NFT succeed
callbackUrl	Y	Y	string	Webhook URL to get the notify message from Alchemy Pay
merchantOrderNo	Y	Y	string	Merchant defined order ID
merchantName	C	Y	string	Merchant name
signature	Y	Y	string	Signature

Example

Fiat-based parameters:

{
    "amount": "5",
    "appId": "ahzxh0klegv1fzol",
    "callbackUrl": "https://alchemypay.org",
    "fiat": "SGD",
    "merchantName": "name",
    "merchantOrderNo": "ACH_TEST2023020110027",
    "name": "xter-nft",
    "nonce": 223634627,
    "picture": "https://download.bit.store/official/BitStore/pic/user_portrait/20.jpeg",
    "quantity": "3",
    "redirectUrl": "https://alchemypay.org",
    "signature": "nLjws0bt5PANY0ZE9BlnvFnHL4Y=",
    "targetFiat": "SGD",
    "timeout": "1675311363000",
    "timestamp": 1675305175,
    "type": "MINT"
}

https://nft-test.alchemytech.cc/?amount=200&appId=ahzxh0klegv1fzol&callbackUrl=https%3A%2F%2Falchemypay.org&email=oiSNiys7o%252BPHh6XiTeTg4xAw6za%252BOlzyajeYuue%252FTVc%253D&fiat=USD&id=EGPDNKKDygNT5vgBzYVwsA%253D%253D&merchantName=name&merchantOrderNo=ACH_TEST202212191001&name=%E4%B8%AD%E6%96%87&nonce=1674517091&picture=https%3A%2F%2Falchemypay.org%2Fwp-content%2Fuploads%2F2022%2F05%2Falchemy-pay-logo-light-1.png&redirectUrl=https%3A%2F%2Falchemypay.org&signature=frP9wAqJrbpE3Ui43QABGqph%2BUc%3D&targetFiat=USD&timeout=1701677383000&timestamp=1671608907&token=ACH3430784095ACHjF25%252F8dIFInSYQKgxn1786sqkncE0eYfsoCzNbtAuYdSzezW0oBnxoxmVbQUR%252FhnKz8tBDEptJfr22eZRvmRgA%253D%253D&type=MARKET&uniqueId=11133#/

Crypto-based parameters:

{
    "appId": "ahzxh0klegv1fzol",
    "callbackUrl": "https://alchemypay.org",
    "crypto": "ETH",
    "cryptoAmount": "0.01",
    "merchantName": "name",
    "merchantOrderNo": "ACH_TEST2023020110027",
    "name": "xter-nft",
    "nonce": 839208497,
    "picture": "https://download.bit.store/official/BitStore/pic/user_portrait/20.jpeg",
    "quantity": "3",
    "redirectUrl": "https://alchemypay.org",
    "signature": "NzFLwv6pIwkN09SxKBz8QwFyxdA=",
    "targetFiat": "SGD",
    "timeout": "1675311363000",
    "timestamp": 1675305012,
    "type": "MINT"
}

https://nft-sbx.alchemytech.cc?appId=o0hz2e8avsbuk12h&callbackUrl=https%3A%2F%2Falchemypay.org&crypto=ETH&cryptoAmount=0.5&email=oiSNiys7o%2BPHh6XiTeTg4xAw6za%2BOlzyajeYuue%2FTVc%3D&fiat=USD&id=c5IC7mkHz7ku95dYUU7FHw%3D%3D&merchantName=name&merchantOrderNo=ACH_TEST202301091005&name=NFT+name&nonce=557173557&picture=https%3A%2F%2Fdownload.bit.store%2Fofficial%2FBitStore%2Fpic%2Fuser_portrait%2F20.jpeg&quantity=3&redirectUrl=https%3A%2F%2Falchemypay.org&signature=NsvaSQ67qwo1weRryNgMAM%2B2D5Q%3D&timeout=1673251045000&timestamp=1673258682&token=ACH6335436896ACHoAcgGT0oMCAkRKxUR8k0efO2H8RJpOxNl1ox%2FZpdH0eYOAHQtUYveEyQ86QDsmW6e6oST0xmwIefqHE5auuWIg%3D%3D&type=MINT