Create a deposit

By using this API endpoint, you will generate a unique cryptocurrency address for your user. This address will be permanently associated with the user's unique ID (UID) that you provide. All funds sent to this address will be credited to your Plisio account and associated with that user.

You can request one or multiple cryptocurrency addresses in a single call by providing a comma-separated list in the psys_cid parameter.

Note: This feature is exclusively available for businesses with "White-label payment processing" enabled. If you need to enable it, please go to your Shop settings.

API Endpoint:

GET https://plisio.net/api/v1/shop/deposit/new

Parameters

Parameter	Located in	Description	Required
psys_cid	query	One or a comma-separated list of the cryptocurrencies supported by Plisio. You can find the full list on the supported cryptocurrencies page (use the "ID" column). If multiple values are provided, an array of deposit objects will be returned.	Yes
uid	query	Your internal unique user identifier. This ID will be used to link the deposit address to your user. Max 255 characters.	Yes
api_key	query	Your secret API key. You can find it in your API settings.	Yes

Example Request (single cryptocurrency)

curl "https://plisio.net/api/v1/shop/deposit/new?api_key=YOUR_API_KEY&psys_cid=BTC&uid=USER-12345"

Example Request (multiple cryptocurrencies)

curl "https://plisio.net/api/v1/shop/deposit/new?api_key=YOUR_API_KEY&psys_cid=BTC,ETH,USDT&uid=USER-12345"

Example Response (single)

If the request is successful, you will receive a JSON response containing the deposit details.

{
  "status": "success",
  "data": {
    "uid": "USER-12345",
    "hash": "bc1q...",
    "psys_cid": "BTC"
  }
}

Example Response (multiple)

{
  "status": "success",
  "data": [
    { "uid": "USER-12345", "hash": "bc1q...", "psys_cid": "BTC" },
    { "uid": "USER-12345", "hash": "0x...",  "psys_cid": "ETH" },
    { "uid": "USER-12345", "hash": "TR...",  "psys_cid": "USDT" }
  ]
}

Response Parameters

Parameter	Description
uid	The unique user identifier you provided in the request.
hash	The generated cryptocurrency address for the user's deposit.
psys_cid	The cryptocurrency ID for which the address was generated.

Callbacks (Status URL and Success URL)

When a pay_in is received, Plisio will send a POST callback to both the Status URL and Success URL configured in your Shop settings.

Default content type: multipart/form-data (fields are sent as form fields)
If your Status URL contains json=true (https://example.com/plisio_cb.php?json=true) in the query string, the callback will be sent as application/json with the same payload.
Payload example:

{
  "amount": "2.000000",
  "comment": "Invoice details: https://plisio.net/account/transactions/68da2...",
  "confirmations": "37",
  "currency": "USDT_TRX",
  "deposit_sum": "1.978000",
  "deposit_uid": "test8",
  "invoice_commission": "0.022000",
  "invoice_sum": "1.978000",
  "invoice_total_sum": "2.000000",
  "ipn_type": "pay_in",
  "merchant": "Test shop",
  "merchant_id": "5d09...",
  "pending_amount": "0.000000",
  "psys_cid": "USDT_TRX",
  "qr_code": "****",
  "source_amount": "1.978000",
  "source_currency": "USD",
  "source_rate": "0.999920",
  "status": "completed",
  "tx_urls": [
    "https://tronscan.org/#/transaction/571a...",
    "https://tronscan.org/#/transaction/e4f3..."
  ],
  "txn_id": "68da23e93ee47b52a808af13",
  "wallet_hash": "TH3q...",
  "verify_hash": "f935032c5f78dfc93fcd36866657ec99907e83b8"
}

For handling guidelines and signature verification, see the Create an invoice page, section Callback.

List deposits

This endpoint returns a paginated list of deposit addresses associated with a shop. You can optionally filter the results by one or more cryptocurrencies (comma-separated) and by UID.

API Endpoint:

GET https://plisio.net/api/v1/shop/deposit

Parameters

Parameter	Located in	Description	Required
uid	query	Your internal unique user identifier to filter deposits.	No
psys_cid	query	Optional comma-separated list of cryptocurrency IDs to filter the results.	No
page	query	Page number for pagination (default: 1).	No
limit	query	Number of items per page (default: 20).	No
api_key	query	Your secret API key. You can find it in your API settings.	Yes

Example Request

curl "https://plisio.net/api/v1/shop/deposit?api_key=YOUR_API_KEY&uid=USER-12345&psys_cid=BTC,ETH&page=1&limit=20"

Example Response

The response contains an array of deposit items for the requested page.

{
  "status": "success",
  "data": [
    { "uid": "USER-12345", "hash": "bc1q...", "psys_cid": "BTC" },
    { "uid": "USER-12345", "hash": "0x...",  "psys_cid": "ETH" }
  ]
}

Error Responses

If the request fails, you will receive an error response.

White-label disabled

{
  "status": "error",
  "data": {
    "message": "White-label payment processing is disabled for this shop. Please enable White-label payment processing in your shop settings to activate this feature.",
    "code": 400
  }
}

Resource not found

This error can occur if the shop associated with the API key is not found.

{
  "status": "error",
  "data": {
    "message": "The specified resource does not exist",
    "code": 401
  }
}

Validation Error

This error occurs if required parameters are missing or invalid.

{
  "status": "error",
  "data": {
    "message": "{\"uid\":\"Missing required attribute\"}",
    "code": 103
  }
}