Overview
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.
...
OTP override: All providers of this service should implement OTP, but support the configuration of
otp_overridesuch that based on this configuration, they could be instructed to bypass the OTP requirement for an app.SMS handler: All providers that need to do OTP validation can use the Send SMS and Send Email services on OnePipe to send their OTP.
Acceptable values for auth.type
card
bank.account
wallet
null
Process flows
Sequence of calls
...
| Gliffy | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"get_accounts_min",
"auth": {
"type": "card | wallet | bank.account", //This only applies if the source is sensitive. Can be null
"secure": "{{encrypted_secure}}", //This only applies if the source is sensitive. Can be 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}}", //This is the main source (customer ref)
"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
}
} |
...
| Code Block | ||
|---|---|---|
| ||
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"accounts": [
{
"account_number": "009****000",
"account_name": "Ola Waheed",
"bank_name": "FBN",
"bank_code": "011"
},
{
"account_number": "009****000",
"account_name": "Ola Waheed",
"bank_name": "FBN",
"bank_code": "011"
}
],
"reference": "000022200225154318222333334432",
"meta": {{
"field_key":"field_value",
"afield_key":"afield_value"
}
}
}
} |
Request (validate with otp)
...
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 |
...
. |
...
card
...
bank.account
...
wallet
...
INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)
...