With this service, the calling apps can open a wallet on behalf of a customer. Apps may collect BVN as an input or not. But at a minimum, apps will need to collect customer details and forward to OnePipe. If BVN is required, it would be passed in as part of authorization details. OnePipe will in turn forward to the provider’s dedicated implementation. This service may use OTP to confirm the account opening request from the customer.

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

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 (if supplied)
Provider responds with WaitingForOTP or PendingValidation (if 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)

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

Request (Transact)

{
    "request_mode": "transact",
    "request_ref": "{{request_ref}}",
    "request_type": "open_wallet",
    "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": {
            "name_on_account": "Tobi Olajide",
            "middlename": "string",
            "otp_override": true,
            "dob": "yyyy-MM-dd-HH-mm-ss",
            "gender": "M",
            "title": "Mr",
            "address_line_1": "23, Okon street, Ikeja",
            "address_line_2": "Ikeja",
            "city": "lagos",
            "state": "lagos",
            "country": "NG"
        }
    }
}

Response (when otp_override = false)

{
    "status": "PendingValidation",
    "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": {
            "account_number": "2233305555"
        }
    }
}

Request (validate with otp)

{
  "request_ref":"{{request_ref}}", 
  "request_type":"open_account",
	"auth": {
        "secure": "{{encrypted_otp}}",
        "auth_provider": "Beeceptor" 
    },
    "transaction": {
        "transaction_ref": "70713093460718"
    }
}

Acceptable values for `auth.type`

Type	Description
bvn	Specifies that encrypted value in `auth.secure` is a customer bvn. It can also be null.
null	To open this account, it can be done without a BVN

Breakdown of the details object

For this service, the details object will have the following:

Field	Type	Requirement	Description
otp_override	boolean	optional	Defaults to `false`. If set to `true`, request will not be validated by OTP.
middlename	string	optional	Middle name of the customer.
name_on_account	string	compulsory	The name that should be on the account.
dob	string	compulsory	Date string for date of birth
gender	string	compulsory	Gender of the customer. This can be set to either `M` or `F`
title	string	compulsory	Gender of the customer. This can be set to either `Mr`, `Mrs`, `Ms`
address_line_1	string	compulsory	Address of customer
address_line_2	string	compulsory	Address of customer
city	string	compulsory	City
state	string	compulsory	State
country	string	compulsory	Country

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 MICRO SERVICE)

Request payload from OnePipe to the provider microservice comes encrypted, using the Triple DES Algorithm. See details.

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

Open Wallet