Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: delete info about accumulation

Communication takes place with the help of postback requests (postbacks). After each Client request for input or output, a postback is sent to the Client with the result of the operation.

Attention: To change the time zone when displaying the time in transactions, set the required time zone in the settings (path: Personal Account -> Settings -> paykassma Settings -> Time Zone) via the Paykassma TP request. Default time zone +08: 00 PST Asia/Manila

Receiving the postback

(postbake)

To accept postbacks, you need to implement a separate path that you can use to receive postbacks. They are sent by a POST request in JSON format.

The Paykassma server is waiting for a response in json {"status": "ok"} response code 200, otherwise, when receiving a different response, Paykassma will forward the postback with a certain frequency.

    < Home

Deposit/Withdrawal

Client-side signature generation

When sending postbacks, Paykassma also sends a signature: a specially generated hash line that is created using a private key. The signature is calculated following way:

$signature = sha1($postback_access_key . $postback_private_access_key . md5($transactions$additionalDataArray->toJson(JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE)));

a string consisting of three parameters is passed to the sha1 function:

Parameter

Description

$postback_access_key

public key;

$postback_private_access_key

private key;

Hash from the MD5 function of the entire transaction list in JSON format

The result of executing this code is a string that cannot be forged without having a private key that is not transmitted in postbacks.

The client can compare the generated signature with the received signature from the postback and thus make sure that the data that came was actually sent and not forged by an attacker.

Postback of transactions for deposit

Request Requеst body:

НазваниеТип

Описание

signature                          string

Postback signature                                    

wallet_typestring

Payment system in which the transaction was made

amountfloat 

Transaction amount

currency_code

string

Transaction currency code

Name

Type

Description

access_key

string

The access key is specified in the settings of the personal account of the TS Paykassma

signature

string

The signature used to verify the authenticity of the postback.

Attention: the principle of signature formation is given below in a separate paragraph.

labelstring

Unique user

ID in the client's systemStockpiling

ID 

converted_amountobject

The

amount of transactions involved in the accumulation (one or more transactions) converted to

transaction amount converted into all currencies. Conversion is carried out on the basis of open data on exchange rates.

All currencies are transmitted with an accuracy of up to hundredths, cryptocurrencies have 8 digits in the fractional part (one hundred millionth accuracy). Passed as an list.

Attention: the description of the accumulation functionality is given below in a separate paragraph

stockpiling_id

integer

Unique accumulation ID

transactions

array

Information about completed transactions participating in the accumulation (one or more) is transmitted.

List of transactions:

directionstring

Transaction direction. Possible value:

  • ingoing - deposit 
  • outgoing - withdrawal 

created_datetime

string

Transaction date

access_keystring

The access key is specified in the settings of the personal account of the TS Paykassma

additional_dataarray

Transaction data


activated_datetime

string

Transaction activation date


exchanger_identifierstringUnique User's account identifier which a transaction request came from

commentstringComment

Name

Type

Description

amount

double

Transaction amount

currency_code

string

Transaction currency code

wallet_typestringPayment system in which the transaction was made

amountstringTransaction amount

currency_codestring
or “null”Name of the manual payment system. Filled in only when you specify wallet_type = “manual”.
Transaction currency code


stockpiling_id

integer

Unique postback ID


transaction_id

string

Unique transaction ID in Paykassma


transaction_type

integer

Transaction type: 0 = automatic, 1 = debug

, 2 = forced


plugin_custom_order_id

from

string
or “null”

Unique transaction ID

of

in the

user's account from which the payment was received (if any information is available)

created_datetime

string

Transaction creation date

activated_datetime

string

Transaction activation date

custom_id

string or “null”

Transmitting the transaction ID received from the Client from the plugin to the Client's system.
Attention: It may be "null" if the custom_transaction_id parameter was not passed earlier.

client's system


withdrawal_id

string

Unique withdrawal ID


withdrawal_status

integer

Available withdrawal statuses:

  • Processed = 1
  • Rejected = 5


account_number

string

Recipient’s account number


account_name

string

Recipient name


account_email

string

Recipient email


bank_details

object




bank_code

string

Unique ID assigned by the central bank of the country



branch_code

string

Bank branch code

Code Block
themeDJango
titleExample of a postback sent by a POST request in JSON formatdeposit postback
{
      "signature":"signature",
      "accesswallet_keytype":"mrOYReXJphqo7lkL"//
   "signature":"dfsfrwe3344d",
   "paytm_api",
      "amount": 13629,
      "currency_code": "INR",
      "label":1
   "Stockpiling":{
      "USD":80,
      "INR":6008.39,
      "EUR":72.86
       },
   "stockpiling_id":18,
   "transactions":[
      {
         "amount":6008.39,
        "6424468",
      "converted_amount": {
           "USD":40.43,"INR":3327,"EUR":40.98,"IDR":625650.25,"MYR":190.71,"VND":988191.07,"SGD":57.43,
           "THB":1539,"NGN":17640.29,"TRY":751.48,"AED":148.51,"CAD":55.52,"AUD":64,"BDT":4276.41,"AFN":3531.25,
           "ALL":4807.24,"AMD":16333.46,"AOA":18109.34,"ARS":6179.09,"AWG":72.88,"AZN":68.73,"BAM":80.49,"BBD":80.86,
       "BGN":80.2,"BHD":15.24,"BIF":83303.64,"BMD":40.43,"BND":57.44,"BOB":279.23,"BRL":211.91,"BSD":40.43,"BTC":0.00209234 
           },
       "direction":"ingoing",
       "created_datetime":"2023-06-30 10:59:24",
       "access_key":"access_key",
       "additional_data": [ {
              "activated_datetime":"2023-06-30 13:59:24",
              "exchanger_identifier":"97489343",
              "comment":"",
              "amount":"13628.5",
              "currency_code":"INR",
                      "wallet_type":"paytm_api",
                      "codestockpiling_id":null262402,
                     "transaction_id":"15160028076535305",
                      "transaction_type":10,
         "from":85XXXX1369,
         "created_datetime":"2019-12-18 23:28:45",
         "activated_datetime":"2019-12-18 23:28:45",
         "custom_id":"3123123"
      }
 ]
}

< Home

Withdrawal

Client-side signature generation

Each postback is signed by signature, it is formed as follows:
              "plugin_custom_order_id":"6424468",
              "withdrawal_id":null,
              "withdrawal_status":null,
              "account_number":"",
              "account_name":"",
              "account_email":"",
              "bank_details": {
                     "bank_code":"",
                     "branch_code":"" 
              }
       } 
       {...}
       ]
}
Code Block
themeDJango
titleSignature
$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));
}

Postback of transactions for withdrawal

There are two types of postbacks:
  1. When a client makes a request
  2. When, for technical reasons, the request was created by Paykassma Technical Support

First type:

Requst body:

Name

Type

Description

withdrawal_id

integer

Unique ID withdrawals

status

integer

Available withdrawal statuses:
Processed = 1
Rejected = 5

description

string

Comment, comes with html tags
Code Block
themeDJango
titleExample of a postback sent by a POST request in JSON format
{
	"withdrawal_id":3479370,
	"status": 1,
	"description":"<p>123<\/p>"
}

Second type:

Requst body:

Name

Type

Description

status

integer

Available withdrawal statuses:

New = 0
Canceled = 2
Processed = 1

description

string

Comment, comes with html tags

withdrawal_id

integer

Unique ID withdrawals

wallet_type

string

Payment system type

wallet_recepient

string

Recipient's wallet number

label

string

The unique identifier for the user on the client's system, passed in the label parameter when composing the URL in the iframe

amount

double

Withdrawal amount. Has 2 decimal places for all currencies and 8 digits for cryptocurrencies

currency_code

string

Transaction currency code
Example of withdrawal postback
{
      "signature":"fcb57aabb9a7f46cd27f1b4249aeb9912bd49300",
      "wallet_type":"nagad_api",
      "amount":820,
      "currency_code":"BDT",
      "label":"autotest898404792700response_500",
      "converted_amount":
        {
          "USD":7.56,"INR":620,"IDR":113212.08,"MYR":34.39,"VND":178667.64,"SGD":10,
          "THB":257.14,"NGN":5947.67,"TRY":203.5,"AED":27.75,"CAD":9.93,"AUD":11.07,"BDT":820,"AFN":647.27,
          "ALL":681.27,"AMD":2946.58,"AOA":6231.79,"ARS":2025.9,"AWG":13.62,"AZN":12.84,"BAM":13.17,"BBD":15.11,
          "BGN":13.17,"BHD":2.85,"BIF":21376.13,"BMD":7.56,"BND":10.02,"BOB":52.24,"BRL":36.2,"BSD":7.56,"BTC":0.00025009
         },
      "direction":"outgoing",
      "created_datetime":"2023-07-20 08:09:01",
      "access_key":"Neiwk12Mdk2pdi1Jdi",
      "additional_data":
       [
        {
          "activated_datetime":"",
          "exchanger_identifier":"",
          "comment":"autotest approve by file",
          "amount":"820",
          "currency_code":"BDT",
          "wallet_type":"nagad_api",
          "stockpiling_id":null,
          "transaction_id":"",
          "transaction_type":null,
          "plugin_custom_order_id":"",
          "withdrawal_id":"autotest984047927037",
          "withdrawal_status":1,
          "account_number":"5632221204",
          "account_name":"autotest983948600573",
          "account_email":"",
          "bank_details":
            {
               "bank_code":null,
               "branch_code":null
             }
        }
       ]
}

Receiving information about the postback that was sent earlier

The system allows you to request information about the postback for input or output that was sent earlier. See here for details

Code Block
themeDJango
titleExample of a postback sent by a POST request in JSON format
{ "status": 1, "description": "<p>123<\/p>", "withdrawal_id": 3479370, "wallet_type": "IMPS", "wallet_recipient": "123", "label": "123", "amount": 1000, "currency_code": "INR" }


< Home

Table of Contents
minLevel2