Create a Connected Account
Creation of a connected businesses/account
Connected accounts can be created via dashboard and available via API for larger integrations. If you accessing connected accounts via your business dashboard, simply go to connect and select the connected account tab.
Terminologies for connected businesses
bankName
andaccountNumber
: This refers to the bank account of the connected account while the later refers to the bank code
Access get banks
endpoint here
businessName
anduserMobile
: This refers to the name of the business and the phone number associated with the business/merchant.splitType
: this refers to the commission the parent business would like to receive from the connected account. Split types includeflat
andpercentage with cap
flat
: this refers to a flat fee you want to receive from the connected account from each transaction madeto accept a payment of 50 naira for each transaction,
split_type
will be"flat"
andsplit_value
will be50
to accept a payment of 100 naira for each transaction,
split_type
will be"flat"
andsplit_value
will be100
percentage with cap
: this refers to the percentage of the transaction you would like to get as a commission with a captxCap
(or no cap)to accept payment of 3% for each transaction with a cap of 2000 naira,
split_type
will be"percentage with cap"
andsplit_value
will be0.03
whiletxCap
will be2000
to accept payment of 3% for each transaction with no cap,
split_type
will be"percentage with cap"
andsplit_value
will be0.03
whiletxCap
will be 0
Create Connected accounts
Connected accounts can either be created via your business/merchant dashboard or directly via create account endpoint.
Create a Connected Accounts
POST
https://api2.ourpass.co/v1/api/subaccounts/partial
This endpoint help businesses to create connected accounts
Headers
Name | Type | Description |
---|---|---|
apiKey* | String | Pass your api key in the request header to authorise the call |
Last updated