TarsPay_EN
  1. deposit
TarsPay_EN
Bangladesh🇧🇩
  • Indonesia🇮🇩
  • India🇮🇳
  • Thailand🇹🇭
  • Philippines🇵🇭
  • Malaysia🇲🇾
  • Vietnam🇻🇳
  • Egypt🇪🇬
  • Bangladesh🇧🇩
  • Kenya🇰🇪
  • Pakistan🇵🇰
  • Brazil🇧🇷
  • Mexico🇲🇽
  • Ban_TEST
  • Access Guide
  • Core Business Process Description
  • Attachment Code Table
  • deposit
    • Create a deposit order
      POST
    • Query deposit order status
      POST
    • Query TrxId
      POST
    • Reprocess TrxId
      POST
  • withdraw
    • Create withdraw order
      POST
    • Query withdraw order
      POST
  • account
    • Query balance
      POST
  • CallBack
    • Callback notification interface (customized by the merchant)
      POST
  1. deposit

Create a deposit order

POST
/api/pay/unifiedOrder
deposit amount limit rules
wayCodeMinimum single transactionHighest single transactionDescription
EWALLET_BKASH10050,000bKash Agent
EWALLET_NAGAD10050,000Nagad Agent
EWALLET_BKASH_OFFICIAL5075,000Maintenance in progress, temporarily not supported

Request

Header Params
X-API-KEY
string 
required
The public key applied by the merchant backend
Example:
0221f85d6a09945403ef161b5200f4df152935a748ce2b9f291bb2d351d709b6a0
X-API-NONCE
string 
required
System timestamp accurate to milliseconds
Example:
1704250498993
X-API-SIGNATURE
string 
required
sign
Example:
304502203968d3ce6a4c275816fbf71feee790ca4dfb192df71d49e10d6314368470bf79022100b9cacaf8df3fd302bd408b2f0e75c9a54069b3994748b6a31aac1dd3928ff0a6
Body Params application/json
amount
string 
Amount
required
currency
string 
Currency type
required
BDT
customerContact
string  | null 
User mobile/wallet ID
optional
mchNo
string 
Merchant ID
required
mchOrderNo
string 
Merchant Order Number
required
notifyUrl
string 
Result notification address
required
returnUrl
string  | null 
Return to the previous page
optional
wayCode
string 
Payment method code
required
EWALLET_BKASH、EWALLET_NAGAD
Example
{
    "amount": "100",
    "currency": "BDT",
    "customerContact": "01011111111",
    "mchNo": "M1688443982",
    "mchOrderNo": "MJL8932024090200244",
    "notifyUrl": "http://47.241.33.220:8896/tarspay/notify",
    "returnUrl": "https://merchant-test.tarspay.com/#/",
    "wayCode": "EWALLET_BKASH"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/pay/unifiedOrder' \
--header 'X-API-KEY: 0221f85d6a09945403ef161b5200f4df152935a748ce2b9f291bb2d351d709b6a0' \
--header 'X-API-NONCE: 1704250498993' \
--header 'X-API-SIGNATURE: 304502203968d3ce6a4c275816fbf71feee790ca4dfb192df71d49e10d6314368470bf79022100b9cacaf8df3fd302bd408b2f0e75c9a54069b3994748b6a31aac1dd3928ff0a6' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": "100",
    "currency": "BDT",
    "customerContact": "01011111111",
    "mchNo": "M1688443982",
    "mchOrderNo": "MJL8932024090200244",
    "notifyUrl": "http://47.241.33.220:8896/tarspay/notify",
    "returnUrl": "https://merchant-test.tarspay.com/#/",
    "wayCode": "EWALLET_BKASH"
}'

Responses

🟢200成功
application/json
Body
code
integer 
Response Code
required
0-success others is failed
data
object 
Response data
required
amount
string 
Order amount
required
countryCode
string 
Country code
required
currency
string 
Currency type
required
BDT
customerContact
string 
Wallet ID
required
mchOrderNo
string 
Merchant Order Number
required
orderState
integer 
Order Status
required
payDataType
string 
Payment mode
required
payurl-Checkout Page non-payurl - Merchant-built Checkout Page
payData
string 
Payment data
required
payOrderId
string 
Payment Platform Order Number
required
payUrl
string 
Checkout Page Address
required
Return this link to the frontend.
payWays
object 
required
msg
string 
Response Description
required
sign
string 
required
Example
{
    "code": 0,
    "data": {
        "amount": "48888",
        "body": "Test",
        "countryCode": "bd",
        "currency": "BDT",
        "customerContact": "01011111111",
        "expiredTime": 1727258344,
        "mchOrderNo": "MJL79420240909000173",
        "orderState": 1,
        "payData": "01740026029",
        "payDataType": "payurl",
        "payOrderId": "P1838873343087747073",
        "payUrl": "https://checkout.tpservice.vip/#/pay/bd/EWALLET_BKASH/P1838873343087747073",
        "payWays": {
            "ewallet": [
                {
                    "countryCode": "bd",
                    "createdAt": 0,
                    "id": 105,
                    "payCode": "01740026029",
                    "payWay": "EWALLET_BKASH",
                    "payWayLogo": "https://defipay.oss-ap-southeast-1.aliyuncs.com/bKash.png",
                    "payWayType": "ewallet",
                    "skipMode": 2,
                    "state": 1,
                    "updatedAt": 0
                }
            ]
        },
        "requestUrl": "https://merchant.tarspay.com/#/",
        "subject": "buycar"
    },
    "msg": "SUCCESS",
    "sign": "3046022100feeaf6130bd3e66bd5b476a67bfbbda05fbe60b3f252385ce49e3f00aa34f905022100f237d98c7d5f32246a862746162f2c14a4b8d4fdc4692f038efdb7f1961b18f4"
}
Previous
Attachment Code Table
Next
Query deposit order status
Built with