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?api_key=SECRET_KEY

List of all supported request fields:

FieldDescription
pagePage number
limit Number of elements on the page
shop_idFilter operation by shop
typeTransaction type (Available values : cash_in, cash_out, mass_cash_out, invoice)
statusnew - initial invoice status
pending - some amount received and waiting for confirmations
pending internal - moving invoice money to user wallet has been initiated
expired - look for the “source_amount” field to verify payment. The full amount may not have been paid.
completed - paid in full
mismatch - overpaid
error - some error has occurred
cancelled - no payment received within 10 hours
currencyone 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
api_key*“Secret key” value from your API » Api settings page

* - required

 

Success response example:

 
{
    "status": "success",
    "data": {
        "operations": [
            {
                "user_id": 1,
                "shop_id": "607sdw35f4ee4a2b7t",
                "type": "invoice",
                "status": "completed",
                "tx_url": [
                    "https://etherscan.io/tx/0x0000000000",
                    "https://etherscan.io/tx/0x0000000000"
                ],
                "id": "1000000"
            },
            {
                "user_id": 1,
                "shop_id": null,
                "type": "cash_in",
                "status": "completed",
                "pending_sum": "0.00000000",
                "psys_cid": "BTC",
                "currency": "BTC",
                "source_currency": "USD",
                "source_rate": "0.00010216",
                "fee": null,
                "wallet_hash": "0x0000000000",
                "sendmany": null,
                "params": {
                    "value": "0.00225754",
                    "currency": "BTC"
                },
                "expire_at_utc": null,
                "created_at_utc": 1563529570,
                "amount": "0.00014243",
                "sum": 0.00014243,
                "commission": null,
                "tx_url": null,
                "tx_id": null,
                "id": "1000001"
                "actual_sum": 0.00014243,
                "actual_commission": null,
                "actual_fee": null,
                "actual_invoice_sum": null,
                "status_code": 3
            },
            {
                "user_id": 1,
                "shop_id": null,
                "type": "cash_out",
                "status": "completed",
                "pending_sum": "0.00000000",
                "psys_cid": "ETH-TESTNET",
                "currency": "TETH",
                "source_currency": "USD",
                "source_rate": "0.000216542551694120",
                "fee": "0.00952",
                "wallet_hash": "0x00000000001",
                "sendmany": null,
                "params": {
                    "fee": {
                        "gasLimit": "80000",
                        "gasPrice": "119",
                        "nonce": "",
                        "dynamicField": "gasPrice",
                        "plan": "normal",
                        "unit": "Gwai",
                        "value": "0.00952"
                    },
                    "source_currency": "USD",
                    "source_rate": "0.000216542551694120"
                },
                "expire_at_utc": null,
                "created_at_utc": 1639734963,
                "amount": "0.017948510338824132",
                "sum": "0.027468510338824132",
                "commission": "0.000000000000000000",
                "tx_url": "https://ropsten.etherscan.io/tx/0x00000000001",
                "tx_id": [
                    "0x00000000001"
                ],
                "id": "100000000000000000000002"
                "actual_sum": "0.017948510338824132",
                "actual_commission": null,
                "actual_fee": 0,
                "actual_invoice_sum": null,
                "status_code": 3,
                "tx": [
                    {
                        "url": "https://ropsten.etherscan.io/tx/0x00000000001",
                        "wallet_hash": [
                            "0x00000000001"
                        ]
                    }
                ]
            },
            .....
        ],
        "_links": {
            "self": {
                "href": "https://devdevda.com/api/v1/operations?api_key=...&page=1&per-page=10"
            },
            "first": {
                "href": "https://devdevda.com/api/v1/operations?api_key=...&page=1&per-page=10"
            },
            "last": {
                "href": "https://devdevda.com/api/v1/operations?api_key=...&page=157&per-page=10"
            },
            "next": {
                "href": "https://devdevda.com/api/v1/operations?api_key=...&page=2&per-page=10"
            }
        },
        "_meta": {
            "totalCount": 156,
            "pageCount": 15,
            "currentPage": 1,
            "perPage": 10
        }
    }
}

HTTP response status code: 200

 

Success response:

 

FieldDescription
statussuccess
user_idProfile ID
shop_idShop ID
typecash_in, cash_out, mass_cash_out, invoice
statuspending, completed, error, new, expired, mismatch, cancelled
tx_urllink to the cryptocurrency block explorer
idOperation ID

White-label additional data:

FieldDescription
pending_sumUnconfirmed amount (mempool)
psys_cidID column from supported cryptocurrencies
currencyCode of the cryptocurrency (supported cryptocurrencies)
source_currencyFiat currency - USD by default or source_currency was set (See Code-column from supported fiat currencies)
source_rateExchange rate from the "cryptocurrency"(psys_cid) to the "source_currency" at the moment of transfer
feeTransaction fee set in the transfer
wallet_hashDestination hash (type=cash_out) or invoice hash
sendmanyPairs of hashes and values (type=mass_cash_out)
expire_at_utcTimestamp in UTC timezone; it may need to be divided by 1000
created_at_utcTimestamp in the UTC timezone; it may need to be divided by 1000
amountAmount 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
commissionPlisio commission
tx_idArray of transaction ids
params 
params.feeconf_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)
params.order_numberInvoice order number. It must be unique in your store (invoice)
params.order_nameOrder name (invoice)
params.descriptionOrder description (invoice)
params.source_amountInvoice amount in fiat currency (invoice)
params.source_currencyFiat currency  (See Code-column from supported fiat currencies)
params.source_rateExchange rate from the "cryptocurrency"; to the "source_currency" at the moment of transfer
params.currencyName of the cryptocurrency (supported cryptocurrencies)
params.amountInvoice 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:

 

FieldDescription
statuserror
data.nameerror name
data.messageerror explanation
data.codeerror code