# Get Global Account details

> Retrieve Global Account details by Global Account ID or account number.

```yaml
openapi: 3.1.0
info:
  title: Get Global Account details
  version: 1.0.0
  description: Retrieve Global Account details by Global Account ID or account number.
paths:
  /api/v1/account/global/getDetail:
    post:
      summary: Get Global Account details
      description: Retrieve Global Account details by Global Account ID or account number.
      parameters:
        - name: apikey
          in: header
          required: true
          description: Account service API key request header assigned by Onerway. Use the
            value for the same environment as the request base URL.
          schema:
            type: string
            description: Account service API key request header assigned by Onerway. Use the
              value for the same environment as the request base URL.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                requestId:
                  type: string
                  description: Request ID used for request tracing.
                globalAccountId:
                  type: string
                  description: Numeric Global Account ID, usually returned by the create endpoint.
                  x-onerway-required: conditional
                  x-onerway-condition:
                    - Required when `globalAccountNo` is not provided. If both
                      identifiers are provided, they must refer to the same
                      Global Account.
                globalAccountNo:
                  type: string
                  description: Global Account number. It can be used as a business identifier for
                    querying account details.
                  x-onerway-required: conditional
                  x-onerway-condition:
                    - Required when `globalAccountId` is not provided. If both
                      identifiers are provided, they must refer to the same
                      Global Account.
                onBehalfOf:
                  type: string
                  description: Child customer identifier when a platform merchant queries on
                    behalf of a child customer. The Global Account must belong
                    to this child customer and the caller must be authorized for
                    that customer.
            examples:
              query-global-account-by-id:
                summary: Query a Global Account by ID
                value:
                  requestId: REQ-GA-20260423-0002
                  globalAccountId: "1001"
      responses:
        "200":
          description: Global Account details
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Whether the Global Account detail query was processed successfully.
                      When this value is `false`, read `respCode` and `respMsg`
                      for the failure reason and do not rely on `data` as
                      account details.
                  respCode:
                    type: string
                    description: Business response code for Global Account APIs. The success
                      response code is `20000`.
                  respMsg:
                    type: string
                    description: Human-readable prompt or error message for the response code.
                  data:
                    type: object
                    properties:
                      globalAccountId:
                        type: string
                        description: Global Account ID.
                      globalAccountNo:
                        type: string
                        description: Global Account number.
                      globalAccountInfoId:
                        type:
                          - string
                          - "null"
                        description: Institution-side account information ID.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: May be empty for DBS. CLEARBANK and BANKING_CIRCLE usually return it after
                              successful creation. Do not rely on this field as
                              the primary query identifier for the Global
                              Account.
                            zh: DBS 机构可能为空；CLEARBANK、BANKING_CIRCLE 创建成功后通常返回。接入时不应依赖该字段作为 Global Account
                              的主查询标识。
                      globalAccountName:
                        type: string
                        description: Display name of the Global Account.
                      customerId:
                        type: string
                        description: Customer identifier.
                      customerName:
                        type: string
                        description: Customer name.
                      mainAccountNo:
                        type:
                          - string
                          - "null"
                        description: Associated main account number.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Returned when the account is associated with a main account. It may be empty
                              when no main account is associated.
                            zh: 账户关联主账户时返回；未关联时可能为空。
                      mainAccountName:
                        type:
                          - string
                          - "null"
                        description: Associated main account name.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Returned when the account is associated with a main account. It may be empty
                              when no main account is associated.
                            zh: 账户关联主账户时返回；未关联时可能为空。
                      iban:
                        type:
                          - string
                          - "null"
                        description: IBAN (International Bank Account Number).
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Depends on whether the associated MA information is filled in and whether
                              the institution returns it after successful
                              creation.
                            zh: 依赖关联 MA 信息是否填写，以及创建成功时机构是否返回；可能为空。
                      bankCode:
                        type:
                          - string
                          - "null"
                        description: Bank code.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Depends on whether the associated MA information is filled in and whether
                              the institution returns it after successful
                              creation.
                            zh: 依赖关联 MA 信息是否填写，以及创建成功时机构是否返回；可能为空。
                      swiftCode:
                        type:
                          - string
                          - "null"
                        description: SWIFT Code.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Depends on whether the associated MA information is filled in and whether
                              the institution returns it after successful
                              creation.
                            zh: 依赖关联 MA 信息是否填写，以及创建成功时机构是否返回；可能为空。
                      bankAddress:
                        type:
                          - string
                          - "null"
                        description: Bank address.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Depends on whether the associated MA information is filled in and whether
                              the institution returns it after successful
                              creation.
                            zh: 依赖关联 MA 信息是否填写，以及创建成功时机构是否返回；可能为空。
                      bankName:
                        type:
                          - string
                          - "null"
                        description: Bank name.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Depends on whether the associated MA information is filled in and whether
                              the institution returns it after successful
                              creation.
                            zh: 依赖关联 MA 信息是否填写，以及创建成功时机构是否返回；可能为空。
                      bankCountry:
                        type: string
                        description: Country or region code of the bank where the Global Account is
                          opened. Read it as a two-letter [ISO 3166-1
                          alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
                          code.
                      bizTypeList:
                        type: array
                        description: Business type entry supported by this Global Account.
                        items:
                          type: string
                          enum:
                            - COBO
                            - POBO
                          x-enum-descriptions:
                            COBO: Collection business, used for acquiring-side fund collection scenarios.
                            POBO: Payout business, used for payout and disbursement scenarios.
                      supportCurrencies:
                        type: array
                        description: Currency entry supported by this Global Account. Use three-letter
                          ISO 4217 currency codes.
                        items:
                          type: string
                      institution:
                        type:
                          - string
                          - "null"
                        description: Financial institution.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Usually returned after successful creation. It may be empty in other
                              lifecycle states.
                            zh: 创建成功时通常返回；其他生命周期状态下可能为空。
                      webhookUrl:
                        type:
                          - string
                          - "null"
                        description: Account-service notification URL.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Depends on whether the account-service notification URL is configured.
                            zh: 依赖账户服务通知 URL 是否已配置；可能为空。
                      operatingEntity:
                        type:
                          - string
                          - "null"
                        description: Operating entity.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Usually returned after successful creation. It may be empty in other
                              lifecycle states.
                            zh: 创建成功时通常返回；其他生命周期状态下可能为空。
                      status:
                        type: string
                        description: Lifecycle status of the Global Account. Use this field to determine
                          whether the account can enter subsequent fund
                          collection or payout flows.
                        enum:
                          - Processing
                          - Failed
                          - Active
                          - Suspended
                          - Supervised
                          - Deleted
                          - Closed
                        x-enum-descriptions:
                          Processing: The Global Account opening process is in progress.
                          Failed: The Global Account opening process failed.
                          Active: The Global Account is active and can enter subsequent fund collection or
                            payout flows.
                          Suspended: The Global Account is suspended.
                          Supervised: The Global Account is visible but currently not available for use.
                          Deleted: The Global Account has been logically deleted.
                          Closed: The Global Account is closed.
                      globalActiveTime:
                        type: string
                        description: Global Account activation time.
                      addressCity:
                        type: string
                        description: Bank city.
                      addressPostalCode:
                        type: string
                        description: Bank address postal code.
                      onBehalfOf:
                        type:
                          - string
                          - "null"
                        description: Child customer identifier echoed by Onerway.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Returned when the request was made on behalf of a child customer.
                            zh: 代子客户调用时返回。
                    description: Global Account details.
                  error:
                    type:
                      - object
                      - "null"
                    properties:
                      type:
                        type: string
                        description: Standardized error type.
                      code:
                        type: string
                        description: External business error code, usually aligned with `respCode`.
                      message:
                        type: string
                        description: Human-readable error message.
                      param:
                        type:
                          - string
                          - "null"
                        description: Request field that caused the error.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Returned when the error can be associated with a request field.
                            zh: 错误可关联到请求字段时返回。
                      requestId:
                        type:
                          - string
                          - "null"
                        description: Request ID used for troubleshooting.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Returned when the request ID is available in the failure context.
                            zh: 失败上下文中可取得请求 ID 时返回。
                    description: Structured error details returned by the Account service.
                    x-onerway-value:
                      nullable: true
                      when:
                        en: Returned when the Global Account request fails.
                        zh: Global Account 请求失败时返回。
              examples:
                query-global-account-by-id:
                  summary: Global Account details
                  value:
                    success: true
                    respCode: "20000"
                    respMsg: Success
                    data:
                      globalAccountId: "1001"
                      globalAccountNo: GA-DEMO-0001
                      globalAccountName: Acme USD Collection
                      customerId: CUS-EXAMPLE-001
                      customerName: Acme Ltd
                      mainAccountNo: MAIN-ACCOUNT-001
                      mainAccountName: Main Account
                      iban: GB29NWBK60161331926819
                      bankCode: NWBKGB2L
                      swiftCode: NWBKGB2LXXX
                      bankAddress: 1 Example Street
                      bankName: Example Bank
                      bankCountry: GB
                      bizTypeList:
                        - COBO
                        - POBO
                      supportCurrencies:
                        - USD
                        - EUR
                      institution: Example Institution
                      webhookUrl: https://merchant.example.com/hooks/account
                      operatingEntity: Example Entity
                      status: Active
                      globalActiveTime: 2026-04-23T06:31:18.266Z
                      addressCity: London
                      addressPostalCode: EC1A1BB
```
