Create a Checkout

Create a dynamic checkout page for integration into your service.

POST /checkout/create

Headers

Name	Value
Content-Type	application/json
Accept	application/json
X-TX-AppId	YOUR-APP-ID
X-TX-Signature	HMAC SHA-256 content hash View

Body

Fiat Pricing

{
  "name": "checkout",
  "maxExpiredSeconds": 3600, // Optional. Max expiration time in seconds, or 0 for never expire(default)
  "maximumBeforeExpired": 1, // Optional. Max payments allowed within , or 0 for unlimited (default)
  "pricing": "118.95",
  "pricingCurrency": {       // Fiat currency pricing
    "currencyId": 301,
    "symbol": "USD",
    "currencyType": "FIAT"
  },
  "receiveCurrency": [
    {
      "currencyId": 201,
      "symbol": "USDT",
      "chainName": "ETH"
    },
    {
      "currencyId": 202,
      "symbol": "USDC",
      "chainName": "ETH"
    },
    {
      "currencyId": 201,
      "symbol": "USDT",
      "chainName": "BNB"
    },
    {
      "currencyId": 202,
      "symbol": "USDC",
      "chainName": "BNB"
    },
    {
      "currencyId": 201,
      "symbol": "USDT",
      "chainName": "POL"
    },
    {
      "currencyId": 202,
      "symbol": "USDC",
      "chainName": "POL"
    },
    {
      "currencyId": 201,
      "symbol": "USDT",
      "chainName": "OP"
    },
    {
      "currencyId": 202,
      "symbol": "USDC",
      "chainName": "OP"
    },
    {
      "currencyId": 201,
      "symbol": "USDT",
      "chainName": "ARB"
    },
    {
      "currencyId": 202,
      "symbol": "USDC",
      "chainName": "ARB"
    }
  ],
  "recipients": [
    "0x5FbE74A283f7954f10AA04C2eDf55578811aeb03"
  ],
  "redirectUrl": "https://ok.my-service-domain", // Payment complation
  "backToUrl": "https://order.my-service-domain" // Click the back button in the header
}

Crypto Pricing

{
  "name": "checkout",
  "maxExpiredSeconds": 3600, // Optional. Max expiration time in seconds, or 0 for never expire(default)
  "maximumBeforeExpired": 1, // Optional. Max payments allowed within maxExpiredSeconds, or 0 for unlimited (default)
  "pricing": "118.95",
  "pricingCurrency": {       // Crypto currency pricing
    "currencyId": 201,
    "symbol": "USDT",
    "chainName": "ETH",
    "currencyType": "CRYPTO"
  },
  "receiveCurrency": [
    {
      "currencyId": 201,
      "symbol": "USDT",
      "chainName": "ETH"
    },
    {
      "currencyId": 202,
      "symbol": "USDC",
      "chainName": "ETH"
    },
    {
      "currencyId": 201,
      "symbol": "USDT",
      "chainName": "BNB"
    },
    {
      "currencyId": 202,
      "symbol": "USDC",
      "chainName": "BNB"
    },
    {
      "currencyId": 201,
      "symbol": "USDT",
      "chainName": "POL"
    },
    {
      "currencyId": 202,
      "symbol": "USDC",
      "chainName": "POL"
    },
    {
      "currencyId": 201,
      "symbol": "USDT",
      "chainName": "OP"
    },
    {
      "currencyId": 202,
      "symbol": "USDC",
      "chainName": "OP"
    },
    {
      "currencyId": 201,
      "symbol": "USDT",
      "chainName": "ARB"
    },
    {
      "currencyId": 202,
      "symbol": "USDC",
      "chainName": "ARB"
    }
  ],
  "recipients": [
    "0x5FbE74A283f7954f10AA04C2eDf55578811aeb03"
  ],
  "redirectUrl": "https://ok.my-service-domain", // Payment complation
  "backToUrl": "https://order.my-service-domain" // Click the back button in the header
}

Request

curl -X POST https://api.tradpay.io/v1/checkout/create \
    -H "Content-Type: application/json" \
    -H "X-TX-AppId: YOUR-APP-ID" \
    -H "X-TX-Signature: SIGNATURE-HASH" \
    -d '{"name":"checkout test","pricing":"118.95","pricingCurrency":{"currencyId":301,"currencyType":"FIAT"},"receiveCurrency":[{"currencyId":201,"symbol":"USDT","chainName":"ETH"},{"currencyId":202,"symbol":"USDC","chainName":"ETH"},{"currencyId":201,"symbol":"USDT","chainName":"BNB"},{"currencyId":202,"symbol":"USDC","chainName":"BNB"},{"currencyId":201,"symbol":"USDT","chainName":"POL"},{"currencyId":202,"symbol":"USDC","chainName":"POL"},{"currencyId":201,"symbol":"USDT","chainName":"OP"},{"currencyId":202,"symbol":"USDC","chainName":"OP"},{"currencyId":201,"symbol":"USDT","chainName":"ARB"},{"currencyId":202,"symbol":"USDC","chainName":"ARB"}],"recipients":["0x345558371fF5d0b7F08066906864318c61f37799"],"redirectUrl":"https://ok.my-service-domain","backToUrl":"https://order.my-service-domain"}'

Response

200

{
  "code": 200,
  "msg": "OK",
  "status": "success",
  "result": {
    "checkoutCode": "4cADM2G7UJfXXjJlXsC9t9NL",
    "checkoutLink": "https://pay.tradpay.io/checkout/4cADM2G7UJfXXjJlXsC9t9NL"
  }
}

400

Invalid APP-ID:

{
  "code": 400,
  "msg": "APP-ID is invalid",
  "status": "failed"
}

401

Invalid X-TX-Signature:

{
  "code": 401,
  "msg": "Token validation failed.",
  "status": "failed"
}

403

No X-TX-AppId header:

{
  "code": 403,
  "msg": "Forbidden",
  "status": "failed"
}