---
updatedAt: 2026-05-22T18:18:28.000Z
agentTools:
  projectIndex: https://docs.kyshi.co/llms.txt
---

# List VA beneficiaries

Returns your saved virtual-account payout beneficiaries.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/v1/va/transfer/beneficiaries": {
      "get": {
        "description": "Returns your saved virtual-account payout beneficiaries.",
        "operationId": "listVaTransferBeneficiaries",
        "parameters": [
          {
            "name": "page",
            "required": false,
            "in": "query",
            "description": "Page to retrieve. Defaults to 1.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "limit",
            "required": false,
            "in": "query",
            "description": "Records per page. Maximum 100.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "order",
            "required": false,
            "in": "query",
            "description": "Sort direction. Defaults to DESC.",
            "schema": {
              "type": "string",
              "enum": [
                "ASC",
                "DESC"
              ]
            }
          },
          {
            "name": "sort",
            "required": false,
            "in": "query",
            "description": "Field to sort by.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query",
            "required": false,
            "in": "query",
            "description": "Free-text search.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "accountNumber",
            "required": false,
            "in": "query",
            "description": "Filter by beneficiary account number.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/SuccessResponseDto"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/PublicBeneficiaryListDto"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Missing or invalid request parameter.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDto"
                }
              }
            }
          },
          "401": {
            "description": "No valid API key provided.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDto"
                }
              }
            }
          },
          "403": {
            "description": "The API key lacks permission for this request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDto"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found. A 404 on an object you just created is usually a test/live mode mismatch.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDto"
                }
              }
            }
          },
          "422": {
            "description": "Business rule failure, such as an unsupported currency or insufficient balance.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDto"
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong on Kyshi’s end.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDto"
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "summary": "List VA beneficiaries",
        "tags": [
          "VA Transfer"
        ],
        "x-readme": {
          "code-samples": [
            {
              "language": "typescript",
              "name": "Kyshi SDK",
              "code": "import { Kyshi } from '@kyshi/mor-sdk';\n\nconst kyshi = new Kyshi({ secretKey: process.env.KYSHI_SECRET_KEY! });\n\nconst result = await kyshi.virtualAccountTransfers.listBeneficiaries({\n  \"page\": 1,\n  \"limit\": 20\n});",
              "install": "npm install @kyshi/mor-sdk"
            },
            {
              "language": "curl",
              "code": "curl --request GET \\\n  --url 'https://api.kyshi.co/v1/va/transfer/beneficiaries' \\\n  --header 'x-api-key: YOUR_API_KEY' \\\n  --header 'Content-Type: application/json'"
            },
            {
              "language": "javascript",
              "name": "Node.js (fetch)",
              "code": "const response = await fetch('https://api.kyshi.co/v1/va/transfer/beneficiaries', {\n  method: 'GET',\n  headers: {\n    'x-api-key': process.env.KYSHI_API_KEY,\n    'Content-Type': 'application/json',\n  },\n});\n\nconst result = await response.json();"
            }
          ]
        }
      }
    }
  },
  "info": {
    "title": "Kyshi MoR Public API",
    "description": "Public API reference for Kyshi integrators.",
    "version": "1.0",
    "contact": {}
  },
  "tags": [
    {
      "name": "VA Transfer",
      "description": "Send NGN payouts from the virtual-account rail, including amounts above the provider limit."
    }
  ],
  "servers": [
    {
      "url": "https://api.kyshi.co",
      "description": "Production and Sandbox"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      }
    },
    "schemas": {
      "SuccessResponseDto": {
        "type": "object",
        "properties": {
          "status": {
            "type": "boolean",
            "example": true,
            "description": "`true` on success."
          },
          "message": {
            "type": "string",
            "example": "Success"
          },
          "code": {
            "type": "number",
            "example": 200,
            "description": "Mirrors the HTTP status code."
          },
          "data": {
            "type": "object",
            "example": {},
            "description": "The endpoint-specific payload."
          }
        },
        "required": [
          "status",
          "message",
          "code",
          "data"
        ]
      },
      "ErrorResponseDto": {
        "type": "object",
        "properties": {
          "status": {
            "type": "boolean",
            "example": false,
            "description": "`false` on failure."
          },
          "message": {
            "type": "string",
            "example": "Unsupported Merchant Currency",
            "description": "Human-readable summary. Log it, but do not branch on it: the wording can change."
          },
          "code": {
            "type": "number",
            "example": 422,
            "description": "Mirrors the HTTP status code."
          },
          "data": {
            "type": "object",
            "example": {},
            "description": "Always empty on failure."
          }
        },
        "required": [
          "status",
          "message",
          "code",
          "data"
        ]
      },
      "PublicTransferBeneficiaryDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "b6f6a56f-1e55-4fb0-a9d4-8fdd680fd0a1"
          },
          "accountName": {
            "type": "string",
            "example": "John Clam"
          },
          "accountNumber": {
            "type": "string",
            "example": "2250734567890"
          },
          "bankCode": {
            "type": "string",
            "example": "ORANGE_CIV"
          },
          "bankName": {
            "type": "string",
            "example": "Orange CIV"
          },
          "providerId": {
            "type": "string",
            "example": "ORANGE_CIV"
          },
          "description": {
            "type": "string",
            "example": "Primary mobile money beneficiary"
          },
          "isActive": {
            "type": "boolean",
            "example": true
          },
          "mode": {
            "type": "string",
            "enum": [
              "test",
              "live"
            ],
            "example": "test"
          },
          "createdAt": {
            "type": "string",
            "example": "2026-09-22T06:11:46.331Z"
          },
          "updatedAt": {
            "type": "string",
            "example": "2026-09-22T06:11:46.331Z"
          }
        },
        "required": [
          "id",
          "accountName",
          "accountNumber",
          "bankCode",
          "bankName",
          "isActive",
          "mode",
          "createdAt",
          "updatedAt"
        ]
      },
      "PublicBeneficiaryListDto": {
        "type": "object",
        "properties": {
          "page": {
            "type": "number",
            "example": 1
          },
          "limit": {
            "type": "number",
            "example": 20
          },
          "total": {
            "type": "number",
            "example": 12
          },
          "pageCount": {
            "type": "number",
            "example": 1
          },
          "hasPreviousPage": {
            "type": "boolean",
            "example": false
          },
          "hasNextPage": {
            "type": "boolean",
            "example": false
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PublicTransferBeneficiaryDto"
            }
          }
        },
        "required": [
          "page",
          "limit",
          "total",
          "pageCount",
          "hasPreviousPage",
          "hasNextPage",
          "data"
        ]
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ]
}
```