# Beneficiary Details Query

> Query the profile details and review status of a single beneficiary.

```yaml
openapi: 3.1.0
info:
  title: Beneficiary Details Query
  version: 1.0.0
  description: Query the profile details and review status of a single beneficiary.
paths:
  /api/v1/beneficiary/queryDetail:
    post:
      summary: Beneficiary Details Query
      description: Query the profile details and review status of a single beneficiary.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                merchantNo:
                  type: string
                  description: Merchant number assigned by Onerway. Retrieve it from the merchant
                    portal or onboarding material after your sandbox or
                    production account is created.
                beneficiaryId:
                  type: string
                  description: Beneficiary ID returned by the create-beneficiary API.
                sign:
                  type: string
                  description: Request signature string. Generate it according to the Transfer
                    request-signing rules with your merchant private key.
              required:
                - merchantNo
                - beneficiaryId
                - sign
            examples:
              get-beneficiary-details:
                summary: Get beneficiary details request
                value:
                  beneficiaryId: "1984102812163112960"
                  merchantNo: 801129
                  sign: d2ea92efff636320122021f65b613201403f6d34334cfbc7e589ce9f842284u3
      responses:
        "200":
          description: Get beneficiary details response
          content:
            application/json:
              schema:
                type: object
                properties:
                  respCode:
                    type: string
                    description: Response code returned by Onerway.
                  respMsg:
                    type:
                      - string
                      - "null"
                    description: Response message returned by Onerway.
                    x-onerway-value:
                      nullable: true
                      when:
                        en: No response message is returned.
                        zh: 未返回响应信息时为 `null`。
                  data:
                    type: object
                    properties:
                      beneficiaryId:
                        type: string
                        description: Beneficiary ID.
                      createTime:
                        type: string
                        description: Creation time of the beneficiary record.
                      updateTime:
                        type: string
                        description: Last update time of the beneficiary record.
                      merchantRefId:
                        type: string
                        description: Merchant-side beneficiary reference ID.
                      merchantNo:
                        type: string
                        description: Merchant number.
                      nationality:
                        type:
                          - string
                          - "null"
                        description: Nationality of the beneficiary when provided.
                        x-onerway-value:
                          nullable: true
                      status:
                        type: string
                        description: Stored beneficiary status code.
                      remark:
                        type:
                          - string
                          - "null"
                        description: Additional review remark when available.
                        x-onerway-value:
                          nullable: true
                      payoutCurrency:
                        type: string
                        description: Payout currency configured for the beneficiary.
                      expireDate:
                        type:
                          - string
                          - "null"
                        description: Expiry date when the beneficiary record has one.
                        x-onerway-value:
                          nullable: true
                      bankName:
                        type:
                          - string
                          - "null"
                        description: Beneficiary bank name when applicable.
                        x-onerway-value:
                          nullable: true
                      accountName:
                        type:
                          - string
                          - "null"
                        description: Beneficiary account holder name.
                        x-onerway-value:
                          nullable: true
                      bankAddress:
                        type:
                          - string
                          - "null"
                        description: Beneficiary bank address when applicable.
                        x-onerway-value:
                          nullable: true
                      payeeStatus:
                        type: string
                        description: Beneficiary review status used before transfer submission.
                      accountBelong:
                        type: string
                        description: Account ownership type code.
                      bankCountry:
                        type: string
                        description: Bank country of the beneficiary account.
                      entityType:
                        type: string
                        description: Entity type of the beneficiary.
                      payeeAddress:
                        type: string
                        description: Beneficiary address summary.
                      paymentMethod:
                        type: string
                        description: Configured payout method for the beneficiary.
                      payeeCountry:
                        type: string
                        description: Country of the beneficiary.
                      receiverInfo:
                        type: string
                        description: Beneficiary identity information encoded as a JSON string.
                        contentMediaType: application/json
                        contentSchema:
                          type: object
                          properties:
                            nickName:
                              type: string
                              description: nickName field.
                            companyName:
                              type: string
                              description: companyName field.
                            lastName:
                              type: string
                              description: lastName field.
                            firstName:
                              type: string
                              description: firstName field.
                            areaCode:
                              type: string
                              description: areaCode field.
                            phone:
                              type: string
                              description: phone field.
                            vatNumber:
                              type: string
                              description: vatNumber field.
                            birthDate:
                              type: string
                              description: birthDate field.
                            email:
                              type: string
                              description: email field.
                            identityNumber:
                              type: string
                              description: identityNumber field.
                            identityType:
                              type: string
                              description: identityType field.
                        x-onerway-format: json_string
                      address:
                        type: string
                        description: Beneficiary address information encoded as a JSON string.
                        contentMediaType: application/json
                        contentSchema:
                          type: object
                          properties:
                            countryCode:
                              type: string
                              description: countryCode field.
                            state:
                              type: string
                              description: state field.
                            city:
                              type: string
                              description: city field.
                            townName:
                              type: string
                              description: townName field.
                            addressLine1:
                              type: string
                              description: addressLine1 field.
                            addressLine2:
                              type: string
                              description: addressLine2 field.
                            addressLine3:
                              type: string
                              description: addressLine3 field.
                            postalCode:
                              type: string
                              description: postalCode field.
                        x-onerway-format: json_string
                      accountInfomation:
                        type: string
                        description: Beneficiary account information encoded as a JSON string.
                        contentMediaType: application/json
                        contentSchema:
                          type: object
                          properties:
                            cardNumber:
                              type: string
                              description: cardNumber field.
                            accountType:
                              type: string
                              description: accountType field.
                            swiftCode:
                              type: string
                              description: swiftCode field.
                            sortCode:
                              type: string
                              description: sortCode field.
                            bankName:
                              type: string
                              description: bankName field.
                            branchCode:
                              type: string
                              description: branchCode field.
                            bankHolderName:
                              type: string
                              description: bankHolderName field.
                            walletType:
                              type: string
                              description: walletType field.
                            walletPhone:
                              type: string
                              description: walletPhone field.
                            pickUpBankName:
                              type: string
                              description: pickUpBankName field.
                            pickUpBankBranchName:
                              type: string
                              description: pickUpBankBranchName field.
                            pickUpBankBranchId:
                              type: string
                              description: pickUpBankBranchId field.
                            pickUpBankBranchAddress:
                              type: string
                              description: pickUpBankBranchAddress field.
                        x-onerway-format: json_string
                    description: Beneficiary detail record and review status.
              examples:
                beneficiary-details-returned:
                  summary: Get beneficiary details response
                  value:
                    respCode: "20000"
                    respMsg: null
                    data:
                      beneficiaryId: "1984102812163112960"
                      createTime: 2025-10-31 11:39:07
                      updateTime: 2025-10-31 11:48:49
                      merchantNo: "801129"
                      nationality: null
                      status: S
                      remark: null
                      payoutCurrency: PKR
                      expireDate: null
                      bankName: null
                      accountName: betaData testData
                      bankAddress: null
                      payeeStatus: unnecessary
                      accountBelong: "1"
                      bankCountry: PK
                      entityType: "1"
                      payeeAddress: testdsgddfs1233
                      paymentMethod: E_WALLET
                      payeeCountry: PK
                      receiverInfo: '{"nickName":"CyBetatestInvolidPKR3","companyName":"helloBoy","lastName":"testData","firstName":"betaData","areaCode":"+92","phone":"2313019452","vatNumber":"8859884832","birthDate":"1990-12-04","email":null,"identityNumber":null,"identityType":null}'
                      address: '{"countryCode":null,"state":"NY","city":"NY","townName":null,"addressLine1":"testdsgddfs1233","addressLine2":null,"addressLine3":null,"postalCode":"10005"}'
                      accountInfomation: '{"cardNumber":null,"accountType":"","swiftCode":null,"sortCode":null,"bankName":"MCB
                        BankLimited","branchCode":null,"bankHolderName":null,"walletType":"EASYPAISA","walletPhone":"03079770877","pickUpBankName":null,"pickUpBankBranchName":null,"pickUpBankBranchId":null,"pickUpBankBranchAddress":null}'
```
