# Retrieve a beneficiary

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/beneficiaries/{beneficiary_id}:
    get:
      summary: Retrieve a beneficiary
      deprecated: false
      description: ''
      tags:
        - API Reference/Payouts/Beneficiary
      parameters:
        - name: beneficiary_id
          in: path
          description: ''
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
        - name: Content-Type
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Beneficiary'
          headers: {}
          x-apifox-name: OK
      security:
        - basic: []
      x-apifox-folder: API Reference/Payouts/Beneficiary
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/1296482/apis/api-90777814-run
components:
  schemas:
    Beneficiary:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the object, "bn_xxxxx".
        object:
          type: string
          description: '"beneficiary"'
        created:
          type: integer
          description: >-
            The time at which the object was created. Measured in seconds since
            the Unix epoch.
        destination_data:
          type: object
          properties:
            destination_type:
              type: string
              description: Payment method
              enum:
                - bank_account
                - card
                - carrier_billing
                - alipay
              x-apifox-enum:
                - value: bank_account
                  name: ''
                  description: ''
                - value: card
                  name: ''
                  description: ''
                - value: carrier_billing
                  name: ''
                  description: ''
                - value: alipay
                  name: ''
                  description: ''
            bank_account:
              description: Condtional requried
              type: object
              x-apifox-refs: {}
              x-apifox-orders:
                - account_number
                - iban
                - account_holder_name
                - account_holder_type
                - phone_number
                - email
                - country
                - swift
                - dob
                - gender
                - certificate
                - bank_name
                - metadata
                - routing_number
                - routing_type
                - description
              properties:
                account_number:
                  type: string
                  description: The number of the bank account
                iban:
                  type: string
                  description: >-
                    International bank account number, mostly for european
                    countries
                account_holder_name:
                  type: string
                  description: >-
                    The name of the person or business that owns the bank
                    account. If the account holder is Chinese, this field should
                    be in Chinese characters.
                account_holder_type:
                  type: string
                  description: >-
                    The type of entity that holds the account. This can be
                    either individual or company.
                  enum:
                    - individual
                    - company
                  x-apifox-enum:
                    - value: individual
                      name: ''
                      description: ''
                    - value: company
                      name: ''
                      description: ''
                phone_number:
                  type: string
                  description: >-
                    The phone number of the beneficiary. The format of phone
                    number should be like regioncode-phonenumber. e.g.1-123456.
                email:
                  type: string
                  description: The email of the beneficiary
                country:
                  type: string
                  description: >-
                    Two-letter ISO code representing the country the bank
                    account is located in.
                swift:
                  type: string
                  description: The swift code of this bank account.
                dob:
                  type: object
                  properties:
                    day:
                      type: string
                      description: The day of birth, between 1 and 31.
                    month:
                      type: string
                      description: The month of birth, between 1 and 12.
                    year:
                      type: string
                      description: The four-digit year of birth.
                  x-apifox-orders:
                    - day
                    - month
                    - year
                  required:
                    - day
                    - month
                    - year
                  description: >-
                    When the beneficiary is a person, the person’s date of
                    birth.
                  x-apifox-ignore-properties: []
                gender:
                  type: string
                  description: >-
                    The person’s gender (International regulations require
                    either “male” or “female”).
                  enum:
                    - male
                    - female
                  x-apifox-enum:
                    - value: male
                      name: ''
                      description: ''
                    - value: female
                      name: ''
                      description: ''
                certificate:
                  type: object
                  properties:
                    certificate_type:
                      type: string
                      enum:
                        - id_card
                        - national_id
                        - driving_license
                        - social_security
                        - tax_id
                        - resident_card
                        - alien_registration
                        - employer_id
                      x-apifox-enum:
                        - value: id_card
                          name: ''
                          description: ''
                        - value: national_id
                          name: ''
                          description: ''
                        - value: driving_license
                          name: ''
                          description: ''
                        - value: social_security
                          name: ''
                          description: ''
                        - value: tax_id
                          name: ''
                          description: ''
                        - value: resident_card
                          name: ''
                          description: ''
                        - value: alien_registration
                          name: ''
                          description: ''
                        - value: employer_id
                          name: ''
                          description: ''
                    certificate_number:
                      type: string
                  x-apifox-orders:
                    - certificate_type
                    - certificate_number
                  description: Condtional requried
                  x-apifox-ignore-properties: []
                bank_name:
                  type: string
                  description: Name of the bank associated with the routing number
                metadata:
                  type: object
                  properties: {}
                  description: Set of key-value pairs that you can attach to an object.
                  x-apifox-orders: []
                  x-apifox-ignore-properties: []
                routing_number:
                  type: string
                  description: The routing transit number for the bank account.
                routing_type:
                  type: string
                  description: The routing transit type for the bank account.
                  enum:
                    - aba
                    - sort_code
                    - cc
                    - bsb
                    - zengin
                    - biller_code
                  x-apifox-enum:
                    - value: aba
                      name: ''
                      description: ''
                    - value: sort_code
                      name: ''
                      description: ''
                    - value: cc
                      name: ''
                      description: ''
                    - value: bsb
                      name: ''
                      description: ''
                    - value: zengin
                      name: ''
                      description: ''
                    - value: biller_code
                      name: ''
                      description: ''
                description:
                  type: string
                  description: >-
                    It can be used as a merchant order number or a transfer
                    note.
              required:
                - account_number
                - account_holder_name
                - account_holder_type
                - phone_number
                - country
                - swift
              x-apifox-ignore-properties: []
            card:
              description: Condtional requried
              type: object
              x-apifox-refs: {}
              x-apifox-orders:
                - name
                - number
                - description
                - billing_address
                - metadata
              properties:
                name:
                  type: string
                  description: Cardholder name.
                number:
                  type: string
                  description: Card number
                description:
                  type: string
                  description: >-
                    Condtional requried. It can be used as a merchant order
                    number or a transfer note.
                billing_address:
                  type: object
                  x-apifox-refs:
                    01JCYZV2FZ407X0Q0F4GGGV10R:
                      $ref: '#/components/schemas/Billing%20Details'
                      x-apifox-overrides:
                        name: null
                        phone: null
                        email: null
                  x-apifox-orders:
                    - 01JCYZV2FZ407X0Q0F4GGGV10R
                  properties:
                    address: &ref_0
                      $ref: '#/components/schemas/Address'
                  x-apifox-ignore-properties:
                    - address
                metadata:
                  type: object
                  properties: {}
                  x-apifox-orders: []
                  description: >-
                    Set of key-value pairs that you can attach to an object.
                    This can be useful for storing additional information about
                    the object in a structured format.
                  x-apifox-ignore-properties: []
              required:
                - name
                - number
              x-apifox-ignore-properties: []
            carrier_billing:
              type: object
              properties:
                carrier:
                  type: string
                  description: The telecom carrier of the mobile.
                  enum:
                    - megafon
                    - tmobile
                    - beeline
                    - mts
                    - tele2
                    - yota
                  x-apifox-enum:
                    - value: megafon
                      name: ''
                      description: Megafon
                    - value: tmobile
                      name: ''
                      description: T-Mobile
                    - value: beeline
                      name: ''
                      description: Beeline
                    - value: mts
                      name: ''
                      description: MTS
                    - value: tele2
                      name: ''
                      description: Tele2
                    - value: yota
                      name: ''
                      description: Yota
                phone_number:
                  type: string
                  description: >-
                    The format of phone number should be like
                    regioncode-phonenumber. e.g.86-123456.
                country:
                  type: string
                description:
                  type: string
                  description: >-
                    It can be used as a merchant order number or a transfer
                    note.
              x-apifox-orders:
                - carrier
                - phone_number
                - country
                - description
              description: Condtional requried
              required:
                - carrier
                - phone_number
                - country
              x-apifox-ignore-properties: []
            alipay:
              type: object
              properties:
                user_id:
                  type: string
                  description: >-
                    This is unique ID registered by beneficiary in Alipay+ with
                    a phone number or email address. The format of phone number
                    should be like regioncode-phonenumber. e.g.86-123456. 
                first_name:
                  type: string
                  description: The given name of a person. Only support Chinese Pinyin
                last_name:
                  type: string
                  description: >-
                    The surname or family name of a person. Only support Chinese
                    Pinyin
              x-apifox-orders:
                - user_id
                - first_name
                - last_name
              required:
                - user_id
                - first_name
                - last_name
              description: Condtional requried
              x-apifox-ignore-properties: []
            imps:
              type: object
              properties:
                account_number:
                  type: string
                  description: Account number of the beneficairy of IMPS
                phone_number:
                  type: string
                  description: >-
                    The phone number of the beneficiary. The format of phone
                    number should be like regioncode-phonenumber. e.g.1-123456.
                email:
                  type: string
                  description: The format of email. e.g.XXX@XXX.XXX
                name:
                  type: string
                  description: The full name of a person.
                bank_code:
                  type: string
                  description: >-
                    Bank code under the IFSC (Indian Financial System Code).

                    Format: fixed length of 11 characters, XXXX0XXXXXX –
                    consisting of 4 letters + 0 + 6 digits
              x-apifox-orders:
                - account_number
                - phone_number
                - email
                - name
                - bank_code
              required:
                - account_number
                - phone_number
                - email
                - name
                - bank_code
              description: Condtional requried
              x-apifox-ignore-properties: []
            upi:
              type: object
              properties:
                vpa:
                  type: string
                  description: Email ID of VPA（Virtual Payment Address）. e.g.XXX@XXX.XXX
                phone_number:
                  type: string
                  description: >-
                    The phone number of the beneficiary. The format of phone
                    number should be like regioncode-phonenumber. e.g.1-123456.
              x-apifox-orders:
                - vpa
                - phone_number
              description: Condtional requried
              required:
                - vpa
                - phone_number
              x-apifox-ignore-properties: []
            jazzcash:
              type: object
              properties:
                account_number:
                  type: string
                name:
                  type: string
                phone_number:
                  type: string
                email:
                  type: string
                dob:
                  type: string
                gender:
                  type: string
              x-apifox-orders:
                - account_number
                - name
                - phone_number
                - email
                - dob
                - gender
              description: Condtional requried
              x-apifox-ignore-properties: []
            easypaisa:
              type: object
              properties:
                account_number:
                  type: string
                name:
                  type: string
                phone_number:
                  type: string
                email:
                  type: string
                dob:
                  type: string
                gender:
                  type: string
                certificate:
                  type: object
                  properties:
                    certificate_type:
                      type: string
                      enum:
                        - cnic
                      x-apifox-enum:
                        - value: cnic
                          name: ''
                          description: ''
                    certificate_number:
                      type: string
                  x-apifox-orders:
                    - certificate_type
                    - certificate_number
                  x-apifox-ignore-properties: []
              x-apifox-orders:
                - account_number
                - name
                - phone_number
                - email
                - dob
                - gender
                - certificate
              description: Condtional requried
              x-apifox-ignore-properties: []
          x-apifox-orders:
            - destination_type
            - bank_account
            - card
            - carrier_billing
            - alipay
            - imps
            - upi
            - jazzcash
            - easypaisa
          description: >-
            Create a new card or bank account for payouts was sent to.
            Condtional requried, one of destination and destination is required.
          required:
            - destination_type
          x-apifox-ignore-properties: []
        nickname:
          type: string
          description: Nickname of beneficiary for quickly retrieving
        metadata:
          type: object
          properties: {}
          x-apifox-orders: []
          description: >-
            Set of key-value pairs attaching to an object. This can be a channel
            for customers that provides additional material about the
            beneficiary
          x-apifox-ignore-properties: []
        livemode:
          type: boolean
          description: >-
            Has the value true if the object exists in live mode or the value
            false if the object exists in test mode.
      x-apifox-orders:
        - id
        - object
        - created
        - destination_data
        - nickname
        - metadata
        - livemode
      required:
        - destination_data
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    Address:
      type: object
      properties:
        city:
          type: string
          description: City, district, suburb, town, or village.
        country:
          type: string
          description: Two-letter country code (ISO 3166-1 alpha-2 ).
        line1:
          type: string
          description: Address line 1 (e.g., street, PO Box, or company name).
        line2:
          type: string
          description: Address line 2 (e.g., apartment, suite, unit, or building).
        postal_code:
          type: string
          description: ZIP or postal code.
        state:
          type: string
          description: State, county, province, or region.
      x-apifox-orders:
        - city
        - country
        - line1
        - line2
        - postal_code
        - state
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    Billing Details:
      type: object
      properties:
        address: *ref_0
        email:
          type: string
          description: Email address.
        name:
          type: string
          description: 'Full name. '
        phone:
          type: string
          description: Billing phone number (including extension).
      x-apifox-orders:
        - address
        - email
        - name
        - phone
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
  securitySchemes:
    basic:
      type: http
      scheme: basic
servers:
  - url: https://apitest.wooshpay.com
    description: 官网测试
security:
  - basic: []

```