PATCH
/
v1
/
beneficiaries
/
{beneficiary_id}
curl --request PATCH \
  --url https://api.sandbox.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>",
  "is_favourite": true
}'
{
  "id": "9b294222-3a53-427f-9393-95dc6d63ee6c",
  "is_external": true,
  "country": "us",
  "currency": "usd",
  "transfer_method": "local",
  "nickname": null,
  "remark": "Remark 1706327127",
  "holder_name": "US Customer123",
  "holder_type": "individual",
  "email": "test@gmail.com",
  "bank_routing_number": "021000021",
  "account_number": "50001121",
  "address": {
    "city": "New York",
    "state": "US-NY",
    "street": "Test Street",
    "postcode": "10015"
  },
  "is_favourite": false,
  "created_at": "2024-01-23T21:04:15+08:00",
  "updated_at": "2024-01-27T11:45:27+08:00",
  "deleted_at": null
}

Headers

​
X-BUSINESS-API-KEY
string
required

Path Parameters

​
beneficiary_id
string
required

The Beneficiary id

Body

application/json
​
nickname
string
​
remark
string
​
is_favourite
boolean

Response

200 - application/json
200
​
id
string
required
​
is_external
boolean
required
​
country
string
required
​
currency
string
required
​
transfer_method
string
required
​
nickname
any
required
​
remark
string
required
​
holder_name
string
required
​
holder_type
string
required
​
email
string
required
​
bank_routing_number
string
required
​
account_number
string
required
​
address
object
required
​
is_favourite
boolean
required
​
created_at
string
required
​
updated_at
string
required
​
deleted_at
any
required

Was this page helpful?

Create BeneficiaryDelete Beneficiary