Skip to main content

Copy link

Using API for transaction and currency

Postman collection with all endpoints - Using_API_for_transaction_and_currency.postman_collection.zip

Fee estimate for currency​

post
https://api.cpay.world
/api/public/transaction/fee
Endpoint POST /api/public/transaction/fee
Endpoint, allows you to estimate transactions. You need to log in with the wallet in conjunction with the merchant.

Parameters

Body

  • to

    *

    string

  • amount

    *

    number

Responses

  • 200:OK
    {
      data: {
        fee: "String",
        minerFee: "String",
        systemFee: "String",
        merchantFee: "String",
        currencyMinerFee: "String",
        currencyFee: "String"
      }
    }
  • 200:OK

    Example

    {
      data: {
        fee: "0.002426",
        minerFee: "0.002226",
        systemFee: "0.0002",
        merchantFee: "0",
        currencyMinerFee: "BNB",
        currencyFee: "BNB"
      }
    }
  • 400:Bad request
    {
      status: "fail",
      data: {
        message: [
          "amount must be a number conforming to the specified constraints",
          "priority must be a boolean value"
        ]
      }
    }
  • 401
    {
      status: "fail",
      data: {
        message: "Unauthorized"
      }
    }

Fee estimate for token​

post
https://api.cpay.world
/api/public/transaction/fee
Endpoint POST /api/public/transaction/fee
Endpoint, allows you to estimate transactions. You need to log in with the wallet in conjunction with the merchant.

Parameters

Body

  • to

    *

    string

  • amount

    *

    number

  • currencyToken

    *

    string

Responses

  • 200:OK
    {
      data: {
        fee: "String",
        minerFee: "String",
        systemFee: "String",
        merchantFee: "String",
        currencyMinerFee: "String",
        currencyFee: "String"
      }
    }
  • 200:OK

    Example

    {
      data: {
        fee: "0.01",
        minerFee: "0.006420716",
        systemFee: "0.01",
        merchantFee: "0",
        currencyMinerFee: "BNB",
        currencyFee: "BUSD"
      }
    }
  • 400:Bad request
    {
      status: "fail",
      data: {
        message: [
          "amount must be a number conforming to the specified constraints",
          "priority must be a boolean value"
        ]
      }
    }
  • 401
    {
      status: "fail",
      data: {
        message: "Unauthorized"
      }
    }

Merchant currency​

get
https://api.cpay.world
/api/public/currency
Endpoint GET /api/public/currency
The endpoint allows you to get all the currencies that the merchant supports. You need to log in to the merchant.

Parameters

Query

  • publicKey

    *

    string

  • privateKey

    *

    string

Responses

  • 200:OK
    {
      data: {
        page: "Number",
        pages: "Number",
        countItems: "Number",
        currencies: [
          {
            _id: "String",
            name: "String",
            title: "String",
            nodeType: "String",
            currencyType: "String"
          }
        ]
      }
    }
  • 200:OK

    Example

    {
      data: {
        page: 1,
        pages: 20,
        countItems: 10,
        currencies: [
          {
            _id: "5edf2767c9ca4d5a342bf8ac",
            name: "BTC",
            title: "Bitcoin",
            nodeType: "btc",
            currencyType: "currency"
          }
        ]
      }
    }
  • 401
    {
      status: "fail",
      data: {
        message: "Unauthorized"
      }
    }

Get list of transactions for wallets​

get
https://api.cpay.world
/public/transaction/list
Endpoint GET /api/public/transaction/list

Parameters

Query

  • sort

    string

    Default value : date

  • order

    string

    Available values: ASC, DESC. Defaule value: ASC

  • page

    number

    Default value: 1

  • limit

    number

    Default value: 10

  • from

    number

    from

  • to

    number

    to

  • currencyId

    string

    currencyId

  • fromUSD

    number

    fromUSD

  • toUSD

    number

    toUSD

  • type

    string

    Available values : Replenishment, InternalTransfer, Multisend, Withdrawal, SystemFee, Checkout, Error, ExternalCall

  • status

    string

    Available values : New, Pending, Waiting for funds, Error, Failed, Done, Exchanging, DepositPending, DepositComplete, ReceiveComplete

  • search

    string

Responses

  • 200:OK
    {
       data: {
          page: "number",
          pages: "number",
          countItem: "number",
          entities: [
              {
                type: "string",
                typeNetwork: "string",
                status: "Boolean",
                systemStatus: "string",
                merchant: "string",
                user: "string",
                info: {
                    incomingTxHash: "string",
                    currencyId: "string",
                    currency: "string",
                    nodeType: "string",
                    currencyType: "string",
                    exchangeId: 1,
                    hashs: [
                        "string"
                    ],
                    addresses: [
                        "string",
                        "string"
                    ],
                    steps: {},
                    multisend: [],
                    call: {},
                    amount: {
                        value: "number",
                        usd: "number"
                    },
                    minerFee: {
                        value: "number",
                        usd: "number",
                        currency: "string"
                    },
                    from: "string",
                    to: "string",
                    fromId: "string",
                    toId: "string"
                    },
                checkout: {},
                fees: {},
                createdAt: "string",
                updatedAt: "string",
                _id: "string"
                }
            ]
        }
    }
  • 200:OK

    Example

    {
      data: {
        page: 3,
        pages: 8,
        countItem: 8,
        entities: [
            {
                type: "Replenishment",
                typeNetwork: "testnet",
                status: true,
                systemStatus: "Done",
                merchant: "617fe0f3ba2765021ce93060",
                user: "609a6340e5e1cf02156d0df7",
                info: {
                    incomingTxHash: "",
                    currencyId: "60ebfe8ffe376807f22943ef",
                    currency: "BNB",
                    nodeType: "bsc",
                    currencyType: "currency",
                    exchangeId: 1,
                    hashs: [
                        "0x43a449e7a3a1b3245d7d9a1170784f1a8d0f7ff2a962111727fc38c797e65cdf"
                    ],
                    addresses: [
                        "0x8A2f2cfB0B094e064ca67FB64AA47eA8429e099e",
                        "0x81adeFFD3fbC8A321fe7D484d79d165Daf059792"
                    ],
                    steps: {},
                    multisend: [],
                    call: {},
                    amount: {
                        value: "0.3",
                        usd: 73
                    },
                    minerFee: {
                        value: "0.00021",
                        usd: 0.05,
                        currency: "BNB"
                    },
                    from: "0x8A2f2cfB0B094e064ca67FB64AA47eA8429e099e",
                    to: "0x81adeFFD3fbC8A321fe7D484d79d165Daf059792",
                    fromId: "",
                    toId: "61f16424722a8c0076dc1220"
                },
                checkout: {},
                fees: {},
                createdAt: "2022-12-27T13:32:02.298Z",
                updatedAt: "2022-12-27T13:32:02.298Z",
                _id: "63aaf3d2bbedbe04d421f56e"
            }
          ]
        }
    }
  • 401
    {
      status: "fail",
      data: {
        message: "Unauthorized"
      }
    }

Copy link