# 2、Create payment out
Proxy payment order PIX
Used for merchants to initiate PIX payment requests, the system will execute the transfer to the recipient's account.
Request method
- POST
Request URL
Either of the following two URLs can be used (with consistent functionality):
/api/v3/mex/createTransferOrder
- Content-Type:
Content-Type: application/json; charset=utf-8
Header Parameters(Header)
Param | Type | Description | Sample |
---|---|---|---|
access_key | String | Access key obtained from the merchant backend | pFqV75X3 |
timestamp | int64 | Unix timestamp in milliseconds (13-digit) | 1679724896223 |
nonce | String | UUID v4 random string | 794c26b0-d33c-4394-b2bb-c485eca16d9e |
sign | String | Signature calculated through signature algorithm | kAXyh+eerqrefyaF8dyFB0M4FVo= |
All parameters need to be sent in the header. Please refer to the data signature specification for signature generation
Example of requesting body data
{
"currencyAmount": "40.11",
"channelType": "BANK",
"externalOrderId": "20250604152811292579",
"accountName": "AN GENGYU",
"accountId": "646180000030056845",
"bankName": "BANXICO",
"accountType": "CLABE",
"certificatesId": "646180000030056845",
"notifyUrl": "https://tofficeapi.io/api/v1/api/test/testNotifySuccess"
}
Parameter description:
Suggestion: To improve the efficiency of proxy payment processing, it is recommended to pass in all of the following fields.
Param | Desc | Require | Sample |
---|---|---|---|
currencyAmount | String | Yes | Payment amount, up to two decimal places |
channelType | String | Yes | Payment type, possible value: BANK |
externalOrderId | String | Yes | Merchant order ID |
accountName | String | Yes | Bank account name |
accountId | String | Yes | Recipient account ID: 18 digits for CLABE, 16 digits for BANK_CARD |
bankName | String | Yes | Bank name |
accountType | String | Yes | Bank account type: CLABE or BANK_CARD |
notifyUrl | String | No | Callback URL after payment is completed (server-side) |
remark | String | No | Custom remark information from the merchant |
certificatesId | String | Yes | ID number |
Response Example
Response Header Type
Content-Type: application/json; charset=utf-8
Response Data (Success)
{
"code": "200",
"success": true,
"msg": "Success",
"msgEn": "SUCCESS",
"data": {
"orderId": "OCURRDRAW202506040728131749022093339HAMBIT-U0000000201299923",
"orderStatus": "Accepted",
"externalOrderId": "20250604152811292579",
"currencyType": "MXN"
}
}
Response Field Description
Param | Type | Desc |
---|---|---|
currencyType | String | Local currency type |
externalOrderId | String | Merchant order ID |
orderId | String | System order ID |
orderStatus | String | Order status, usually returns “Accepted”; subsequent status updates can be obtained via query/callback |