Deposit of funds (API)

Access to the shared API is implemented using a whitelist of IP addresses and a secret key. Before starting to work with the API for deposit, it is necessary to send to the Paykassma TS the IP address from which requests will be sent.

PLUGINAPI_SECRET - secret key string. It will need to be added to all requests in the form of the secret get parameter.
    For example: https://api.{URL_Paykassma_Server}/api/v1/deposit-info?secret=pluginapi_secret

When you send a request without using these parameters, the error 404 'Not found' will be displayed

Attention: Before starting to work with the API for deposit, it is necessary to send the IP address from which requests will be sent to the Paykassma TS.

Obtaining available PSs

https://api.{URL_Paykassma_Server}/api/v1/payment-systems/available

Request method: GET

Format: JSON

Parameters:

{
    "currency_code": [ "USD", "INR" ],
    "label": "55"
}

{
  "status": "ok",
  "params": {
    "gif_guide": {
      "upi": "http:\/\/api.pay.test\/storage\/guide-image\/upi.mp4?cache=1587635151",
      "phonePe": "http:\/\/api.pay.test\/storage\/guide-image\/phonePe.gif?cache=1589958899",
      "bkash": "http:\/\/api.pay.test\/storage\/guide-image\/bkash.mpg?cache=1611553163"
    },
    "currency_data": [
      {
        "code": "INR",
        "symbol": "₹"
      }
    ],
    "wallets": [
      {
        "type": "paytm",
        "currency_code": "INR",
        "order": 5,
        "logo": "http:\/\/api.pay.test\/storage\/payment_system\/logos\/paytm_default.svg",
        "name": "PayTM"
      },
      {
        "type": "paytm",
        "currency_code": "INR",
        "order": 5,
        "logo": "http:\/\/api.pay.test\/storage\/payment_system\/logos\/paytm_34.svg",
        "name": "paytm",
        "hints": [
          {
            "type": "requisites_hint",
            "text": null
          },
          {
            "type": "payment_hint",
            "text": null
          },
          true
        ],
        "show_limits": true
      }
    ],
      "imps": {
        "INR": {
          "min": "8000",
          "max": "560000"
        }
      },
      "bkash": {
        "BDT": {
          "min": "100",
          "max": "1000000"
        }
      },
      "upi": {
        "INR": {
          "min": "20000",
          "max": "50000"
        }
      },
      "paytm": {
        "INR": {
          "min": "100000",
          "max": "20000000"
        }
      },
      "phone_pe": {
        "INR": {
          "min": "100",
          "max": "800000"
        }
      }
    }
  }
}

{
    "status": "fail"
    "message": "MESSAGE"
}

Creating a payment

Currently, there are two types of requests for creating a payment, depending on the PS.

Type of request №1:

https://api.{URL_Paykassma_Server}/api/v1/transaction/create/{wallet_type}

1.1 Requests that require activation

https://api.{URL_Paykassma_Server}/api/v1/transaction/create/paytm

In this case, first we accept a request for deposit via PayTM, then in response we will provide details of the wallet to which the user should transfer the payment, and after payment you need to send a request to activate the transaction

Request method: POST

Format: JSON

Parameters:

{
    "currency": "INR",
    "label": "eligendi"
}

{
    "status": "ok",
    "params":  {
        "identifier": "6234234234"
                      }
}

{
    "status": "fail"
    "message": "MESSAGE"
}

1.2 Activation request: 

https://api.{URL_Paykassma_Server}/api/v1/transaction/activate

Request method: POST

Format: JSON

Parameters:

{
    "currency_code": "USD",
    "wallet_type": "paytm",
    "label": "55",
    "key1": "123-ABC-456-DEF"
    "custom_transaction_id": "123465477897"
}

{
    "status": "ok"
}

{
    "status": "fail"
    "message": "MESSAGE"
}

*For some PS, it is also necessary to send the amount field in the request:

Type of request №2:

2.1 Requests not requiring activation

https://api.{URL_Paykassma_Server}/api/v1/payment/create/{payment_system}

Request method: POST

Format: JSON

Parameters:

{
   "language": "en",
   "currency": "USD",
   "bank": "MBB",
   "amount": "1000",
   "label": "55",
   "redirect_url": "https:\/\/google.com"
   "custom_transaction_id": "123465477897"
}

{
    "status": "ok"
}

{
    "status": "fail"
    "message": "MESSAGE"
}

Information about savings

Request to provide information about savings of a certain user

To save information about transactions, the amount of which does not exceed the minimum deposit amount for a particular payment system, the functionality of savings has been implemented. The user's transactions (selected by the label parameter) are accumulated in the system and are not credited to the user's account until their amount reaches the minimum deposit amount of this payment system. The postback will be sent to the client's server only after the minimum deposit amount is reached. Until the postback is sent, the transaction is not considered credited to the account.

https://api.{URL_Paykassma_Server}/api/v1/deposit-info

Request method: GET

Format: JSON

Parameters:

{
   "label": "55",
   "wallet_type": "paytm",
   "currency": "UDS"
}

{
    "status": "ok"
    "stockpiling_sum": 0,
    "lacks_sum": 0,
    "minimum_deposit": 148
}

{
    "status": "fail"
    "message": "MESSAGE"
}

    < Home

Withdrawal of funds (API, actual version)

To withdraw funds by the user via payment systems available to the Client, it is necessary to:

1. Once send Paykassma TS the URL of the server where postbacks with the withdrawal status will be sent.

2. Send withdrawal requests (POST) to the URL:

   API url

   https://api.{URL_Paykassma_Server}/v2/withdrawal/create

Each withdrawal request is signed by signature, it is formed as follows:

$data = [
    ...
];

$data['signature'] = generateSignature($data); // return fa0ee1e2acf7f898635ec417491381c0a4f9d35c

//send $data like json ...

function generateSignature(array $data) {
    $privateKey = 'yourprivatekey';
	ksort($data);
	$implode = implode(':', $data);
	return sha1($privateKey . md5($implode));
}

Required parameters for transmission in POST request:

Payment method

Recipient document ID

Required fields for PS Bkash, PayTm, IMPS/UPI:

Request:

{
	'withdrawal_id': '1234567',
    'payment_system': 'paytm',
	'amount' : '1000',      
	'type': '0',   
    'currency_code': 'IDR',
	'label': '55',        
	'comment': 'withdrawal',       
	'account_number': '11111111', 
	'account_name' : '',
	'account_email' : '',
	'payments_details':
        {
            'payments_method': '',
            'payments_provider': ''
        },
    'bank_details':
        {
            'bank_code': '',
            'branch_code': '',
            'bank_code_in_payments_system': ''
        },
	'account_type': '',
	'document_type': '',
	'document_id': '',
	'account_digit': '',
	'iban': ''
}

{
    'status': 'ok'
}

{
    'status': 'fail'
    'message': 'MESSAGE'
}

After processing the withdrawal, Paykassma will send a postback about the result of the withdrawal with a status, signed with a signature.

Withdrawal status

Withdrawal of funds (API, the outdated version is not longer supported)

API url:

https://api.{URL_Paykassma_Server}/withdrawal/manual/create

Required parameters for transmission in POST request:

Request:

{
    "wallet_type":"paytm",
    "wallet_recipient":"123123232",
    "wallet_sender":1111,
    "email":"[email protected]",
    "amount":1000,
    "withdrawal_id":"13",
    "signature":"fae51673a8a9c85f724317214bd0bcc665ebc799"
}

When sending a withdrawal request to Paykassma, the first response received the generated data on the request, without a signature:

Example first response:

{
    "id":1,
    "wallet_type":"paytm",
    "wallet_recipient":"123123232",
    "wallet_sender":"1111",
    "email":"[email protected]",
    "amount":1000,
    "status":1,
    "created_at":"2020-07-08 07:06:06",
    "updated_at":"2020-07-08 09:40:39"
}

The second response will already come a postback about the withdrawal, signed by the signature.

    < Home