TarsPay_EN
  1. withdraw
TarsPay_EN
Mexico🇲🇽
  • 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
  • withdraw
    • Create withdraw order
      POST
    • Query withdraw order
      POST
  • account
    • Query balance
      POST
  • CallBack
    • Callback notification interface (customized by the merchant)
      POST
  1. withdraw

Create withdraw order

POST
/api/payOut/unifiedOrder

withdraw code#

withdraw bank code#

bank codebank name
BANXICOBANXICO
BANCOMEXTBANCOMEXT
BANOBRASBANOBRAS
BANJERCITOBANJERCITO
NAFINNAFIN
BANSEFIBANSEFI
HIPOTECARIA FEDHIPOTECARIA FED
BANAMEXBANAMEX
SANTANDERSANTANDER
BBVA MEXICOBBVA MEXICO
HSBCHSBC
BAJIOBAJIO
INBURSAINBURSA
MIFELMIFEL
SCOTIABANKSCOTIABANK
BANREGIOBANREGIO
INVEXINVEX
BANSIBANSI
AFIRMEAFIRME
BANORTEBANORTE
BANK OF AMERICABANK OF AMERICA
MUFGMUFG
JP MORGANJP MORGAN
BMONEXBMONEX
VE POR MASVE POR MAS
CREDIT SUISSECREDIT SUISSE
AZTECAAZTECA
AUTOFINAUTOFIN
BARCLAYSBARCLAYS
COMPARTAMOSCOMPARTAMOS
MULTIVA BANCOMULTIVA BANCO
BANCOPPELBANCOPPEL
ABC CAPITALABC CAPITAL
CONSUBANCOCONSUBANCO
VOLKSWAGENVOLKSWAGEN
CIBANCOCIBANCO
BBASEBBASE
BANKAOOLBANKAOOL
PAGATODOPAGATODO
INMOBILIARIOINMOBILIARIO
DONDEDONDE
BANCREABANCREA
BANCO FINTERRABANCO FINTERRA
ICBCICBC
SABADELLSABADELL
SHINHANSHINHAN
MIZUHO BANKMIZUHO BANK
BANK OF CHINABANK OF CHINA
BANCO S3BANCO S3
MONEXCBMONEXCB
GBMGBM
MASARIMASARI
VALUEVALUE
VECTORVECTOR
MULTIVA CBOLSAMULTIVA CBOLSA
FINAMEXFINAMEX
VALMEXVALMEX
PROFUTUROPROFUTURO
CB INTERCAMCB INTERCAM
CI BOLSACI BOLSA
FINCOMUNFINCOMUN
NU MEXICONU MEXICO
REFORMAREFORMA
STPSTP
EVERCOREEVERCORE
CREDICAPITALCREDICAPITAL
KUSPITKUSPIT
UNAGRAUNAGRA
ASP INTEGRA OPCASP INTEGRA OPC
LIBERTADLIBERTAD
CAJA POP MEXICACAJA POP MEXICA
CRISTOBAL COLONCRISTOBAL COLON
CAJA TELEFONISTCAJA TELEFONIST
TACTIV CBTACTIV CB
FONDO (FIRA)FONDO (FIRA)
INVERCAPINVERCAP
FOMPEDFOMPED
NVIONVIO
INDEVALINDEVAL
CoDi ValidaCoDi Valida
BBVA BANCOMER2BBVA BANCOMER2
SANTANDER2SANTANDER2
HSBC2HSBC2
AZTECA2AZTECA2
BANORTE2BANORTE2
ARCUSARCUS
NVIONVIO
BANAMEX2BANAMEX2

Limit information#

Withdraw amount rules
Withdraw channelMinimum single transactionMaximum single transaction
BANK101,000,000

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
mchNo
string 
Merchant number
required
mchOrderNo
string 
Merchant order number (guaranteed to be unique)
required
wayCode
string 
Payment code
required
currency
string 
Currency
required
Fixed to MXN
amount
string 
Amount
required
notifyUrl
string 
Result notification address
required
customerName
string 
User name
required
customerEmail
string 
User email
required
customerContact
string 
User's mobile phone
required
customerAccountNumber
string 
User's payment account
required
Bank card or wallet account
customerType
string 
Account type (DebitCard or Credit Card CLABE)
required
DebitCard or CLABE
Example
{
    "mchNo": "string",
    "mchOrderNo": "string",
    "wayCode": "string",
    "currency": "string",
    "amount": "string",
    "notifyUrl": "string",
    "customerName": "string",
    "customerEmail": "string",
    "customerContact": "string",
    "customerAccountNumber": "string",
    "customerType": "string"
}

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/payOut/unifiedOrder' \
--header 'X-API-KEY: 02106af2a085fbfc6d1bb49f485205fcdfcc79a4ddb1913c72a271fedd24c2d7fe' \
--header 'X-API-NONCE: 1702279880267' \
--header 'X-API-SIGNATURE: 304502207a4a88a5b0def29b9dbbf8563112d090c0e0b793ff6a5c57fe9d4fd1254d8ecf022100ff63c279f5926069fa1d161598e8d3249cb90e9d728e88e514352cdae6feff72' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mchNo": "string",
    "mchOrderNo": "string",
    "wayCode": "string",
    "currency": "string",
    "amount": "string",
    "notifyUrl": "string",
    "customerName": "string",
    "customerEmail": "string",
    "customerContact": "string",
    "customerAccountNumber": "string",
    "customerType": "string"
}'

Responses

🟢200成功
application/json
Body
code
integer 
required
data
object 
required
mchOrderNo
string 
Merchant order number
required
payOrderId
string 
Platform order number
required
msg
string 
required
Example
{
    "code": 0,
    "data": {
        "mchOrderNo": "M1655535407",
        "payOrderId": "P1551409540398772225"
    },
    "msg": "SUCCESS"
}
Previous
Query deposit order status
Next
Query withdraw order
Built with