Account Services
A set of services with which you can operate and manage accounts. It covers capabilities like opening an account, getting the accounts linked to a mobile number, blocking an account, etc. These set of services are particularly useful to lenders and credit businesses who need to assess risk, verify account ownership and much more. Also, the APIs defined here can be useful for companies working on personal finance management and asset tracking tools.
Open Account
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.
Get Accounts Min
With this service, the calling apps can take customer ref and return a masked list of accounts linked to it. Apps will collect the customer ref they will like to obtain information on and forward to OnePipe. 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.
Get Accounts Mid
With this service, the calling apps can take customer ref and return an unmasked list of accounts linked to it. Apps will collect the customer ref they will like to obtain information on and forward to OnePipe. 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.
Get Accounts Max
With this service, the calling apps can take customer ref and return an unmasked list of accounts linked to it as well as extended data per account. Apps will collect the customer ref they will like to obtain information on and forward to OnePipe. 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.
Get Balance
With this service, the calling apps can get available balance for a given source. 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. It’s also possible that some providers will require extended authorization information (like an OTP), if needed, providers need to prompt for this. Upon the correct details being provided, the provider will respond with account/wallet balance information.
Get Statement
With this service, the calling apps can get statements of accounts. Apps will forward the customer reference (account number, or any unique reference) they will like to obtain information on and forward to OnePipe. 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.
Block Account
With this service, the calling app can request that debit access to a customer’s account or wallet or other store of value be disabled. Apps will collect authorisation details and forward to OnePipe to execute, OnePipe will in turn forward to the provider’s dedicated implementation. For this service, apps are required to obtain consent to block account from the customer (likely at a prior time before the time the hold is required).
Hold funds
With this service, the calling app can request for a fixed amount of money be held from a customer’s account or wallet or other store of value. Apps will collect authorisation details and forward to OnePipe to execute, OnePipe will in turn forward to the provider’s dedicated implementation. For this service, apps are required to obtain consent to hold funds from the customer (likely at a prior time before the time the hold is required).
Lookup Account Min
With this service, the calling apps can KYC a customer's account number or other authorization details like cards or wallets. This service will only return minimal KYC information. Apps will collect the account number they will like to obtain information on and forward it to OnePipe. If authorization details are required by a provider, apps will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation.
Lookup Account Mid
With this service, the calling apps can do KYC with the customer's account number. This service will return slightly above minimal KYC information. Apps will forward the account number they will like to obtain information on and forward it to OnePipe. If authorization details are required by a provider, apps will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation.
Lookup Account Max
With this service, the calling apps can do KYC with the customer's account number or card or other supported auth details. This service will return maximum KYC information. Apps will forward the auth details to OnePipe. If authorization details are required by a provider, apps will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation.
Get Stamped Statement
With this service, the calling apps can get stamped statements of accounts. Apps will forward the customer reference (account number, or any unique reference) they will like to obtain information on and forward to OnePipe. 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.
Close Account
With this service, the calling apps can carry out account closure operations. Apps will forward details to OnePipe. Apps will supply details required to close 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.