Create a deposit order

Payment method code

Code	Description
bank	bank_account (online)
store	convenience store
va	Va repayment

store Convenience store

Name
7-ELEVEN
Soriana
Circulo K / Tiendas Extra
Bodega Aurrera
Walmart
Sam's Club
Walmart express
Kiosko
Calimax
CITY CLUB
Farmacia la más barata
Farmacia Roma
Super del norte
SMB Rural
Caja Cerano
Caja Morelia Valladolid
Caja Oblatos
Vía servicios

Limit information

	Deposit amount rules
Deposit channel	Minimum single transaction	Maximum single transaction
CASHIER	10	1,000,00
VA	10	1,000,00
STORE	10	1,000,00

Request

Header Params

X-API-KEY

string

required

The public key applied by the merchant backend

Example:

02106af2a085fbfc6d1bb49f485205fcdfcc79a4ddb1913c72a271fedd24c2d7fe

X-API-NONCE

string

required

System timestamp accurate to milliseconds

Example:

1702279880267

X-API-SIGNATURE

string

required

signature

Example:

304502207a4a88a5b0def29b9dbbf8563112d090c0e0b793ff6a5c57fe9d4fd1254d8ecf022100ff63c279f5926069fa1d161598e8d3249cb90e9d728e88e514352cdae6feff72

Body Params application/json

amount

string

Amount

required

body

string | null

Product description

optional

currency

string

Currency

required

Fixed to MXN

customerAccountNumber

string | null

User bank card

optional

customerContact

string | null

User mobile phone

optional

customerEmail

string

User email

required

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

subject

string

Product title

optional

wayCode

string

Payment method code

required

CASHIER-Cashier mode Non-CASHIER-Reference collection method code

Example

{
    "amount": "string",
    "body": "string",
    "currency": "string",
    "customerAccountNumber": "string",
    "customerContact": "string",
    "customerEmail": "string",
    "customerName": "string",
    "mchNo": "string",
    "mchOrderNo": "string",
    "notifyUrl": "string",
    "returnUrl": "string",
    "subject": "string",
    "wayCode": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

body

string

Product Description

required

countryCode

string

Country Code

required

currency

string

Currency

required

Fixed as MXN

customerContact

string

User Phone Number

required

mchOrderNo

string

Merchant Order Number

required

orderState

integer

Order Status

required

payDataType

string

Payment Mode

required

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

payOrderId

string

Payment Platform Order Number

required

payUrl

string

Cashier Desk Address

required

In the cashier desk order mode, return this link to the front - end

payWays

object

required

subject

string

Product Title

required

payData

string

Payment Data

required

When it is a merchant self - built cashier desk, the returned data is payment information, and the merchant can build a cashier desk according to the payment information

msg

string

Response Description

required

sign

string

required

Examples

Checkout success exampleVA Success ExampleStore Success Example

{
    "code": 0,
    "data": {
        "amount": "100",
        "body": "Test",
        "countryCode": "mx",
        "currency": "MXN",
        "customerContact": "13116709877",
        "mchOrderNo": "MXG92420230300602",
        "orderState": 0,
        "payDataType": "payurl",
        "payOrderId": "P1742796436918980610",
        "payUrl": "https://payment.tpservice.pro/#/order/mx/P1742796436918980610",
        "payWays": {
            "va": [
                {
                    "countryCode": "mx",
                    "createdAt": 0,
                    "id": 75,
                    "payWay": "va",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/ee9eae3d-b189-4e13-820e-9229d77f1bad.png",
                    "payWayType": "va",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                }
            ],
            "store": [
                {
                    "countryCode": "mx",
                    "createdAt": 0,
                    "id": 74,
                    "payWay": "store",
                    "payWayLogo": "https://tarspay.oss-ap-southeast-1.aliyuncs.com/tarspay_v_1.0/cbdb026d-83f7-428d-a11d-4222b050957f.png",
                    "payWayType": "store",
                    "skipMode": 1,
                    "state": 1,
                    "updatedAt": 0
                }
            ]
        },
        "subject": "buycar"
    },
    "msg": "SUCCESS",
    "sign": "3046022100ec39249c5a698d6a28edbbb1940ea664d3d9c127148da26b8fa083571d860386022100bf318403b22339db3b91f0b18900b345cfb561e461c8f7822852e19c721895ee"
}

Create a deposit order

Payment method code#

store Convenience store#

Limit information#

Request

Request samples

Responses

Payment method code

store Convenience store

Limit information