Get a beneficiary by ID
curl --request GET \
--url https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id} \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'import requests
url = "https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}"
headers = {"X-BUSINESS-API-KEY": "<x-business-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BUSINESS-API-KEY': '<x-business-api-key>'}};
fetch('https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-BUSINESS-API-KEY: <x-business-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-BUSINESS-API-KEY", "<x-business-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}")
.header("X-BUSINESS-API-KEY", "<x-business-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-BUSINESS-API-KEY"] = '<x-business-api-key>'
response = http.request(request)
puts response.read_body{
"id": "9eb3d3ff-3fb0-450e-bb61-7c0753974398",
"status": "approved",
"country": "sg",
"currency": "sgd",
"transfer_method": "bank_transfer",
"transfer_type": "local",
"nickname": "Test QA",
"remark": "Test QA",
"holder_name": "Test QA",
"holder_type": "individual",
"bank_branch_code": "001",
"account_number": "173737377",
"bank_name": "AMERICAN EXPRESS BANK LTD",
"bank_id": "AEIBSGSXXXX[7454]",
"email": "[email protected]",
"is_favourite": true,
"created_by": {
"id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
"display_name": "TestingSG",
"first_name": "QA",
"last_name": "SG"
},
"created_at": "2025-04-18T12:52:10+08:00",
"updated_at": "2025-04-18T12:52:10+08:00",
"deleted_at": null
}{
"message": "No query results for model [App\\Models\\Business\\BankAccount] 9eb3d3ff-3fb0-450e-bb61-7c0753974392"
}Beneficiary
Get Beneficiary Detail
Retrieve a beneficiary’s full details by ID
GET
/
v1
/
beneficiaries
/
{beneficiary_id}
Get a beneficiary by ID
curl --request GET \
--url https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id} \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'import requests
url = "https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}"
headers = {"X-BUSINESS-API-KEY": "<x-business-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BUSINESS-API-KEY': '<x-business-api-key>'}};
fetch('https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-BUSINESS-API-KEY: <x-business-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-BUSINESS-API-KEY", "<x-business-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}")
.header("X-BUSINESS-API-KEY", "<x-business-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-BUSINESS-API-KEY"] = '<x-business-api-key>'
response = http.request(request)
puts response.read_body{
"id": "9eb3d3ff-3fb0-450e-bb61-7c0753974398",
"status": "approved",
"country": "sg",
"currency": "sgd",
"transfer_method": "bank_transfer",
"transfer_type": "local",
"nickname": "Test QA",
"remark": "Test QA",
"holder_name": "Test QA",
"holder_type": "individual",
"bank_branch_code": "001",
"account_number": "173737377",
"bank_name": "AMERICAN EXPRESS BANK LTD",
"bank_id": "AEIBSGSXXXX[7454]",
"email": "[email protected]",
"is_favourite": true,
"created_by": {
"id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
"display_name": "TestingSG",
"first_name": "QA",
"last_name": "SG"
},
"created_at": "2025-04-18T12:52:10+08:00",
"updated_at": "2025-04-18T12:52:10+08:00",
"deleted_at": null
}{
"message": "No query results for model [App\\Models\\Business\\BankAccount] 9eb3d3ff-3fb0-450e-bb61-7c0753974392"
}Headers
Example:
"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"
Path Parameters
The Beneficiary id
Example:
"9b294222-3a53-427f-9393-95dc6d63ee6c"
Response
200
Show child attributes
Show child attributes
Last modified on February 25, 2026
Was this page helpful?
⌘I