API Documentation
Create Payout Order

2min
This API creates a payout order to enable users to withdraw funds. It accepts amount and currency details. On creating an order a dynamic token is returned from this api which is required to be passed to pay3Pay.openPayout()﻿ 
This api requires access token that can be generated using Access Token﻿ API.
Create an order with payout details from application's backend
POST
Request
Header Parameters
signature
String
required
Signature generated with sha256 followed by base64 encoding. Check below section for more details
access-token
String
required
Access token received from Access token API. You can reuse the access token across multiple API calls till it is expired
Body Parameters
requestId
String
required
Identifier that is created by Application's backend. This will be passed in relevant events and webhooks from Pay3 to Application
currencyId
String
required
Currency id supported in the payout flow. This will be provided by Pay3 during onboarding
fiatAmount
String
required
Amount user can withdraw in string format. Maximum two decimal places are allowed
paymentMethodId
String
required
Unique string identifier. This will be provided by Pay3 during onboarding 
email
String
required
User email to identify the user, which will be available in reporting dashboard
userId
String
optional
It is a type of UUID. It will used as unique identifier of the user. If this is not passed, email will be used as a unique identifier of the user within Pay3.
clientId
String
required
Client id. Application's identifier
firstName
String
optional
Optional first name of the user
lastName
String
optional
Optional last name of the user
taxId
String
optional
Tax ID issued to the user by their country
pixKey
String
optional
PIX Key is a unique identifier that links to a Brazilian user’s bank account and determines where the funds will be received.
mode
String
optional
mode can accept values like bank, cpf, pix etc. pixKey is mandatory if mode is set to pix.
﻿
Signature Generation
The request for creating payout order requires a header signature. This can be generated using following javascript code snippet. 
JS
const crypto = require('crypto');

// Required Parameters
const secretKey="Api-Secret-Provided-By-Pay3";
const currencyId = "currency-id";
const fiatAmount =  "0.02";
const requestId = "Order-Id-Generated-By-Application";
const clientId = "your-client-id";
const accessToken = "dynamic-access-token";

const getSignature = (secretKey, currencyId, fiatAmount, requestId) => {
    // Prepare the string to sign in same format. 
    // currencyId followed by fiatAmount followed by requestId
    const stringToSign = 'currencyId=' + currencyId + '&fiatAmount=' + fiatAmount + '&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, currencyId, fiatAmount, requestId);

const crypto = require('crypto');

// Required Parameters
const secretKey="Api-Secret-Provided-By-Pay3";
const currencyId = "currency-id";
const fiatAmount =  "0.02";
const requestId = "Order-Id-Generated-By-Application";
const clientId = "your-client-id";
const accessToken = "dynamic-access-token";

const getSignature = (secretKey, currencyId, fiatAmount, requestId) => {
    // Prepare the string to sign in same format. 
    // currencyId followed by fiatAmount followed by requestId
    const stringToSign = 'currencyId=' + currencyId + '&fiatAmount=' + fiatAmount + '&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, currencyId, fiatAmount, requestId);
﻿
﻿
Updated 20 Feb 2025
Did this page help you?
Get Order Details
Create Crypto Checkout Order