With this service, the calling apps can get list of financial institutions with their corresponding codes. Apps will collect authorisation details and forward to OnePipe to execute, OnePipe will in turn forward to the provider’s dedicated implementation. The provider will return a list of all financial institutions available.

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.

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, setting auth.Type as null is supported.
Provider responds with any of the completion codes Successful or Failed.

INTERFACE SPECIFICATION (APP → ONEPIPE)

Request (Transact)

{
  "request_ref":"{{request_ref}}", 
  "request_type":"get_banks",
  "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": null
  }
}

Response

{
    "status": "Successful",
    "message": "Transaction processed successfully",
    "data": {
        "provider_response_code": "00",
        "provider": "Beeceptor",
        "errors": null,
        "error": null,
        "provider_response": {
            "banks": [
                {
                    "bank_cbn_code": "050",
                    "bank_nip_code": "090270",
                    "bank_name": "Ecobank Bank"
                },
                {
                    "bank_cbn_code": "214",
                    "bank_nip_code": "000270",
                    "bank_name": "FCMB"
                },
                {
                    "bank_cbn_code": "313",
                    "bank_nip_code": "000070",
                    "bank_name": "Mkudi"
                },
                {
                    "bank_cbn_code": "401",
                    "bank_nip_code": "107019",
                    "bank_name": "ASOSavings"
                },
                {
                    "bank_cbn_code": "917",
                    "bank_nip_code": "100016",
                    "bank_name": "GOWANS MFB"
                }
            ],
            "reference": "000022200225154318222333334432",
            "meta":{
              "field_key":"field_value",
              "field_key":"field_value"
            }
        }
    }
}

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.

Acceptable values for auth.type

null

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)

Read this closely.

Public wiki

Get Banks

Analytics