With this service, the calling apps can get list of branches for financial institutions. Effectively, a provider will provide the list of physical locations that a given financial institution operates from. This services makes a fundamental assumption that the provider here is also the said financial institution. It would be either branches, offices, or other relevant addresses as relates to the given financial institution. OnePipe will forward to the provider’s dedicated implementation to provide this information.

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
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 authType 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":"list_branches",
  "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": {
            "branches": [
                {
                    "branch_code": "355",
                    "branch_name": "BRD STR BRANCH",
                    "branch_address1": "51/55  BROAD STREET, ",
                    "branch_address2": "LAGOS",
                    "branch_address3": " LAGOS "
                },
                {
                    "branch_code": "364",
                    "branch_name": "KIRIKASA BRANCH",
                    "branch_address1": "1, KIRIKASSAMA  ROAD ",
                    "branch_address2": "MAIDUGURI",
                    "branch_address3": "BORNO"
                }
            ],
            "meta": {}
        }
    }
}

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

Acceptable values for auth.type

null

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)

Read this closely.

List Branches