Update Beneficiary

Update a beneficiary’s nickname, remark, or favourite status

PATCH /v1/beneficiaries/{beneficiary_id}

Update existing beneficiary

cURL

curl --request PATCH \
  --url https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id} \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '
{
  "nickname": "<string>",
  "remark": "<string>"
}
'

import requests

url = "https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}"

payload = {
    "nickname": "<string>",
    "remark": "<string>"
}
headers = {
    "X-BUSINESS-API-KEY": "<x-business-api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-BUSINESS-API-KEY': '<x-business-api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({nickname: '<string>', remark: '<string>'})
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'nickname' => '<string>',
    'remark' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}"

	payload := strings.NewReader("{\n  \"nickname\": \"<string>\",\n  \"remark\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-BUSINESS-API-KEY", "<x-business-api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}")
  .header("X-BUSINESS-API-KEY", "<x-business-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"nickname\": \"<string>\",\n  \"remark\": \"<string>\"\n}")
  .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::Patch.new(url)
request["X-BUSINESS-API-KEY"] = '<x-business-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"nickname\": \"<string>\",\n  \"remark\": \"<string>\"\n}"

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

200

{
  "id": "9eb3d3ff-3fb0-450e-bb61-7c0753974398",
  "status": "approved",
  "country": "sg",
  "currency": "sgd",
  "transfer_method": "bank_transfer",
  "transfer_type": "local",
  "nickname": "Harry Satterfield",
  "remark": "RemarkAnimi veniam recusandae nihil sapiente temporibus voluptas aliquam.",
  "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": "[e-mail]",
  "bank_swift_code": "AEIBSGSXXXX",
  "is_favourite": false,
  "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-24T16:03:03+08:00",
  "deleted_at": null
}

{
  "message": "The given data was invalid. The remark may not be greater than 255 characters.",
  "errors": {
    "remark": [
      "The remark may not be greater than 255 characters."
    ]
  }
}

Headers

X-BUSINESS-API-KEY · string · required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Path Parameters

beneficiary_id · string<uuid> · required

The Beneficiary id

Example:

"9b294222-3a53-427f-9393-95dc6d63ee6c"

Body

application/json

nickname · string

Maximum string length: 255

remark · string

Maximum string length: 255

is_favourite · enum<boolean>

Set to true to mark this beneficiary as favourite

Available options: true, false

Response

200

application/json

200

id · string · required

status · string · required

country · string · required

currency · string · required

transfer_method · string · required

transfer_type · string · required

nickname · string · required

remark · string · required

holder_name · string · required

holder_type · string · required

bank_branch_code · string · required

account_number · string · required

bank_name · string · required

bank_id · string · required

email · string · required

bank_swift_code · string · required

is_favourite · boolean · required

created_by · object · required

Show child attributes

created_at · string · required

updated_at · string · required

deleted_at · string | null · required