Aller au contenu principal

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

NametypeMandatoryDescription
firstNameStringMandatoryFirst name sender
lastNameStringMandatoryLast name sender
addressstringMandatoryAddress sender
phoneStringMandatoryPhone sender
countryStringMandatorySender country Iso code 2 (Ex:FR, CM, SN)
cityStringMandatoryCity sender
emailStringOptionalEmail to be use to contact beneficiary
idNumberStringMandatoryID number identification document beneficiary
idTypeStringMandatoryType Identification sender (PP:Passeport, CNI: National Idendity Card
stateStringOptionalState sender
zipcodestringOptionalZip code sender country
dateOfBirthDate format Y-m-dMandatoryDate of birth Ex:1990-03-02
dateExpireIdDate format Y-m-dMandatoryDate expire ID document Ex:1990-03-02
pepBoolMandatorypolitically exposed person (true or false)
updateIfExistBoolMandatoryIf False the new sender is create when is exist but the code sender is different

EndFragment

Request

Responses

Response Headers