PayKassa.pro - SCI/API (English)

PayKassa.pro offers external developers a variety of ways to interact with the service through software. One such method involves utilizing an SCI/API. This SCI/API defines a collection of functions that enable seamless interaction via HTTPS protocols. By employing these functions, developers can access various system resources, such as payment, withdrawal methods, and balance information. This interaction is achieved using POST requests in UTF-8 encoding sent to the following URLs: https://paykassa.app/sci/0.4/index.php (SCI) and https://paykassa.app/api/0.9/index.php (API).

Each response from the PayKassa.pro server must include the sci_id and sci_key fields, which indicate the accuracy of the entered authentication parameters. If the server returns a non-JSON response, it signifies the presence of a request error. In this case, an error == true statement indicates an error has occurred, with a description provided in the message field. Conversely, a successful request will show error == false, and the message field will contain a description or be empty. Additionally, the data field may hold supplementary information or be empty.

API

API | Get Balance of merchant

Method name: api_get_shop_balance. Get balance of merchant.

POST
https://paykassa.app/api/0.9/index.php

Parameter

Field Type Description
func required String

Method name, must be: api_get_shop_balance

Default value: api_get_shop_balance

api_id required String

API ID

api_key required String

API Password

shop_id required String

Merchant ID

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata - cointain pairs key system name and currency name(ex. BinanceCoin BNB => "binancecoin_bnb") from https://coinmarketcap.com in lowercase, value current balance

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Balance store successfully received.",
     "data": {
         "bitcoin_btc": "6.19148781",
         "ethereum_eth": "16.65759653",
         "litecoin_ltc": "10.81039547",
         "dogecoin_doge": "14055330.30324031",
         "dash_dash": "62.08654262",
         "bitcoincash_bch": "230.00235701",
         "ripple_xrp": "130977.938830",
         "tron_trx": "15003.120000",
         "stellar_xlm": "150325.0002350",
         "binancecoin_bnb": "1525.003350",
         "tron_trc20_usdt": "100.0000",
         "binancesmartchain_bep20_usdt": "100.0000",
         "ethereum_erc20_usdt": "100.0000",
         "binancesmartchain_bep20_usdc": "100.0000",
         "binancesmartchain_bep20_ada": "100.0000",
         "binancesmartchain_bep20_eos": "30.0000",
         "binancesmartchain_bep20_btc": "0.002355",
         "binancesmartchain_bep20_eth": "2.2342356",
         "binancesmartchain_bep20_doge": "1100300.003423400"
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Access is denied. Error code: 10.",
     "data": {}
 }

API | Get currency rate for pair

Method name: api_currency_rate. Get currency rate for pair. Attention!!! Instead of the paykassa.pro domain, you should use the currency.paykassa.pro subdomain.

GET/POST
https://currency.paykassa.pro/index.php

Parameter

Field Type Description
currency_in required String

From currency

Allowed values: USD, RUB, BTC, ETH, LTC, DOGE, DASH, BCH, XRP, TRX, XLM, BNB, USDT, ADA, EOS, GBP, EUR, USDC, TON, SHIB

currency_out required String

To currency

Allowed values: USD, RUB, BTC, ETH, LTC, DOGE, DASH, BCH, XRP, TRX, XLM, BNB, USDT, ADA, EOS, GBP, EUR, USDC, TON, SHIB

Success 200

Field Type Description
error required Boolean

false - Success

message required String

Success message

data required Object

Extradata

  value required String

Current rate currency_in / currency_out

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Ok",
     "data": {
         "value": "11873.180000000000"
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Wrong currency_out!",
     "data": {}
 }

API | Get txids of invoices

Method name: api_get_shop_txids. Get balance of merchant.

POST
https://paykassa.app/api/0.9/index.php

Parameter

Field Type Description
func required String

Method name, must be: api_get_shop_txids

Default value: api_get_shop_txids

api_id required String

API ID

api_key required String

API Password

shop_id required String

Merchant ID

invoices required Array

Invoice IDs

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata - key - invoice_id (string) value - array (txids as string)

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Ok",
      "data": {
         "37202989": [
             "3789588db700d2d43b1f4933d9917e0956de5635a8304dcdd36d58e3e2a91796"
         ],
         "374118633": [
             "5b70f95fa238822e4c2f62e3755c5d41e0fe024df8d865b001bc1cfd99763808"
         ],
         "3741186333": [
             "fbe747ff4f84d8e934fc78c3b89e6983a60bdaef1bb0948c973658c4609de6be"
         ]
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Access is denied. Error code: 10.",
     "data": {}
 }

API | Instant payment

Method name: api_payment. This is an instant payment method designed for executing automatic mass payments from your merchant account.

POST
https://paykassa.app/api/0.9/index.php

Parameter

Field Type Description
func required String

A method name, must be: api_payment

Default value: api_payment

api_id required String

An API ID

api_key required String

An API Password

shop_id required String

An Merchant ID

amount required String

The amount that will be sent (transferred to the recipient)"

currency required String

An currency

Allowed values: BTC, ETH, LTC, DOGE, DASH, BCH, XRP, TRX, XLM, BNB, USDT, USDC, ADA, EOS, SHIB, TON

system required String

An system ID

Allowed values: 11-BitCoin(BTC), 12-Ethereum(ETH), 14-Litecoin(LTC), 15-Dogecoin(DOGE), 16-Dash(DASH), 18-BitcoinCash(BCH), 33-TON(TON, USDT), 22-Ripple(XRP), 27-TRON(TRX), 28-Stellar(XLM), 29-BinanceCoin(BNB), 30-TRON_TRC20(USDT), 31-BinanceSmartChain_BEP20(USDT, USDC, ADA, EOS, BTC, ETH, DOGE, SHIB), 32-Ethereum_ERC20(USDT, USDC, SHIB)

number required String

An address of a recipient, ex. 3LPnTCZFWdHRUC3imeyPsFEeAV68Qkpw9E

tag required Number

A tag of Ripple or Stellar if the one is required

Allowed values: 1, 2, ...

priority required String

The parameter influences the order in which a transaction is included into a block (BitCoin, Litecoin, Dogecoin, Dash, BitcoinCash)

Default value: medium

Allowed values: low, medium, high

test required String

Turn on/off a test mode

Default value: false

Allowed values: false, true

Success 200

Field Type Description
error required Boolean

false - Success

message required String

An information of a message

  data required Object

An extra data

  shop_id required String

Merchant ID of Paykassa

  transaction required String

Transaction number of Paykassa.pro

  payment_id required String

Transaction number of payment system

  txid required String

Transaction number of CoinNetwork

  amount required String

Amount of the payment charge from balance

  amount_pay required String

Amount of the payment to balance target wallet

  system required String

Name of system(BitCoin(BTC), Ethereum(ETH), Litecoin(LTC), Dogecoin(DOGE), Dash(DASH), BitcoinCash(BCH), TON(TON, USDT), Ripple(XRP), TRON(TRX), Stellar(XLM), BinanceCoin(BNB), TRON_TRC20(USDT), BinanceSmartChain_BEP20(USDT, USDC, ADA, EOS, BTC, ETH, DOGE, SHIB), Ethereum_ERC20(USDT,USDC,SHIB)

  currency required String

Name of currency(BTC, ETH, LTC, DOGE, DASH, BCH, TON, XRP, TRX, XLM, BNB, USDT, USDC, ADA, EOS, SHIB)

  number required String

Address where you sent the funds

  shop_commission_percent required String

Fee % value

  shop_commission_amount required String

Fee fix value

  paid_commission required String

Who paid commission

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Data has been successfully received.",
     "data": {
         "shop_id": "123", // id merchant from which you made the payment, example 122
         "transaction": "130236", // transaction number of the payment, example 130236
         "payment_id": "478937139", // transaction number of the payment system, example 478937139
         "txid": "70d6dc6841782c6efd8deac4b44d9cc3338fda7af38043dd47d7cbad7e84d5dd" // txid 70d6dc6841782c6efd8deac4b44d9cc3338fda7af38043dd47d7cbad7e84d5dd
         "amount": "1.01", // the amount of the payment, how much was written off from the balance store 0.42
         "amount_pay": "1.0306", // the amount of the payment, as it is the user, example: 0.41
         "system": "BitCoin", // system, example: BitCoin(BTC), Ethereum(ETH), Litecoin(LTC), Dogecoin(DOGE), Dash(DASH), BitcoinCash(BCH), TON(TON, USDT), Ripple(XRP), TRON(TRX), Stellar(XLM), BinanceCoin(BNB), TRON_TRC20(USDT), BinanceSmartChain_BEP20(USDT, USDC, ADA, EOS, BTC, ETH, DOGE, SHIB), Ethereum_ERC20(USDT,USDC,SHIB)
         "currency": "BTC", // the currency of payment, for example: USD, RUB, BTC, ETH, LTC, DOGE, DASH, BCH, TON, XRP, XLM, BNB, USDT, USDC, ADA, EOS, SHIB
         "number": "3LaKdUrPfVyZeEVYpZei3HwjqQj5AHHTCE", // the address where you sent the funds
         "shop_comission_percent": "1.5", // the transfer fee percentage, example: 1.5
         "shop_comission_amount": "1.0", // the transfer fee amount, example: 1.00
         "paid_commission": "shop" // who paid for the commission, for example: shop
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "There is not enough money on the account. Error code: 58.",
     "data": {}
 }

SCI

SCI | Check payment(for IPN)

Method name: sci_confirm_order. This method is used in the handler of the payment receipt. The handler is called automatically by the PayKassa.pro service until the script responds <order_id>|success (maximum 5 times, otherwise you need to send a notification manually from the profile). The payment processor is called automatically from the notification servers 54.37.60.196, 51.91.80.241, 138.68.137.53. These IPs need to be added to the exceptions of your FireWall or DDoS filter, so that notifications go smoothly. The current list of IP can be obtained in text format via the URL: https://paykassa.pro/ips.txt or in JSON format: https://paykassa.pro/ips.php. The server sends a POST request, in which it passes a private_hash (random string), system (the name of the payment system or currency), currency (abbreviated currency name), order_id (payment id in your project). Next you must pass the received private_hash in the SCI request to the sci_confirm_order method, which will allow you to check whether the payment was successful.

POST
https://paykassa.app/sci/0.4/index.php

Parameter

Field Type Description
func required String

Method name, must be: sci_confirm_order

Default value: sci_confirm_order

sci_id required String

Merchant ID

sci_key required String

Merchant Password

private_hash required String

From POST request

test required Boolean

Turn on test mode

Default value: false

Allowed values: false, true

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata

  transaction required String

Invoice ID in Paykassa

  shop_id required String

Merchant ID in Paykassa

  order_id required String

Payment ID in your merchant

  amount required String

Amount to be received

  currency required String

Name of currency

  system required String

Name of system

  address required String

Destination address

  tag required String

Tag for Ripple and Stellar

  hash required String

Uuid of payment link

  partial required String

Arbitrary amount payment identifier

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Payment successfully verified",
     "data": {
         "transaction": "96401", // transaction number in the system paykassa: 96401
         "shop_id": "123", // Merchant ID 123
         "order_id": "12345",  // unique numeric identifier of the payment in your merchant, example: 150800
         "amount": "1.01", // invoice amount example: 1.01
         "currency": "BTC", // currency(BTC, ETH, LTC, DOGE, DASH, BCH, TON, XRP, TRX, XLM, BNB, USDT, USDC, ADA, EOS, SHIB)
         "system": "BitCoin", // system(BitCoin, Ethereum, Litecoin, Dogecoin, Dash, BitcoinCash, TON, Ripple, TRON, Stellar, BinanceCoin, TRON_TRC20, BinanceSmartChain_BEP20, Ethereum_ERC20)
         "address": "3LaKdUrPfVyZeEVYpZei3HwjqQj5AHHTCE", //Destination address
         "tag": "", //Tag for Ripple and Stellar
         "hash": "ba276492c1c8ff5bfad7ea46463aca85d9c447ee940aceeb71e4a726d89458cd", //uuid of payment link
         "partial": "no" // set up underpayments or overpayments 'yes' to accept, 'no' - do not take
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Account not found",
     "data": {}
}

SCI | Check payment(for IPN)

Method name: sci_confirm_order. This method is used in the handler of the payment receipt. The handler is called automatically by the PayKassa.pro service until the script responds <order_id>|success (maximum 5 times, otherwise you need to send a notification manually from the profile). The payment processor is called automatically from the notification servers 54.37.60.196, 51.91.80.241, 138.68.137.53. These IPs need to be added to the exceptions of your FireWall or DDoS filter, so that notifications go smoothly. The current list of IP can be obtained in text format via the URL: https://paykassa.pro/ips.txt or in JSON format: https://paykassa.pro/ips.php. The server sends a POST request, in which it passes a private_hash (random string), system (the name of the payment system or currency), currency (abbreviated currency name), order_id (payment id in your project). Next you must pass the received private_hash in the SCI request to the sci_confirm_order method, which will allow you to check whether the payment was successful.

POST
https://paykassa.app/sci/0.4/index.php

Parameter

Field Type Description
func required String

Method name, must be: sci_confirm_order

Default value: sci_confirm_order

sci_id required String

Merchant ID

sci_key required String

Merchant Password

private_hash required String

From POST request

test required Boolean

Turn on test mode

Default value: false

Allowed values: false, true

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata

  transaction required String

Invoice ID in Paykassa

  shop_id required String

Merchant ID in Paykassa

  order_id required String

Payment ID in your merchant

  amount required String

Amount to be received

  currency required String

Name of currency

  system required String

Name of system

  address required String

Destination address

  tag required String

Tag for Ripple and Stellar

  hash required String

Uuid of payment link

  partial required String

Arbitrary amount payment identifier

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Payment successfully verified",
     "data": {
         "transaction": "96401", // transaction number in the system paykassa: 96401
         "shop_id": "123", // Merchant ID 123
         "order_id": "12345",  // unique numeric identifier of the payment in your merchant, example: 150800
         "amount": "1.01", // invoice amount example: 1.01
         "currency": "BTC", // currency(BTC, ETH, LTC, DOGE, DASH, BCH, TON, XRP, TRX, XLM, BNB, USDT, USDC, ADA, EOS, SHIB)
         "system": "BitCoin", // system(BitCoin, Ethereum, Litecoin, Dogecoin, Dash, BitcoinCash, TON, Ripple, TRON, Stellar, BinanceCoin, TRON_TRC20, BinanceSmartChain_BEP20, Ethereum_ERC20)
         "address": "3LaKdUrPfVyZeEVYpZei3HwjqQj5AHHTCE", //Destination address
         "tag": "", //Tag for Ripple and Stellar
         "hash": "ba276492c1c8ff5bfad7ea46463aca85d9c447ee940aceeb71e4a726d89458cd", //uuid of payment link
         "partial": "no" // set up underpayments or overpayments 'yes' to accept, 'no' - do not take
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Account not found",
     "data": {}
}

SCI | Check payment(for IPN)

Method name: sci_confirm_order. This method is used in the handler of the payment receipt. The handler is called automatically by the PayKassa.pro service until the script responds <order_id>|success (maximum 5 times, otherwise you need to send a notification manually from the profile). The payment processor is called automatically from the notification servers 54.37.60.196, 51.91.80.241, 138.68.137.53. These IPs need to be added to the exceptions of your FireWall or DDoS filter, so that notifications go smoothly. The current list of IP can be obtained in text format via the URL: https://paykassa.pro/ips.txt or in JSON format: https://paykassa.pro/ips.php. The server sends a POST request, in which it passes a private_hash (random string), system (the name of the payment system or currency), currency (abbreviated currency name), order_id (payment id in your project). Next you must pass the received private_hash in the SCI request to the sci_confirm_order method, which will allow you to check whether the payment was successful.

POST
https://paykassa.app/sci/0.4/index.php

Parameter

Field Type Description
func required String

Method name, must be: sci_confirm_order

Default value: sci_confirm_order

sci_id required Number

Merchant ID

sci_key required String

Merchant Password

private_hash required String

From POST request

test required Boolean

Turn on test mode

Default value: false

Allowed values: false, true

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata

  transaction required Number

Invoice ID in Paykassa

  shop_id required Number

Merchant ID in Paykassa

  order_id required String

Payment ID in your merchant

  amount required String

Amount to be received

  currency required String

Name of currency

  system required String

Name of system

  address required String

Destination address

  tag required String

Tag for Ripple and Stellar

  hash required String

Uuid of payment link

  partial required String

Arbitrary amount payment identifier

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Payment successfully verified",
     "data": {
         "transaction": "96401", // transaction number in the system paykassa: 96401
         "shop_id": "123", // Merchant ID 123
         "order_id": "12345",  // unique numeric identifier of the payment in your merchant, example: 150800
         "amount": "1.01", // invoice amount example: 1.01
         "currency": "BTC", // currency(USD, RUB, BTC, ETH, LTC, DOGE, DASH, BCH, ZEC, XRP, TRX, XLM, BNB, USDT, BUSD, USDC, ADA, EOS)
         "system": "BitCoin", // system(BitCoin, Ethereum, Litecoin, Dogecoin, Dash, BitcoinCash, Zcash, Ripple, TRON, Stellar, BinanceCoin, TRON_TRC20, BinanceSmartChain_BEP20, Ethereum_ERC20)
         "address": "3LaKdUrPfVyZeEVYpZei3HwjqQj5AHHTCE", //Destination address
         "tag": "", //Tag for Ripple and Stellar
         "hash": "ba276492c1c8ff5bfad7ea46463aca85d9c447ee940aceeb71e4a726d89458cd", //uuid of payment link
         "partial": "no" // set up underpayments or overpayments 'yes' to accept, 'no' - do not take
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Account not found",
     "data": {}
}

SCI | Check transaction notification(for IPN)

Method name: sci_confirm_transaction_notification. This method should be called to get and check notification information for incoming transactions. The handler is called automatically by the PayKassa.pro service until the script responds <order_id>|success (maximum 5 times, send notification by manual not supported). The payment processor is called automatically from the notification servers 54.37.60.196, 51.91.80.241, 138.68.137.53. These IPs need to be added to the exceptions of your FireWall or DDoS filter, so that notifications go smoothly. The current list of IP can be obtained in text format via the URL: https://paykassa.pro/ips.txt or in JSON format: https://paykassa.pro/ips.php. The server sends a POST request, in which it passes a private_hash (random string), system (the name of the payment system or currency), currency (abbreviated currency name), order_id (payment id in your project). Next you must pass the received private_hash in the SCI request to the sci_confirm_transaction_notification method, which will allow you to check whether the payment was successful.

POST
https://paykassa.app/sci/0.4/index.php

Parameter

Field Type Description
func required String

Method name, must be: sci_confirm_transaction_notification

Default value: sci_confirm_transaction_notification

sci_id required String

Merchant ID

sci_key required String

Merchant Password

private_hash required String

From POST request

test required Boolean

Must be false only

Default value: false

Allowed values: false

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata

  transaction required String

Invoice ID in Paykassa

  txid required String

Public transaction hash for track transfer

  shop_id required String

Merchant ID in Paykassa

  order_id required String

Payment ID in your merchant

  amount required String

Amount to be received

  fee required String

Fee of network

  currency required String

Name of currency

  system required String

Name of system

  address_from required String

Source address if exist

  address required String

Destination address

  tag required String

Tag for Ripple and Stellar

  confirmations required String

Current count confirmations

  required_confirmations required String

Count confirmations for credited

  status required String

"no" - not confirmed, "yes" - confirmed and credited

  static required String

"yes" - yes only

  date_update required String

Date last change transaction info

  explorer_address_link required String

Link to address explorer

  explorer_transaction_link required String

Link to transaction explorer

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Ok",
     "data": {
         "transaction": "2431038", // transaction number in the system paykassa: 96401
         "txid": "e2be8b51ad0ccbae2a2433f8c940035ce97903c7de1a1cefa1db40cc1cabb0e5", //Hash track for explorer
         "shop_id": "138",  // Merchant ID 123
         "order_id": "order 1", // unique numeric identifier of the payment in your merchant, example: 150800
         "amount": "1.00000000", //  amount to credited example: 1.01
         "fee": "0.00000000", //  fee of network
         "currency": "DOGE", // currency(USD, RUB, BTC, ETH, LTC, DOGE, DASH, BCH, TON, XRP, TRX, XLM, BNB, USDT, USDC, ADA, EOS, SHIB)
         "system": "Dogecoin", //system(BitCoin, Ethereum, Litecoin, Dogecoin, Dash, BitcoinCash, TON, Ripple, TRON, Stellar, BinanceCoin, TRON_TRC20, BinanceSmartChain_BEP20, Ethereum_ERC20)
         "address_from": "", //Not empty for: Ethereum, TON,  Ripple, Stellar, TRON, BinanceCoin, TRON_TRC20, BinanceSmartChain_BEP20, Ethereum_ERC20
         "address": "DKpzDZuFoTpPpnpsMro8NBtmDz8rinCjqp", //Target address
         "tag": "", //Tag for Ripple and Stellar
         "confirmations": 0, //Current count confirmations
         "required_confirmations": 3, //Count confirmations for credited
         "status": "no", //"no" - not confirmed, "yes" - confirmed and credited
         "static": "yes", //"yes" - yes only
         "date_update": "2020-07-23 15:06:58", //Date last change transaction info
         "explorer_address_link": "https://explorer.paykassa.pro/address/dogecoin-doge/DKpzDZuFoTpPpnpsMro8NBtmDz8rinCjqp", //Link to address explorer
         "explorer_transaction_link": "https://explorer.paykassa.pro/transaction/dogecoin-doge/e2be8b51ad0ccbae2a2433f8c940035ce97903c7de1a1cefa1db40cc1cabb0e5" //Link to transaction explorer
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Account not found",
     "data": {}
}

SCI | Check transaction notification(for IPN)

Method name: sci_confirm_transaction_notification. This method should be called to get and check notification information for incoming transactions. The handler is called automatically by the PayKassa.pro service until the script responds <order_id>|success (maximum 5 times, send notification by manual not supported). The payment processor is called automatically from the notification servers 54.37.60.196, 51.91.80.241, 138.68.137.53. These IPs need to be added to the exceptions of your FireWall or DDoS filter, so that notifications go smoothly. The current list of IP can be obtained in text format via the URL: https://paykassa.pro/ips.txt or in JSON format: https://paykassa.pro/ips.php. The server sends a POST request, in which it passes a private_hash (random string), system (the name of the payment system or currency), currency (abbreviated currency name), order_id (payment id in your project). Next you must pass the received private_hash in the SCI request to the sci_confirm_transaction_notification method, which will allow you to check whether the payment was successful.

POST
https://paykassa.app/sci/0.4/index.php

Parameter

Field Type Description
func required String

Method name, must be: sci_confirm_transaction_notification

Default value: sci_confirm_transaction_notification

sci_id required String

Merchant ID

sci_key required String

Merchant Password

private_hash required String

From POST request

test required Boolean

Must be false only

Default value: false

Allowed values: false

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata

  transaction required String

Invoice ID in Paykassa

  txid required String

Public transaction hash for track transfer

  shop_id required String

Merchant ID in Paykassa

  order_id required String

Payment ID in your merchant

  amount required String

Amount to be received

  fee required String

Fee of network

  currency required String

Name of currency

  system required String

Name of system

  address_from required String

Source address if exist

  address required String

Destination address

  tag required String

Tag for Ripple and Stellar

  confirmations required String

Current count confirmations

  required_confirmations required String

Count confirmations for credited

  status required String

"no" - not confirmed, "yes" - confirmed and credited

  static required String

"yes" - yes only

  date_update required String

Date last change transaction info

  explorer_address_link required String

Link to address explorer

  explorer_transaction_link required String

Link to transaction explorer

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Ok",
     "data": {
         "transaction": "2431038", // transaction number in the system paykassa: 96401
         "txid": "e2be8b51ad0ccbae2a2433f8c940035ce97903c7de1a1cefa1db40cc1cabb0e5", //Hash track for explorer
         "shop_id": "138",  // Merchant ID 123
         "order_id": "order 1", // unique numeric identifier of the payment in your merchant, example: 150800
         "amount": "1.00000000", //  amount to credited example: 1.01
         "fee": "0.00000000", //  fee of network
         "currency": "DOGE", // currency(USD, RUB, BTC, ETH, LTC, DOGE, DASH, BCH, TON, XRP, TRX, XLM, BNB, USDT, USDC, ADA, EOS, SHIB)
         "system": "Dogecoin", //system(BitCoin, Ethereum, Litecoin, Dogecoin, Dash, BitcoinCash, TON, Ripple, TRON, Stellar, BinanceCoin, TRON_TRC20, BinanceSmartChain_BEP20, Ethereum_ERC20)
         "address_from": "", //Not empty for: Ethereum, TON,  Ripple, Stellar, TRON, BinanceCoin, TRON_TRC20, BinanceSmartChain_BEP20, Ethereum_ERC20
         "address": "DKpzDZuFoTpPpnpsMro8NBtmDz8rinCjqp", //Target address
         "tag": "", //Tag for Ripple and Stellar
         "confirmations": 0, //Current count confirmations
         "required_confirmations": 3, //Count confirmations for credited
         "status": "no", //"no" - not confirmed, "yes" - confirmed and credited
         "static": "yes", //"yes" - yes only
         "date_update": "2020-07-23 15:06:58", //Date last change transaction info
         "explorer_address_link": "https://explorer.paykassa.pro/address/dogecoin-doge/DKpzDZuFoTpPpnpsMro8NBtmDz8rinCjqp", //Link to address explorer
         "explorer_transaction_link": "https://explorer.paykassa.pro/transaction/dogecoin-doge/e2be8b51ad0ccbae2a2433f8c940035ce97903c7de1a1cefa1db40cc1cabb0e5" //Link to transaction explorer
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Account not found",
     "data": {}
}

SCI | Check transaction notification(for IPN)

Method name: sci_confirm_transaction_notification. This method should be called to get and check notification information for incoming transactions. The handler is called automatically by the PayKassa.pro service until the script responds <order_id>|success (maximum 5 times, send notification by manual not supported). The payment processor is called automatically from the notification servers 54.37.60.196, 51.91.80.241, 138.68.137.53. These IPs need to be added to the exceptions of your FireWall or DDoS filter, so that notifications go smoothly. The current list of IP can be obtained in text format via the URL: https://paykassa.pro/ips.txt or in JSON format: https://paykassa.pro/ips.php. The server sends a POST request, in which it passes a private_hash (random string), system (the name of the payment system or currency), currency (abbreviated currency name), order_id (payment id in your project). Next you must pass the received private_hash in the SCI request to the sci_confirm_transaction_notification method, which will allow you to check whether the payment was successful.

POST
https://paykassa.app/sci/0.4/index.php

Parameter

Field Type Description
func required String

Method name, must be: sci_confirm_transaction_notification

Default value: sci_confirm_transaction_notification

sci_id required Number

Merchant ID

sci_key required String

Merchant Password

private_hash required String

From POST request

test required Boolean

Must be false only

Default value: false

Allowed values: false

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata

  transaction required Number

Invoice ID in Paykassa

  txid required Number

Public transaction hash for track transfer

  shop_id required Number

Merchant ID in Paykassa

  order_id required String

Payment ID in your merchant

  amount required String

Amount to be received

  fee required String

Fee of network

  currency required String

Name of currency

  system required String

Name of system

  address_from required String

Source address if exist

  address required String

Destination address

  tag required String

Tag for Ripple and Stellar

  confirmations required String

Current count confirmations

  required_confirmations required String

Count confirmations for credited

  status required String

"no" - not confirmed, "yes" - confirmed and credited

  static required String

"yes" - yes only

  date_update required String

Date last change transaction info

  explorer_address_link required String

Link to address explorer

  explorer_transaction_link required String

Link to transaction explorer

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Ok",
     "data": {
         "transaction": "2431038", // transaction number in the system paykassa: 96401
         "txid": "e2be8b51ad0ccbae2a2433f8c940035ce97903c7de1a1cefa1db40cc1cabb0e5", //Hash track for explorer
         "shop_id": "138",  // Merchant ID 123
         "order_id": "order 1", // unique numeric identifier of the payment in your merchant, example: 150800
         "amount": "1.00000000", //  amount to credited example: 1.01
         "fee": "0.00000000", //  fee of network
         "currency": "DOGE", // currency(USD, RUB, BTC, ETH, LTC, DOGE, DASH, BCH, ZEC, XRP, TRX, XLM, BNB, USDT, BUSD, USDC, ADA, EOS)
         "system": "Dogecoin", //system(BitCoin, Ethereum, Litecoin, Dogecoin, Dash, BitcoinCash, Zcash, Ripple, TRON, Stellar, BinanceCoin, TRON_TRC20, BinanceSmartChain_BEP20, Ethereum_ERC20)
         "address_from": "", //Not empty for: Ethereum, Ripple, Stellar, TRON, BinanceCoin, TRON_TRC20, BinanceSmartChain_BEP20, Ethereum_ERC20
         "address": "DKpzDZuFoTpPpnpsMro8NBtmDz8rinCjqp", //Target address
         "tag": "", //Tag for Ripple and Stellar
         "confirmations": 0, //Current count confirmations
         "required_confirmations": 3, //Count confirmations for credited
         "status": "no", //"no" - not confirmed, "yes" - confirmed and credited
         "static": "yes", //"yes" - yes only
         "date_update": "2020-07-23 15:06:58", //Date last change transaction info
         "explorer_address_link": "https://explorer.paykassa.pro/address/dogecoin-doge/DKpzDZuFoTpPpnpsMro8NBtmDz8rinCjqp", //Link to address explorer
         "explorer_transaction_link": "https://explorer.paykassa.pro/transaction/dogecoin-doge/e2be8b51ad0ccbae2a2433f8c940035ce97903c7de1a1cefa1db40cc1cabb0e5" //Link to transaction explorer
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Account not found",
     "data": {}
}

SCI | Get cryptocurrency address for deposit

Method name: sci_create_order_get_data. Creates an address to receive payment. After creating an address for payment, you need to display it on your project page along with a small instruction on how to pay.

POST
https://paykassa.app/sci/0.4/index.php

Parameter

Field Type Description
func required String

Method name, must be: sci_create_order_get_data

Default value: sci_create_order_get_data

sci_id required String

Merchant ID

sci_key required String

Merchant Password

order_id required String

Payment ID in your merchant

amount required String

Amount to be received

currency required String

Currency to be received

Allowed values: BTC, ETH, LTC, DOGE, DASH, BCH, TON, XRP, TRX, XLM, BNB, USDT, USDC, ADA, EOS, SHIB

system required Number

ID of system must match currency

Allowed values: 11-BitCoin(BTC), 12-Ethereum(ETH), 14-Litecoin(LTC), 15-Dogecoin(DOGE), 16-Dash(DASH), 18-BitcoinCash(BCH), 33-TON(TON, USDT), 22-Ripple(XRP), 27-TRON(TRX), 28-Stellar(XLM), 29-BinanceCoin(BNB), 30-TRON_TRC20(USDT), 31-BinanceSmartChain_BEP20(USDT, USDC, ADA, EOS, BTC, ETH, DOGE, SHIB), 32-Ethereum_ERC20(USDT, USDC, SHIB)

comment required String

Comments for history

phone required String

Must be false

paid_commission required String

Who paid commission (only fiat, default: shop)

Default value: shop

Allowed values: shop, client, ''

test required Boolean

Turn on test mode

Default value: false

Allowed values: false, true

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata

  invoice required String

Invoice ID in Paykassa

  order_id required String

Payment ID in your merchant

  wallet required String

Destination address

  amount required String

Amount to be received

  system required String

Name of system

  currency required String

Name of currency

  url required String

URL to redirect user for paying process

  tag required String

Optional if not false, you must pass he payeer

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Data has been successfully received.",
     "data": {
         "invoice": "579205",
         "order_id": "12345",
         "wallet": "3LaKdUrPfVyZeEVYpZei3HwjqQj5AHHTCE", // Wallet to pay
         "amount": "1.03030000",
         "system": "BitCoin",
         "currency": "BTC",
         "url": "https://crypto.paykassa.pro/sci/index.php?hash=ba276492c1c8ff5bfad7ea46463aca85d9c447ee940aceeb71e4a726d89458cd", # link to redirect
         "tag": false // not false if exists
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Specify the payment amount. Error code: 22",
     "data": {}
}

SCI | Get cryptocurrency address for deposit

Method name: sci_create_order_get_data. Creates an address to receive payment. After creating an address for payment, you need to display it on your project page along with a small instruction on how to pay.

POST
https://paykassa.app/sci/0.4/index.php

Parameter

Field Type Description
func required String

Method name, must be: sci_create_order_get_data

Default value: sci_create_order_get_data

sci_id required String

Merchant ID

sci_key required String

Merchant Password

order_id required String

Payment ID in your merchant

amount required String

Amount to be received

currency required String

Currency to be received

Allowed values: BTC, ETH, LTC, DOGE, DASH, BCH, TON, XRP, TRX, XLM, BNB, USDT, USDC, ADA, EOS, SHIB

system required Number

ID of system must match currency

Allowed values: 11-BitCoin(BTC), 12-Ethereum(ETH), 14-Litecoin(LTC), 15-Dogecoin(DOGE), 16-Dash(DASH), 18-BitcoinCash(BCH), 33-TON(TON, USDT), 22-Ripple(XRP), 27-TRON(TRX), 28-Stellar(XLM), 29-BinanceCoin(BNB), 30-TRON_TRC20(USDT), 31-BinanceSmartChain_BEP20(USDT, USDC, ADA, EOS, BTC, ETH, DOGE, SHIB), 32-Ethereum_ERC20(USDT, USDC, SHIB)

comment required String

Comments for history

phone required String

Must be false

paid_commission required String

Who paid commission (only fiat, default: shop)

Default value: shop

Allowed values: shop, client, ''

test required Boolean

Turn on test mode

Default value: false

Allowed values: false, true

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata

  invoice required String

Invoice ID in Paykassa

  order_id required String

Payment ID in your merchant

  wallet required String

Destination address

  amount required String

Amount to be received

  system required String

Name of system

  currency required String

Name of currency

  url required String

URL to redirect user for paying process

  tag required String

Optional if not false, you must pass he payeer

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Data has been successfully received.",
     "data": {
         "invoice": "579205",
         "order_id": "12345",
         "wallet": "3LaKdUrPfVyZeEVYpZei3HwjqQj5AHHTCE", // Wallet to pay
         "amount": "1.03030000",
         "system": "BitCoin",
         "currency": "BTC",
         "url": "https://crypto.paykassa.pro/sci/index.php?hash=ba276492c1c8ff5bfad7ea46463aca85d9c447ee940aceeb71e4a726d89458cd", # link to redirect
         "tag": false // not false if exists
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Specify the payment amount. Error code: 22",
     "data": {}
}

SCI | Get cryptocurrency address for deposit

Method name: sci_create_order_get_data. Creates an address to receive payment. After creating an address for payment, you need to display it on your project page along with a small instruction on how to pay.

POST
https://paykassa.app/sci/0.4/index.php

Parameter

Field Type Description
func required String

Method name, must be: sci_create_order_get_data

Default value: sci_create_order_get_data

sci_id required Number

Merchant ID

sci_key required String

Merchant Password

order_id required String

Payment ID in your merchant

amount required Number

Amount to be received

currency required String

Currency to be received

Allowed values: BTC, ETH, LTC, DOGE, DASH, BCH, ZEC, XRP, TRX, XLM, BNB, USDT, BUSD, USDC, ADA, EOS

system required Number

ID of system must match currency

Allowed values: 11-BitCoin(BTC), 12-Ethereum(ETH), 14-Litecoin(LTC), 15-Dogecoin(DOGE), 16-Dash(DASH), 18-BitcoinCash(BCH), 19-Zcash(ZEC), 22-Ripple(XRP), 27-TRON(TRX), 28-Stellar(XLM), 29-BinanceCoin(BNB), 30-TRON_TRC20(USDT), 31-BinanceSmartChain_BEP20(USDT, BUSD, USDC, ADA, EOS, BTC, ETH, DOGE), 32-Ethereum_ERC20(USDT)

comment required String

Comments for history

phone required String

Must be false

paid_commission required String

Who paid commission

Default value: shop

Allowed values: shop, client, ''

test required Boolean

Turn on test mode

Default value: false

Allowed values: false, true

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata

  invoice required Number

Invoice ID in Paykassa

  order_id required String

Payment ID in your merchant

  wallet required String

Destination address

  amount required String

Amount to be received

  system required String

Name of system

  currency required String

Name of currency

  url required String

URL to redirect user for paying process

  tag required String

Optional if not false, you must pass he payeer

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Data has been successfully received.",
     "data": {
         "invoice": 579205,
         "order_id": "12345",
         "wallet": "3LaKdUrPfVyZeEVYpZei3HwjqQj5AHHTCE", // Wallet to pay
         "amount": "1.03030000",
         "system": "BitCoin",
         "currency": "BTC",
         "url": "https://crypto.paykassa.pro/sci/index.php?hash=ba276492c1c8ff5bfad7ea46463aca85d9c447ee940aceeb71e4a726d89458cd", # link to redirect
         "tag": false // not false if exists
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Specify the payment amount. Error code: 22",
     "data": {}
}

SCI | Get link for deposit

Method name: sci_create_order. Creates a link to payment. After creating the link, you need to redirect to it for further payment.

POST
https://paykassa.app/sci/0.4/index.php

Parameter

Field Type Description
func required String

Method name, must be: sci_create_order

Default value: sci_create_order

sci_id required String

Merchant ID

sci_key required String

Merchant Password

order_id required String

Payment ID in your merchant

amount required String

Amount to be received

currency required String

Currency to be received

Allowed values: BTC, ETH, LTC, DOGE, DASH, BCH, TON, XRP, TRX, XLM, BNB, USDT, USDC, ADA, EOS, SHIB

system required Number

ID of system must match currency

Allowed values: 11-BitCoin(BTC), 12-Ethereum(ETH), 14-Litecoin(LTC), 15-Dogecoin(DOGE), 16-Dash(DASH), 18-BitcoinCash(BCH), 33-TON(TON, USDT), 22-Ripple(XRP), 27-TRON(TRX), 28-Stellar(XLM), 29-BinanceCoin(BNB), 30-TRON_TRC20(USDT), 31-BinanceSmartChain_BEP20(USDT, USDC, ADA, EOS, BTC, ETH, DOGE, SHIB), 32-Ethereum_ERC20(USDT, USDC, SHIB)

comment required String

Comments for history

phone required String

Must be false

paid_commission required String

Who paid commission (only fiat, default: shop)

Default value: shop

Allowed values: shop, client, ''

test required String

Turn on test mode

Default value: false

Allowed values: false, true

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata

  url required String

URL to create the payment form

  method required String

Method to create the payment form

  params required String

Params to create the payment form

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Data has been successfully received.",
     "data": {
         "url": "https://crypto.paykassa.pro/sci/index.php?hash=ba276492c1c8ff5bfad7ea46463aca85d9c447ee940aceeb71e4a726d89458cd", # link to redirect
         "method": "GET",
         "params": {
             "hash": "ba276492c1c8ff5bfad7ea46463aca85d9c447ee940aceeb71e4a726d89458cd"
         },
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Specify the payment amount. Error code: 22",
     "data": {}
}

SCI | Get link for deposit

Method name: sci_create_order. Creates a link to payment. After creating the link, you need to redirect to it for further payment.

POST
https://paykassa.app/sci/0.4/index.php

Parameter

Field Type Description
func required String

Method name, must be: sci_create_order

Default value: sci_create_order

sci_id required String

Merchant ID

sci_key required String

Merchant Password

order_id required String

Payment ID in your merchant

amount required String

Amount to be received

currency required String

Currency to be received

Allowed values: BTC, ETH, LTC, DOGE, DASH, BCH, TON, XRP, TRX, XLM, BNB, USDT, USDC, ADA, EOS, SHIB

system required Number

ID of system must match currency

Allowed values: 11-BitCoin(BTC), 12-Ethereum(ETH), 14-Litecoin(LTC), 15-Dogecoin(DOGE), 16-Dash(DASH), 18-BitcoinCash(BCH), 33-TON(TON, USDT), 22-Ripple(XRP), 27-TRON(TRX), 28-Stellar(XLM), 29-BinanceCoin(BNB), 30-TRON_TRC20(USDT), 31-BinanceSmartChain_BEP20(USDT, USDC, ADA, EOS, BTC, ETH, DOGE, SHIB), 32-Ethereum_ERC20(USDT, USDC, SHIB)

comment required String

Comments for history

phone required String

Must be false

paid_commission required String

Who paid commission (only fiat, default: shop)

Default value: shop

Allowed values: shop, client, ''

test required String

Turn on test mode

Default value: false

Allowed values: false, true

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata

  url required String

URL to create the payment form

  method required String

Method to create the payment form

  params required String

Params to create the payment form

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Data has been successfully received.",
     "data": {
         "url": "https://crypto.paykassa.pro/sci/index.php?hash=ba276492c1c8ff5bfad7ea46463aca85d9c447ee940aceeb71e4a726d89458cd", # link to redirect
         "method": "GET",
         "params": {
             "hash": "ba276492c1c8ff5bfad7ea46463aca85d9c447ee940aceeb71e4a726d89458cd"
         },
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Specify the payment amount. Error code: 22",
     "data": {}
}

SCI | Get link for deposit

Method name: sci_create_order. Creates a link to payment. After creating the link, you need to redirect to it for further payment.

POST
https://paykassa.app/sci/0.4/index.php

Parameter

Field Type Description
func required String

Method name, must be: sci_create_order

Default value: sci_create_order

sci_id required Number

Merchant ID

sci_key required String

Merchant Password

order_id required String

Payment ID in your merchant

amount required Number

Amount to be received

currency required String

Currency to be received

Allowed values: USD, RUB, BTC, ETH, LTC, DOGE, DASH, BCH, ZEC, XRP, TRX, XLM, BNB, USDT, BUSD, USDC, ADA, EOS

system required Number

ID of system must match currency

Allowed values: 2-PerfectMoney(USD), 7-Berty(USD, RUB), 11-BitCoin(BTC), 12-Ethereum(ETH), 14-Litecoin(LTC), 15-Dogecoin(DOGE), 16-Dash(DASH), 18-BitcoinCash(BCH), 19-Zcash(ZEC), 22-Ripple(XRP), 27-TRON(TRX), 28-Stellar(XLM), 29-BinanceCoin(BNB), 30-TRON_TRC20(USDT), 31-BinanceSmartChain_BEP20(USDT, BUSD, USDC, ADA, EOS, BTC, ETH, DOGE), 32-Ethereum_ERC20(USDT)

comment required String

Comments for history

phone required String

Must be false

paid_commission required String

Who paid commission

Default value: shop

Allowed values: shop, client, ''

test required String

Turn on test mode

Default value: false

Allowed values: false, true

Success 200

Field Type Description
error required Boolean

false - Success

Information required String

message

data required Object

Extradata

  invoice required Number

Invoice ID in Paykassa

  order_id required String

Payment ID in your merchant

  amount required String

Amount to be received

  system required String

Name of system

  currency required String

Name of currency

  url required String

URL to redirect user for paying process

HTTP/1.1 200 OK
{
     "error": false,
     "message": "Data has been successfully received.",
     "data": {
         "invoice": 579205,
         "order_id": "12345",
         "amount": "1.03030000",
         "system": "BitCoin",
         "currency": "BTC",
         "url": "https://crypto.paykassa.pro/sci/index.php?hash=ba276492c1c8ff5bfad7ea46463aca85d9c447ee940aceeb71e4a726d89458cd" # link to redirect
     }
}

Error 4xx

Name Type Description
error required Boolean

true - Fail

message required String

Error description

data required Object

Empty

HTTP/1.1 200 OK
{
     "error": true,
     "message": "Specify the payment amount. Error code: 22",
     "data": {}
}