Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

With this service, the calling apps can do KYC with the customer's BVNbvn. This service will return slightly above minimal KYC information. Apps will collect authorisation details the BVN they will like to obtain information on and forward to OnePipe to execute a lookup; . If authorisation 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

...

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.

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 can use the Send SMS and Send Email services on OnePipe to send their OTP.

Settlement & fees model

...

Amount

Model

How it works

N/A

Commission

N/A

Invoice

The host client will invoice the calling app periodically for all calls to the endpoint.

Acceptable values for auth.type

  • bvn

Process flows

Sequence of calls

  1. App calls /transact with the right auth details

  2. Provider responds with WaitingForOTP or PendingValidation as may be required

  3. App calls /transact/validate to supply OTP if needed

  4. Provider responds with any of the completion codes Successful or Failed.

  5. To query the status of a transaction, the app can call /transact/query

  6. Where the provider supports it, the app can call /transact/reverse to request a reversal

Gliffy
imageAttachmentIdatt32243723
macroIda9d3d285-2916-4123-9e93-236a130f390f
baseUrlhttps://onepipe.atlassian.net/wikimacroIda9d3d285-2916-4123-9e93-236a130f390f
nameOnePipe 2.0 Collect Service
diagramAttachmentIdatt32210953
containerId32243713
timestamp1581541644494

Interface specification - apps

...

1581541309221

INTERFACE SPECIFICATION (APP → ONEPIPE)

Info

For details on encryption using the Triple DES Algorithm, read this.

Request (Transact)

Code Block
languagejson
{
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_bvn_2mid",
  "auth": {
    "type": null"bvn", 
    "secure": null"{{encrypted_bvn}}",
    "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",
    	"anotherb_key":"a_meta_value_2"
    },
    "details": {
    	"bvn":"23632626327",null
    	"otp_override": true
    }
  }
}

Response (when otp_override = false)

Code Block
languagejson
{
    "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
languagejson
{
    "status": "Successful",
    "message": "Transaction processed successfully",
    "data": {
        "provider_response_code": "00",
        "provider": "Beeceptor",
        "errors": null,
        "error": null,
        "provider_response": {
            "customer_idreference": "00793512598776665556665",
            "account_currencybvn": "NGN22333055555",
            "accountfirst_numbername": "1020123456John",
            "accountmiddle_name": "BOLA SALAMIJane",
            "last_name": "SALAMIDoe",
            "middle_namedob": "1990-12-22",
            "firstphone_namenumber1": "BOLA07037608648",
            "genderphone_number2": "Male",
            "dobregistration_date": "19711990-03-12T00:00:0012-22",
            "account_branchemail": "101john.doe@gmail.com",
            "scheme_codegender": "SAVMale",
            "bvnlevel_of_account": "22211055555",Level 2 - Medium          "account_status": "ACCOUNT OPEN"Level Accounts",
            "ledgerlga_of_balanceorigin": 2524.59,
            "available_balance": 2524.59"Owerri West",
            "kyclga_of_levelresidence": "3Ikeja",
            "namemarital_enquiry_idstatus": "0000028301Single",
            "address1meta":{}
"9 LIGALI STREET",      }
    }
 "address2": ".",
        }

Request (validate with otp)

Code Block
languagejson
{
  "request_ref":"{{request_ref}}", 
  "address3request_type": "IBADANlookup_bvn_mid",
            "email	"auth": "BOLASALAMI@yahoo.com",
{
           "mobile_number"secure": "080913333333{{encrypted_otp}}",
 
          "responseauth_codeprovider": "00Beeceptor", 
    },
      "response_messagetransaction": "Success",
  {
         "usertransaction_messageref": "Success"
        }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_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

...

...

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

...

will

...

be

...

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 response.message will contain the prompt.

Interface specification - Providers

Request

Code Block
languagejson
{
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_bvn_2",
  "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": {
    	"bvn":"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 (otp_override = false)

Code Block
languagejson
{
    "status": "WaitingForOTP",
    "message": "Please enter the OTP sent to 2348022****08",
    "data": {
        "provider_response_code": "10",
        "provider": "Beeceptor",
        "errors": null,
        "error": null,
        "provider_response": null
    }
}

Response (otp_override = true)

...

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

...