HIhitpayapp

Update existing beneficiary

we only accept to update nickname, remark and is_favourite fields

patch/v1/beneficiaries/{beneficiary_id}

Request

  • Base URL
    https://api.hit-pay.com
  • URL
    https://api.hit-pay.com/v1/beneficiaries/{beneficiary_id}
  • Auth
    none declared. Required headers: X-BUSINESS-API-KEY

Path parameters

beneficiary_idstring uuid required
Example:9b294222-3a53-427f-9393-95dc6d63ee6c

The Beneficiary id

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Request body

nicknamestring
remarkstring
is_favouritetrue | false

Set to true to mark this beneficiary as favourite

Response

200

idstring required
statusstring required
countrystring required
currencystring required
transfer_methodstring required
transfer_typestring required
nicknamestring required
remarkstring required
holder_namestring required
holder_typestring required
bank_branch_codestring required
account_numberstring required
bank_namestring required
bank_idstring required
emailstring required
bank_swift_codestring required
is_favouriteboolean required
created_atstring required
updated_atstring required
deleted_atstring nullable required

Changes

No recorded changes to this operation across all 8 revisions of this API.