...
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 account number they will like to obtain information on and forward it to 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.
...
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"lookup_account_max",
"auth": {
"type": "bank.account | card",
"secure": "{{encrypted_secure}}",
"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
"otp_override": false
}
}
} |
Response (when otp_override = false)
...
| Code Block | ||
|---|---|---|
| ||
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"customer_id": "007935125",
"account_currency": "NGN",
"account_number": "1020123456",
"account_name": "BOLA SALAMI",
"last_name": "SALAMI",
"middle_name": "-",
"first_name": "BOLA",
"gender": "Male",
"dob": "1971-03-12T00:00:00",
"account_branch": "101",
"scheme_code": "SAV",
"bvn": "22211055555",
"account_status": "ACCOUNT OPEN",
"ledger_balance": 2524.59,
"available_balance": 2524.59,
"kyc_level": "3",
"name_enquiry_id": "0000028301",
"address1": "9 LIGALI STREET",
"address2": ".",
"address3": "IBADAN",
"email": "BOLASALAMI@yahoo.com",
"mobile_number": "080913333333",
"account_type": "CURRENT",
"meta": {}
}
}
} |
Request (validate with otp)
...
| Code Block |
|---|
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"customer_id": "007935125",
"account_currency": "NGN",
"account_number": "1020123456",
"account_name": "BOLA SALAMI",
"last_name": "SALAMI",
"middle_name": "-",
"first_name": "BOLA",
"gender": "Male",
"dob": "1971-03-12T00:00:00",
"account_branch": "101",
"scheme_code": "SAV",
"bvn": "22211055555",
"account_status": "ACCOUNT OPEN",
"ledger_balance": 2524.59,
"available_balance": 2524.59,
"kyc_level": "3",
"name_enquiry_id": "0000028301",
"address1": "9 LIGALI STREET",
"address2": ".",
"address3": "IBADAN",
"email": "BOLASALAMI@yahoo.com",
"mobile_number": "080913333333",
"account_type": "CURRENT",
"meta" : {}
}
}
} |
Request (validate with otp)
...
Whenever a request is to be validated by OTP, the provider microservice should first call the provider, store response info in the database, send an OTP to the phone number attached to the BVN, then respond with WaitingForOTP.
On the OTP validation phase, if user OTP is valid, provider should retrieve info from the database, then respond with a Successful response.
NB: Data should be erased from the DB.
Special notes for providers
This should be seen as a standard payments service. All providers are required to execute settlement per agreed contracts to the account designated by the client bank.