SoftPOS
SoftPOS Virtual Account Service makes receiving payments from your customer seamless.
Request made without the authorization key will fail with a 401 (Service Not Authorize) response code.
Create Virtual Account
This allows you to create a virtual account for merchants/agents.
Endpoint to create virtual account
POST {{baseUrl}}/pip/softpos/create-virtual-account
The merchant super-agent can create a virtual account with this endpoint.
Headers
authorization*
String
secret-key
client-id*
String
Merchant Id
Content-Type*
String
application/json
Request Body
address*
String
customer address
customer_identifier*
String
customer's unique identifier
dob*
Date
customer date of birth (dd/mm/yy)
email*
String
customer email address
first_name*
String
customer first name
last_name*
String
customer last name
mobile_num*
String
customer's moblie number
gender*
String
customer gender ("1" - MALE, "2" -FEMALE )
{
"statusCode": 200,
"description": "Successful",
"data": {
"first_name": "Taofeek",
"last_name": "Ogunlola",
"bank_code": "058",
"virtual_account_number": "0345431014",
"customer_identifier": "12345",
"created_at": "2022-11-23T20:35:41.142Z",
"update_at": null
}
}Create Terminal
This allows you to create terminals for different businesses. The terminal is location-based and each location has an Id that you must include.
Endpoint for merchant to create terminal
POST {{baseUrl}}/pip/softpos/create-terminal
Headers
Content-Type*
String
application/json
authorization*
String
secret-key
client-id*
String
Merchant ID
Request Body
name*
String
Name on terminal
email*
String
phone*
String
Phone number on terminal
location_id*
String
The Id of the terminal location
merchantId*
String
The merchant Id
{
"statusCode": 200,
"description": "Successful",
"data": {
"terminalId": null,
"enabled": false
}
}Last updated
