Skip to content

API Documentation

Authentication

All APIs require an API key for authentication. The API key must be sent in the request header:

json
{
  "api-key": "YOUR-API-KEY"
}

Note

Please keep your API key secure and do not share it with others.

Get List of Payment Methods

To get a list of supported payment methods:

Request

bash
GET https://api.cryptommo.net/api/merchants/payment-methods

Response

json
[
  {
    "paymentMethodId": "c018947a-12e5-41b7-acf2-b1b36aee0ccc",
    "currencyName": "USDT",
    "vmType": "evm",
    "symbol": "USDT",
    "network": "Binance Smart Chain",
    "contractAddress": "0x55d398326f99059fF775485246999027B3197955",
    "status": "active",
    "networkCode": "bsc",
    "logoNetwork": "https://s2.coinmarketcap.com/static/img/coins/64x64/1839.png",
    "chainId": 56
  },
  {
    "paymentMethodId": "b2f26627-adbe-4233-99bd-bd547f754af6",
    "currencyName": "USDT",
    "vmType": "evm",
    "symbol": "USDT",
    "network": "Ethereum",
    "contractAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
    "status": "active",
    "networkCode": "eth",
    "logoNetwork": "https://s2.coinmarketcap.com/static/img/coins/64x64/1027.png",
    "chainId": 1
  },
  {
    "paymentMethodId": "c480bee8-b721-4f92-ac61-6d7477ad2252",
    "currencyName": "USDT",
    "vmType": "evm",
    "symbol": "USDT",
    "network": "Arbitrum",
    "contractAddress": "0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9",
    "status": "active",
    "networkCode": "arb",
    "logoNetwork": "https://s2.coinmarketcap.com/static/img/coins/64x64/11841.png",
    "chainId": 42161
  }
]

Create New Transaction

To create a new transaction:

Request

bash
POST https://api.cryptommo.net/api/transactions

Body

json
{
  "networkCode": "BSC",
  "orderId": "ORD121212",
  "amount": 30.5,
  "urlCallback": "https://google.com" // Optional - Payment page URL will be returned if provided
}

Response

Without urlCallback:

json
{
  "transactionId": "de3148d3-22fe-4d97-8f10-d98b008c5e4a",
  "walletId": "06a9044c-86b3-4bb4-acee-33cc4f1683c3",
  "merchantId": "75ff4eff-164c-4b13-adde-1118f8277a54",
  "paymentMethodId": "b2f26627-adbe-4233-99bd-bd547f754af6",
  "orderId": "ORD121212",
  "amount": 30.5,
  "createdAt": "2025-02-21T04:11:27.946361+00:00",
  "wallet": {
    "walletId": "06a9044c-86b3-4bb4-acee-33cc4f1683c3",
    "address": "0x4035bb59573acf9ff6c428667f3b1f4af7d68a80"
  },
  "paymentMethod": {
    "paymentMethodId": "b2f26627-adbe-4233-99bd-bd547f754af6",
    "networkCode": "eth",
    "chainId": 1,
    "vmType": "evm"
  },
  "qrUrl": "https://example.com/network-address-amount.png"
}

With urlCallback:

json
{
  "transactionId": "de3148d3-22fe-4d97-8f10-d98b008c5e4a",
  "walletId": "06a9044c-86b3-4bb4-acee-33cc4f1683c3",
  "merchantId": "75ff4eff-164c-4b13-adde-1118f8277a54",
  "paymentMethodId": "b2f26627-adbe-4233-99bd-bd547f754af6",
  "orderId": "ORD121212",
  "amount": 30.5,
  "createdAt": "2025-02-21T04:11:27.946361+00:00",
  "wallet": {
    "walletId": "06a9044c-86b3-4bb4-acee-33cc4f1683c3",
    "address": "0x4035bb59573acf9ff6c428667f3b1f4af7d68a80"
  },
  "paymentMethod": {
    "paymentMethodId": "b2f26627-adbe-4233-99bd-bd547f754af6",
    "networkCode": "eth",
    "chainId": 1,
    "vmType": "evm"
  },
  "qrUrl": "https://example.com/network-address-amount.png",
  "paymentPageUrl": "https://payment.crbgroup.live/API-c7e33cde-8ea2-4393-a21b-c0c8e330f463/107f7a3c-4f0a-4123-a63b-8d15a2cce391/https%3A%2F%2Fwww.google.com%2F"
}

Payment Page Behavior

When redirecting to paymentPageUrl, the payment page will:

  1. Monitor the transaction for incoming payments
  2. Automatically redirect back to the provided urlCallback once the required amount is received

Get List Transactions

To get list transactions:

Request

bash
GET https://api.cryptommo.net/api/transactions

Query Parameters

ParameterTypeDefaultDescription
createdAtstring-Filter by creation date
updatedAtstring-Filter by last update date
walletIdstring-Filter by wallet ID
networkCodestring-Filter by network code
orderIdstring-Filter by order ID
transactionIdstring-Filter by transaction ID
transactionHashstring-Filter by transaction hash
pagenumber1Page number for pagination
limitnumber10Number of items per page (max: 100)
sortstring"createdAt"Field to sort by
orderstring"asc"Sort order ("asc" or "desc")

Response

json
[
  {
    "transactionId": "6e6dd075-e193-40cc-8c34-210f1f50dba3",
    "walletId": "c75fa280-672d-4a27-8eee-3106c9c89a36",
    "merchantId": "75ff4eff-164c-4b13-adde-1118f8277a54",
    "paymentMethodId": "b2f26627-adbe-4233-99bd-bd547f754af6",
    "orderId": "ORD9",
    "amount": 100.5,
    "createdAt": "2025-02-11T04:00:17.766562+00:00",
    "wallet": {
      "walletId": "c75fa280-672d-4a27-8eee-3106c9c89a36",
      "address": "0xd8697d34bc347a792e1dc4e3f5b1df6ccfb91c8e"
    },
    "paymentMethod": {
      "paymentMethodId": "b2f26627-adbe-4233-99bd-bd547f754af6",
      "networkCode": "eth",
      "chainId": 1,
      "vmType": "evm"
    }
  }
]

Note

  • The maximum limit for items per page is 100
  • Authentication is required using the API key in the request header

Get Transaction Information

To get detailed information about a transaction:

Request

bash
GET https://api.cryptommo.net/api/transactions/{transactionId}

Response

json
{
  "transactionId": "de3148d3-22fe-4d97-8f10-d98b008c5e4a",
  "walletId": "06a9044c-86b3-4bb4-acee-33cc4f1683c3",
  "merchantId": "75ff4eff-164c-4b13-adde-1118f8277a54",
  "paymentMethodId": "b2f26627-adbe-4233-99bd-bd547f754af6",
  "orderId": "ORD121212",
  "amount": 30.5,
  "createdAt": "2025-02-21T04:11:27.946361+00:00",
  "wallet": {
    "walletId": "06a9044c-86b3-4bb4-acee-33cc4f1683c3",
    "address": "0x4035bb59573acf9ff6c428667f3b1f4af7d68a80"
  },
  "paymentMethod": {
    "paymentMethodId": "b2f26627-adbe-4233-99bd-bd547f754af6",
    "networkCode": "eth",
    "chainId": 1,
    "vmType": "evm"
  }
}