> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidoc-v1.maniscloud.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidoc-v1.maniscloud.com/_mcp/server.

# Get beneficiary by id

GET https://api/v1/beneficiaries/%7BbeneficiaryId%7D

### Get Beneficiary Details

This endpoint retrieves the details of a specific beneficiary identified by the `beneficiaryId`.

#### Request Parameters

- `beneficiaryId` (path parameter): The unique identifier for the beneficiary whose details are being requested.
    

Response body

| Field | Type | Description |
| --- | --- | --- |
| `id` | string | Identifier of the beneficiary |
| `merchantId` | string | merchantId |
| `customerId` | string | customer id |
| `type` | string | Beneficiary type: `INDIVIDUAL` or `COMPANY`. |
| `beneficiaryName` | string | A custom internal name for the beneficiary. Must be unique. |
| `companyInfo` | object | Information about the company beneficiary. |
| └─ `name` | string | Company name. |
| └─ `registrationNumber` | string | Company registration number. |
| └─ `incorporationCountry` | string | Country where the company was incorporated. |
| └─ `email` | string | Email address of the beneficiary company. |
| └─ `phoneCountryCode` | string | Phone number country code (e.g., `+84`). |
| └─ `phoneNumber` | string | Phone number |
| └─ `addressCountry` | string | Country of the beneficiary address. |
| └─ `addressZipCode` | string | ZIP/postal code. |
| └─ `addressCity` | string | City of the address. |
| └─ `addressStreet` | string | Street name and number. |
| └─ `addressState` | string | State/province of the address. |
| └─ `addressLocation` | string | Additional address info (e.g., suite, building). |
| `firstName` | string | First name of the contact person or individual beneficiary. |
| `lastName` | string | Last name of the contact person or individual beneficiary. |
| `dob` | string | Date of birth (format: `YYYY-MM-DD`). Applicable for individuals. |
| `email` | string | Email address of the beneficiary. |
| `phoneCountryCode` | string | Phone number country code (e.g., `+84`). |
| `phoneNumber` | string | Phone number. |
| `addressCountry` | string | Country of the beneficiary address. |
| `addressCity` | string | City of the address. |
| `addressState` | string | State/province of the address. |
| `addressZipCode` | string | ZIP/postal code. |
| `addressStreet` | string | Street name and number. |
| `addressLocation` | string | Additional address info (e.g., suite, building). |
| `identificationType` | string | Type of ID document (e.g., `PASSPORT`, `NATIONAL_ID`). |
| `identificationValue` | string | ID number or code. |
| `identificationCustomType` | string | Custom identification type (used when `identificationType` is null). |
| `description` | string | Free text description or note about the beneficiary. |
| relationship | string | relationship with the customer |
| accountInfo | object | account information |
| └─ `accountType` | string | Account type, one of value: BANK, CARD, WALLET, PROXY, CASH |
| └─ `accountNumber` | string | Account number of the beneficiary (may be null or optional for some PSPs). |
| └─ `currency` | string | Transaction currency (e.g., `USD`, `SGD`). |
| └─ `bankName` | string | Beneficiary bank name. |
| └─ `bankCity` | string | Beneficiary bank city. |
| └─ `bankCountry` | string | Beneficiary bank country. |
| └─ `routingCodeType1` | string | Local payment routing system. If supplied, a value for routing_code_value_1 must also be supplied.  <br>Enum: ABA  <br>BSB  <br>BIC_SWIFT  <br>BANK_CODE  <br>BRANCH_CODE  <br>IFSC  <br>IBAN  <br>SORT_CODE |
| └─ `routingCodeValue1` | string | The value for any routing system specified in routing_code_type_1. If supplied, a value for routing_code_type_1 must also be supplied. |
| └─ `routingCodeType2` | string | Local payment routing system. If supplied, a value for routing_code_value_2 must also be supplied.  <br>Enum: ABA  <br>BSB  <br>BIC_SWIFT  <br>BANK_CODE  <br>BRANCH_CODE  <br>IFSC  <br>IBAN  <br>SORT_CODE |
| └─ `routingCodeValue2` | string | The value for any routing system specified in routing_code_type_2. If supplied, a value for routing_code_type_2 must also be supplied. |
| └─ `routingCodeType3` | string | Local payment routing system. If supplied, a value for routing_code_value_3 must also be supplied.  <br>Enum: ABA  <br>BSB  <br>BIC_SWIFT  <br>BANK_CODE  <br>BRANCH_CODE  <br>IFSC  <br>IBAN  <br>SORT_CODE |
| └─ `routingCodeValue3` | string | The value for any routing system specified in routing_code_type_3. If supplied, a value for routing_code_type_3 must also be supplied. |
| └─ `proxyType` | string | Proxy type for this payout are MOBILE, UEN or NRIC |
| └─ `proxyValue` | string | Proxy values are dependent on proxy type |
| └─ `intermediaryBicSwift` | string | SWIFT BIC associated to the Intermediary Agent |
| └─ `payId` | string | NPP PayID (AU Specific) |
| └─ `payIdType` | string | Mention the type of PayID,It takes values \["EMAIL, PHONE, ORG, ABN"\] |
| `pspBeneficiaries` | object array | psp beneficiary info |
| └─ `pspId` | string | Identifier of the Payment Service Provider (e.g., `finmo`). |
| └─ `pspBeneficiaryId` | string | Identifier of the beneficiary in Payment Service |
| └─ `createdAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |
| └─ `createdBy` | string |  |
| `createdAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |
| `createdBy` | `createdBy` |  |
| `updatedAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |
| `updatedBy` | string |  |

Reference: https://apidoc-v1.maniscloud.com/manis-unified-api-v-1-0/payout-beneficiary/get-beneficiary-by-id

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /api/v1/beneficiaries/%7BbeneficiaryId%7D:
    get:
      operationId: get-beneficiary-by-id
      summary: Get beneficiary by id
      description: >-
        ### Get Beneficiary Details


        This endpoint retrieves the details of a specific beneficiary identified
        by the `beneficiaryId`.


        #### Request Parameters


        - `beneficiaryId` (path parameter): The unique identifier for the
        beneficiary whose details are being requested.
            

        Response body


        | Field | Type | Description |

        | --- | --- | --- |

        | `id` | string | Identifier of the beneficiary |

        | `merchantId` | string | merchantId |

        | `customerId` | string | customer id |

        | `type` | string | Beneficiary type: `INDIVIDUAL` or `COMPANY`. |

        | `beneficiaryName` | string | A custom internal name for the
        beneficiary. Must be unique. |

        | `companyInfo` | object | Information about the company beneficiary. |

        | └─ `name` | string | Company name. |

        | └─ `registrationNumber` | string | Company registration number. |

        | └─ `incorporationCountry` | string | Country where the company was
        incorporated. |

        | └─ `email` | string | Email address of the beneficiary company. |

        | └─ `phoneCountryCode` | string | Phone number country code (e.g.,
        `+84`). |

        | └─ `phoneNumber` | string | Phone number |

        | └─ `addressCountry` | string | Country of the beneficiary address. |

        | └─ `addressZipCode` | string | ZIP/postal code. |

        | └─ `addressCity` | string | City of the address. |

        | └─ `addressStreet` | string | Street name and number. |

        | └─ `addressState` | string | State/province of the address. |

        | └─ `addressLocation` | string | Additional address info (e.g., suite,
        building). |

        | `firstName` | string | First name of the contact person or individual
        beneficiary. |

        | `lastName` | string | Last name of the contact person or individual
        beneficiary. |

        | `dob` | string | Date of birth (format: `YYYY-MM-DD`). Applicable for
        individuals. |

        | `email` | string | Email address of the beneficiary. |

        | `phoneCountryCode` | string | Phone number country code (e.g., `+84`).
        |

        | `phoneNumber` | string | Phone number. |

        | `addressCountry` | string | Country of the beneficiary address. |

        | `addressCity` | string | City of the address. |

        | `addressState` | string | State/province of the address. |

        | `addressZipCode` | string | ZIP/postal code. |

        | `addressStreet` | string | Street name and number. |

        | `addressLocation` | string | Additional address info (e.g., suite,
        building). |

        | `identificationType` | string | Type of ID document (e.g., `PASSPORT`,
        `NATIONAL_ID`). |

        | `identificationValue` | string | ID number or code. |

        | `identificationCustomType` | string | Custom identification type (used
        when `identificationType` is null). |

        | `description` | string | Free text description or note about the
        beneficiary. |

        | relationship | string | relationship with the customer |

        | accountInfo | object | account information |

        | └─ `accountType` | string | Account type, one of value: BANK, CARD,
        WALLET, PROXY, CASH |

        | └─ `accountNumber` | string | Account number of the beneficiary (may
        be null or optional for some PSPs). |

        | └─ `currency` | string | Transaction currency (e.g., `USD`, `SGD`). |

        | └─ `bankName` | string | Beneficiary bank name. |

        | └─ `bankCity` | string | Beneficiary bank city. |

        | └─ `bankCountry` | string | Beneficiary bank country. |

        | └─ `routingCodeType1` | string | Local payment routing system. If
        supplied, a value for routing_code_value_1 must also be supplied. 
        <br>Enum: ABA  <br>BSB  <br>BIC_SWIFT  <br>BANK_CODE  <br>BRANCH_CODE 
        <br>IFSC  <br>IBAN  <br>SORT_CODE |

        | └─ `routingCodeValue1` | string | The value for any routing system
        specified in routing_code_type_1. If supplied, a value for
        routing_code_type_1 must also be supplied. |

        | └─ `routingCodeType2` | string | Local payment routing system. If
        supplied, a value for routing_code_value_2 must also be supplied. 
        <br>Enum: ABA  <br>BSB  <br>BIC_SWIFT  <br>BANK_CODE  <br>BRANCH_CODE 
        <br>IFSC  <br>IBAN  <br>SORT_CODE |

        | └─ `routingCodeValue2` | string | The value for any routing system
        specified in routing_code_type_2. If supplied, a value for
        routing_code_type_2 must also be supplied. |

        | └─ `routingCodeType3` | string | Local payment routing system. If
        supplied, a value for routing_code_value_3 must also be supplied. 
        <br>Enum: ABA  <br>BSB  <br>BIC_SWIFT  <br>BANK_CODE  <br>BRANCH_CODE 
        <br>IFSC  <br>IBAN  <br>SORT_CODE |

        | └─ `routingCodeValue3` | string | The value for any routing system
        specified in routing_code_type_3. If supplied, a value for
        routing_code_type_3 must also be supplied. |

        | └─ `proxyType` | string | Proxy type for this payout are MOBILE, UEN
        or NRIC |

        | └─ `proxyValue` | string | Proxy values are dependent on proxy type |

        | └─ `intermediaryBicSwift` | string | SWIFT BIC associated to the
        Intermediary Agent |

        | └─ `payId` | string | NPP PayID (AU Specific) |

        | └─ `payIdType` | string | Mention the type of PayID,It takes values
        \["EMAIL, PHONE, ORG, ABN"\] |

        | `pspBeneficiaries` | object array | psp beneficiary info |

        | └─ `pspId` | string | Identifier of the Payment Service Provider
        (e.g., `finmo`). |

        | └─ `pspBeneficiaryId` | string | Identifier of the beneficiary in
        Payment Service |

        | └─ `createdAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |

        | └─ `createdBy` | string |  |

        | `createdAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |

        | `createdBy` | `createdBy` |  |

        | `updatedAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |

        | `updatedBy` | string |  |
      tags:
        - subpackage_payoutBeneficiary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Payout Beneficiary_Get beneficiary by
                  id_Response_200
servers:
  - url: https:/
    description: https://{url}
components:
  schemas:
    ApiV1Beneficiaries7BbeneficiaryId7DGetResponsesContentApplicationJsonSchemaAccountInfo:
      type: object
      properties:
        payId:
          type: string
          format: email
        bankName:
          type: string
        currency:
          type: string
        payIdType:
          type: string
        proxyType:
          type: string
        proxyValue:
          type: string
        accountType:
          type: string
        accountNumber:
          type: string
        routingCodeType1:
          type: string
        routingCodeType2:
          type: string
        routingCodeValue1:
          type: string
        routingCodeValue2:
          type: string
        intermediaryBicSwift:
          type: string
      required:
        - payId
        - bankName
        - currency
        - payIdType
        - proxyType
        - proxyValue
        - accountType
        - accountNumber
        - routingCodeType1
        - routingCodeType2
        - routingCodeValue1
        - routingCodeValue2
        - intermediaryBicSwift
      title: >-
        ApiV1Beneficiaries7BbeneficiaryId7DGetResponsesContentApplicationJsonSchemaAccountInfo
    ApiV1Beneficiaries7BbeneficiaryId7DGetResponsesContentApplicationJsonSchemaPspBeneficiariesItems:
      type: object
      properties:
        pspId:
          type: string
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
          format: uuid
        pspBeneficiaryId:
          type: string
      required:
        - pspId
        - createdAt
        - createdBy
        - pspBeneficiaryId
      title: >-
        ApiV1Beneficiaries7BbeneficiaryId7DGetResponsesContentApplicationJsonSchemaPspBeneficiariesItems
    Payout Beneficiary_Get beneficiary by id_Response_200:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
        email:
          type: string
          format: email
        lastName:
          type: string
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
          format: uuid
        firstName:
          type: string
        updatedAt:
          type: string
          format: date-time
        updatedBy:
          type: string
          format: uuid
        customerId:
          type: string
          format: uuid
        merchantId:
          type: string
          format: uuid
        accountInfo:
          $ref: >-
            #/components/schemas/ApiV1Beneficiaries7BbeneficiaryId7DGetResponsesContentApplicationJsonSchemaAccountInfo
        addressCity:
          type: string
        description:
          type: string
        phoneNumber:
          type: string
        addressState:
          type: string
        relationship:
          type: string
        addressStreet:
          type: string
        addressCountry:
          type: string
        addressZipCode:
          type: string
        addressLocation:
          type: string
        beneficiaryName:
          type: string
        phoneCountryCode:
          type: string
        pspBeneficiaries:
          type: array
          items:
            $ref: >-
              #/components/schemas/ApiV1Beneficiaries7BbeneficiaryId7DGetResponsesContentApplicationJsonSchemaPspBeneficiariesItems
      required:
        - id
        - type
        - email
        - lastName
        - createdAt
        - createdBy
        - firstName
        - updatedAt
        - updatedBy
        - customerId
        - merchantId
        - accountInfo
        - addressCity
        - description
        - phoneNumber
        - addressState
        - relationship
        - addressStreet
        - addressCountry
        - addressZipCode
        - addressLocation
        - beneficiaryName
        - phoneCountryCode
        - pspBeneficiaries
      title: Payout Beneficiary_Get beneficiary by id_Response_200

```

## Examples



**Response**

```json
{
  "id": "dfc5cf7d-05a9-43fd-a6b5-158b1681961d",
  "type": "INDIVIDUAL",
  "email": "chi.nguyenquynh@eastgate-software.com",
  "lastName": "Nguyen",
  "createdAt": "2025-06-19T09:51:49.759Z",
  "createdBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56",
  "firstName": "Chi 196",
  "updatedAt": "2025-06-19T09:51:49.759Z",
  "updatedBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56",
  "customerId": "8ef3cb75-6be5-4851-819e-3ee0a517dcb3",
  "merchantId": "7eea1a78-6e23-49e4-a6c7-31d3181edb56",
  "accountInfo": {
    "payId": "email@gmail.com",
    "bankName": "DBS Bank Ltd",
    "currency": "SGD",
    "payIdType": "EMAIL",
    "proxyType": "MOBILE",
    "proxyValue": "+919021221212",
    "accountType": "BANK",
    "accountNumber": "123456789012",
    "routingCodeType1": "BIC_SWIFT",
    "routingCodeType2": "BANK_CODE",
    "routingCodeValue1": "DBSSSGSG",
    "routingCodeValue2": "7171",
    "intermediaryBicSwift": "intermediaryBicSwift"
  },
  "addressCity": "Singapore",
  "description": "Payroll beneficiary",
  "phoneNumber": "81234567",
  "addressState": "Sing",
  "relationship": "Employee",
  "addressStreet": "10 Anson Road",
  "addressCountry": "SG",
  "addressZipCode": "079903",
  "addressLocation": "International Plaza, #05-15",
  "beneficiaryName": "Chi beneficiary with SGD",
  "phoneCountryCode": "+65",
  "pspBeneficiaries": [
    {
      "pspId": "finmo",
      "createdAt": "2025-06-19T09:51:50.739Z",
      "createdBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56",
      "pspBeneficiaryId": "po_ben_7b8f36b7007b41d9a275e8400b1848f1"
    }
  ]
}
```

**SDK Code**

```python Payout Beneficiary_Get beneficiary by id_example
import requests

url = "https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D"

response = requests.get(url)

print(response.json())
```

```javascript Payout Beneficiary_Get beneficiary by id_example
const url = 'https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Payout Beneficiary_Get beneficiary by id_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Payout Beneficiary_Get beneficiary by id_example
require 'uri'
require 'net/http'

url = URI("https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java Payout Beneficiary_Get beneficiary by id_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D")
  .asString();
```

```php Payout Beneficiary_Get beneficiary by id_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D');

echo $response->getBody();
```

```csharp Payout Beneficiary_Get beneficiary by id_example
using RestSharp;

var client = new RestClient("https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift Payout Beneficiary_Get beneficiary by id_example
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```