CreateCheckoutUrlRequest.md

BleumiPay::CreateCheckoutUrlRequest

Properties

Name	Type	Description	Notes
id	String	Unique identifier for this payment. Warning! - Do not reuse this id with the Create a Payment endpoint.
currency	String	Currency Code When you configure custom tokens for the Hosted Checkout in your account in the Bleumi Pay Dashboard, please use: - ISO 4217 Alphabetic Code for fiat, gold, silver, etc. - Token Symbol for crypto
amount	String	Token amount for this payment
cancel_url	String	Buyer will be redirected to this URL upon canceling the payment.
success_url	String	Buyer will be redirected to this URL upon successfully completing the payment and the following data is passed as GET parameters, id - Unique identifier of the checkout URL hmac_input - Payment parameters used to generate HMAC. The format is described below. hmac_keyId - Key ID used to generate HMAC hmac_alg - Algorithm used to generate HMAC hmac_value - HMAC generated for hmac.input
transfer_address (Optional)	String	Payment transfer address (only used in case of Marketplace payments). Use this field to override the token's settlement address specified in the Bleumi Pay Dashboard for the payment.	[optional]
chain (Optional)	Chain	(Required if specifying 'token') Network in which the hosted checkout is to be created. Please refer to the Supported Networks.
token (Optional)	String	If this field is not specified, a list of tokens configured for the provided currency code for the Hosted Checkout in your account in the Bleumi Pay Dashboard is sent to the buyer. The buyer can complete the payment using any one of token from this list. Set the token which must be used by the buyer for this payment. The token provided must be set in your portal for the provided currency code. The token is assumed to be 1:1 with the currency unit. ETH - for Ethereum XDAI - for xDai XDAIT - for xDai Testnet ALGO - for Algo RBTC - for R-BTC <asset id> - for Algorand Standard Asset <contract address of ERC-20 token> - for ERC-20 Tokens. Please refer to ERC-20 Tokens for contract address; <contract address of RSK ERC-20 token> - for RSK ERC-20 Tokens. Please refer to RSK ERC-20 Tokens for contract address;
base64_transform (Optional)	Boolean	Base64 encode hmac_input GET parameter passed to the successUrl

Example

{
    "id": "4",
    "currency": "USD",
    "amount": "10",
    "cancelUrl": "https://demo.store/api/cancelOrder",
    "successUrl": "https://demo.store/api/completeOrder",
    "token":"0x115615dbd0f835344725146fa6343219315f15e5",
    "chain":"goerli"
}