createBeneficiary
POST/beneficiary/create
This API use to create beneficiary
This feature allows you to create a beneficiary. Reference will be returned in response on this API. This reference will be the unique identifier of each Beneficiary registered by partner through API. Partner will provide this unique reference to identify the Beneficiary of that remittance.
Parameters constraint
| Name | type | Mandatory | Description |
|---|---|---|---|
| firstName | String | Mandatory | First name sender |
| lastName | String | Mandatory | Last name sender |
| address | string | Mandatory | Address sender |
| phone | String | Mandatory | Phone sender |
| country | String | Mandatory | Sender country Iso code 2 (Ex:FR, CM, SN) |
| city | String | Mandatory | City sender |
| String | Optional | Email to be use to contact beneficiary | |
| idNumber | String | Mandatory | ID number identification document beneficiary |
| idType | String | Mandatory | Type Identification sender (PP:Passeport, CNI: National Idendity Card |
| state | String | Optional | State sender |
| zipcode | string | Optional | Zip code sender country |
| dateOfBirth | Date format Y-m-d | Mandatory | Date of birth Ex:1990-03-02 |
| dateExpireId | Date format Y-m-d | Mandatory | Date expire ID document Ex:1990-03-02 |
| pep | Bool | Mandatory | politically exposed person (true or false) |
| updateIfExist | Bool | Mandatory | If False the new sender is create when is exist but the code sender is different |
EndFragment
Request
Responses
- default