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

# Beneficiaries



## OpenAPI

````yaml openapi.json get /payout/beneficiaries
openapi: 3.0.0
info:
  title: Monieswitch API Reference
  version: 1.0.0
  description: ''
servers: []
security:
  - bearerAuth: []
paths:
  /payout/beneficiaries:
    parameters: []
    get:
      tags:
        - Payout
        - Beneficiary
      summary: Beneficiaries
      parameters:
        - name: page
          in: query
          required: false
          example: '1'
          schema:
            type: integer
        - name: perPage
          in: query
          required: false
          example: '20'
          schema:
            type: integer
      responses:
        '200':
          headers:
            Content-Security-Policy:
              schema:
                type: string
              example: >-
                default-src 'self';base-uri 'self';font-src 'self' https:
                data:;form-action 'self';frame-ancestors 'self';img-src 'self'
                data:;object-src 'none';script-src 'self';script-src-attr
                'none';style-src 'self' https:
                'unsafe-inline';upgrade-insecure-requests
            Cross-Origin-Opener-Policy:
              schema:
                type: string
              example: same-origin
            Cross-Origin-Resource-Policy:
              schema:
                type: string
              example: same-origin
            Origin-Agent-Cluster:
              schema:
                type: string
              example: '?1'
            Referrer-Policy:
              schema:
                type: string
              example: no-referrer
            Strict-Transport-Security:
              schema:
                type: string
              example: max-age=15552000; includeSubDomains
            X-Content-Type-Options:
              schema:
                type: string
              example: nosniff
            X-DNS-Prefetch-Control:
              schema:
                type: string
              example: 'off'
            X-Download-Options:
              schema:
                type: string
              example: noopen
            X-Frame-Options:
              schema:
                type: string
              example: SAMEORIGIN
            X-Permitted-Cross-Domain-Policies:
              schema:
                type: string
              example: none
            X-XSS-Protection:
              schema:
                type: integer
              example: '0'
            Access-Control-Allow-Origin:
              schema:
                type: string
              example: '*'
            Access-Control-Allow-Credentials:
              schema:
                type: boolean
              example: 'true'
            Content-Type:
              schema:
                type: string
              example: application/json; charset=utf-8
            Content-Length:
              schema:
                type: integer
              example: '289'
            ETag:
              schema:
                type: string
              example: W/"121-KMz8BXS2wVtC2hpWeS+Wx+pR0G0"
            Vary:
              schema:
                type: string
              example: Accept-Encoding
            Date:
              schema:
                type: string
              example: Fri, 24 Nov 2023 10:41:59 GMT
            Connection:
              schema:
                type: string
              example: keep-alive
            Keep-Alive:
              schema:
                type: string
              example: timeout=5
          description: Beneficiaries
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                  data:
                    type: object
                    properties:
                      beneficiaries:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            accountNumber:
                              type: string
                              format: utc-millisec
                            accountName:
                              type: string
                            bankCode:
                              type: string
                              format: color
                            bankName:
                              type: string
                            createdAt:
                              type: string
                              format: date-time
                      page:
                        type: integer
                      perpage:
                        type: integer
                      totalRecords:
                        type: integer
                      totalPages:
                        type: integer
              example:
                status: true
                data:
                  beneficiaries:
                    - id: e5b931f2-9aa9-4f80-8c59-591cbca756bb
                      accountNumber: '2394934323'
                      accountName: Obagunwa Emmanuel
                      bankCode: '000013'
                      bankName: GTBANK PLC
                      createdAt: '2023-11-24T10:41:46.890Z'
                  page: 1
                  perpage: 100
                  totalRecords: 1
                  totalPages: 1
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````