'/%3e%3cdefs%3e%3cpattern%20id='pattern0_2104_4598'%20patternContentUnits='objectBoundingBox'%20width='1'%20height='1'%3e%3cuse%20xlink:href='%23image0_2104_4598'%20transform='matrix(0.00376176%200%200%200.0172414%20-0.00219436%200)'/%3e%3c/pattern%3e%3cimage%20id='image0_2104_4598'%20width='267'%20height='58'%20preserveAspectRatio='none'%20xlink:href='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQsAAAA6CAMAAACQ2ozcAAAAM1BMVEVMaXH////////////////////////////////////////////////////////////////x7/yuAAAAEHRSTlMAoDDgEPBgwIBAINCwkHBQDIOTDwAAAAlwSFlzAAFxGAABcRgB7MGwCAAABm1JREFUaIHlW+uWsyoMLSIIeH3/pz0CKrmgQuusdn0nf2YaMW42kISgr1cQK+SySj+61/9cmm45RLTfRvNV0WoBIptv4/mi6AWLuiVDd0lKmLPGGPsA0nelGG8TZoXU69poTPi/v1smBjB338dZxvk218B/VIrxBl8hth9t73+Zp2x7SdNuLMX+tJTitZCKjQx1MzFquLBVc+hvpBSv8NMX/Hb+Bv2MbS8DaNsVYn9aSvFK2nWB5slHtr0sUL4Ur0vx+usowdL3A1jBhUVcfGmR1HCBFPbvuWhskvuefC4/wkWbWyMgzV2ub39GarhA+cf0KBevHrTdffSvcuGxonzCA73JBGq4gFnt7qN/lYtxwflEWOA3KWJVriWOpkd0+lUuQj6Rsu6QkcuL9jW2o4xbyzTZfpWLOG79FlatgnP5Y9tRnFn3RAYE7p/loo1bJ6GtnSLIYbuwRrz8rq6SCyY/y8W2UU0SFkw7xQCghszN/y4Xr0ZCKjpPxQz46Vjdj9pupiHUBsxclmRXcOG0CKZHfVV9dHqM1QmRrZNU4IVN15kwQ98fNHSlYNsaUsmmEUw899gNuQCck2ur17KwZXcypM6gsVSCtSN4YcozzLmWqtvbNCPRUDKgbU07RiC/z8XgmOnMtHNiYUJZu8Tbg8YW3B6HOK6PwRPQRo1sT21nBGVq73OxKNaElx8n3iiAR4CL8YbOHlH0YHnXtAL2osg2Gr8PuMgIIaPNTIooqIJdijfkyFO6b6u9gBTDo1M1PKOK6bNcYCBtf9Gwqcc7LHgr1qqFaHil69Y2KAY9zMWe/Ny3BWSU4vVdZ3UtvCHxGuQD7m2nmfY0FyBBGK8bJidXitf/gxbA7DVQwStdBbbVng48zsUxMexdy7EWr/8H9dw/QjJNLRfHKnmci2Pk5G1LW4nX/2U9x5p5eYOLvYj6PBfb+qXHfacWy/H6P6yuhavBfl1Cl0VtK7MaaGcS30wZF6ny2WS4kD71ttjyZgXHEDk5j4Ew2dTh9SbREYCEqA/NBBXY9pHX4E2eLOPiRQT1RsDAv0sc7QZhOHowIwxjHd4wDcDEmCJ1jmjQREG2werBxt3HXKRIwE+cEAYwmMijygze/hxvrq6FNJp0mNp2Zxf0x1ykWD8zLmA7lIChqe+u8U4Eb2goLbjYSaCJdnDqC20jR4JOAMzHXADYjAs4pCj5QYvH3uCFVjy66IR6Y8zoSfDlPr1rhEKdyHCB64GwJ8PHXAA144L3eBcYaw3DixwfW3skqw+GcUpHj1fP60TwSveXXKDRP7fAubjBi2bKwnrAT5p/gAsEEFuA41jNBQ60YZEip8Lq4r/NBexOLRfbvX0XfGZY5i5uVjcNOzs6tz0S23/GhYNctKcWKrmI4Sq+2BlebpRm9FSY8IRYcVTndS3si6DrEX/JBfKdeKjgitcMLw4DxNf7oVcHW/viSLt/kfqV46KHF9BofR5Tr7iA0QKhg6lIJqZe4Q3hExAroJEgIe6c17XgpEOeZy7ighatS7mA0RDlTyiJr8Obr2sJqjmva4H1g7eObREXNEiVcoGeBWqKuXy7FG9kBEhwfyjPZG9wkQOVfJlgS/Bu9+wbyy5z7YoLNL2XfgNMisFTBd6+qH5xW9fqjbV6JLUVfc4FzuS6yVoz3Lyzw7jAi2SlfrWiBTkhaOvwZrnomaa6lrNPxRwX2ft1JRe3Jb40mUvxkmc+Vtcy0NyFjgIv5oJOjEz39nVXitf/Rb6c+4txufQXWTkqpjkuXrnDLlnLhcsfmSU5Up9SvP7ZvK7F4shFXSsrB5lZLrLHXbzGd80FziS4pN15Kd6QXIGJYUhftolyXtfKSgrBWS5c7p6plguyayJyFmcv8IZRT1nmHnKJ5jzvzAoormS5yFoYqrm4AgI//LjFu3cvkKvioLQp2qlIlQseSuEXQYDt7JqFiVmei+wqqeeCfBIFewcT5XK80R+rwZgNx/F60qEhm3Zgu+HHuxK54hMucmTYei5e7B2NCD37hknAy9tDvPS0WjDNef1iTUQMploZvKc942L/3Aj0sXmDi9UOGw0KoQovzAPD2miRhr35mr7fCo3BO0K9pq/ONOBbL03NpIfIcXNQI2gP2gIteym5gSmkGvgbmRd4J/aqj93zFiUc1VCSc+K0WWWytd+HtHZ678YTQ2Yu+4jSzVePbcNVe6n51+U/wZKesx3N5aEAAAAASUVORK5CYII='/%3e%3c/defs%3e%3c/svg%3e)
Customers
The Customers API enables you to create, retrieve, update, and delete customer profiles. Use these endpoints to manage customer identity details, contact information, and track customers across transactions for reporting and compliance.
Create a new customer
Use Case
This endpoint is used to create a new customer.
Create Customer Request Body
First name of the customer. This is typically used for identification and personalization in communications.
Last name or surname of the customer. Combined with the first name to form the full legal name.
A valid and unique email address used to identify and contact the customer. It also serves as a primary login credential.
Customer’s active phone number, formatted in international standard (e.g., +233XXXXXXXXX). May be used for verification and notifications.
The country dial code used for phone number formatting (e.g., '+234' for Nigeria, '+1' for United States).
Create Customer Response
Returns a Customer Response.
Standard response structure for all customer endpoints.
Universally unique identifier (UUID) assigned to the customer. This ID is used to reference the customer across all systems and APIs.
The customer's given name. Useful for personalization in communications and customer interfaces.
The customer’s family name or surname. When combined with the first name, it forms the customer’s full name.
A unique and valid email address associated with the customer. Used for communication, verification, and login purposes.
Customer’s contact phone number in international format (e.g., +233XXXXXXXXX). May be used for notifications or identity verification.
The country dial code used for phone number formatting (e.g., '+234' for Nigeria, '+1' for United States).
Indicates whether the customer is blacklisted (true) or allowed (false). Blacklisted customers are restricted from performing certain actions.
The date and time when the customer record was initially created, formatted as an ISO 8601 timestamp (e.g., '2024-11-05T12:34:56Z').
The date and time of the most recent update to the customer record, also in ISO 8601 format.
Update Customer
Use Case
This endpoint is used to update an existing customer's information.
The unique identifier of the customer you want to update
Update Customer Request Body
Customer's first name.
Customer's last name.
Customer's phone number in international format.
Customer's valid email address.
Update Customer Response
Returns an updated CustomerResponse..
The response is identical to that of Customer Response. Refer to the Customer Response. section for field explanations.
Blacklist A Customer
Use Case
This endpoint is used to mark a customer as blacklisted.
Unique identifier of the customer to be blacklisted. This is passed as a path parameter.
Set to true to blacklist the customer, or false to remove them from blacklist.
Blacklisted Customer Response
Returns an updated CustomerResponse. with blacklist: true..
A globally unique identifier (UUID) that uniquely identifies the customer record in the system.
The first or given name of the customer. Used for display and personalization.
The surname or family name of the customer. Useful for full name generation.
A valid and unique email address associated with the customer. Used for communication and identification.
The customer's phone number in international format. Optional but can be used for verification or contact.
The country dial code used for phone number formatting (e.g., '+234' for Nigeria, '+1' for United States).
Indicates if the customer is blacklisted. A value of true means restricted from transactions.
Timestamp (ISO 8601 format) indicating when the customer was created in the system.
Timestamp (ISO 8601 format) of the most recent update made to the customer's profile.
Get Customer by ID, Reference or Email
Use Case
This endpoint is used to retrieve a single customer by id, ref, or email.
Response
Returns a Customer Response.
The response is identical to that of Customer Response. Refer to the Customer Response. section for field explanations.
Retrieve customers
Use Case
This endpoint is used to retrieve a list of all customers with optional filtering and pagination.
Query Parameters
An array of customer objects. Empty if no customers are found, but when present, contains detailed information about each customer.
Contains pagination information including current page, items per page, total item count, total page count, and flags for previous/next pages.
The current page number of the results.
The number of items returned per page.
Total number of customer items available.
Total number of pages available based on the current 'take' value.
Indicates whether there is a previous page of results available.
Indicates whether there is a next page of results available.
Retrieved Response
Returns a paginated list of Customer Response[].
A system-generated universally unique identifier (UUID) for the customer. Used to reference the customer internally.
The customer’s given name. Typically used in user-facing communication or personalization.
The customer’s surname. Helpful for identity verification or formal communications.
The customer's unique email address, used for communication and login. Must follow standard email format.
The customer's mobile number in international format (e.g., +234xxxxxxxxx). Useful for two-factor authentication or support.
The country dial code used for phone number formatting (e.g., '+234' for Nigeria, '+1' for United States).
Boolean flag that indicates if the customer is blacklisted, true means they are blocked from certain actions.
Timestamp in ISO 8601 format indicating when the customer profile was first created.
Timestamp in ISO 8601 format marking the last time the customer profile was updated.