注册

POST /v1/merchants/registration

使用此接口向 Antom 注册二级商户。

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息,有关报文头的结构信息,请参阅:

注意:将每个字段(除数组外)的数据类型设置为字符串。这意味字段值必须使用双引号(" ")括起来。例如:

  • 如果字段的数据类型为整数属性,且其值为 20,设置为 "20"。
  • 如果字段的数据类型为布尔属性,且其值为 true,设置为 "true"。

入参

registrationRequestId String  REQUIRED

用于识别注册请求的专属 ID。

更多信息:

  • 此为幂等字段。商户使用 registrationRequestId 字段进行幂等性控制。对于使用相同 registrationRequestId 值发起并达到最终状态(SF)的注册请求,应返回相同的请求结果。
  • 最大长度:64 字符

registrationNotifyURL URL  

商户提供的用以接收注册通知的链接。

更多信息:

  • 最大长度:2048 字符

passThroughInfo String  

仅用于站点透明数据传输的键值结构。

更多信息:

  • 最大长度:2048 字符

merchantInfo MerchantRegistrationInfo  REQUIRED

商户信息

Show child parameters

productCodes Array<String>  REQUIRED

产品代码。对于线下支付,此字段的有效值为IN_STORE_PAYMENT

storeInfo StoreRegistrationInfo  

商店信息

注意:此字段仅在 productCodes IN_STORE_PAYMENT时必需。如果没有传递 storeInfo ,将返回错误PARAM_ILLEGAL

Show child parameters

出参

result Result  REQUIRED

请求结果包含状态和错误代码等信息。

Show child parameters

passThroughInfo String  

仅用于站点透明数据传输的键值结构。

更多信息:

  • 最大长度:2048 字符
API Explorer

请求

URL
请求体

响应

响应体

更多信息

请参阅以下列表,了解主要参数的重要细节:

  • 对于二级商户注册请求,merchantIdreferanceMerchantId 必须全局唯一。如果重复注册,将返回错误 REPEAT_REGISTRATION
  • 如果字段的类型为枚举类,字段值必须在指定的枚举类的范围内。例如,attachmentTypecontactTyperegistrationTypebusinessTypeproductCodes 是枚举类型。如果传递的值不是枚举值中的一个,将返回错误 PARAM_ILLEGAL
  • 如果未传递必需字段,将返回错误 PARAM_ILLEGAL
  • 对于字符串类型的字段,如果参数长度超过指定的最大长度或小于最小长度,将返回错误 PARAM_ILLEGAL
  • websiteurl 必须是有效的 链接,否则将返回错误 PARAM_ILLEGAL
  • address 必须是 Google Maps 可识别的地址。
  • merchantInfo.registrationDetail.attachments.file 必须是可下载文件的链接。
  • merchantInfo.merchantMCC 的值,请参阅 MCC代码以获取详细信息。

结果/错误码

结果码结果码信息行动建议
SUCCESSS成功

注册成功,无需进一步操作。

INVALID_CLIENTF客户端无效。

请检查 clientId 是否正确。

MEDIA_TYPE_NOT_ACCEPTABLEF服务器不支持客户端可接受的媒体类型。

请检查媒体类型是否正确。

METHOD_NOT_SUPPORTEDF服务器不支持请求的 HTTP 方法。

请检查 HTTP 方法是否正确。

REPEAT_REQ_INCONSISTENTF重复请求不一致。

更改 registrationRequestId,然后再次调用接口。

REGISTRATION_UNDER_REVIEWF先前提交的注册正在审核中。不允许新的注册或修改。

提交的注册正在审核中。请等待最终结果。

REPEAT_REGISTRATIONF商户重复注册

请勿重复注册。