API en

Deposit of funds (API)

Доступ к общему API реализован по белому листу IP-адресов и секретному ключу. Перед началом работы с API на ввод, необходимо передать ТП Paykassma IP-адрес с которого будут отправляться запросы.

PLUGINAPI_SECRET - строка секретного ключа. Ее необходимо будет добавлять ко всем запросам в виде get-параметра secret.
Например: https://api.{URL_сервера_Paykassma}/api/v1/deposit-info?secret=pluginapi_secret

При отправки запроса без использования данных параметров, будет выдаваться ошибка 404 'Не найдено'

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.

Saving the client’s ID transaction

Request for sending your transaction ID (custom_transaction_id) to Paykassma. In the future, this ID is assigned to the transaction performed by the user and is transmitted in the postback.

API url

https://api.{URL_сервера_Paykassma}/api/v1/payment/save-transaction-custom-id

Request method: POST

Format: JSON

Parameters:

Параметр	Тип	Обязательность	Описание
label	string (190)	YES	Unique identifier (ID) of the user making the payment
transaction_custom_id	string (190)	YES	Transaction ID in the Client’s system

Request

{
    "label": "55",
    "transaction_custom_id": "123465477897"
}

Response Success

{
    "status": "ok"
}

Response Fail

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

Obtaining available PSs

API url

https://api.{URL_сервера_Paykassma}/api/v1/payment-systems/available

Request method: GET

Format: JSON

Parameters:

Параметр	Тип	Обязательность	Описание
currency_code	string[] (3)	YES	An array consisting of currency codes. PS that work with the specified currencies will be displayed
label	string (190)	YES	Unique identifier (ID) of the user making the payment

Request

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

Response Success

{
  "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"
        }
      }
    }
  }
}

Response Fail

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

Creating a payment

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

Attention! To get a complete list of available PSs, you need to contact Paykassma TS. TS will provide complete examples of requests for currently available PSs. They will also determine the correct request, depending on the selected PS.

Type of request №1:

API url

https://api.{URL_сервера_Paykassma}/api/v1/transaction/create/{wallet_type}

1.1

API url

https://api.{URL_сервера_Paykassma}/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	string (3)	YES	Currency code
label	string (190)	YES	Unique identifier of the user making the payment

Request

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

Response Success

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

Response Fail

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

1.2 Activation request:

API url

https://api.{URL_сервера_Paykassma}/api/v1/transaction/activate

Request method: POST

Format: JSON

Parameters:

Параметр	Тип	Обязательность	Описание
currency_code	string (3)	YES	Currency code
wallet_type	string (190)	YES	Value from the list of available PSs. Attention: To get a complete available list, contact Paykassma TS.
label	string (190)	YES	Unique identifier of the user making the payment
key1	string (190)	YES	A code on which activation is performed (Transiction_ID), received from the user

Request

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

Response Success

{
    "status": "ok"
}

Response Fail

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

Type of request №2:

2.1

API url

https://api.{URL_сервера_Paykassma}/api/v1/payment/create/{payment_system}

Request method: POST

Format: JSON

Parameters:

Параметр	Тип	Обязательность	Описание
language	string (2)	YES	Interface language
currency	string (3)	YES	Currency code
bank	string (3)	YES	The bank via which the payment is performed
amount	numeric (ограничена max. депозитом)	YES	Payment amount
label	string (190)	YES	Unique identifier of the user making the payment
redirect_url	url	YES	URL of the page for redirecting after payment

Request

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

Response Success

{
    "status": "ok"
}

Response Fail

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

Information about savings

Request to provide information about savings of a certain user

Для сохранения информации о транзакциях, сумма которых не превышает размер минимального депозита для конкретной платёжной системы, был реализован функционал накоплений. Транзакции пользователя (выборка по параметру label) копятся в системе и не зачисляются на счёт пользователя до тех пор, пока их сумма не достигнет минимального депозита этой платёжной системы. Постбек на сервер клиента отправится только после достижения суммы минимального депозита. До момента отправки postback транзакция не считается зачисленной на счёт.

API url

https://api.{URL_сервера_Paykassma}/api/v1/deposit-info

Request method: GET

Format: JSON

Parameters:

Параметр	Тип	Обязательность	Описание
label	string (190)	YES	Unique identifier of the user making the payment
wallet_type	url	YES	Value from the list of available PSs. Attention: To get a complete available list, contact Paykassma TS.
currency	string (3)	YES	Currency code
code	string (190) или “null”	NO	Name of the manual payment system. It’s filled in when wallet_type = manual

Request

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

Response Success

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

Response Fail

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

Withdrawal of funds (API)

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

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

Send withdrawal requests (POST) to the URL:

API url

https://api.{ URL сервера }/v2/withdrawal/create

Attention: When transmitting data, there should be no spaces at the beginning and end

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

Signature

$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:

Наименование	Тип	Обязательность	Описание
withdrawal_id	string(1-7)	optional	Withdrawal ID, if the parameter is not passed, then the system generates withdrawal _id
payment_system	string	required	Payment system
amount	numeric	required	Withrawal amount
currency_code	string(3)	required	Currency code
label	string	required	Unique identifier of the user making the payment
comment	string(4-64)	optional	Comment
account_number	string	*required_if PS = bkash,imps, upi,paytm,....	Number of the bank account
account_name	string	*required_if PS = imps, upi,....	Name of the bank account holder
account_email	string	*required_if PS = bkash,...	Email of the person who is being paid
receiver_name	string(190)	required_if PS = imps	Name of the person who is being paid
payments_details.payments_method	string	*required_if	Payment method
payments_details.payments_provider	string	optional	Supplier who makes electronic payment using the selected payment method
bank_details.bank_code	string	*required_if	Unique ID assigned by the country's central bank
bank_details.branch_code	string	*required_if	Bank branch code
bank_details.bank_code_in_payments_system	string	*required_if	Bank code in payments system, with which data is exchanged
account_type	string	*required_if	Account type
document_type	string	*required_if	Document type
document_id	string	*required_if	Recipient document ID
account_digit	string	*required_if	Account digit
iban	string	*required_if	IBAN

*The withdrawal request contains fields that are required only for some payment systems (required_if), to get a complete list of required fields for a specific payment system, you need to contact Paykassma technical support.

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

Payment system	account_number	account_name	account_email	receiver_name	payments_details		bank_details
Payment system	account_number	account_name	account_email	receiver_name	payments_method	payments_provider	bank_code	branch_code	bank_code_in_payment_system
Bkash	required	-	required	-	-	-	-	-	-
IMPS/UPI	required	required	-	required for IMPS	-	-	optional	-	-
Paytm	required	-	-	-	-	-	-	-	-

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': ''
}

Response Success

{
    'status': 'ok'
}

Response Fail

{
    '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

Статус	Описание
NEW (0)	In processing
CANCELED (2)	Unsuccessful
PROCESSED (1)	Uccessful

The old withdrawal request is also available for work.

API url:

https://api.{URL_сервера_Paykassma}/withdrawal/manual/create

Required parameters for transmission in POST request:

Параметр	Тип данных	Описание
wallet_type	text(191) Selection from the available list	Type of the payment system
wallet_recipient	string(191)	The recipient's wallet, to whose account the payment will be made Attention! wallet_recipient (For the Paytm method) must contain the Paytm wallet number without the international code +91
wallet_sender	string(191)	The sender's wallet, from whose account money will be withdrawn. The final choice of the sender is left to Paykassma. Attention: it is necessary to fill in the field with arbitrary four digits
account_name	string(191)	Name of the bank account holder
account_number	string(191)	Number of the bank account
email	string(191)	Email of the person who is being paid
amount	Double	Withdrawal amount
withdrawal_id	Integer	Client side withdrawal ID (returned in postback).

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.

Content

Space Tools

Deposit of funds (API)

Saving the client’s ID transaction

Obtaining available PSs

Creating a payment

Type of request №1:

1.1

1.2 Activation request:

Type of request №2:

2.1

Information about savings

Withdrawal of funds (API)

Withdrawal status

Content

Space Tools

Breadcrumbs

API en

Deposit of funds (API)

Saving the client’s ID transaction

Obtaining available PSs

Creating a payment

Type of request №1:

1.1

1.2 Activation request:

Type of request №2:

2.1

Information about savings

Withdrawal of funds (API)

Withdrawal status