Update Remitter
POST https://test.remit.by/korifinances/ws/remitter/updateRemitter
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 | |
|---|---|---|---|
remitter_id |
String | required | |
firstname |
String | optional | |
middlename |
String | optional | |
lastname |
String | optional | |
type |
String | optional | registered / basicregistered |
nationality |
String | optional | 2 letter country ISO code. Please refer to Appendix A. |
Visa Status |
String | optional | Values must be one of setting “VISA_STATUS_LIST” |
status |
String | optional | valid / expired / blocked |
comments |
String | optional | |
address1 |
String | optional | |
address2 |
String | optional | |
city |
String | optional | |
state |
String | optional | |
postcode |
String | optional | |
email |
String | optional | |
telephone |
String | optional | |
mobile |
String | optional | |
Occupation |
String | optional | |
dob |
Date | optional | YYYY-MM-DD |
place_of_birth |
String | optional | |
country_of_birth |
String | optional | 2 letter country ISO code. Please refer to Appendix A. |
fathers_name |
String | optional | |
mothers_name |
String | optional | |
national_id_number |
String | optional | |
id_type |
String | optional | See Appendix B for codes |
id_details |
String | optional | |
id_issued_by |
String | optional | |
id_issue_place |
String | optional | |
id_start |
Date | optional | YYYY-MM-DD |
id_expiry |
Date | optional | YYYY-MM-DD |
id_verified |
String | optional | VERIFIED, UNVERIFIED, FAIL |
id2_type |
Code | optional | See Appendix B for codes |
id2_details |
String | optional | |
id2_issued_by |
String | optional | |
id2_issue_place |
String | optional | |
id2_start |
Date | optional | YYYY-MM-DD |
id2_expiry |
Date | optional | YYYY-MM-DD |
id2_verified |
Date | optional | VERIFIED, UNVERIFIED, FAIL |
id3_type |
String | optional | |
id3_details |
String | optional | |
id3_issued_by |
String | optional | |
id3_issue_place |
String | optional | |
id3_start |
String | optional | YYYY-MM-DD |
id3_expiry |
String | optional | YYYY-MM-DD |
id4_type |
String | optional | |
id4_details |
String | optional | |
id4_issued_by |
String | optional | |
id4_issue_place |
String | optional | |
id4_start |
String | optional | YYYY-MM-DD |
id4_expiry |
String | optional | YYYY-MM-DD |
Annual income |
String | optional | |
account_number |
String | optional | |
sort_code |
String | optional | |
groups |
String | optional | Comma separate stringe.g Default,Group2,Group3 |
Id1_scan |
File | optional | png, gif, jpg, jpeg, bmp and pdf |
Id1_scan 2 |
String | optional | |
Id1_scan 3 |
String | optional | |
Id2_scan |
File | optional | png, gif, jpg, jpeg, bmp and pdf |
Id2_scan 2 |
String | optional | |
Id2_scan 3 |
String | optional | |
Id3_scan |
String | optional | png, gif, jpg, jpeg, bmp and pdf |
Id3_scan 2 |
String | optional | |
Id3_scan 3 |
String | optional | |
Id4_scan |
String | optional | png, gif, jpg, jpeg, bmp and pdf |
Id4_scan 2 |
String | optional | |
Id4_scan 3 |
String | optional | |
receive_marketing |
String | optional | t/f |
orgtype |
String | optional | ‘Individual’ or ‘Corporate’ |
company_name |
String | optional | If orgtype is ‘Individual’ it will be set to empty |
company_type |
String | optional | If orgtype is ‘Individual’ it will be set to empty |
company_reg_no |
String | optional | If orgtype is ‘Individual’ it will be set to empt |
purpose |
String | optional | |
source_of_income |
String | optional | |
sector |
String | optional | The sector where the remitter is involved |
employer |
String | optional | |
business_address |
String | optional | The address of the employer |
contract_date |
String | optional | Date of contract with employer |
annual_income |
String | optional | |
annual_remittance |
String | optional | |
hear_about_us |
String | optional | as per the output of getRemitterUISettings. |
hear_about_us_other |
String | optional | If hear_about_us is “Other” then specify, otherwise it will be saved as empty anyway |
remitter_username |
String | optional | The new email (username) of the remitter |
referral_code |
String | optional | Customer referral code |
residency_status |
String | optional | Values can be “resident” or “nonresident” |
nearest_airport |
String | optional | The name of the nearest airport |
PAYLOAD JSON
{
"remitter_id": "",
"firstname": "",
"middlename": "",
"lastname": "",
"type": "",
"nationality": "",
"gender": "",
"status": "",
"comments": "",
"address1": "",
"address2": "",
"city": "",
"state": "",
"postcode": "",
"email": "",
"telephone": "",
"mobile": "",
"Occupation": "",
"dob": "",
"place_of_birth": "",
"country_of_birth": "",
"fathers_name": "",
"mothers_name": "",
"national_id_number": "",
"id_type": "",
"id_details": "",
"id_issued_by": "",
"id_issue_place": "",
"id_issue_country": "",
"id_start": "",
"id_expiry": "",
"id2_type": "",
"id2_details": "",
"id2_issued_by": "",
"id2_issue_place": "",
"id2_start": "",
"id2_expiry": "",
"id3_type": "",
"id3_details": "",
"id3_issued_by": "",
"id3_issue_place": "",
"id3_start": "",
"id3_expiry": "",
"id4_type": "",
"id4_details": "",
"id4_issued_by": "",
"id4_issue_place": "",
"id4_start": "",
"id4_expiry": "",
"Annual income": "",
"account_number": "",
"sort_code": "",
"groups": "",
"Id1_scan": "",
"Id1_scan 2": "",
"Id1_scan 3": "",
"Id2_scan": "",
"Id2_scan 2": "",
"Id2_scan 3": "",
"Id3_scan": "",
"Id3_scan 2": "",
"Id3_scan 3": "",
"Id4_scan": "",
"Id4_scan 2": "",
"Id4_scan 3": "",
"receive_marketing": "",
"orgtype": "",
"company_name": "",
"company_type": "",
"company_reg_no": "",
"purpose": "",
"source_of_income": "",
"sector": "",
"employer": "",
"business_address": "",
"contract_date": "",
"annual_income": "",
"annual_remittance": "",
"hear_about_us": "",
"hear_about_us_other": "",
"referral_code": "",
"residency_status": "",
"nearest_airport": "",
"firstname": "",
"middlename": "",
"lastname": "",
"type": "",
"nationality": "",
"gender": "",
"status": "",
"comments": "",
"address1": "",
"address2": "",
"city": "",
"state": "",
"postcode": "",
"email": "",
"telephone": "",
"mobile": "",
"Occupation": "",
"dob": "",
"place_of_birth": "",
"country_of_birth": "",
"fathers_name": "",
"mothers_name": "",
"national_id_number": "",
"id_type": "",
"id_details": "",
"id_issued_by": "",
"id_issue_place": "",
"id_issue_country": "",
"id_start": "",
"id_expiry": "",
"id2_type": "",
"id2_details": "",
"id2_issued_by": "",
"id2_issue_place": "",
"id2_start": "",
"id2_expiry": "",
"id3_type": "",
"id3_details": "",
"id3_issued_by": "",
"id3_issue_place": "",
"id3_start": "",
"id3_expiry": "",
"id4_type": "",
"id4_details": "",
"id4_issued_by": "",
"id4_issue_place": "",
"id4_start": "",
"id4_expiry": "",
"Annual income": "",
"account_number": "",
"sort_code": "",
"groups": "",
"Id1_scan": "",
"Id1_scan 2": "",
"Id1_scan 3": "",
"Id2_scan": "",
"Id2_scan 2": "",
"Id2_scan 3": "",
"Id3_scan": "",
"Id3_scan 2": "",
"Id3_scan 3": "",
"Id4_scan": "",
"Id4_scan 2": "",
"Id4_scan 3": "",
"receive_marketing": "",
"orgtype": "",
"company_name": "",
"company_type": "",
"company_reg_no": "",
"purpose": "",
"source_of_income": "",
"sector": "",
"employer": "",
"business_address": "",
"contract_date": "",
"annual_income": "",
"annual_remittance": "",
"hear_about_us": "",
"hear_about_us_other": "",
"referral_code": "",
"residency_status": "",
"nearest_airport": "",
}