WorldFirst DocsWorldFirst Docs

applyCard需要签名验签

POST /amsin/api/v2.1/business/worldcard/applyCard

当前文档对应最新 API 版本。若您的对接版本为 V1,请参考历史版本文档


集成商可调用此接口,向万里汇申请 World Card。

报文结构

万里汇接口报文结构包括:请求头、请求体、响应体。

请求头

字段名

是否必传

范例

说明

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-AccountId

否(有条件要求)

Connected-AccountId: *****

注意此字段

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

Access-Token

有条件要求

Access-Token: ******

注意此字段

当用 OAUTH 授权时需要传递。参考 applyToken


入参

requestId String  REQUIRED

针对本次申卡请求,由集成商指定的唯一请求号,用于幂等处理。

更多信息:

  • 此为幂等字段。具体详见幂等字段介绍。
  • 最大长度:32 字符

cardHolderId String  REQUIRED

由万里汇定义的持卡人 ID。

cardNickName String  

由用户定义的卡昵称,可以帮助用户更方便地管理多张 World Card。

更多信息:

  • 最大长度:120 字符

note String  

本次申请开卡的备注。

更多信息:

  • 最大长度:512 字符

authorizationControl Object  

授权控制规则。

Show child parameters

email String  REQUIRED

持卡人的电邮地址。将用于 3DS 身份验证。

更多信息:

  • 最大长度:32 字符

mobileNumber String  REQUIRED

持卡人的手机号。例如:+6512345678(其中 +65 是新加坡的国家代码)。这项信息将用于 3DS 身份验证。

更多信息:

  • 最大长度:32 字符

metadata Object  

业务相关详情。

billAddress Object  REQUIRED

账单地址。此字段只有当 result.resultStatus = S 时才会按需返回。

此字段只有当 result.resultStatus = S 时才会按需返回。

Show child parameters

出参

result Result  REQUIRED

代表 API 接口的调用结果。

Show child parameters

status String  REQUIRED

代表 World Card 的申请状态。取值范围为:SUCCESS(申请成功)、PROCESSING(已申请,受理中)、FAIL(申请失败)。

此字段只有当 result.resultStatus = ​S​ 时才会按需返回。

requestId String  REQUIRED

针对本次申卡请求,由集成商指定的唯一请求号。

此字段只有当 result.resultStatus = S 时才会按需返回。

更多信息:

  • 最大长度:32 字符

accountId String  REQUIRED

由万里汇定义,万里汇账户的唯一标识。

更多信息:

  • 最大长度:64 字符
API Explorer

请求

URL
请求体

响应

响应体

响应处理

集成商调用接口后,万里汇返回集成商API调用结果。result.resultStatus 取值范围为:

result.resultStatus

描述

S

API请求成功。

F

API请求失败。

失败原因参见结果码(即 result.resultCode 和 result.resultMessage

U

API响应结果为UNKNOWN(未知)时,需重试API请求。

重试策略:

  • 重试次数上限:7次
  • 重试时间间隔:5分钟、10分钟、20分钟、40分钟、80分钟、160分钟、320分钟

如果问题依旧,请联系万里汇技术支持。

result.resultCode:系统结果码

结果码结果码信息行动建议
SUCCESSSSuccess
PARAM_ILLEGALF存在非法参数。例如,输入了非数字或无效的日期。

参考 API 文档页面,确认请求头和传参是否正确。

SYSTEM_ERRORF系统错误。

请勿重试,联系万里汇技术支持了解详情。

SERVICE_NOT_ALLOWEDF服务不允许。

使用正确的信息重试,若问题依旧,联系万里汇技术支持以解决问题。

UNKNOWN_EXCEPTIONUAPI 因未知原因失败。

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

REQUEST_TRAFFIC_EXCEED_LIMITU请求流量超过限制。

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

OAUTH_FAILFOAuth 流程失败。

联系万里汇技术支持了解详情。

INVALID_APIF调用的 API 无效或未激活。

确认是否调用正确的 API。

INVALID_CLIENTF客户端无效。

Client ID 不存在或无效。

INVALID_SIGNATUREF签名无效。

确认请求正确加签。

METHOD_NOT_SUPPORTEDF服务器未实现请求的 HTTP 方法。

确认 HTTP 请求方法为 POST。

CONTRACT_CHECK_FAILF合约检查失败。

联系万里汇技术支持了解合约状态后重试。

result.resultCode:业务结果码

结果码结果码信息行动建议
REPEAT_REQUESTU重复请求。

更换 requestId 并重试调用此 API。

USER_NOT_EXISTF用户不存在。

使用正确的用户信息重试。

USER_INFORMATION_INCOMPLETEF用户的英文名信息不能为空。

用户信息不完整。请提供完整的用户信息并重试。如果再次调用失败,请联系技术支持团队。

CONTACT_ENTITY_ID_MATCH_MULTIPLEF匹配到多个 contactEntityId,需要输入指定的 contactEntityId。

匹配到多个 contactEntityId,需要输入指定的 contactEntityId,然后发起重试。

APPLY_CARD_NUMBER_LIMITF申卡数量已达上限。

请联系技术支持团队寻求帮助。

RISK_REJECTF因风控原因请求被拒绝。

请联系技术支持团队寻求帮助。

ACCESS_TOKEN_EXPIREDF访问令牌已过期。

刷新令牌以获取新的访问令牌,或联系技术支持团队解决。

AUTHORIZATION_NOT_EXISTF授权不存在。

确保输入正确。如果问题仍然存在,请联系技术支持团队核实授权状态。