Redemption API Documentation


Redemption

The new redemption accept a post with Json parameters.

URI Parameters

{baseurl}/api/v1/newredem

Body Parameters

                  {
                 "Fundcode": string ,         - Mandatory (e.g.  Fundcode as advise by Registrars)
                 "AccountNumber": string ,   - Mandatory (e.g. Account number Identifier) 
                  "RegistrarsNumber": string ,   (e.g. Registrars Account number "367862")
                 "Surname ": string            - Mandatory (e.g. AWOTUNDE)
                 "FirstName": string,         - Mandatory (e.g. EMMANUEL)
                 "OtherNames": string,        -(e.g. ADEBAYO AND ELIZABETH OMOBOLA)
                 "TransactionType": string,    - Mandatory (e.g. REDEMPTION )
                 "QuantityRedemption": Decimal,  - Mandatory (e.g. 45.6)
                 "Username": string,           - Mandatory  (e.g. staff that worked on the upload sent to Registrar) 
                 "Trandate": dateTime,         - Mandatory  (e.g. 06/02/2024 DD/MM/YYYY)
                  }
              

Request Header

                {
                "AuthorizationKey": "string",  -Mandatory (To be issued by Registrars)
                "Tokenid": "String"             -Mandatory (To be issued by Registrars)
                }
                

Request Formats

application/json, text/json

Sample:
                              {
                    "Fundcode": 34,
                    "AccountNumber": "0238824536",
                    "RegistrarsNumber": "1234",
                    "Surname ": "AWOTUNDE",
                    "FirstName": "EMMANUEL,
                    "OtherNames": "ELIZABETH",
                    "TransactionType": "REDEMPTION", 
                    "QuantitySubscription": 45.6, 
                    "Username": "Micheal Oyeniyi" 
                    "Trandate": "2023-12-05"                     


                       }
                      

Response Header

content-type: application/json; charset=utf-8

Response Information

Successful transaction:
              {
       "ControlNum": "0238824536",
       "Message": "Successful",
        "Status":1
       }
      
None Successful transaction
        {
 "ControlNum": "0",
 "Message": "Fail",
  "status":0
 }

Status code

Code Desccription
1 Success
2 Fund code is missing
3 Account Number is missing
4 Surname is missing
5 Firstname is missing
6 Transaction Type is missing
7 Quantity is missing
8 Username is missing
9 Transaction Date is missing
10 AuthorizationKey not Provided or incorrect
11 TokenID not provided or incorrect