> ## Documentation Index
> Fetch the complete documentation index at: https://developers.uqpay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 预检出款

> 检查已保存的受益人、金额、手续费、余额及渠道可用性，不创建出款。Mastercard 有效期会再次校验。结果不预留资金，也不保证后续创建成功。



## OpenAPI

````yaml /zh/global-account/v1.6/banking.yaml get /v1/payouts/validation
openapi: 3.0.2
info:
  title: Banking API
  version: 0.0.1
  x-source-en-commit: 46d1ca2
  x-source-en-path: global-account/v1.6/banking.yaml
  description: |
    UQPAY Banking API 为全球资金流转提供完整的银行与支付解决方案。

    ## 核心功能
    - 国际支付与转账
    - 多币种账户管理
    - 实时换汇
    - 虚拟账户服务
    - 资金充值与提现

    ## 认证
    调用 UQPAY API 时，使用 API 密钥对客户端请求进行认证。
    API 密钥是用于认证用户身份、授予特权操作访问权限的唯一数据字符串。
    请始终对 API 密钥保密并妥善保管。

    ## 服务组件
    - **Payout**：创建并管理向受益人发起的国际资金转账
    - **Payer**：管理发起付款并授权资金转账的实体
    - **Beneficiary**：管理收款方信息与银行信息
    - **Balance**：查看并管理多币种账户余额
    - **Deposit**：处理入账资金转账
    - **Virtual Accounts**：使用外币本地银行账户
    - **Conversion**：以有竞争力的汇率执行换汇

    ## 快速开始
    1. 获取 API 凭证
    2. 使用 sandbox URL 搭建测试环境
    3. 接入认证
    4. 从基础操作开始

    ## 支持
    如需技术支持与集成协助，请联系 UQPAY 支持团队。
  contact:
    name: UQPAY Support
    url: https://www.uqpay.com/support
    email: banking.tech@uqpay.com
  license:
    name: Proprietary
    url: https://www.uqpay.com/legal/api-terms
  termsOfService: https://www.uqpay.com/legal/terms
  x-api-id: banking-api-v1.6.0
  x-logo:
    url: https://uqpay.com/img/UQPAY_LogoAnimv2.gif
    backgroundColor: '#FFFFFF'
    altText: UQPAY Logo
  x-categories:
    - Banking
    - Payment Processing
    - Foreign Exchange
servers:
  - url: https://api-sandbox.uqpaytech.com/api
    description: Sandbox 基础 URL。
  - url: https://api.uqpay.com/api
    description: 生产环境基础 URL。
security: []
tags:
  - name: Balances
    description: 查看并管理账户中不同币种的可用资金。
  - name: Transfers
    description: 钱包转账资源用于将资金从你的 UQPAY 账户直接转入关联账户。
  - name: Deposits
    description: 充值是指向你的 UQPAY 全球收款账户发起的银行转账，用于补充资金或从第三方收款。
  - name: Virtual Accounts
    description: 虚拟账户是以外币形式存在的本地银行账户。它们支持全球收款，提供可从各类平台收款的账户信息。虚拟账户也可用于为 UQPAY 余额充值。
  - name: Payout
    description: >-
      当你向受益人发起付款时会创建一个 Payout
      资源。它记录受益人、银行信息、付款金额、状态及其他相关信息。你可以使用直接填写的受益人信息，或使用先前创建的受益人 ID 来创建 payout。
  - name: Beneficiaries
    description: 受益人是资金的收款方，通常也是最终从 payout 中获益的一方。
  - name: Conversion
    description: 管理交易的换汇与汇率。
  - name: Exchange Rates
    description: 获取指定货币对或全部可用货币对的实时汇率。
  - name: Global Accounts
    description: ⚠️ 警告 此 API 版本已弃用。已弃用的 API 版本最终将不再受支持。全球收款账户是充当本地银行账户的外币账户。
  - name: Simulator
    description: 在 sandbox 环境中模拟充值交易。
paths:
  /v1/payouts/validation:
    get:
      tags:
        - Payouts
      summary: 预检出款
      description: 检查已保存的受益人、金额、手续费、余额及渠道可用性，不创建出款。Mastercard 有效期会再次校验。结果不预留资金，也不保证后续创建成功。
      operationId: validate-payout
      parameters:
        - $ref: '#/components/parameters/XOnBehalfOf'
        - name: beneficiary_id
          in: query
          required: true
          schema:
            type: string
        - name: currency
          in: query
          required: true
          schema:
            type: string
        - name: amount
          in: query
          required: true
          schema:
            type: string
        - name: fee_paid_by
          in: query
          required: true
          schema:
            type: string
            enum:
              - OURS
              - SHARED
      responses:
        '200':
          description: 出款预检结果。
          content:
            application/json:
              schema:
                type: object
                properties:
                  currency:
                    type: string
                  amount:
                    type: string
                  fee_amount:
                    type: string
                  total_amount:
                    type: string
                  channel_code:
                    type: string
                    description: 服务端选择的渠道，不是创建出款请求参数。
                  sufficient_funds:
                    type: boolean
                  beneficiary_valid:
                    type: boolean
              examples:
                sandbox:
                  summary: Sandbox Mastercard preflight
                  value:
                    currency: USD
                    amount: '1'
                    fee_amount: '5'
                    total_amount: '6'
                    channel_code: MASTERCARD_20260306
                    sufficient_funds: true
                    beneficiary_valid: true
        '400':
          description: 请求不合法或不满足出款前提。产品或费率配置异常可能返回 validation failed，其他错误具有各自的消息。
      security:
        - XAuthToken: []
      servers:
        - url: https://api-sandbox.uqpaytech.com/api
          description: Sandbox
components:
  parameters:
    XOnBehalfOf:
      in: header
      name: x-on-behalf-of
      schema:
        type: string
      required: false
      description: >
        指定代表哪个子账户发起请求。应设为
        `account_id`，可通过[查询关联账户列表](/zh/account-center/v1.6/api-reference/list-connected-accounts-1)获取。如果省略或留空，请求将使用主账户执行。

        更多信息参见[关联账户](/zh/account-center/v1.6/guide/connected-accounts)。
      example: 18523f72-f4de-4f9c-bb8e-ec7d1c4f32be
  securitySchemes:
    XAuthToken:
      type: apiKey
      in: header
      name: x-auth-token
      description: 由 UQPAY 提供的登录 API Token。

````