跳转到主要内容
GET
Retrieve Payout

授权

x-auth-token
string
header
必填

由 UQPay 提供的登录 API Token。

请求头

x-on-behalf-of
string

指定代表哪个子账户发起请求。应设为 account_id,可通过查询关联账户列表获取。如果省略或留空,请求将使用主账户执行。 更多信息参见关联账户

路径参数

id
string<uuid>
必填

资源的通用唯一标识符(UUID v4)。

示例:

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

响应

200 - application/json

OK —— 成功获取 payout。

unique_request_id
string<uuid>
必填

通用唯一标识符(UUID v4)。客户端将在 POST 操作中使用该标识符来创建资源。

示例:

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

payout_id
string<uuid>
必填

该 payout 的唯一标识符。

示例:

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

amount_payer_pays
string
必填

付款人为该 payout 实际支付的金额。

示例:

"1000.00"

payout_currency
string
必填

受益人银行账户中持有资金的币种。三位字母 ISO 4217 币种代码。

Required string length: 3
示例:

"USD"

payout_amount
string
必填

付款人将汇出的金额,以 currency 计。

示例:

"1000.00"

purpose_code
string
必填

payout 的用途代码,必须为以下之一:

  • AUDIO_VISUAL_SERVICES - 视听服务。
  • BILL_PAYMENT - 账单支付。
  • BUSINESS_EXPENSES - 企业开支。
  • CONSTRUCTION - 建筑。
  • DONATION_CHARITABLE_CONTRIBUTION - 捐赠/慈善捐赠。
  • EDUCATION_TRAINING - 教育/培训。
  • FAMILY_SUPPORT - 家庭赡养。
  • FREIGHT - 运费。
  • GOODS_PURCHASED - 购买商品。
  • INVESTMENT_CAPITAL - 投资本金。
  • INVESTMENT_PROCEEDS - 投资收益。
  • LIVING_EXPENSES - 生活开支。
  • LOAN_CREDIT_REPAYMENT - 贷款/信贷还款。
  • MEDICAL_SERVICES - 医疗服务。
  • PENSION - 养老金。
  • PERSONAL_REMITTANCE - 个人汇款。
  • PROFESSIONAL_BUSINESS_SERVICES - 专业/商业服务。
  • REAL_ESTATE - 房地产。
  • TAXES - 税费。
  • TECHNICAL_SERVICES - 技术服务。
  • TRANSFER_TO_OWN_ACCOUNT - 转账至本人账户。
  • TRAVEL - 旅行。
  • WAGES_SALARY - 工资/薪酬。
示例:

"AUDIO_VISUAL_SERVICES"

source_currency
string
必填

付款人将汇出的币种。

Required string length: 3
示例:

"USD"

source_amount
string
必填

付款人为该 payout 支付的金额。

示例:

"1000.00"

amount_beneficiary_receives
string
必填

受益人收到的金额。

示例:

"1000.00"

fee_paid_by
enum<string>
必填

付款手续费的承担类型。仅在 payment_method = SWIFT 时生效并必填。

  • SHARED:交易手续费由付款人与收款方分担;付款人承担汇出行费用,收款方承担收款行费用。当付款人为企业且付款人所在国家/地区为 SG、VN、HK 或 AU 之一时,SWIFT payout 可使用此项。
  • OURS:所有交易手续费(含中间行费用)均由付款人承担。
可用选项:
SHARED,
OURS
示例:

"SHARED"

fee_currency
string
必填

用于支付手续费的币种。三位字母 ISO 4217 币种代码。

Required string length: 3
示例:

"USD"

fee_amount
string
必填

该 payout 的手续费金额。

示例:

"1.00"

payout_date
string<date>
必填

系统尝试向受益人提交付款的日期。

示例:

"2024-03-01"

short_reference_id
string
必填

系统生成的用于标识该 payout 的编号。

示例:

"P220406-LLCVLRM"

payout_reference
string
必填

显示在受益人银行交易记录中的银行付款附言。会发送给收款方(如 For Further Credit、For Benefit of 或自定义信息)。在控制台中亦称 Payment reference。

  • SWIFT 付款:必须符合正则 /^[a-zA-Z0-9/-?:().'+, ]+$/。 允许的字符:英文字母、数字、空格,以及以下特殊符号:- / ? : ( ) . ' + ,
  • LOCAL 付款:当 payment_method = LOCALaccount_currency_code 不是 CNH 或 SGD 时,不应用输入格式校验。
Maximum string length: 100
示例:

"026073150"

payout_reason
string
必填

该 payout 的自定义事由,将显示在受益人的银行交易记录中。

Maximum string length: 200
示例:

"Audiovisual services"

payout_status
enum<string>
必填

该 payout 的状态。

  • READY_TO_SEND:payout 已通过校验,准备处理。
  • PENDING:payout 正在由系统处理中。
  • REJECTED:payout 因未满足校验或合规要求而被拒绝。
  • FAILED:payout 处理过程中发生错误,无法完成。
  • COMPLETED:payout 已成功处理,资金已转出。
可用选项:
READY_TO_SEND,
PENDING,
REJECTED,
FAILED,
COMPLETED
create_time
string<date/time>
必填

该 payout 的创建时间。

示例:

"2024-03-01T00:00:00+08:00"

update_time
string<date/time>
必填

该 payout 的更新时间。

示例:

"2024-03-01T00:00:00+08:00"

complete_time
string<date/time>
必填

该 payout 的完成时间。

示例:

"2024-03-01T00:00:00+08:00"

payout_method
enum<string>
必填

需要指定支付方式,以确保针对该支付方式采集并校验准确的银行信息。

  • LOCAL:通过本地清算系统的境内支付网络处理的付款。
  • SWIFT:通过 SWIFT 网络处理的跨境国际付款。
可用选项:
LOCAL,
SWIFT
示例:

"LOCAL"

payer
object
必填

与该 payout 关联的付款人信息。

beneficiary
object
必填
failure_returned_amount
string

失败 payout 中待退回的金额。

示例:

"1000.00"

failure_reason
string

该 payout 失败的原因。

示例:

""

quote_id
string

预先创建的报价的 ID,通过创建报价获取。

仅在跨币种 payout 场景下需要。 如果提供,还必须同时提供 payout_currencypayout_amount

示例:

"784832f7-1f8a-4b08-ac2a-8719b5b2a590"

conversion
object

该 payout 的换汇详情。 仅在跨币种 payout 场景下需要。