Overview
With this service, the calling apps can do KYC with the customer's account number. Apps will collect authorisation details and forward to OnePipe to execute a debit, OnePipe will in turn forward to the provider’s dedicated implementation.
Commercial model
N/A
Special configuration notes
All providers of this service should implement OTP, but support the configuration of otp_override such that based on this configuration, they could be instructed to bypass the OTP requirement for an app.
Settlement & fees model
Depending on the provider implementation, this service supports any of the 3 models.
Model | How it works |
|---|---|
Amount | N/A |
Commission | N/A |
Invoice | The client will invoice the calling app periodically for all calls to the endpoint. |
Process flows
Sequence of calls
App calls
/transactwith the right auth detailsProvider responds with
WaitingForOTPorPendingValidationas may be requiredApp calls
/transact/validateto supply OTP if neededProvider responds with any of the completion codes
SuccessfulorFailed.To query the status of a transaction, the app can call
/transact/queryWhere the provider supports it, the app can call
/transact/reverseto request a reversal
| Gliffy | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
|
INTERFACE SPECIFICATION (APP → ONEPIPE)
Request
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"lookup_account_3max",
"auth": {
"type": null,
"secure": null,
"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",
"otp_override": truefalse
}
}
} |
Response (when otp_override = false)
| Code Block | ||
|---|---|---|
| ||
{
"status": "WaitingForOTP",
"message": "Please enter the OTP sent to 2348022****08",
"data": {
"provider_response_code": "10900T0",
"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",
"response_code": "00",
"response_message": "Success",
"user_message": "Success"
}
}
} |
Request
...
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_2
...
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 - Providers
Request
...
| language | json |
|---|
...
(validate with otp)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"lookup_account_max",
"auth": {
"secure": "{{encrypted_otp}}",
"auth_provider": "Beeceptor"
},
"transaction": {
"transaction_ref": "70713093460718"
}
} |
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 |
auth.type | string | N/A | This can be set to |
auth.secure | string | N/A | This can be set to |
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 |
transaction.mock_mode | string | optional | This can be set to either |
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 |
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 |
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)
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": { "mockaccount_modenumber": "live23632626327", "transactionotp_refoverride": "{{transaction_ref}}",true "transaction_desc": "A random transaction", }, "transactionclient_ref_parentinfo": { null, "amountname": 0"TrustPay", "customerid":{ null, "customerbank_cbn_refcode": "{{customer_id}}",null, "firstname "bank_name": "Uju"null, "surname": "Usmanu", "emailconsole_url": "ujuusmanu@gmail.com"null, "mobile_no "js_background_image": "234802343132" null, }, "metacss_url":{ null, "alogo_keyurl":"a_meta_value_1", "https://trustpay.onepipe.io/img/trustpay_logo_console.png", "anotherfooter_keytext":"a_meta_value_2" }, "Brought to you by <strong>SunTrust Bank</strong>", "detailsoptions": {[ "account_number":"23632626327","BANK.TRANSFER", "otp_override": true "CARD" }, "client_info": { ], "nameprimary_color": "TrustPay#b37038", "idsecondary_color": null"#b37038", "bankprimary_cbnbutton_codecolor": null"#b37038", "bankmodal_background_namecolor": null"linear-gradient(147.44deg, #d8903c "console_url": null26.99%, #e69921 74.1%)", "jspayment_backgroundoption_imagecolor": null"rgba(76, 61, "css_url": null47, 0.08)", "logo_url": "https://trustpay.onepipe.io/img/trustpay_logo_console.pngpayment_option_active_color": "rgba(31, 31, 31, 0.25)", "footerapp_textcolor": "#b37038"Brought to you by <strong>SunTrust Bank</strong>"}, "app_info": { "options": [ "name": "Victor Motors", "id": "BANK.TRANSFER5cdab3332b7d4100015f0db4", "beneficiary_account_no": "0001137069", "CARDextras": {/*this will contain an array of provider ],override settings*/} } "primary_color": "#b37038", } } |
Response (when otp_override = false)
Set provider_response_code to 900T0
| Code Block | ||
|---|---|---|
| ||
{ "secondary_color"status": "#b37038WaitingForOTP", "primary_button_color"message": "#b37038",Please enter the OTP sent "modal_background_color": "linear-gradient(147.44deg, #d8903c 26.99%, #e69921 74.1%)",to 2348022****08", "data": { "paymentprovider_optionresponse_colorcode": "rgba(76, 61, 47, 0.08)900T0", "payment_option_active_colorprovider": "rgba(31, 31, 31, 0.25)"Beeceptor", "errors": null, "app_colorerror": "#b37038"null, }, "appprovider_inforesponse": {null } "name": "Victor Motors", "id} |
Response (otp_override = true)
| Code Block |
|---|
{ "status": "5cdab3332b7d4100015f0db4Successful", "beneficiary_account_nomessage": "0001137069Transaction processed successfully", "extrasdata": {/*this will contain an array of provider override settings*/} } "provider_response_code": "00", } } |
Response (otp_override = false)
| Code Block | ||
|---|---|---|
| ||
{ "statusprovider": "WaitingForOTPBeeceptor", "message": "Please enter the OTP sent to 2348022****08",errors": null, "dataerror": {null, "provider_response_code": "10", { "providercustomer_id": "Beeceptor007935125", "errorsaccount_currency": null,"NGN", "account_number": "error": null,1020123456", "provideraccount_responsename": null"BOLA SALAMI", } } |
Response (otp_override = true)
| Code Block |
|---|
{ "statuslast_name": "SuccessfulSALAMI", "message": "Transaction processed successfully", "datamiddle_name": { "-", "provider_responsefirst_codename": "00BOLA", "providergender": "BeeceptorMale", "errorsdob": null,"1971-03-12T00:00:00", "erroraccount_branch": null"101", "providerscheme_responsecode": {"SAV", "customer_idbvn": "00793512522211055555", "account_currencystatus": "NGNACCOUNT OPEN", "accountledger_numberbalance": "1020123456"2524.59, "accountavailable_namebalance": "BOLA SALAMI"2524.59, "lastkyc_namelevel": "SALAMI3", "middlename_enquiry_nameid": "-0000028301", "first_nameaddress1": "BOLA9 LIGALI STREET", "genderaddress2": "Male.", "dobaddress3": "1971-03-12T00:00:00IBADAN", "account_branchemail": "101BOLASALAMI@yahoo.com", "schememobile_codenumber": "SAV080913333333", "bvnresponse_code": "2221105555500", "accountresponse_statusmessage": "ACCOUNT OPENSuccess", "ledgeruser_balancemessage": 2524.59,"Success" } "available_balance": 2524.59, "kyc_level": "3", "name_enquiry_id": "0000028301", "address1": "9 LIGALI STREET", "address2": ".", } } |
Request (validate with otp)
| Code Block | ||
|---|---|---|
| ||
{ "request_mode":"validate", "request_ref":"{{request_ref}}", "request_type":"lookup_account_min", "auth": { "type": null, "address3secure": "IBADAN{{otp}}", "emailauth_provider": "BOLASALAMI@yahoo.comBeeceptor", }, "transaction": { "mobile_number": "080913333333", mock_mode": null, "responsetransaction_coderef": "00{{transaction_ref}}", "transaction_desc": null, "responsetransaction_ref_messageparent": "Success"null, "amount": 0, "user_messagecustomer":null, "Success" "meta":null, } "details": null } } |
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, then respond with WaitingForOTP.
On the OTP validation leg, 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.
...