createOrUpdateCustomer

Request to create a new or update an existing customer profile on the service provider's system.

SecurityhttpBasic or oauth2

Request

Request Body schema: application/json

A message containing the data required to carry out the admin request, as well as information about the point-of-sale from which the transaction originates.

required	object (Originator) The Originator object encapsulates data relating to the originator of the transaction
required	object (Institution) Originating, acquiring, processing, or receiving institution details
	object (PersonalDetails) Personal details of a customer.
customerProfileId	string Uniquely identifies customer's profile on the upstream entity's system.

Responses

200

successful operation

201

Created

400

Bad request

500

Internal Server Error

501

Not implemented

503

Service Unavailable

504

Gateway Timeout

post/admin/customers

Request samples

Payload
curl
Java
Node.js

application/json

{"originator": {"institution": {"id": "string",
"name": "string"
},
"terminalId": "stringst",
"merchant": {"merchantType": "string",
"merchantId": "stringstringstr",
"merchantName": {"name": "string",
"city": "string",
"region": "st",
"country": "st"
}
},
"operatorId": "string",
"channelId": "string"
},
"receiver": {"id": "string",
"name": "string"
},
"customerDetails": {"firstName": "string",
"lastName": "string",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"province": "string",
"country": "st",
"postCode": "string"
},
"idNumber": "string",
"idType": "NATIONAL_ID",
"idCountryCode": "st",
"nationality": "st",
"countryOfBirth": "st",
"dateOfBirth": "string",
"contactNumber": "string",
"altContactWork": "string",
"altContactHome": "string",
"email": "string",
"accountDetails": {"accountId": "string",
"type": "ACCOUNT"
},
"idIssuedDate": "2019-08-24T14:15:22Z",
"idExpiryDate": "2019-08-24T14:15:22Z",
"culturalName": "string",
"sourceOfIncome": "SALARIED",
"occupation": "BUSINESSMAN"
},
"customerProfileId": "string"
}

Response samples

application/json

{"originator": {"institution": {"id": "string",
"name": "string"
},
"terminalId": "stringst",
"merchant": {"merchantType": "string",
"merchantId": "stringstringstr",
"merchantName": {"name": "string",
"city": "string",
"region": "st",
"country": "st"
}
},
"operatorId": "string",
"channelId": "string"
},
"receiver": {"id": "string",
"name": "string"
},
"customerDetails": {"firstName": "string",
"lastName": "string",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"province": "string",
"country": "st",
"postCode": "string"
},
"idNumber": "string",
"idType": "NATIONAL_ID",
"idCountryCode": "st",
"nationality": "st",
"countryOfBirth": "st",
"dateOfBirth": "string",
"contactNumber": "string",
"altContactWork": "string",
"altContactHome": "string",
"email": "string",
"accountDetails": {"accountId": "string",
"type": "ACCOUNT"
},
"idIssuedDate": "2019-08-24T14:15:22Z",
"idExpiryDate": "2019-08-24T14:15:22Z",
"culturalName": "string",
"sourceOfIncome": "SALARIED",
"occupation": "BUSINESSMAN"
},
"customerProfileId": "string"
}