Quickstart

Use the TradPay API to create payments and track transactions

In order to perform actions using the TradPay API, you need to complete the following steps.

1. Create TradPay Account & Get API keys

Go to TradPay and log in.
Under Developer → API, check Enable to generate your Secret API Keys.
Save these securely, as the Secret API Key won’t be retrievable later (you can regenerate both if needed).
Prerequisite: Account verification is required. (Dashboard → Settings → Merchant Profile → Select Creator or Business)

2. Signature

Some API requests may require signature in the header. It’s computed by concatenating your signing key and request body. Then generates a hash using the HMAC SHA256 hash algorithm.

The Header contains: the signature content of X-TX-Signature and X-TX-AppId

Example request header

POST https://api.tradpay.io/v1/{PATH} HTTP/1.1
Content-Type: application/json;
X-TX-Signature: signature-content-hash
X-TX-AppId: YOUR-APP-ID

Example signature Compress JSON before signing.

import crypto from "crypto";

function signRequestBody(
    body: string, // JSON from request body
    secretKey: string // taken from dashboard for API secret key
  ): string {
    return crypto
        .createHmac("sha256", secretKey) // Create a HMAC SHA256 hash
        .update(body, "utf8") // Update the token hash with the request body using utf8
        .digest("hex");
}

import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.nio.charset.StandardCharsets;
import org.apache.commons.codec.binary.Hex;

public static String signRequestBody(String body, String secretKey) throws NoSuchAlgorithmException, InvalidKeyException{
    Mac sha256Hmac = Mac.getInstance("HmacSHA256");
    SecretKeySpec secretKeySpec = new SecretKeySpec(secretKey.getBytes(StandardCharsets.UTF_8), "HmacSHA256");
    sha256Hmac.init(secretKeySpec);
    byte[] bytes = sha256Hmac.doFinal(body.getBytes(StandardCharsets.UTF_8));
    return Hex.encodeHexString(bytes);
}

import (
    "crypto/hmac"
    "crypto/sha256"
    "encoding/hex"
)

func signRequestBody(
    body string, // JSON from request body
    secretKey string // taken from dashboard for API secret key
    ) string {
    mac := hmac.New(sha256.New, []byte(secretKey))
    mac.Write([]byte(body)) // Use UTF-8 encoded strings (default in Go)
    signature := mac.Sum(nil)
    return hex.EncodeToString(signature)
}

import hmac
import hashlib

def sign_request_body(
    body: str, # JSON from request body
    secret_key: str # taken from dashboard for API secret key
) -> str:
    return hmac.new(
        key=secret_key.encode('utf-8'),
        msg=body.encode('utf-8'),
        digestmod=hashlib.sha256
    ).hexdigest()

3. Send requests

Note: When using TradPay on mainnet, set your Base URL to https://api.tradpay.io/v1 and generate your API keys from app.tradpay.io

Please replace YOUR-APP-ID with your actual APP-ID.

curl -X POST https://api.tradpay.io/v1/{PATH} \
    -H "Content-Type: application/json" \
    -H "X-TX-Signature: SIGNATURE-HASH" \
    -H "X-TX-AppId: YOUR-APP-ID" \
    -d '{}'

PreviousPricing & Fees NextIntegration Practices

Last updated 1 month ago