Create a deposit order

	Deposit amount rules
Deposit channel	Minimum single transaction	Maximum single transaction
EWALLET	30	10,000

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

signature

Example:

304502203968d3ce6a4c275816fbf71feee790ca4dfb192df71d49e10d6314368470bf79022100b9cacaf8df3fd302bd408b2f0e75c9a54069b3994748b6a31aac1dd3928ff0a6

Body Params application/json

amount

string

Amount

required

currency

string

Currency

required

Fixed EGP

customerAccountNumber

string | null

User bank card

optional

customerContact

string

User mobile phone

required

Wallet id, starting with 01, and is 11 pure digits

customerEmail

string | null

User email

optional

customerName

string

User name

required

mchNo

string

Merchant number

required

mchOrderNo

string

Merchant order number

required

notifyUrl

string

Result notification address

required

returnUrl

string | null

Cashier return page

optional

wayCode

string

Payment method code

required

Payment method (fixed to: CASHIER)

attach

string | null

User id

optional

If this field is passed in, the next time the same user comes in, the user's Vodafone wallet id will be automatically filled in (this field is currently deprecated)

Example

{
    "amount": "100",
    "currency": "EGP",
    "customerAccountNumber": "123456789",
    "customerContact": "01011111111",
    "customerEmail": "xiaohua661085@126.com",
    "customerName": "G D W",
    "mchNo": "M1688443982",
    "mchOrderNo": "AJ56820230300926",
    "notifyUrl": "http://47.241.33.220:8896/tarspay/notify",
    "returnUrl": "https://merchant-test.tarspay.com/#/",
    "wayCode": "CASHIER"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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": "EGP",
    "customerAccountNumber": "123456789",
    "customerContact": "01011111111",
    "customerEmail": "xiaohua661085@126.com",
    "customerName": "G D W",
    "mchNo": "M1688443982",
    "mchOrderNo": "AJ56820230300926",
    "notifyUrl": "http://47.241.33.220:8896/tarspay/notify",
    "returnUrl": "https://merchant-test.tarspay.com/#/",
    "wayCode": "CASHIER"
}'

Responses

🟢200成功

application/json

Body

code

integer

Response Code

required

0 - Success, Non - 0 - Failure

data

object

Response Data

required

amount

string

Order Amount

required

countryCode

string

Country Code

required

currency

string

Currency

required

Fixed as EGP

customerContact

string

User Phone Number

required

mchOrderNo

string

Merchant Order Number

required

orderState

integer

Order Status

required

payDataType

string

Payment Mode

required

payurl - Cashier, Non - payurl - Merchant Self - built Cashier

payData

string

Payment Data

required

payOrderId

string

Payment Platform Order Number

required

payUrl

string

Cashier Address

required

For cashier order placement mode, return this link to the front - end

payWays

object

required

msg

string

Response Description

required

sign

string

required

Example

{
    "code": 0,
    "data": {
        "amount": "100",
        "countryCode": "eg",
        "currency": "EGP",
        "customerContact": "01011111111",
        "mchOrderNo": "AJ56820230300926",
        "orderState": 0,
        "payDataType": "payurl",
        "payOrderId": "P1742378977238810625",
        "payUrl": "https://payment-test.tarspay.com/#/order/common/eg/P1742378977238810625",
        "payWays": {
            "sim": [
                {
                    "countryCode": "eg",
                    "createdAt": 0,
                    "id": 60,
                    "payWay": "SIM",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/SIM-danamon-vector-logo.png",
                    "payWayType": "sim",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                }
            ]
        }
    },
    "msg": "SUCCESS",
    "sign": "3046022100e84f6794f4f91eb26fc719b30e43f5f666ba1d6b2592eda097662eaf371eccbc022100f5cf108b8d21d9cf38581790ff411a4539d7fec9af698dacad76497e3bc7d989"
}

Create a deposit order

Limit information#

Request

Request samples

Responses

Limit information