Transactions

1. Create your website and get the “SECRET_KEY”. Instruction can be found here.

2. Send the “GET” request to get list of transactions.


Endpoint:

https://plisio.net/api/v1/operations

cURL request example:

curl --location --request GET https://plisio.net/api/v1/operations
  ?limit=1
  &api_key=SECRET_KEY

List of all supported request fields:

Field Description
api_key “Secret key” value from your API » Api settings page
page page number
limit number of elements on the page
type cash_in, cash_out, mass_cash_out, invoice
status pending, completed, error, new, expired, mismatch, cancelled
currency one of the cryptocurrencies supported by Plisio (ID column from supported cryptocurrencies)
search text search by the transaction id (txid), invoice’s order number or customer email from invoice

* - required


Success response example:

   {
    "status": "success",
    "data": {
      "operations": [
        {
          "type": "mass_cash_out",
          "status": "completed",
          "pending_sum": 0,
          "psys_cid": "BTC",
          "currency": "BTC",
          "source_currency": "USD",
          "source_rate": "0.00010203",
          "fee": "0.00000288",
          "sendmany": {
            "2NAAdn1BiHuXgckPKmREfVc8WTX3U3N7Qo4": "0.00020000",
            "2N7cy1atVsNZhH6EuKE7HPseMSW5QbEEC6g": "0.00020000"
          },
          "params": {
            "fee": {
              "conf_target": 3,
              "plan": "normal",
              "value": "0.00000288"
            }
          },
          "expire_at_utc": null,
          "created_at_utc": 1591873548,
          "amount": "0.00040000",
          "tx_url": "https://sochain.com/resolver?query=86b5ec4404d98b9bccaaa39630e01d49f6e5e76a97664bf18a4e0da800b9f949",
          "id": "5ee210133f5a5e30771f0283"
        }
      ],
      "_links": {
        "self": {
          "href": "https://plisio.net/api/v1/operations?limit=1&api_key=-tJvk7ZI-HoYdfPKMA_2ENdvV4LhP1-XngzaYd68kbVPmUqtwRcqqh4xTaJN9aDy&page=1&per-page=1"
        },
        "next": {
          "href": "https://plisio.net/api/v1/operations?limit=1&api_key=-tJvk7ZI-HoYdfPKMA_2ENdvV4LhP1-XngzaYd68kbVPmUqtwRcqqh4xTaJN9aDy&page=2&per-page=1"
        },
        "last": {
          "href": "https://plisio.net/api/v1/operations?limit=1&api_key=-tJvk7ZI-HoYdfPKMA_2ENdvV4LhP1-XngzaYd68kbVPmUqtwRcqqh4xTaJN9aDy&page=478&per-page=1"
        }
      },
      "_meta": {
        "totalCount": 478,
        "pageCount": 478,
        "currentPage": 1,
        "perPage": 1
      }
    }
  }
  

HTTP response status code: 200


Success response:

Field Description
type cash_in, cash_out, mass_cash_out, invoice
status pending, completed, error, new, expired, mismatch, cancelled
pending_sum invoice underpayment amount, if it was underpaid
psys_cid ID column from supported cryptocurrencies
currency Code column from supported cryptocurrencies
source_currency fiat currency - only USD available at the moment
source_rate exchange rate from the “psys_cid” to the “source_currency” at the moment of transfer
fee transaction fee stated in the transfer
wallet_hash destination hash (type=cash_out) or invoice hash
sendmany pairs of hashes and values (type=mass_cash_out)
params
fee conf_target - estimated fee parameter to confirm the transaction in the “conf_target” blocks
plan - the Plisio’s fee plan name
value - fee value
source_currency
source_amount
expire_at_utc timestamp in UTC timezone; it may need to be divided by 1000
created_at_utc timestamp in UTC timezone; it may need to be divided by 1000
amount transfer amount in cryptocurrency
tx_url link to the cryptocurrency block explorer
id internal Plisio operation ID

Error response example:

   {
    "status": "error",
    "data": {
      "name": "Unauthorized",
      "message": "Please check your secret key is correct and domain is verified",
      "code": 101
    }
  }
  

HTTP response status codes: 401, 500


Error response:

Field Description
status error
data.name error name
data.message error explanation
data.code error code