Specta-Prime

Specta-prime requests.

STAGING_URL: https://switchapi3.azurewebsites.net
LIVE_URL: https://switchapi.azurewebsites.net

Register

POST https://switchapi3.azurewebsites.net/user/specta_prime/register

Registers a verified user on Specta-prime.

Headers

Name	Type	Description
SWI-CS	string	Payload checksum
SWI-CID	string	Client ID
Authorization	string	Bearer is Bearer token

Request Body

Name	Type	Description
username	string	Username for Specta
password	string	Password for Specta

200

{
    "message": "Specta-Prime registration successful"
}

400

Loan Tenors

GET https://switchapi3.azurewebsites.net/user/specta_prime/loan_tenors

Get Loan Tenors.

Headers

Name	Type	Description
SWI-CS	string	Payload checksum
SWI-CID	string	Client ID
Authorization	string	Format is Bearer token

200

{
    "message": "Loan tenors retrieved successfully",
    "data": [
        {
            "text": "7 days",
            "value": 7
        },
        {
            "text": "14 days",
            "value": 14
        },
        {
            "text": "21 days",
            "value": 21
        },
        {
            "text": "1 month",
            "value": 30
        },
        {
            "text": "2 months",
            "value": 60
        },
        {
            "text": "3 months",
            "value": 90
        },
        {
            "text": "4 months",
            "value": 120
        },
        {
            "text": "5 months",
            "value": 150
        },
        {
            "text": "6 months",
            "value": 180
        },
        {
            "text": "7 months",
            "value": 210
        },
        {
            "text": "8 months",
            "value": 240
        },
        {
            "text": "9 months",
            "value": 270
        },
        {
            "text": "10 months",
            "value": 300
        },
        {
            "text": "11 months",
            "value": 330
        },
        {
            "text": "1 year",
            "value": 365
        }
    ]
}

ORR questions

GET https://switchapi3.azurewebsites.net/user/specta_prime/orr_questions

Get ORR questions.

Headers

Name	Type	Description
SWI-CID	string	Client ID
Authorization	string	Format is Bearer token

200

{
    "message": "ORR questions retrieved successfully",
    "data": {
        "dropdownList": [
            {
                "dropdownListName": "accommodationType",
                "value": [
                    {
                        "descrip": "COMPANY LEASED",
                        "refid": "3"
                    },
                    {
                        "descrip": "FAMILY OWNED",
                        "refid": "1"
                    },
                    {
                        "descrip": "RENTED",
                        "refid": "4"
                    },
                    {
                        "descrip": "SELF OWNED",
                        "refid": "2"
                    }
                ]
            },
            {
                "dropdownListName": "maritalStatus",
                "value": [
                    {
                        "descrip": "MARRIED",
                        "refid": "2"
                    },
                    {
                        "descrip": "SINGLE",
                        "refid": "1"
                    }
                ]
            },
            {
                "dropdownListName": "dependant",
                "value": [
                    {
                        "descrip": "0 TO 1",
                        "refid": "1"
                    },
                    {
                        "descrip": "2 TO 3",
                        "refid": "2"
                    },
                    {
                        "descrip": "ABOVE 3",
                        "refid": "3"
                    }
                ]
            },
            {
                "dropdownListName": "loanPurpose",
                "value": [
                    {
                        "descrip": "Personal",
                        "refid": "1"
                    },
                    {
                        "descrip": "Wedding",
                        "refid": "2"
                    },
                    {
                        "descrip": "Medical",
                        "refid": "3"
                    },
                    {
                        "descrip": "Holiday",
                        "refid": "4"
                    },
                    {
                        "descrip": "Personal project",
                        "refid": "5"
                    },
                    {
                        "descrip": "Fees",
                        "refid": "6"
                    },
                    {
                        "descrip": "Education",
                        "refid": "7"
                    },
                    {
                        "descrip": "Rent",
                        "refid": "8"
                    }
                ]
            },
            {
                "dropdownListName": "numberOfJobChanged",
                "value": [
                    {
                        "descrip": "0",
                        "refid": "1"
                    },
                    {
                        "descrip": "1",
                        "refid": "2"
                    },
                    {
                        "descrip": "2",
                        "refid": "3"
                    },
                    {
                        "descrip": "ABOVE 2",
                        "refid": "4"
                    }
                ]
            },
            {
                "dropdownListName": "numberOfYearsInCurrentResidence",
                "value": [
                    {
                        "descrip": "2 TO 5 YEARS",
                        "refid": "2"
                    },
                    {
                        "descrip": "BELOW 2 YEARS",
                        "refid": "3"
                    },
                    {
                        "descrip": "MORE THAN 5 YEARS ",
                        "refid": "1"
                    }
                ]
            },
            {
                "dropdownListName": "state",
                "value": [
                    {
                        "descrip": "Abia\r",
                        "refid": "1"
                    },
                    {
                        "descrip": "Adamawa",
                        "refid": "2"
                    },
                    {
                        "descrip": "Akwa Ibom",
                        "refid": "3"
                    },
                    {
                        "descrip": "Anambara",
                        "refid": "4"
                    },
                    {
                        "descrip": "Bauchi",
                        "refid": "5"
                    },
                    {
                        "descrip": "Bayelsa",
                        "refid": "6"
                    },
                    {
                        "descrip": "Benue",
                        "refid": "7"
                    },
                    {
                        "descrip": "Borno",
                        "refid": "8"
                    },
                    {
                        "descrip": "Cross River",
                        "refid": "9"
                    },
                    {
                        "descrip": "Delta",
                        "refid": "10"
                    },
                    {
                        "descrip": "Ebonyi",
                        "refid": "11"
                    },
                    {
                        "descrip": "Edo",
                        "refid": "12"
                    },
                    {
                        "descrip": "Ekiti",
                        "refid": "13"
                    },
                    {
                        "descrip": "Enugu",
                        "refid": "14"
                    },
                    {
                        "descrip": "FCT Abuja",
                        "refid": "37"
                    },
                    {
                        "descrip": "Gombe",
                        "refid": "15"
                    },
                    {
                        "descrip": "Imo",
                        "refid": "16"
                    },
                    {
                        "descrip": "Jigawa",
                        "refid": "17"
                    },
                    {
                        "descrip": "Kaduna",
                        "refid": "18"
                    },
                    {
                        "descrip": "Kano",
                        "refid": "19"
                    },
                    {
                        "descrip": "Katsina",
                        "refid": "20"
                    },
                    {
                        "descrip": "Kebbi",
                        "refid": "21"
                    },
                    {
                        "descrip": "Kogi",
                        "refid": "22"
                    },
                    {
                        "descrip": "Kwara",
                        "refid": "23"
                    },
                    {
                        "descrip": "Lagos",
                        "refid": "24"
                    },
                    {
                        "descrip": "Nasarawa",
                        "refid": "25"
                    },
                    {
                        "descrip": "Niger",
                        "refid": "26"
                    },
                    {
                        "descrip": "Ogun",
                        "refid": "27"
                    },
                    {
                        "descrip": "Ondo",
                        "refid": "28"
                    },
                    {
                        "descrip": "Osun",
                        "refid": "29"
                    },
                    {
                        "descrip": "Oyo",
                        "refid": "30"
                    },
                    {
                        "descrip": "Plateau",
                        "refid": "31"
                    },
                    {
                        "descrip": "Rivers",
                        "refid": "32"
                    },
                    {
                        "descrip": "Sokoto",
                        "refid": "33"
                    },
                    {
                        "descrip": "Taraba",
                        "refid": "34"
                    },
                    {
                        "descrip": "Yobe",
                        "refid": "35"
                    },
                    {
                        "descrip": "Zamfara",
                        "refid": "36"
                    }
                ]
            },
            {
                "dropdownListName": "tenor",
                "value": [
                    {
                        "descrip": "1 Month   ",
                        "refid": "1"
                    },
                    {
                        "descrip": "2 Months  ",
                        "refid": "2"
                    },
                    {
                        "descrip": "3 Months  ",
                        "refid": "3"
                    },
                    {
                        "descrip": "4 Months  ",
                        "refid": "4"
                    },
                    {
                        "descrip": "5 Months  ",
                        "refid": "5"
                    },
                    {
                        "descrip": "6 Months  ",
                        "refid": "6"
                    },
                    {
                        "descrip": "7 Months  ",
                        "refid": "7"
                    },
                    {
                        "descrip": "8 Months  ",
                        "refid": "8"
                    },
                    {
                        "descrip": "9 Months  ",
                        "refid": "9"
                    },
                    {
                        "descrip": "10 Months ",
                        "refid": "10"
                    },
                    {
                        "descrip": "11 Months ",
                        "refid": "11"
                    },
                    {
                        "descrip": "12 Months ",
                        "refid": "12"
                    },
                    {
                        "descrip": "24 Months ",
                        "refid": "13"
                    },
                    {
                        "descrip": "36 Months ",
                        "refid": "14"
                    },
                    {
                        "descrip": "48 Months ",
                        "refid": "15"
                    },
                    {
                        "descrip": "60 Months ",
                        "refid": "16"
                    }
                ]
            }
        ]
    }
}

Repayment modes

GET https://switchapi3.azurewebsites.net/user/specta_prime/repayment_modes

Get repayment modes.

Headers

Name	Type	Description
SWI-CID	string	Client ID
Authorization	string	Format is Bearer token

200

{
    "message": "Repayment modes retrieved successfully",
    "data": [
        {
            "name": "MonthlyPayment",
            "value": 0
        },
        {
            "name": "SinglePayment",
            "value": 1
        }
    ]
}

User's existing investments

GET https://switchapi3.azurewebsites.net/user/specta_prime/existing_investments

Get user's existing investments.

Headers

Name	Type	Description
SWI-CID	string	Client ID
Authorization	string	Format is Bearer token

200

{
    "message": "User's existing investments retrieved successfully",
    "data": [
        {
            "amount": 0,
            "tenorInDays": 0,
            "currency": 566,
            "currencyName": "string",
            "effectiveDate": "2020-06-10T14:46:41.799Z",
            "maturityDate": "2020-06-10T14:46:41.799Z",
            "investmentAccount": "string",
            "responseText": "string",
            "responseCode": "string",
            "referenceId": "string",
            "interestPercentage": 0,
            "amountAtMaturity": 0,
            "interestAmount": 0,
            "withholdingTax": 0,
            "netInterestAmount": 0,
            "description": "string",
            "id": "string"
        }
    ]
}

Calculate cash-backed detail

POST https://switchapi3.azurewebsites.net/user/specta_prime/calculate_cash_backed_detail

Calculate cash-backed detail.

Headers

Name	Type	Description
SWI-CS	string	Payload checksum
SWI-CID	string	Client ID
Authorization	string	Format is Bearer token

Request Body

Name	Type	Description
amount	integer	Amount in naira
tenor	string	Loan tenor
repayment_mode	integer	Repayment mode value from the GET /repayment_modes endpoint
investment_reference_id	string	The reference id of the investment

200

{
    message: "Cash-backed details calculated successfully",
    data: {
      "id": "string",
      "loan": {
        "amount": 0,
        "tenorInDays": 0,
        "currency": 566,
        "currencyName": "string",
        "effectiveDate": "2020-06-10T14:58:45.679Z",
        "installmentDayOfMonth": 0,
        "installmentType": 0,
        "maturityDate": "2020-06-10T14:58:45.679Z",
        "responseText": "string",
        "disbursementAccount": "string",
        "responseCode": "string",
        "referenceId": "string",
        "interestPercentage": 0,
        "repaymentAmount": 0,
        "id": "string"
      },
      "investment": {
        "amount": 0,
        "tenorInDays": 0,
        "currency": 566,
        "currencyName": "string",
        "effectiveDate": "2020-06-10T14:58:45.679Z",
        "maturityDate": "2020-06-10T14:58:45.679Z",
        "investmentAccount": "string",
        "responseText": "string",
        "responseCode": "string",
        "referenceId": "string",
        "interestPercentage": 0,
        "amountAtMaturity": 0,
        "interestAmount": 0,
        "withholdingTax": 0,
        "netInterestAmount": 0,
        "description": "string",
        "id": "string"
      },
      "transactionState": 1,
      "customerComment": "string",
      "offerLetter": "string",
      "processingFeePercentage": 0,
      "managementFeePercentage": 0,
      "backer": {
        "id": "string",
        "amount": 0,
        "accountNumber": "string",
        "user": {
          "userName": "string",
          "name": "string",
          "surname": "string",
          "emailAddress": "string",
          "isActive": true,
          "fullName": "string",
          "lastLoginTime": "2020-06-10T14:58:45.679Z",
          "dateOfBirth": "2020-06-10T14:58:45.679Z",
          "gender": 0,
          "bankAccount": {
            "accountNumber": "string"
          },
          "creationTime": "2020-06-10T14:58:45.679Z",
          "phoneNumber": "string",
          "bvn": "string",
          "address": "string",
          "roleNames": [
            "string"
          ],
          "userType": 0,
          "id": 0
        },
        "hasPaid": true
      },
      "user": {
        "userName": "string",
        "name": "string",
        "surname": "string",
        "emailAddress": "string",
        "isActive": true,
        "fullName": "string",
        "lastLoginTime": "2020-06-10T14:58:45.679Z",
        "dateOfBirth": "2020-06-10T14:58:45.679Z",
        "gender": 0,
        "bankAccount": {
          "accountNumber": "string"
        },
        "creationTime": "2020-06-10T14:58:45.679Z",
        "phoneNumber": "string",
        "bvn": "string",
        "address": "string",
        "roleNames": [
          "string"
        ],
        "userType": 0,
        "id": 0
      },
      "transactionType": 1
    }
}

Begin Transaction

POST https://switchapi3.azurewebsites.net/user/specta_prime/begin_transaction

Begin transaction.

Headers

Name	Type	Description
SWI-CS	string	Payload checksum
SWI-CID	string	Client ID
Authorization	string	Format is Bearer token

Request Body

Name	Type	Description
amount	string	Amount in naira
tenor	string	Loan tenot
repayment_mode	string	value from GET /repayment_modes
investment_reference_id	string	Investment reference_id

200

{
    message: "Transaction created successfully",
    data: {
      "id": "string",
      "loan": {
        "amount": 0,
        "tenorInDays": 0,
        "currency": 566,
        "currencyName": "string",
        "effectiveDate": "2020-06-10T15:45:05.725Z",
        "installmentDayOfMonth": 0,
        "installmentType": 0,
        "maturityDate": "2020-06-10T15:45:05.725Z",
        "responseText": "string",
        "disbursementAccount": "string",
        "responseCode": "string",
        "referenceId": "string",
        "interestPercentage": 0,
        "repaymentAmount": 0,
        "id": "string"
      },
      "investment": {
        "amount": 0,
        "tenorInDays": 0,
        "currency": 566,
        "currencyName": "string",
        "effectiveDate": "2020-06-10T15:45:05.725Z",
        "maturityDate": "2020-06-10T15:45:05.725Z",
        "investmentAccount": "string",
        "responseText": "string",
        "responseCode": "string",
        "referenceId": "string",
        "interestPercentage": 0,
        "amountAtMaturity": 0,
        "interestAmount": 0,
        "withholdingTax": 0,
        "netInterestAmount": 0,
        "description": "string",
        "id": "string"
      },
      "transactionState": 1,
      "customerComment": "string",
      "offerLetter": "string",
      "processingFeePercentage": 0,
      "managementFeePercentage": 0,
      "backer": {
        "id": "string",
        "amount": 0,
        "accountNumber": "string",
        "user": {
          "userName": "string",
          "name": "string",
          "surname": "string",
          "emailAddress": "string",
          "isActive": true,
          "fullName": "string",
          "lastLoginTime": "2020-06-10T15:45:05.725Z",
          "dateOfBirth": "2020-06-10T15:45:05.725Z",
          "gender": 0,
          "bankAccount": {
            "accountNumber": "string"
          },
          "creationTime": "2020-06-10T15:45:05.725Z",
          "phoneNumber": "string",
          "bvn": "string",
          "address": "string",
          "roleNames": [
            "string"
          ],
          "userType": 0,
          "id": 0
        },
        "hasPaid": true
      },
      "user": {
        "userName": "string",
        "name": "string",
        "surname": "string",
        "emailAddress": "string",
        "isActive": true,
        "fullName": "string",
        "lastLoginTime": "2020-06-10T15:45:05.725Z",
        "dateOfBirth": "2020-06-10T15:45:05.725Z",
        "gender": 0,
        "bankAccount": {
          "accountNumber": "string"
        },
        "creationTime": "2020-06-10T15:45:05.725Z",
        "phoneNumber": "string",
        "bvn": "string",
        "address": "string",
        "roleNames": [
          "string"
        ],
        "userType": 0,
        "id": 0
      },
      "transactionType": 1
    }
}

Submit ORR Response

POST https://switchapi3.azurewebsites.net/user/specta_prime/orr_questions

Submit ORR response.

Headers

Name	Type	Description
SWI-CS	string	Payload checksum
SWI-CID	string	Client ID
Authorization	string	Format is Bearer token

Request Body

Name	Type	Description
accommodationType	number	value from the GET /orr_questions endpoint
jobChange	number	value from the GET /orr_questions endpoint
maritalStatus	number	value from the GET /orr_questions endpoint
numberOfDependents	number	value from the GET /orr_questions endpoint
tenorOfLoan	number	value from the GET /orr_questions endpoint
residenceDuration	number	value from the GET /orr_questions endpoint
transactionId	string	The transaction ID gotten from the POST /begin_transaction endpoint

200

Transaction Summary

GET https://switchapi3.azurewebsites.net/user/specta_prime/transaction_summary

Get transaction summary

Query Parameters

Name	Type	Description
transaction_id	string	Id of the transaction.

Headers

Name	Type	Description
SWI-CS	string	Payload checksum
SWI-CID	string	Client ID
Authorization	string	Format is Bearer token

200

{
    message: "Transaction summary retrieved successfully",
    data: {
      "id": "string",
      "loan": {
        "amount": 0,
        "tenorInDays": 0,
        "currency": 566,
        "currencyName": "string",
        "effectiveDate": "2020-06-10T16:14:39.943Z",
        "installmentDayOfMonth": 0,
        "installmentType": 0,
        "maturityDate": "2020-06-10T16:14:39.943Z",
        "responseText": "string",
        "disbursementAccount": "string",
        "responseCode": "string",
        "referenceId": "string",
        "interestPercentage": 0,
        "repaymentAmount": 0,
        "id": "string"
      },
      "investment": {
        "amount": 0,
        "tenorInDays": 0,
        "currency": 566,
        "currencyName": "string",
        "effectiveDate": "2020-06-10T16:14:39.943Z",
        "maturityDate": "2020-06-10T16:14:39.943Z",
        "investmentAccount": "string",
        "responseText": "string",
        "responseCode": "string",
        "referenceId": "string",
        "interestPercentage": 0,
        "amountAtMaturity": 0,
        "interestAmount": 0,
        "withholdingTax": 0,
        "netInterestAmount": 0,
        "description": "string",
        "id": "string"
      },
      "transactionState": 1,
      "customerComment": "string",
      "offerLetter": "string",
      "processingFeePercentage": 0,
      "managementFeePercentage": 0,
      "backer": {
        "id": "string",
        "amount": 0,
        "accountNumber": "string",
        "user": {
          "userName": "string",
          "name": "string",
          "surname": "string",
          "emailAddress": "string",
          "isActive": true,
          "fullName": "string",
          "lastLoginTime": "2020-06-10T16:14:39.943Z",
          "dateOfBirth": "2020-06-10T16:14:39.943Z",
          "gender": 0,
          "bankAccount": {
            "accountNumber": "string"
          },
          "creationTime": "2020-06-10T16:14:39.943Z",
          "phoneNumber": "string",
          "bvn": "string",
          "address": "string",
          "roleNames": [
            "string"
          ],
          "userType": 0,
          "id": 0
        },
        "hasPaid": true
      },
      "user": {
        "userName": "string",
        "name": "string",
        "surname": "string",
        "emailAddress": "string",
        "isActive": true,
        "fullName": "string",
        "lastLoginTime": "2020-06-10T16:14:39.943Z",
        "dateOfBirth": "2020-06-10T16:14:39.943Z",
        "gender": 0,
        "bankAccount": {
          "accountNumber": "string"
        },
        "creationTime": "2020-06-10T16:14:39.943Z",
        "phoneNumber": "string",
        "bvn": "string",
        "address": "string",
        "roleNames": [
          "string"
        ],
        "userType": 0,
        "id": 0
      },
      "transactionType": 1
    }
}

Send Otp to finalize Loan Application

POST https://switchapi3.azurewebsites.net/user/specta_prime/send_loan_application_finalization_otp

Send otp.

Headers

Name	Type	Description
SWI-CID	string	Client ID
SWI-CS	string	Payload checksum
Authorization	string	Format is Bearer token

Request Body

Name	Type	Description
transaction_id	string	Transaction ID

200

{
    message: "Otp for loan application finalization sent"
}

Resend Otp to finalize Loan Application

POST https://switchapi3.azurewebsites.net/user/specta_prime/resend_loan_application_finalization_otp

Resend otp.

Headers

Name	Type	Description
SWI-CS	string	Payload checksum
SWI-CID	string	Client ID
Authorization	string	Format is Bearer token

Request Body

Name	Type	Description
transaction_id	string	ID of transaction

200

{
    message: "Otp for loan application finalization resent"
}

User's transactions

GET https://switchapi3.azurewebsites.net/user/specta_prime/transactions

Get User's transactions.

Headers

Name	Type	Description
SWI-CS	string	Payload checksum
SWI-CID	string	Client ID
Authentication	string	Format is Bearer token

200

{
    message: "User's transactions retrieved successfully",
    data: []
}

Finalize Loan Application

POST https://switchapi3.azurewebsites.net/user/specta_prime/finalize_loan_application

Finalize loan application

Headers

Name	Type	Description
SWI-CS	string
SWI-CID	string	Client ID
Authorization	string	Format is Bearer token

Request Body

Name	Type	Description
transaction_id	string	Transaction ID
otp	string	Otp

200

{
    message: "Loan application completed successfully"
}