consultPayout

POST: /amsin/api/v1/business/fund/consultPayout

需要签名验签

集成商可调用本接口按所需场景查询转账相关信息。

接口结构

万里汇接口的报文结构包括:请求头、请求体、响应头和响应体。该章节主要介绍请求体和响应体的结构。关于请求头和响应头的更多信息,参见:

请求头

字段名

是否必传

范例

说明

Client-Id

Client-Id: *****

关于这些参数的解释说明,详见:请求头

Signature

Signature: algorithm=RSA256, keyVersion=2, signature=*****

Content-Type

Content-Type: application/json; charset=UTF-8

Request-Time

Request-Time: 2019-04-04T12:08:56+08:00

Connected-CustomerId

否(有条件)

Connected-CustomerId: *****

注意此header字段

当平台客户操作商户账户时需要传递

请求参数

字段名

数据类型

是否必传

描述

transferFromDetail

TransferFromDetail 对象

支付方需要支付的转账到卡金额

transferToDetail

TransferToDetail 对象

转账到卡细节,包括收款方可收到的金额等。

businessSceneCode

String

有使用条件

转账到卡业务类型码。当 transferToDetail.transferToAmount.currency = CNY 时,此字段为必填。

可取值如下:

  • THIRD_PARTY_PAYOUT:转账到第三方卡。第三方卡包括企业卡和个人卡。
  • SAME_NAME_PAYOUT:提现到同名卡。

响应参数

字段名

数据类型

是否必传

描述

result

Result 对象

代表API调用结果

说明:只有当 result.resultStatus = S 时,以下字段才会按需返回。

transferFromDetail

TransferFromDetail 对象

支付方需要支付的转账到卡金额

transferToDetail

TransferToDetail 对象

转账到卡细节,包括收款方可收到的金额等

availableQuota

Amount 对象

有使用条件

剩余可结汇额度。当 transferToDetail.transferToAmount.currency = CNY 时,此字段为必填。

响应处理

集成商调用接口后,万里汇通过 result.resultStatus 字段返回集成商 API 调用结果。此字段的取值范围如下:

result.resultStatus

描述

S

API请求成功。

F

API 请求失败。具体失败原因,参见结果码(即 result.resultCoderesult.resultMessage)。

U

API响应结果为UNKNOWN(未知)时,集成商可重试请求。

结果码

result.resultCode

系统结果码

resultCode

resultStatus

resultMessage

处理建议

SUCCESS

S

Success

UNKNOWN_EXCEPTION

U

API failed due to unknown reason.

服务器错误,若稍后重试问题依旧,联系万里汇技术支持以解决问题

REQUEST_TRAFFIC_EXCEED_LIMIT

U

The request traffic exceeds the limit.

重试,若问题依旧,联系万里汇技术支持

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.

需要人工介入,联系万里汇技术支持以解决此问题

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请求方法为POST

业务结果码

resultCode

resultStatus

resultMessage

处理建议

UN_SUPPORT_BUSINESS

F

Unsupported business.

包含无效参数(如货币代码错误),使用正确的参数重试

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.

使用其他用户信息重试。如问题依旧,看戏万里汇技术支持

USER_STATUS_ABNORMAL

F

The status of the user is abnormal. Retry with another card.

使用其他用户信息重试

CONTRACT_CHECK_FAIL

F

The contract check has failed.

检查合约状态后重试

示例

请求体

copy
{
  "transferFromDetail":{
    "transferFromAmount":{
      "currency":"USD",
      "value":100
    }
  },
  "businessSceneCode":"THIRD_PARTY_PAYOUT",
  "transferToDetail":{
    "transferToMethod":{
      "paymentMethodMetaData":{
        "bankLocalName":"xxxxxxxx",
        "bankCountryCode":"CN",
        "bankAccountLocalName":"xxxxxxx",
        "beneficiaryType":"THIRD_PARTY_PERSONAL_BANK_ACCOUNT",
        "bankAccountNo":"xxxxxxxxxxxx"
      },
      "paymentMethodType":"BANK_ACCOUNT_DETAIL"
    },
    "transferToAmount":{
      "currency":"CNY"
    }
  }
}

响应体

copy
{
  "result":{
    "resultStatus":"S",
    "resultCode":"SUCCESS",
    "resultMessage":"success."
  },
  "transferFromDetail":{
    "transferFromAmount":{
      "currency":"USD",
      "value":100
    },
    "transferFromMethod":{
      "customerId":"2120120009881770",
      "paymentMethodType":"BALANCE"
    }
  },
  "transferToDetail":{
    "feeAmount":{
      "currency":"USD",
      "value":0
    },
    "transferQuote":{
      "quoteCurrencyPair":"USD/CNY",
      "quoteExpiryTime":"2023-04-19T13:09:24Z",
      "quoteId":"20230419C575757009",
      "quotePrice":"6.89269099",
      "quoteStartTime":"2023-04-19T13:08:56Z"
    },
    "transferToAmount":{
      "currency":"CNY",
      "value":689
    },
    "transferToMethod":{
      "paymentMethodId":"2023041919027700120770254104460",
      "paymentMethodType":"BANK_ACCOUNT_DETAIL"
    }
  }
}

@2024 WorldFirst