createPayout
POST
: /amsin/api/v1/business/fund/createPayout
集成商可调用本接口向蚂蚁国际生态产品之外的账户进行转账结汇(比如转账到银行卡、支付宝账户或支付宝钱包)。
接口结构
万里汇接口报文结构包括:请求头,请求体。
请求头
字段名 | 是否必传 | 范例 | 说明 |
Client-Id | 是 |
| 关于这些参数的解释说明,详见:请求头 |
Signature | 是 |
| |
Content-Type | 是 |
| |
Request-Time | 是 |
| |
Connected-CustomerId | 否(有条件) |
| 当平台客户操作商户账户时需要传递 |
请求参数
字段名 | 数据类型 | 是否必传 | 描述 |
transferRequestId | 字符串 | 是 | 由集成商定义的唯一转账到卡识别ID。 更多信息:
|
transferFromDetail | 是 | 支付方需要支付的转账到卡金额 | |
transferToDetail | 是 | 转账到卡细节,包括收款方可收到的金额等。 | |
businessSceneCode | String | 有使用条件 | 转账到卡业务类型码。当 transferToDetail.transferToAmount.currency = 可取值如下:
|
transferOrderAddition | 否 | 转账到卡的更多信息,包括支付方和收款方的信息等。 |
响应参数
字段名 | 数据类型 | 是否必传 | 描述 |
result | Result 对象 | 是 | 代表API调用结果 |
说明:以下字段,只有当 | |||
transferRequestId | 字符串 | 是 | 由集成商定义的唯一转账到卡识别ID。 更多信息:
|
transferId | 字符串 | 是 | 由万里汇定义的转账到卡识别ID 更多信息:
|
transferFromDetail | 是 | 支付方需要支付的转账到卡金额 | |
transferToDetail | 是 | 转账到卡细节,包括收款方可收到的金额等。 | |
transferOrderAddition | 否 | 转账到卡的更多信息,包括支付方和收款方的信息等。 |
响应处理
集成商调用接口后,万里汇返回集成商API调用结果。result.resultStatus
字段取值范围为:
result.resultStatus | 描述 |
S | API请求成功。
|
F | API请求失败。 失败原因参见结果码(即 |
U | API响应结果为 |
结果码
result.resultCode
系统结果码
resultCode | resultStatus | resultMessage | 处理建议 |
PROCESSING | S | The transfer is in process. | 转账代发请求已创建,处理中。 |
PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | 参考API文档页面,确认请求头和传参是否正确 |
PROCESS_FAIL | F | A general business failure occurred. Do not retry. | 需要人工介入,联系万里汇技术支持以解决此问题 |
UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | 服务器错误,若稍后重试问题依旧,联系万里汇技术支持以解决问题 |
REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | 重试,若问题依旧,联系万里汇技术支持 |
INVALID_API | F | The called API is invalid or not active. | 确认是否调用正确的API |
INVALID_CLIENT | F | The client is invalid. | Client ID不存在或无效 |
INVALID_SIGNATURE | F | The signature is invalid. | 确认请求正确加签 |
METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | 确认HTTP请求方法为 |
业务结果码
resultCode | resultStatus | resultMessage | Further action |
UN_SUPPORT_BUSINESS | F | Unsupported business. | 包含无效参数(如货币代码错误),使用正确的参数重试 |
ORDER_NOT_EXIST | F | The order does not exist. | 订单不存在,重新下单 |
USER_NO_PERMISSION | F | User does not have permission. | 使用其他用户信息重试 |
CURRENCY_NOT_SUPPORT | F | The currency is not supported. | 确认币种信息正确后重试 |
USER_NOT_EXIST | F | The user does not exist. | 使用正确的用户信息重试 |
USER_ACCOUNT_ABNORMAL | F | The user account status is abnormal. | 使用其他用户信息重试。如问题依旧,看戏万里汇技术支持 |
REPEAT_REQ_INCONSISTENT | F | Repeated requests are inconsistent. | 确认请求中所有参数一致重试 |
USER_STATUS_ABNORMAL | F | The status of the user is abnormal. Retry with another card. | 使用其他用户信息重试 |
BALANCE_NOT_ENOUGH | F | Balance is not enough. | 确认余额充足后重试 |
AMOUNT_EXCEED_LIMIT | F | The amount exceeds the limit. | 确认提交的金额是正确的后重试 |
CONTRACT_NOT_EXIST | F | Contract does not exist. | 确认集成商已签约、且输入的签约信息正确后重试 |
CONTRACT_CHECK_FAIL | F | The contract check has failed. | 和万里汇技术支持确认合约的状态 |
QUOTE_EXPIRED | F | The quote is expired. | 调用 createQuote 接口创建一个新的报价。使用新的报价重试。 |
AVAILABLE_QUOTA_NOT_ENOUGH | F | Payout quota is not enough. | 调用inquiryAvailableQuota接口查询目前可用的结汇额度,确保额度充足后重试。 |
示例
请求体
{
"transferRequestId":"outBiz_903548903459278420062333",
"transferFromDetail":{
"transferFromAmount":{
"currency":"USD",
"value":100
}
},
"businessSceneCode":"THIRD_PARTY_PAYOUT",
"transferToDetail":{
"transferQuote":{
"quoteId":"20230419C575757009"
},
"transferToMethod":{
"paymentMethodMetaData":{
"bankLocalName":"xxxxxxxxx",
"bankCountryCode":"CN",
"bankAccountLocalName":"xxxxx",
"beneficiaryType":"THIRD_PARTY_PERSONAL_BANK_ACCOUNT",
"bankAccountNo":"xxxxxxxxx"
},
"paymentMethodType":"BANK_ACCOUNT_DETAIL"
},
"purposeCode":"GDS",
"transferToAmount":{
"currency":"CNY",
"value":0
},
"transferNotifyUrl":"www.test.com/api/transfer/notify"
}
}
响应体
{
"result":{
"resultStatus":"S",
"resultCode":"PROCESSING",
"resultMessage":"request is processing.
},
"transferFromDetail":{
"transferFromAmount":{
"currency":"USD",
"value":100
},
"transferFromMethod":{
"customerId":"2120120009881770",
"paymentMethodType":"BALANCE"
}
},
"transferId":"2023041919121000110770000001002",
"transferOrderAddition":{
},
"transferRequestId":"outBiz_903548903459278420062333",
"transferToDetail":{
"feeAmount":{
"currency":"USD",
"value":0
},
"purposeCode":"GDS",
"transferQuote":{
"quoteCurrencyPair":"USD/CNY",
"quoteExpiryTime":"2023-04-19T13:11:10Z",
"quoteId":"20230419C575757009",
"quotePrice":"6.89269099",
"quoteStartTime":"2023-04-19T13:08:56Z"
},
"transferToAmount":{
"currency":"CNY",
"value":689
},
"transferToMethod":{
"paymentMethodId":"2023041919027700120770254104460",
"paymentMethodType":"BANK_ACCOUNT_DETAIL"
}
}
}