Overview

With this service, the calling apps can get list of branches for financial institutions. Apps will collect authorisation details and forward to OnePipe to execute, 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. Parties that share the fees are:

OnePipe
Host client
Provider
ISO

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"
                }
            ]
        }
    }
}

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 `list_branches`
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	compulsory	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

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.

Request (Transact)

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

Successful 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"
                }
            ]
        }
    }
}

Failed Response

{
    "status": "Failed",
    "message": "Operation was not successful",
    "data": {
    	"provider_responde_code":"91",
    	"provider": "Beeceptor",
        "errors": [
          {
            "code" : "91",
            "message : "Reason why it failed"
          }
        ],
        "error": {
          "code" : "01",
          "message : "Reason why it failed"
        },
        "provider_response": {
	       "response_code": "91",
		   "response_message":"Failed",
		   "banks": null
        }
    }
}

List Branches

Overview

Commercial model

Settlement & fees model

Process flows

INTERFACE SPECIFICATION (APP → ONEPIPE)

Request (Transact)

Response

Request Payload Description

Possible status response codes

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)

Request (Transact)

Successful Response

Failed Response

0 Comments