Sale API

Web service for create sales request

Register

POST https://{baseurl}/sales/sale/api/register

This endpoint allows you to create sales request.

Query Parameters

Name	Type	Description
country	string	Country Code
partner_code	string	Partner Code
plan_code	string	Plan Code
partner_reference	string	Partner Reference Number
name	string	Customer Name
mobile	string	Customer Mobile
id_type	string	Customer Id Type
id_number	string	Customer Id Number
email	string	Customer Email
dob	string	Customer Date of Birth (YYYY-MM-DD)
sale_date	string	Sale Date (YYYY-MM-DD)
beneficiaryName	string	Beneficiary Name
beneficiaryRelationship	string	Beneficiary Relationship
beneficiaryIdType	string	Beneficiary National Id Type
beneficiaryidNumber	string	Beneficiary Id Number
beneficiaryFatherName	string	Beneficiary Father Name
notes	array	Other Useful Information

Headers

Name	Type	Description
EIGER-SESSION-ID	string	Webservice Token API Generated Value
EIGER-TOKEN	string	Webservice Token API Generated Value
EIGER-API-REQUEST-TYPE	string	REST
Accept	string	application/json
Content-Type	string	application/json

200 Sale successfully registered.

{
"status": "SUCCESS",
"errorcode": "0000",
"data": {
"apiType": "Create Sale API",
"sale_number": "SC.XXXX.20.0000000062.00",
"certificate_start_date": "2020-01-25",
"certificate_end_date": "2030-11-08"
},
"message": "Sales registered successfully",
"errors": null
}

404 Failed to register sale.

{    "message": "Failed"}