Use Cases
Credit Scoring & Underwriting:
Endpoint
POST /api/credit-scoring
Description
This endpoint allows merchants to perform credit scoring and underwriting for a customer, assessing their creditworthiness before approving a financial product or service. The credit scoring process may include various factors such as credit history, income verification, and other relevant data.
Request Parameters:
| Field | What it means |
|---|---|
api_key (string, required) | The API key provided by CrediPay to authenticate the merchant. |
customer_id (string, required) | A unique identifier for the customer within the merchant's system. |
full_name (string, required) | The full name of the customer. |
date_of_birth (string, required) | The customer's date of birth in ISO 8601 format (e.g., "1990-01-01"). |
mobile_number (string, required) | The customer's mobile phone number. |
email (string, required) | The customer's email address. |
address (string, required) | The customer's residential address. |
monthly_income (float, required) | The customer's monthly income. |
credit_history (string, required) | The customer's credit history, represented as a summary or score. |
loan_amount (float, required) | The amount the customer is requesting as a loan. |
loan_purpose (string, required) | The purpose for which the customer is seeking a loan. |
Response:
| Field | What it means |
|---|---|
application_status (string) | The status of the credit scoring and underwriting application (e.g., approved, pending, declined). |
credit_score (int) | The numerical credit score assigned to the customer based on the evaluation. |
approved_loan_amount (float, optional) | The approved loan amount if the application is approved. |
interest_rate (float, optional) | The interest rate assigned to the approved loan. |
terms_and_conditions_url (string, optional) | A URL to the terms and conditions associated with the approved loan. |
Example Request:
{
"api_key": "your_api_key_here",
"customer_id": "123456789",
"full_name": "John Doe",
"date_of_birth": "1990-01-01",
"mobile_number": "+1234567890",
"email": "john.doe@example.com",
"address": "123 Main St, City, Country",
"monthly_income": 5000.0,
"credit_history": "good",
"loan_amount": 1000.0,
"loan_purpose": "home_improvement"
}
Example Response:
{
"application_status": "approved",
"credit_score": 750,
"approved_loan_amount": 900.0,
"interest_rate": 10.5,
"terms_and_conditions_url": "https://credipay.finance/terms/loan123"
}
Error Responses:
| Error | What it means |
|---|---|
400 Bad Request | If the request is missing required parameters or contains invalid data. |
401 Unauthorized | If the provided API key is invalid. |
403 Forbidden | If the merchant account is not authorized to perform credit scoring and underwriting. |
500 Internal Server Error | If there is an issue on the CrediPay server. |
Paying Bills on Credit (Biller Service) API Endpoint
Endpoint
POST /api/biller-service/pay
Description
This endpoint enables customers to pay their bills on credit using CrediPay's Biller Service. Customers can defer bill payments to a later date, and merchants offering biller services can integrate this endpoint to facilitate credit-based bill payments.
Request Parameters:
| Field | What it means |
|---|---|
api_key (string, required) | The API key provided by CrediPay to authenticate the merchant. |
customer_id (string, required) | A unique identifier for the customer within the merchant's system. |
bill_amount (float, required) | The total amount of the bill the customer wishes to pay on credit. |
currency (string, required) | The currency in which the bill amount is specified (e.g., "GHS"). |
bill_description (string, required) | A brief description of the bill being paid. |
payment_due_date (string, required) | The due date for the deferred bill payment in ISO 8601 format (e.g., "2024-12-31"). |
Response:
| Field | What it means |
|---|---|
transaction_id (string) | A unique identifier for the bill payment transaction. |
approval_status (string) | The status of the transaction approval (e.g., approved, pending, declined). |
approval_code (string, optional) | An authorization code if the transaction is approved. |
new_due_date (string, optional) | The updated due date for the bill payment if deferred. |
Example Request:
{
"api_key": "your_api_key_here",
"customer_id": "123456789",
"bill_amount": 150.0,
"currency": "GHS",
"bill_description": "Electricity Bill",
"payment_due_date": "2024-12-31"
}
Example Response:
{
"transaction_id": "xyz789abc",
"approval_status": "approved",
"approval_code": "987654",
"new_due_date": "2025-01-15"
}
Error Responses:
| Error | What it means |
|---|---|
400 Bad Request | If the request is missing required parameters or contains invalid data. |
401 Unauthorized | If the provided API key is invalid. |
403 Forbidden | If the merchant account is not authorized to use the Biller Service. |
500 Internal Server Error | If there is an issue on the CrediPay server. |
Online Lending API Endpoint for Ghana
Endpoint
POST /api/online-lending/apply
Description
This endpoint facilitates the online lending application process for customers in Ghana. Merchants can integrate this endpoint to allow customers to apply for loans through CrediPay's platform, leveraging credit scoring and underwriting services for quick and efficient loan approvals.
Credit Collections
Collect from multiple bank and mobile money accounts for account receivables and instant credit repayments
Buy Now Pay Later Checkout
Enable Buy Now Pay Later check out capabilities for your online commerce marketplaces
Send Now Pay Later
Allow your customers to send money to family and friends even on zero balance.