Overview

With this service, the calling apps can do KYC with the customer's account number. This service will return maximum KYC information. Apps will forward the account number they will like to obtain information on and forward it to OnePipe. If authorization details are required by a provider, apps will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation.

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
ISO

Special configuration notes

OTP override: 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.
SMS handler: All providers that need to do OTP validation need to have otp_api_key, and otp_api_secret configured. They will use this to call the Send SMS and Send Email service on OnePipe to send their OTP.

Settlement & fees model

Model	How it works
Invoice	The host client will invoice the calling app periodically for all calls to the endpoint.

Process flows

Sequence of calls

App calls /transact with the right auth details
Provider responds with WaitingForOTP or PendingValidation as may be required
App calls /transact/validate to supply OTP if needed
Provider responds with any of the completion codes Successful or Failed.
To query the status of a transaction, the app can call /transact/query
Where the provider supports it, the app can call /transact/reverse to request a reversal

INTERFACE SPECIFICATION (APP → ONEPIPE)

Request

{
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_account_max",
  "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": false
    }
  }
}

Response (when otp_override = false)

{
    "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)

{
    "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"
        }
    }
}

Request (validate with otp)

{
  "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 `lookup_account_max`
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`, the 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 the 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	The email address of the 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 lookup
otp_override	boolean	optional	Defaults to `false`. If set to `true`, the 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

{
  "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

{
    "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)

{
    "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"
        }
    }
}

Request (validate with otp)

{
  "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
  }
}

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, the 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.

Lookup Account Max

Overview

Commercial model

Special configuration notes

Settlement & fees model

Process flows

INTERFACE SPECIFICATION (APP → ONEPIPE)

Request

Response (when otp_override = false)

Response (when otp_override = true)

Request (validate with otp)

Request Payload Description

Breakdown of the details object

Possible status response codes

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER)

Request

Response (when otp_override = false)

Response (otp_override = true)

Request (validate with otp)

Special notes for OTP override

Special notes for providers

0 Comments