Cashonrails - Developer Documentation

Create Customer

The Create Customer endpoint allows you to create a new customer by providing their details such as email, name, phone number, and other optional information.

Endpoint

POST https://mainapi.cashonrails.com/api/v1/customer

Request Headers

Header	Type	Description
Content-Type	string	application/json
Authorization	string	Bearer token with your secret key

Request Body

Include the following parameters in your request body:

Parameter	Type	Description	Required
email	string	The email address of the customer	Yes
first_name	string	The first name of the customer	Yes
last_name	string	The last name of the customer	Yes
phone	string	The phone number of the customer	Yes
dob	string	The date of birth of the customer	No
bvn	string	The Bank Verification Number	No
nin	string	The National Identification Number	No

Sample Request

{
    "email": "johndoe@gmail.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "08023456542",
    "dob": "hello",
    "bvn": "", 
    "nin": ""
}

Sample cURL Request

curl --location 'https://mainapi.cashonrails.com/api/v1/customer' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer sk_test_0123456789abcdefghijkl' \
--data-raw '{
    "email": "johndoe@gmail.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "08023456542",
    "dob": "hello",
    "bvn": "", 
    "nin": ""
}'

Sample cURL Response

{
    "success":true,
    "message":"Customer created",
    "data":{
        "email":"johndoe@gmail.com",
        "domain":"test",
        "customer_code":"CUS_ptvqrx4fuprqx4f",
        "id":7,
        "created_at":"2025-01-29T16:56:49.000000Z",
        "updated_at":"2025-01-29T16:56:49.000000Z"
    }
}

Introduction Fetch Customers