InstantTransfer
  1. PayStar API Documentation
InstantTransfer
  • PayStar API Documentation
    • Introduction
    • Authorization Bearer
    • Sandbox
    • Callbacks
    • Glossary
    • Dictionarys
      • Currencys
      • Telecom operators
      • Bank names
    • Deposit direct (Merch)
      • Create | Deposit order
      • Check status | Deposit order
    • Deposit reverse (Gateway)
      • Create | Reverse deposit order
      • Check status | Deposit order
    • Withdrawal direct (Merch)
      • Create | Withdrawal order
      • Check status | Withdrawal order
    • Balance
      • GET Merchant balance
  • Armax API
    • POST Armax Order
      POST
  • Butler API Bridge
    • Authorization Bearer
    • Withdrawal direct | PDO API Bridge
      • Check status | Withdrawal order
      • Create | Withdrawal Order
    • PSP Deposit Order
      • PSP Deposit Order
      • PSP Deposit Order status
    • Merch Deposit Order
      • Merch Deposit Order
      • Merch Deposit Order status
  • CoreFy API
    • Withdrawal Order
      POST
    • Payment Order
      POST
  • PayNetEasy API Bridg
    • Introduсtion
    • Autorization
    • Glossary
    • POST order
      POST
    • POST Status order
      POST
  1. PayStar API Documentation

Callbacks

INFO
In our system, we have implemented a callback function, and to set it up, we need to add the merchant's URL in merchan settings where the callbacks will be sent.
The callback can be sent in next cases:
when the order status changes.
when the order amount changes.
Callback will be a POST HTTP request to the address you have configured, depending on the status the order transitions to.
The request will include a "Signature" header by which you can verify the validity of the request. However, we still recommend making a request to check the status.

CallBack params#

POST {yourCallBackUrl}#

Body:
externald - order id in our system (string)
status - order status (string)
amount - order amount (number)
orderType - type of the order (string) It can accept values Deposit or Withdrawal
   {
     "externald": "e21ac743-9205-4a22-a634-bcd772ad770e",
     "status": "Processing",
     "amount": 100,
     "orderType": "Deposit" 
   }

Signature#

The request will include a Signature header, which you can use to verify that the request is valid. However, we still recommend making a status check request.

Step 1#

Retrieving Data for the Signature:
1.
Extract the values of externalId, status, amount and orderType from the request.
2.
Use your privateKey to construct the signature string in the following format: externald;status;amount;orderType;privatekey

Step 2#

Calculating the Signature:
1.
Apply SHA-256 hashing to the string obtained in Step 1.
2.
Convert the hash result to a hexadecimal string.

Step 3#

Verifying the Signature:
1.
Extract the Signature header from the request.
2.
Repeat steps 1 and 2 to obtain the expected signature.
3.
Compare the received signature with the expected one. If they match, the request signature is valid.

Examples of validation#

JavaScript#

Python#

C Sharp#

Modified at 2024-12-13 10:06:37
Previous
Sandbox
Next
Glossary
Built with