Skip to content

Update Beneficiary

POST https://test.remit.by/korifinances/ws/beneficiary/updateBeneficiary

Request

Creates a Remitter.

Use this endpoint a new create a new kyced remitter into our system.

Identification

username , password and pin - required

Parameters:
Body

object | application/json

Common remitter creation object properties.

Name Type Notes
beneficiary_id Integer required
name String optional
fname String optional
mname String optional
lname String optional
local_name String optional
organisation_type String optional INDIVIDUAL or CORPORATE
company_name String optional
company_type String optional
company_reg_no String optional
address1 String optional
address2 String optional
address3 String optional
city String optional
state String optional
postcode String optional
country String optional As per output of getDestinationCountries
nationality String optional Nationality Name, See Appendix A for the names
dob Date optional YYYY-MM-DD
fathers_name String optional
mothers_name String optional
national_id_number String optional
gender String optional Allowed values: UNSPECIFIED, MALE, FEMALE
telephone String optional
mobile String optional
email String optional
id_type Code optional See Appendix C for codes
id_details String optional
id_start Date optional When the document has been released, format yyyy-mm-dd or dd/mm/yyyy
id_expiry Date optional When the document is going to expire, format yyyy-mm-dd or dd/mm/yyyy
id_issued_by String optional
id_issue_place String optional
id_issue_country String optional
id_scan File optional png, gif, jpg, jpeg, bmp and pdf
id2_type String optional
id2_details String optional
id2_expiry Date optional When the document is going to expire, format yyyy-mm-dd or dd/mm/yyyy
id2_issue_place String optional
card_type String optional Allowed values are from the variable BENEFICIARY_CARD_TYPES from ARM
card_number String optional
account_number String optional
bank String optional
bank_branch String optional
bank_branch_city String optional
bank_branch_state String optional
bank_branch_telephone String optional
bank_branch_manager String optional
benef_bank_swift_code String optional
benef_bank_ifsc_code String optional
benef_bank_account_name String optional
benef_ac_type String optional benef_ac_types retrieved from calling getBeneficiaryAccountTypes
homedelivery_notes String optional
enabled String optional t=true, f=false
suspicious String optional t=true, f=false
suspicion_reason String optional
PAYLOAD JSON

{

"beneficiary_id": "",
"name": "",
"fname": "",
"mname": "",
"lname": "",
"local_name": "",
"organisation_type": "",
"company_name": "",
"company_type": "",
"company_reg_no": "",
"address1": "",
"address2": "",
"address3": "",
"city": "",
"state": "",
"postcode": "",
"country": "",
"nationality": "",
"dob": "",
"fathers_name": "",
"mothers_name": "",
"national_id_number": "",
"gender": "",
"telephone": "",
"mobile": "",
"email": "",
"id_type": "",
"id_details": "",
"id_start": "",
"id_expiry": "",
"id_issued_by": "",
"id_issue_place": "",
"id_issue_country": "",
"id_scan": "",
"id2_type": "",
"id2_details": "",
"id2_expiry": "",
"id2_issue_place": "",
"card_type": "",
"card_number": "",
"account_number": "",
"bank": "",
"bank_branch": "",
"bank_branch_city": "",
"bank_branch_state": "",
"bank_branch_telephone": "",
"bank_branch_manager": "",
"benef_bank_swift_code": "",
"benef_bank_ifsc_code": "",
"benef_bank_account_name": "",
"benef_ac_type": "",

}