With this service, the calling apps can carry out account opening operations. Apps will forward details to OnePipe. Apps will supply details required to open an account on behalf of a customer. 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.

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.

Special Note

This service allows providers to support a manual mode, where if the API call fails or the provider cannot do automated account creation, then the provider implementation should send an email to a configured email address (and cc support@onepipe.io) and in the body of the email, include all the necessary details to open the account. Basically, the payload passed to the Open Account request, should be sent by email to an admin to perform manual account opening. Then the API should respond with a temporary account number of the format TEMP{{transaction_ref}}. And a status of Processing.

This should be encapsulated in a provider setting to be called email_failover. Such that if this flag is true, the above logic then executes.

Settlement & fees model

Model	How it works

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)

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

Request (Transact)

{
    "request_ref": "{{request_ref}}",
    "request_type": "open_account",
    "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": "Remilekun",
            "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": {
            "reference":"263636363633777",
            "account_number": "2233305555",
            "contract_code": null,
            "account_reference": "48214462006092",
            "account_name": "Akinkunmi Olunloye",
            "currency_code": "NGN",
            "customer_email": "akin@onepipe.io",
            "bank_name": null,
            "bank_code": null,
            "account_type": null,
            "status": "ACTIVE",
            "created_on": "2020-04-05 23:08:01",
            "meta":{}
        }
    }
}

Request (validate with otp)

Acceptable values for `auth.type`

Type	Description

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

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	optional	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

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)

Read this closely.

Public wiki

Open Account

Commercial model

Special configuration notes

Settlement & fees model

Process flows

INTERFACE SPECIFICATION (APP → ONEPIPE)

Request (Transact)

Response (when otp_override = false)

Response (when otp_override = true)

Request (validate with otp)

Acceptable values for `auth.type`

Breakdown of the details object

Possible status response codes

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)

Special notes for OTP override

Commercial model

Special configuration notes

Settlement & fees model

Process flows

INTERFACE SPECIFICATION (APP → ONEPIPE)

Request (Transact)

Response (when otp_override = false)

Response (when otp_override = true)

Request (validate with otp)

Acceptable values for auth.type

Breakdown of the details object

Possible status response codes

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)

Special notes for OTP override

Acceptable values for `auth.type`