Overview
With this service, the calling apps can do KYC with the customer's account number or card or other supported auth details. This service will return slightly above minimal maximum KYC information. Apps will forward the account number they will like to obtain information on and forward auth details to OnePipe. If authorisation authorization details are required by a provider, apps will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation.
| Info |
|---|
Before you proceed: Please read this. |
Commercial model
At agreed settlement cycles, the host will debit the configured beneficiary account of the app for the use of this API and share that fee with all participants. Fees will be determined by the provider. Parties that share the fees are:
...
OnePipe
...
Host client
...
Provider
...
Special configuration notes
OTP override: All providers of this service should implement OTP, but support the configuration of
otp_overridesuch that based on this configuration, they could be instructed to bypass the OTP requirement for an app.SMS handler: All providers that need to do OTP validation need to have
otp_api_key, andotp_api_secretconfigured. They will use this to call can use the Send SMS and Send Email service services on OnePipe to send their OTP.
...
INTERFACE SPECIFICATION (APP → ONEPIPE)
| Info |
|---|
For details on encryption using the Triple DES Algorithm, read this. |
Request (Transact)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"lookup_account_max",
"auth": {
"type": null"bank.account | card",
"secure": null,"{{encrypted_secure}}",
"auth_provider": "Beeceptor",
"route_mode":" null"
},
"transaction": {
"mock_mode": "live",
"transaction_ref": "{{transaction_ref}}",
"transaction_desc": "A random transaction",
"transaction_ref_parent": null,
"amount": 0,
"customer":{
"customer_ref": "{{customer_id}}",
"firstname": "Uju",
"surname": "Usmanu",
"email": "ujuusmanu@gmail.com",
"mobile_no": "234802343132"
},
"meta":{
"a_key":"a_meta_value_1",
"another_key":"a_meta_value_2"
},
"details": {
"account_number":"23632626327",null
"otp_override": false
}
}
} |
Response (when otp_override = false)
| Code Block | ||
|---|---|---|
| ||
{
"status": "WaitingForOTP",
"message": "Please enter the OTP sent to 2348022****08",
"data": {
"provider_response_code": "900T0",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": null
}
} |
Response (when otp_override = true)
| Code Block | ||
|---|---|---|
| ||
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"customer_id": "007935125",
"account_currency": "NGN",
"account_number": "1020123456",
"account_name": "BOLA SALAMI",
"last_name": "SALAMI",
"middle_name": "-",
"first_name": "BOLA",
"gender": "Male",
"dob": "1971-03-12T00:00:00",
"account_branch": "101",
"scheme_code": "SAV",
"bvn": "22211055555",
"account_status": "ACCOUNT OPEN",
"ledger_balance": 2524.59,
"available_balance": 2524.59,
"kyc_level": "3",
"name_enquiry_id": "0000028301",
"address1": "9 LIGALI STREET",
"address2": ".",
"address3": "IBADAN",
"email": "BOLASALAMI@yahoo.com",
"mobile_number": "080913333333",
"responseaccount_codetype": "00CURRENT",
"response_messagereference": "Success000022200225154318222333334432",
"user_messagemeta":{
"Success"
} } } |
Request (validate with otp)
| Code Block | ||
|---|---|---|
| ||
{ "requestfield_refkey":"{{request_ref}}field_value", "request_type":"lookup_account_max", "auth": { "securefield_key": "{{encrypted_otp}}",field_value" "auth_provider": "Beeceptor" }, "transaction": { } "transaction_ref": "70713093460718"} } |
Request (validate with otp)
| Code Block | ||
|---|---|---|
| ||
{ "request_ref":"{{request_ref}}", "request_type":"lookup_account_max", "auth": { } } |
Request Payload Description
...
Field
...
Type
...
Requirement
...
Description
...
request_ref
...
string
...
compulsory
...
Takes unique value for every request made to OnePipe
...
request_type
...
string
...
compulsory
...
This should be set to the service lookup_account_1
...
auth.type
...
string
...
N/A
...
This can be set to null
...
auth.secure
...
string
...
N/A
...
This can be set to null
...
auth.provider
...
string
...
compulsory
...
This should be set to the name of the Provider
...
auth.route_mode
...
string
...
N/A
...
This can be set to null
...
transaction.mock_mode
...
string
...
optional
...
This can be set to either live or inspect. If left as null, value will fall back to the state of the service set on the console.
...
transaction.transaction_desc
...
string
...
optional
...
Description of your transaction
...
transaction.transaction_ref_parent
...
string
...
optional
...
Takes value of a (parent) transaction reference
...
transaction.customer.customer_ref
...
string
...
compulsory
...
Identifier for customer
...
transaction.customer.firstname
...
string
...
optional
...
First name of customer
...
transaction.customer.surname
...
string
...
optional
...
Surname of customer
...
transaction.customer.email
...
string
...
optional
...
Email address of customer
...
transaction.customer.mobile_no
...
string
...
optional
...
Phone number of customer
...
transaction.amount
...
big int
...
compulsory
...
This can be set to 0
...
transaction.transaction_ref
...
string
...
compulsory
...
Takes unique value for every transaction call to OnePipe.
...
transaction.meta
...
object
...
optional
...
Json object of your arbitrary transaction parameters
...
transaction.details
...
object
...
compulsory
...
Holds defined fields peculiar to this service
Breakdown of the details object
For this service, the details object will have the following:
...
Field
...
Type
...
Requirement
...
Description
...
account_number
...
string
...
compulsory
...
Customer account number to look up
...
otp_override
...
boolean
...
optional
...
Defaults to false. If set to true, request will not be validated by OTP.
Possible status response codes
For this service, these are the possible responses a client can receive
...
Status
...
Meaning
...
Successful
...
Standard success code
...
Failed
...
Standard failure code
...
WaitingForOTP
...
To signify that this provider has requested an OTP from the customer and it should be supplied.
...
PendingValidation
...
To signify that this provider needs some extra information to be provided. The response.message will contain the prompt.
INTERFACE SPECIFICATION (ONEPIPE → PROVIDER)
Request
| Code Block | ||
|---|---|---|
| ||
{
"request_mode":"transact",
"request_ref":"{{request_ref}}",
"request_type":"lookup_account_max",
"auth": {
"type": null,
"secure": null,
"auth_provider": "Beeceptor"
},
"transaction": {
"mock_mode": "live",
"transaction_ref": "{{transaction_ref}}",
"transaction_desc": "A random transaction",
"transaction_ref_parent": null,
"amount": 0,
"customer":{
"customer_ref": "{{customer_id}}",
"firstname": "Uju",
"surname": "Usmanu",
"email": "ujuusmanu@gmail.com",
"mobile_no": "234802343132"
},
"meta":{
"a_key":"a_meta_value_1",
"another_key":"a_meta_value_2"
},
"details": {
"account_number":"23632626327",
"otp_override": true
},
"client_info": {
"name": "TrustPay",
"id": null,
"bank_cbn_code": null,
"bank_name": null,
"console_url": null,
"js_background_image": null,
"css_url": null,
"logo_url": "https://trustpay.onepipe.io/img/trustpay_logo_console.png",
"footer_text": "Brought to you by <strong>SunTrust Bank</strong>",
"options": [
"BANK.TRANSFER",
"CARD"
],
"primary_color": "#b37038",
"secondary_color": "#b37038",
"primary_button_color": "#b37038",
"modal_background_color": "linear-gradient(147.44deg, #d8903c 26.99%, #e69921 74.1%)",
"payment_option_color": "rgba(76, 61, 47, 0.08)",
"payment_option_active_color": "rgba(31, 31, 31, 0.25)",
"app_color": "#b37038"
},
"app_info": {
"name": "Victor Motors",
"id": "5cdab3332b7d4100015f0db4",
"beneficiary_account_no": "0001137069",
"extras": {/*this will contain an array of provider override settings*/}
}
}
} |
Response (when otp_override = false)
Set provider_response_code to 900T0
| Code Block | ||
|---|---|---|
| ||
{
"status": "WaitingForOTP",
"message": "Please enter the OTP sent to 2348022****08",
"data": {
"provider_response_code": "900T0",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": null
}
} |
Response (otp_override = true)
| Code Block |
|---|
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"customer_id": "007935125",
"account_currency": "NGN",
"account_number": "1020123456",
"account_name": "BOLA SALAMI",
"last_name": "SALAMI",
"middle_name": "-",
"first_name": "BOLA",
"gender": "Male",
"dob": "1971-03-12T00:00:00",
"account_branch": "101",
"scheme_code": "SAV",
"bvn": "22211055555",
"account_status": "ACCOUNT OPEN",
"ledger_balance": 2524.59,
"available_balance": 2524.59,
"kyc_level": "3",
"name_enquiry_id": "0000028301",
"address1": "9 LIGALI STREET",
"address2": ".",
"address3": "IBADAN",
"email": "BOLASALAMI@yahoo.com",
"mobile_number": "080913333333",
"response_code": "00",
"response_message": "Success",
"user_message": "Success"
}
}
} |
Request (validate with otp)
| Code Block | ||
|---|---|---|
| ||
{ "request_mode":"validate", "request_ref":"{{request_ref}}", "request_type":"lookup_account_min", "auth": { "type": null, "secure": "{{otp}}", "auth_provider": "Beeceptor" }, "transaction": { "mock_mode": null, "transaction_ref": "{{transaction_ref}}", "transaction_desc": null, "transaction_ref_parent": null, "amount": 0, "customer":null, "meta":null, "details": null } } "secure": "{{encrypted_otp}}", "auth_provider": "Beeceptor" }, "transaction": { "transaction_ref": "70713093460718" } } |
Breakdown of the details object
For this service, the details object will be null
Acceptable values for auth.type
card
bank.account
wallet
null
Possible status response codes
For this service, these are the possible responses a client can receive
Status | Meaning |
|---|---|
Successful | Standard success code |
Failed | Standard failure code |
WaitingForOTP | To signify that this provider has requested an OTP from the customer and it should be supplied. |
PendingValidation | To signify that this provider needs some extra information to be provided. The |
INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)
Read this closely.
Special notes for OTP override
Whenever a request is to be validated by OTP, the provider microservice should first call the provider, store response info in the database, send an OTP to the phone number attached to the BVN, then respond with WaitingForOTP.
On the OTP validation legphase, if user OTP is valid, provider should retrieve info from the database, then respond with a Successful response.
NB: Data should be erased from the DB.
Special notes for providers
This should be seen as a standard lookup service. All providers are required to execute settlement per agreed contracts to the account designated by the client bank.