📢

Welcome to the xCurrency Hubs - Global Payout API documentation. Before you start coding, please review some important information about our API.

Interface Specification

ㅤ	ㅤ
Communication Mode	https + json
Charset	UTF-8
Encryption Method	Encrypt with `RSA`; Signature with `base64`
Date Format	yyyy-MM-dd
Network Limit	IPs

Sample API Request Flow API

flow

Security

To use our API you will require certain credentials that we will use to identify and authorize the use of Pay Out API.

💡

Please contact us at dev@xcurrency.com to obtain your credentials. You are supposed to get the following credentials from us before starting to use the API.

Name	Description
App Key	Will be used to identify you on consuming the API and obtain the authorization token which is used to access restricted resources.
Secret Key	Will need this to obtain the authorization token which is used to access restricted resources.
SFTP Account Name	Will be used to login SFTP which transfers the user’s KYC files to xCurrency.
SFTP Account Password	Will be used to login SFTP which transfers the user’s KYC files to xCurrency.

Request Header

To start using the API, the request header should be set attributes below.

Name	Description
appkey	required, send by xCurrency.
token	required, get by authorization API.
sign	required, to encrypt with body content string.

Request Body

Content-Type as application/json

API Hosts

sandbox：https://api-sandbox.xcurrency.com

production：https://api.xcurrency.com

Generate Private Key

💡

The Computer’s system environment should support OpenJDK 8 or above and download the file sent to you by email.

OpenSecretToolForWin.zip

54331.7KB

downloaded the file and unzip the file, in the folder, click the secret.jar to open GUI, the generate the private key and public key. The public key is sent to xCurrency Hubs, and the private key you keep safe by yourself.

Encrypt Method

💡

Encrypt: To encrypt with the private key(the request body should convert to JSON string first, then encrypt with the private key, finally get the base64 string and put on request headers. You can see the example of the Java code sent to you by email.)

Java Code Example

java
import com.tratao.jcommon.common.BaseServiceException;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.io.IOUtils;
import org.springframework.stereotype.Component;

import javax.crypto.Cipher;
import java.io.ByteArrayOutputStream;
import java.security.*;
import java.security.interfaces.RSAPrivateKey;
import java.security.interfaces.RSAPublicKey;
import java.security.spec.PKCS8EncodedKeySpec;
import java.security.spec.X509EncodedKeySpec;

public class RsaUtil {

	public static final String CHARSET = "UTF-8";
	public static final String RSA_ALGORITHM = "RSA";
	public static final String RSA_ALGORITHM_SIGN = "SHA256WithRSA";
	
	/**
	* sign data
	* @param data the string value
	* @param privateKeyStr private key 
	* @return
	*/
	public String sign(String data,String privateKeyStr){
	  try{
	      //sign
	      KeyFactory keyFactory = KeyFactory.getInstance(RSA_ALGORITHM);
	      PKCS8EncodedKeySpec pkcs8KeySpec = new PKCS8EncodedKeySpec(Base64.decodeBase64(privateKeyStr));
	      privateKey = (RSAPrivateKey) keyFactory.generatePrivate(pkcs8KeySpec);
	      Signature signature = Signature.getInstance(RSA_ALGORITHM_SIGN);
	      signature.initSign(privateKey);
	      signature.update(data.getBytes(CHARSET));
	      return Base64.encodeBase64URLSafeString(signature.sign());
	  }catch(Exception e){
	      throw new RuntimeException("sign data: [" + data + "] throw exception", e);
	  }
	}
	
	/**
	 * decrypt data
	 * @param data sign data
	 * @param privateKeyStr private key
	 * @return
	 */
	public String privateDecrypt(String data,String privateKeyStr){
	    try{
	        KeyFactory keyFactory = KeyFactory.getInstance(RSA_ALGORITHM);
	        PKCS8EncodedKeySpec pkcs8KeySpec = new PKCS8EncodedKeySpec(Base64.decodeBase64(privateKeyStr));
	        privateKey = (RSAPrivateKey) keyFactory.generatePrivate(pkcs8KeySpec);
	        Cipher cipher = Cipher.getInstance(RSA_ALGORITHM);
	        cipher.init(Cipher.DECRYPT_MODE, privateKey);
	        return new String(rsaSplitCodec(cipher, Cipher.DECRYPT_MODE, Base64.decodeBase64(data), privateKey.getModulus().bitLength()), CHARSET);
	    } catch(Exception e){
	        throw new RuntimeException("decrypt sign data: [" + data + "] throw exception", e);
	    }
	}
}

Postman Collections

We provide the Postman file to facilitate the use of our APIs. Click the following button to open the Postman app. By interacting with the Postman App, you can directly test our APIs, which are convenient for you to access quickly.

User guide for Postman

⏳

Coming Soon

Java SDK

⏳