Transactions

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

2. Send the “GET” request to get transaction details.


Endpoint:

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

cURL request example:

  curl --location --request GET https://plisio.net/api/v1/operations/5ee210133f5a5e30771f0283
    ?api_key=SECRET_KEY
  

List of all supported request fields:

Field Description
api_key “Secret key” value from your API » Api settings page

* - required


Success response example:

   {
    "status": "success",
    "data": {
      "type": "mass_cash_out",
      "status": "completed",
      "confirmations": 0,
      "pending_sum": 0,
      "psys_cid": "BTC",
      "currency": "BTC",
      "source_currency": "USD",
      "source_rate": "0.00010203",
      "fee": "0.00000288",
      "commissionPayment": 2,
      "commis_percent": "1",
      "commis_sum": "0.00000402",
      "memo": "mass_cash_out 0.00040690 with commission 1% (0.00000402) including normal fee plan (0.00000288)",
      "sendmany": {
        "2NAAdn1BiHuXgckPKmREfVc8WTX3U3N7Qo4": "0.00020000",
        "2N7cy1atVsNZhH6EuKE7HPseMSW5QbEEC6g": "0.00020000"
      },
      "params": {
        "fee": {
          "conf_target": 3,
          "plan": "normal",
          "value": "0.00000288"
        }
      },
      "tx": [
        {
          "txid": "86b5ec4404d98b9bccaaa39630e01d49f6e5e76a97664bf18a4e0da800b9f949",
          "value": "0.00040000",
          "block": null,
          "processed": true
        }
      ],
      "expire_at_utc": null,
      "created_at_utc": 1591873548,
      "amount": "0.00040000",
      "tx_url": "https://sochain.com/resolver?query=86b5ec4404d98b9bccaaa39630e01d49f6e5e76a97664bf18a4e0da800b9f949",
      "finished_at_utc": null,
      "id": "5ee210133f5a5e30771f0283"
    }
  }
  

HTTP response status code: 200


Success response:

Field Description
status success
data
user_id your Plisio internal ID
shop_id merchant's Shop ID
type cash_in, cash_out, mass_cash_out, invoice
status pending, completed, error, new, expired, mismatch, cancelled
tx_url link to the cryptocurrency block explorer
id internal Plisio operation ID

White-label additional data:

Field Description
pending_sum unconfirmed amount (mempool)
psys_cid ID column from supported cryptocurrencies
currency Code column from supported cryptocurrencies
source_currency fiat currency - USD by default or source_currency was set (See Code-column from supported fiat currencies)
source_rate exchange rate from the “psys_cid” to the “source_currency” at the moment of transfer
fee transaction fee set in the transfer
wallet_hash destination hash (type=cash_out) or invoice hash
sendmany pairs of hashes and values (type=mass_cash_out)
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 (cash-out, mass-cash-out)
expire_at_utc timestamp in UTC timezone; it may need to be divided by 1000
created_at_utc timestamp in the UTC timezone; it may need to be divided by 1000
amount amount received/transferred by an operation (invoice, cash-in/cash-out)
sum - invoice: params.amount + Plisio commission (if customer pays commission) or params.amount (if merchant pays commission)
- cash-out: transfer amount + network fee
- cash-in: received amount
commission Plisio commission
tx_id array of transaction ids
params
params.order_number invoice order number. It must be unique in your store (invoice)
params.order_name order name (invoice)
params.description order description (invoice)
params.source_amount invoice amount in fiat currency (invoice)
params.source_currency invoice fiat currency (invoice), See Appendix 2
params.source_rate Source currency rate to cryptocurrency
params.currency code column from Appendix 1 (invoice)
params.amount invoice amount in selected cryptocurrency (invoice)

Error response example:

   {
    "status": "error",
    "data": {
      "name": "Not Found",
      "message": "The specified resource does not exist",
      "code": 111
    }
  }
  

HTTP response status codes: 401, 500


Error response:

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