跳转到主要内容
GET
Retrieve Account

授权

x-auth-token
string
header
必填

由 UQPAY 提供的登录 API Token。

路径参数

id
string<uuid>
必填

资源的全局唯一标识符(UUID v4)。

示例:

"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"

查询参数

business_code
enum<string>

业务类型代码。默认为 BANKING。

可用选项:
BANKING,
ACQUIRING,
ISSUING

响应

200 - application/json

OK——成功获取账户详细信息。

有关该公司或企业的信息。

account_id
string

账户的唯一标识符。

示例:

"f5bb6498-552e-40a5-b14b-616aa04ac1c1"

short_reference_id
string

账户的短引用 ID。

示例:

"P220406-LLCVLRM"

business_code
enum<string>[]

该账户的业务类型。

可用选项:
BANKING,
ACQUIRING,
ISSUING,
RAMP
示例:
email
string<email>

账户的电子邮箱地址。

Maximum string length: 100
示例:

"example@company.com"

account_name
string

该账户的客户名称。

示例:

"UQPAY PTE LTD."

country
string

两位字母国家/地区代码 ISO 3166-1 alpha-2

Maximum string length: 2
示例:

"US"

status
string

账户的状态。为以下之一:

  • ACTIVE - 账户已激活。
  • PROCESSING - 账户当前正在审核和处理中。
  • INACTIVE - 账户暂时未激活
  • CLOSED - 账户已关闭。
示例:

"PROCESSING"

verification_status
enum<string>

KYC/KYB 的状态。为以下之一:

  • REJECT - 账户在身份验证过程中被拒绝。
  • APPROVED - 账户已通过验证且处于激活状态。
  • PENDING - 账户当前正在进行身份验证。
  • EXPIRED - 验证已过期。
  • RETURN - 账户已被退回以进行身份验证,需要重新上传。

Webhook 说明:accountStatus webhook 通知中,这两个状态 分别以 REJECTEDRETURNED 下发(而非 REJECT / RETURN)。 其他所有值均相同。参见 账户状态 webhook

可用选项:
APPROVED,
PENDING,
REJECT,
EXPIRED,
RETURN
示例:

"APPROVED"

entity_type
enum<string>

账户类型。 此字段为必填,且必须是以下之一:

  • COMPANY - 为从事商业活动而设立的实体。
  • INDIVIDUAL - 来自业务场景的单一个人。目前仅适用于 Banking。
可用选项:
COMPANY,
INDIVIDUAL
review_reason
string

账户审核未通过时提供的原因。

示例:

"The account is not compliant with the company's policies."

contact_details
object
business_details
object

该账户的企业信息。

registration_address
object

公司的注册地址。

business_address
object[]

公司的经营地址。

representatives
object[]

有关该公司代表人的信息。

documents
object[]

用于确认公司身份的文件。

tos_acceptance
object

有关该账户接受 UQPAY 服务协议的详细信息。此属性仅可针对 Custom 账户更新。