API Documentation
Create Crypto Checkout Order

4min
This API creates a payin order where user can deposit digital assets to wallet address provided by the application. It accepts address, currency and amount. On creating an order a dynamic token is returned from this api which is required to be passed openCryptoCheckout()﻿﻿
This api requires access token that can be generated using Access Token﻿ API.
Create an order with payin details from application's backend
POST
Request
Header Parameters
signature
required
String
Signature generated with sha256 followed by base64 encoding. Check below section for more details
access-token
required
String
Access token received from Access token API. You can reuse the access token across multiple API calls till it is expired
Body Parameters
requestId
required
String
Identifier that is created by client application's backend. This will be passed in relevant events and webhooks from Pay3 to Application
address
required
String
The address is the destination wallet address where the purchased currency will be deposited during the purchase.
currency
required
String
The currency is Pay3's unique string ID denoting the token that needs to be purchased. Example value are btc_bitcoin, usdt_polygon, uni_eth. 
amount
optional
String
The amount in ethereum / btc user needs to pay.  The API expects either this parameter or fiatAmount & fiatCurrency parameter.
clientId
required
String
Client id. Application's identifier
fiatAmount
optional
String
Amount in Fiat say USD (eg: 10.50). This parameter is required when amount is not passed. Example values for ten dollar fifty cents is 10.50.
fiatCurrency
optional
String
Fiat currency code is Pay3's unique string ID denoting the fiat currency. This parameter is required along with fiatAmount when amount is not passed. Pay3 uses current exchange rate to translate fiatAmount to amount.
Supported fiat currencies are usd_usa, gbp_gb and eur_eu.
﻿
﻿
Signature Generation
The request for creating payout order requires a header signature. This can be generated using following javascript code snippet. 
Case 1: With amount parameter 
JS
const crypto = require('crypto');

// Required Parameters
const secretKey="Api-Secret-Provided-By-Pay3";
const address = "destination-wallet-address";
const currency = "currency-id";
const amount =  "0.02";
const requestId = "Order-Id-Generated-By-Application";

const getSignature = (secretKey, address, currency, amount, requestId) => {
    // Prepare the string to sign in same format. 
    const stringToSign = 'address=' + address + '&currency=' + currency + '&amount=' + amount + '&requestId=' + requestId;
    
    // Generating signature using SHA256 and provided secret and
    // base64 encode the result
    const mac = crypto.createHmac('sha256', secretKey);
    return mac.update(stringToSign).digest('base64');
}

// Generate Signature
const signature = getSignature(secretKey, address, currency, amount, requestId);

const crypto = require('crypto');

// Required Parameters
const secretKey="Api-Secret-Provided-By-Pay3";
const address = "destination-wallet-address";
const currency = "currency-id";
const amount =  "0.02";
const requestId = "Order-Id-Generated-By-Application";

const getSignature = (secretKey, address, currency, amount, requestId) => {
    // Prepare the string to sign in same format. 
    const stringToSign = 'address=' + address + '&currency=' + currency + '&amount=' + amount + '&requestId=' + requestId;
    
    // Generating signature using SHA256 and provided secret and
    // base64 encode the result
    const mac = crypto.createHmac('sha256', secretKey);
    return mac.update(stringToSign).digest('base64');
}

// Generate Signature
const signature = getSignature(secretKey, address, currency, amount, requestId);
﻿
Case 2: With fiatAmount & fiatCurrency parameter 
JS
const crypto = require('crypto');

// Required Parameters
const secretKey="Api-Secret-Provided-By-Pay3";
const address = "destination-wallet-address";
const currency = "currency-id";
const fiatAmount =  "10.50"; // $10.50
const fiatCurrency =  "usd_usa"; // Example for USD
const requestId = "Order-Id-Generated-By-Application";

const getSignature = (secretKey, address, currency, fiatAmount, fiatCurrency, requestId) => {
    // Prepare the string to sign in same format. 
    const stringToSign = 'address=' + address + '&currency=' + currency + '&fiatAmount=' + fiatAmount + '&fiatCurrency=' + fiatCurrency + '&requestId=' + requestId;
    
    // Generating signature using SHA256 and provided secret and
    // base64 encode the result
    const mac = crypto.createHmac('sha256', secretKey);
    return mac.update(stringToSign).digest('base64');
}

// Generate Signature
const signature = getSignature(secretKey, address, currency, fiatAmount, fiatCurrency, requestId);

const crypto = require('crypto');

// Required Parameters
const secretKey="Api-Secret-Provided-By-Pay3";
const address = "destination-wallet-address";
const currency = "currency-id";
const fiatAmount =  "10.50"; // $10.50
const fiatCurrency =  "usd_usa"; // Example for USD
const requestId = "Order-Id-Generated-By-Application";

const getSignature = (secretKey, address, currency, fiatAmount, fiatCurrency, requestId) => {
    // Prepare the string to sign in same format. 
    const stringToSign = 'address=' + address + '&currency=' + currency + '&fiatAmount=' + fiatAmount + '&fiatCurrency=' + fiatCurrency + '&requestId=' + requestId;
    
    // Generating signature using SHA256 and provided secret and
    // base64 encode the result
    const mac = crypto.createHmac('sha256', secretKey);
    return mac.update(stringToSign).digest('base64');
}

// Generate Signature
const signature = getSignature(secretKey, address, currency, fiatAmount, fiatCurrency, requestId);
﻿
﻿
Updated 01 Oct 2024
Did this page help you?
Create Payout Order
Payment Methods
Create Crypto Checkout Order

﻿

Signature Generation

Case 1: With amount parameter

Case 2: With fiatAmount & fiatCurrency parameter
