代付业务代码

订单状态代码说明

代码	说明	可能的原因
ACCEPT	已提交	订单已创建，此状态不代表业务成功或失败
PENDING	处理中	订单处理中，此状态不代表业务成功或失败
SUCCESS	成功	业务成功
FAIL	失败	业务失败
REVERSED	退款	成功后退款

接口详情

DANGER

注意： 请求代付超时或未响应上述通用状态，不代表请求失败，可以通过查询接口判断订单是否创建

转账 API

INFO

用途：用于银行/钱包账户之间进行转账

请求URL：/payout

请求方式：POST

WARNING

手续费另计，不在代付金额内扣除

请求头参数

token - 参见基础信息 - 生成公共访问令牌(JWT TOKEN)
X-Timestamp - 参见基础信息 - 生成代付请求签名

请求体参数

参数	必选	类型	说明	示例
clientId	是	String	商户订单号	3548947916558
currency	是	String	货币	INR
payMethod	是	String	支付方式，固定值104001	104001
name	是	String	用户姓名	auog
phone	是	String	用户手机号	8541236971
email	是	String	用户邮箱	845623@21cn.com
amount	是	Number	订单金额	100
callbackUrl	是	String	回调地址	http://callback.com （*请联系我们添加，且参数中传递的回调地址必须和后台添加的一致，否则会拉单失败*）
signature	是	String	签名信息	xxxx
indiaBank	是	Object	账户信息
- accountNo	是	String	收款账号	01415659
- ifsc	是	String	收款银行IFSC编码，11位	12345678951

代付方式编码

编码	名称
104001	BANK

请求示例

json

{
  "clientId": "3548947916558",
  "currency": "INR",
  "amount": 100,
  "payMethod": "104001",
  "name": "auog",
  "phone": "8541236971",
  "email": "845623@21cn.com",
  "callbackUrl": "http://callback.com",
  "indiaBank": {
    "accountNo": "01415659",
    "ifsc": "12345678951"
  },
  "signature": "I3SA71LbT5+h8rvB1d4/MdJj9xlfpk9ZuezvBn4zfzq9jvlb+vqkovZOYwad4AQ0wzXsR8X5rmtpXW/hIW0oUSvodDiDTJMpLG7D2b40dkQ7kX3RSIvVUHRxBM+YmfxxyWdGXirwv85L4r5NLZNO58OptXSCeeLy809aZkwQSsBO0aGVRiSKXRHa1r3gCizO569mAaos72S9w1olYRXQ0JvlmzpvDv/QAHKukNe00T5NpuEfedn4HOvGCoXujelgSq7A/QJ47+7PMFlUowVVYJ1lD7YeItuDsNQnFCS/R8OfKv5NX/m9JiKMQdjPUZuIodwf4PrhPnx3eDn/nhBe7w=="
}

响应参数

参数	类型	说明	示例
clientId	String	商户订单号	3548947916558
orderId	String	平台订单号	CO20250126160147520182
currency	String	货币	INR
payMethod	String	支付方式	104001
amount	Number	订单金额，保留2位小数	100.00
serviceFee	Number	手续费，保留2位小数（若有值）	15.00
status	String	订单状态	ACCEPT
statusReason	String	失败原因，有固定值，如下： LOW_BALANCE、INVALID_IFSC、INVALID_ACCOUNT、INVALID_PARAM、LIMIT_EXCEEDED

响应内容

json

{
  "clientId": "3548947916558",
  "orderId": "CO20250126160147520182",
  "amount": 100.00,
  "currency": "INR",
  "payMethod": "104001",
  "serviceFee": 15.00,
  "status": "ACCEPT",
  "statusReason": null
}

TIP

订单是否成功依靠订单状态代码来判断，也可以通过查询状态API查询业务当前处理状态。

异步回调通知 API

INFO

用途：用于代付完成后平台发送通知给商户

请求URL：商户在接口传入的callbackUrl

请求方式：POST

DANGER

注意：

接收异步通知后，需响应 SUCCESS 字符串，不包含引号，不是 JSON 格式

平台发送参数

参数	类型	说明	示例
clientId	String	商户订单号	2371666556
orderId	String	平台订单号	CI123891203982
amount	Number	订单金额，保留2位小数	100.00
serviceFee	Number	手续费，保留2位小数（若有值）	15.00
status	String	订单状态	SUCCESS
statusReason	String	失败原因	INVALID_ACCOUNT
payReference	String	UTR(支付凭证)	xxxxxx
sign	String	签名	5f4dcc3b5aa765d61d8327deb882cf99

平台发送给商户的数据示例

json

{
  "clientId": "2371666556",
  "orderId": "CI123891203982",
  "amount": 100.00,
  "status": "SUCCESS",
  "serviceFee": 15.00,
  "statusReason": null,
  "sign": "5f4dcc3b5aa765d61d8327deb882cf99"
}

交易查询 API

INFO

用途：通过商户订单号查询订单状态

请求URL：/payout/{currency}/merchant/{clientId}/status

请求方式：GET

请求参数

参数	必选	类型	说明	示例
currency	是	String	固定值，INR	INR
clientId	是	String	商户订单号	2371666556

响应参数

参数	类型	说明	示例
clientId	int	商户订单号	2371666556
orderId	String	平台订单号	CI123891203982
status	String	订单状态	PENDING
amount	String	订单金额，保留2位小数	200.00
serviceFee	Long	手续费，保留2位小数（若有值）	15.00
currency	String	货币	INR
createTime	String	创建时间	2025-01-05 15:36:37
completeTime	String	完成时间	null
statusReason	String	失败原因	null
payReference	String	支付凭证(UTR)	515625108475

响应示例

json

{
  "clientId": "2371666556",
  "orderId": "CI123891203982",
  "amount": 100.00,
  "serviceFee": 15.00,
  "currency": "INR",
  "status": "PENDING",
  "createTime": "2025-01-05 15:36:37",
  "completeTime": null,
  "statusReason": null,
  "payReference": "515625108475"
}

余额查询 API

INFO

用途：用于查询商户账户余额

请求URL：/balance/merchant/{currency}

请求方式：GET

请求参数

无

响应参数

参数	类型	说明	示例
currency	String	货币，固定值INR	INR
settlement	Number	待结算金额，保留2位小数	100.00
available	Number	可用金额，保留2位小数	7600.00
freeze	Number	冻结金额，保留2位小数	0.00

响应示例

json

{
  "currency": "INR",
  "settlement": 100.00,
  "available": 7600.00,
  "freeze": 0.00
}

代付业务代码 ​

订单状态代码说明 ​

接口详情 ​

转账 API ​

请求头参数 ​

请求体参数 ​

代付方式编码 ​

请求示例 ​

响应参数 ​

响应内容 ​

异步回调通知 API ​

平台发送参数 ​

平台发送给商户的数据示例 ​

交易查询 API ​

请求参数 ​

响应参数 ​

响应示例 ​

余额查询 API ​

请求参数 ​

响应参数 ​

响应示例 ​

代付业务代码

订单状态代码说明

接口详情

转账 API

请求头参数

请求体参数

代付方式编码

请求示例

响应参数

响应内容

异步回调通知 API

平台发送参数

平台发送给商户的数据示例

交易查询 API

请求参数

响应参数

响应示例

余额查询 API

请求参数

响应参数

响应示例