![](\"http://www.onepipe.io/docs/chappme.png\")
NOTE: For version 1 information, please see OnePipe v1 documentation
\nThis suite of APIs provides access to an array of financial services-related APIs like card charging, account debit, statement lookup, airtime purchase, bill payment, instant loans and KYC lookup services. Some of these services come from multiple providers like Polaris Bank, SunTrust Bank, Interswitch, Flutterwave and Paystack, but OnePipe wraps around them an abstraction layer with one major goal: To provide a consistent interface to integrators regardless of underlying service provider. That way, you can switch between providers at any time, based on quality of service, business justification, etc. without starting a new integration project or changing your systems in any way.
\nAbility to add multiple providers for the same service
\nA standard unified API interface encapsulating all feature set available across providers
\nAbility to setup as many apps as possible and determine which provider should fulfill the service for each app.
\n![](\"http://www.onepipe.io/docs/principles.jpg\")
\n\nClick the run in postman button in the top right to import the collection.
\nFamiliarise yourself with the variables in the collection
\nTry the various endpoints using the pre-loaded API keys
\nAccess to the APIs can only be via any of the OnePipe partners. We refer to them as \"hosts\". They are Banks with whom we have a special arrangement. Once granted access under their account, you will receive an invite email to set your password.
\nSign up here
\nOnce approved, you will receive an email to set up your password
\nLogin and with newly set password, then generate your API key and secret
\nUpdate the variables api-key and secret-key in the collection
\nChange the mock_mode in any endpoint you want to try to inspect
Use the tools here to manage encryption of the secure elements
\nTry as many API calls as required
\nThe bank will contact you about necessary documentations and KYC
\nOnce completed, the bank will enable you for go live
\nOnce approved, switch your calls between live and test as you see fit. This can be done per service/endpoint (from the console) or changing the mock_mode in the payload of your calls to live.
The APIs are fairly RESTful and are organized around the main services you would be interacting with. The base url sits at:
\nhttps://api.onepipe.io\n\nFor your API calls, include your API key in the Authorization header of every request you make. You can manage your API keys from your dashboard.
\nSample Authorization Header:
\nAuthorization: Bearer {api_key}\n\nAlso, every request requires you to provide a unique request_ref per call within the payload. Then You'd need to add a custom header called Signature which is an MD5 hash of that request_ref and your api_secret separated by a semi-colon. ;. This just serves as a simple way to \"sign\" your payload as a second layer of security.
Sample Signature Header:
\nSignature:MD5Hash(request_ref;client_secret)\n\nYour complete header for evey single call will look like:
\nContent-Type:application/json\nAuthorization:Bearer {{api_key}}\nSignature:{{MD5Hash(request_ref;client_secret)}}\n\nThe operations you can perform on any OnePipe API falls into the following categories
\nFor all requests, you'd put a JSON object in the body of your API call. All payloads have the following high level construct:
\n {\n \"request_ref\":\"{{request_ref}}\", \n \"request_type\":\"transfer_funds\",\n \"auth\": {\n \"type\": \"bank.account | card | wallet\", \n \"secure\": \"{{encrypted(bank account details | card details | wallet)}}\",\n \"auth_provider\": \"Beeceptor\",\n \"route_mode\": null\n },\n \"transaction\": {\n \"mock_mode\": \"live\", \n \"transaction_ref\": \"998383938292\", \n \"transaction_desc\": \"A random transaction\", \n \"transaction_ref_parent\": null, \n \"amount\": 1000,\n \"customer\":{\n \"customer_ref\": \"DemoApp_Customer007\",\n \"firstname\": \"Uju\",\n \"surname\": \"Usmanu\",\n \"email\": \"ujuusmanu@gmail.com\",\n \"mobile_no\": \"234802343132\"\n },\n \"meta\":{\n \"a_key\":\"a_meta_value_1\",\n \"another_key\":\"a_meta_value_2\"\n },\n \"details\": {\n \"a_key\":\"a_value\",\n \"a_key\":\"a_value\"\n }\n }\n }\n\nFor all responses, you'd get a JSON object in the body of the response you receive. All payloads have the following high level construct:
\n {\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"DemoProvider\",\n \"errors\": [],\n \"error\": {},\n \"provider_response\": {\n \"reference\": \"000022200225154318222333334432\",\n \"field_key\":\"field_value\",\n \"field_key\":\"field_value\",\n \"field_etc\": \"3056433222\",\n \"meta\":{\n \"fee_flat\": 0,\n \"fee_percent\": 0,\n \"commission_flat\": 0,\n \"commission_percent\": 0,\n \"field_key\":\"field_value\",\n \"field_key\":\"field_value\"\n }\n }\n }\n }\n\nstatus: Indicates the state of the request, whether successful, failed or anything in between
\nmessage: Provides a text description of the state of the request and at times a message for the customer
\ndata: Will contain much more details of the outcome of the request. The values within this could vary by request type or endpoint called but some standard elements would be in almost all calls
\nprovider_response_code: The actual response code received from the underlying provider, e.g. 00 for Quickteller
provider_response: This contains the actual response from the provider, specific to the actual operation you are trying to perform. The elements here will vary based on the operation. This is the main area of interest.
\nprovider: The provider that was used to process the request
\nerrors: In case of a failed transaction, this contains the lists of errors that occurred while processing the transaction
\nerror: This contains the most important error that hinders the successful completion of the transaction.
We highly recommend that developers use the Errors field to determine the result of an API call. As an empty Errors node indicates a successful transaction.
NOTE: Some API calls may have response elements that are only applicable to those API calls. You will see examples in the provided postman collection and across the documentation.
\nSuccessful: For all requests that were successfully processed
\nFailed: If a request fails. Read the errors object(s)
\nWaitingForOTP: If a request requires OTP validation for completion.
\nPendingValidation: If a request requires other information to be supplied for completion.
\nProcessing: If a transaction request is still in a processing state and needs to be subsequently queried.
\nOptionsDelivered: Applicable only for services that support some form of options processing.
\nInvalidID: If an ID being looked up by service is not valid.
\nFraud: If a request is flagged as suspicious.
\nDuplicate: If a similar request has been made earlier within a stipulated time frame of 5 minutes.
\nPendingFulfilment: The transaction requires extra steps from the customer.
\n[Anything else]: This would vary per endpoint called. Applicable values would be in the documentation for that endpoint.
\n200: Request was processed \"conclusively\". Not to be taken as a successful status. Always read the response.status object for actual processing status. Also note that the description field on the response can contain further steps to be carried on this transaction.
400: Data validation error occurred due to inconsistent data supplied by the client
\n401: Invalid request authorization, which might be due to invalid API key or the client is not registered for the service being accessed.
\n500: An internal server error at our End, this should be reported if it persists.
\nAs mentioned, the auth.secure enlement needs to contain the encrypted value of authorization details or customer credentials. e.g. card details. Encrypt the value using the Triple DES Encryption Algorithm with your Client application secret key as the encryption key.
E.g.
\ncard, it should be:TripleDES.encrypt(\"{card.Pan};{card.Cvv};{card.Expdate};{card.Pin}\",secretKey)\n\nbank.account , it should be:TripleDES.encrypt(\"{accountNumber};{bankCBNCode}\",secretKey)\n\nwallet , it should be:TripleDES.encrypt(\"{walletNumber};{providerCode}\",secretKey)\n\nairtime , it should be:TripleDES.encrypt(\"{phoneNumber};{telcoCode}\",secretKey)\n\nvoucher , it should be:TripleDES.encrypt(\"{voucherCode};{providerCode}\",secretKey)\n\nbvn , it should be:TripleDES.encrypt(\"{bvn}\",secretKey)\n\nbasic , it should be:TripleDES.encrypt(\"{userName};{password}\",secretKey)\n\ncustom , it should be:TripleDES.encrypt(\"{ref}\",secretKey)\n\nNOTE Expiry date is MMyy
\nMessageDigest md = MessageDigest.getInstance(\"md5\");\nbyte[] digestOfPassword = md.digest(key.getBytes(\"UTF-16LE\"));\nbyte[] keyBytes = Arrays.copyOf(digestOfPassword, 24);\nfor (int j = 0, k = 16; j < 8;) {\n keyBytes[k++] = keyBytes[j++];\n}\nSecretKey secretKey = new SecretKeySpec(keyBytes, 0, 24, \"DESede\");\nIvParameterSpec iv = new IvParameterSpec(new byte[8]);\nCipher cipher = Cipher.getInstance(\"DESede/CBC/PKCS5Padding\");\ncipher.init(Cipher.ENCRYPT_MODE, secretKey, iv);\nbyte[] plainTextBytes = toBeEncrypted.getBytes(\"UTF-16LE\");\nbyte[] cipherText = cipher.doFinal(plainTextBytes);\nString output = new String(Base64.encodeBase64(cipherText));\nreturn output;\n\nstring encryptedText = \"\";\nMD5 md5 = new MD5CryptoServiceProvider();\nTripleDES des = new TripleDESCryptoServiceProvider();\ndes.KeySize = 128;\ndes.Mode = CipherMode.CBC;\ndes.Padding = PaddingMode.PKCS7;\nbyte[] md5Bytes = md5.ComputeHash(Encoding.Unicode.GetBytes(key));\nbyte[] ivBytes = new byte[8];\ndes.Key = md5Bytes;\ndes.IV = ivBytes;\nbyte[] clearBytes = Encoding.Unicode.GetBytes(TextToEncrypt);\nICryptoTransform ct = des.CreateEncryptor();\nusing (MemoryStream ms = new MemoryStream())\n{\n using (CryptoStream cs = new CryptoStream(ms, des.CreateEncryptor(), CryptoStreamMode.Write))\n {\n cs.Write(clearBytes, 0, clearBytes.Length);\n cs.Close();\n }\n encryptedText = Convert.ToBase64String(ms.ToArray());\n}\nreturn encryptedText;\n\nfunction EncryptV2($encryption_key,$data)\n{\n $method = \"des-ede3-cbc\";\n $source = mb_convert_encoding($encryption_key, 'UTF-16LE', 'UTF-8');\n $encryption_key = md5($source, true);\n $encryption_key .= substr($encryption_key, 0, 16);\n $iv = \"\\0\\0\\0\\0\\0\\0\\0\\0\";\n $encData = openssl_encrypt($data,$method, $encryption_key, $options=OPENSSL_RAW_DATA, $iv);\n echo base64_encode($encData);\n}\n\nconst crypto = require('crypto');\nfunction encrypt(secretKey, plainText) {\n const bufferedKey = Buffer.from(secretKey, 'utf16le');\n const key = crypto.createHash('md5').update(bufferedKey).digest();\n const newKey = Buffer.concat([key, key.slice(0, 8)]);\n const IV = Buffer.alloc(8, '\\0');\n const cipher = crypto.createCipheriv('des-ede3-cbc', newKey, IV).setAutoPadding(true);\n return cipher.update(plainText, 'utf8', 'base64') + cipher.final('base64');\n}\n\nNB: If the snippet of your preferred language is not available, you can make use of our Encryption Service on Docker
\nAll services subscribed to in your application are attached to providers that will end up fulfilling such service(s) on request. You can switch providers as you wish by managing the application from your dashboard and editing the service details. Also, for some endpoints, you can explicitly set the provider you would like to be used in the request payload. You would see examples in the documentation for the endpoints that support this.
\nAnywhere bank codes are required in the API specification (bank_code), this refers to the CBN bank codes. Details of all bank codes can be found here.
Paystack - Test cards here
\nFlutterwave - Test cards here
\nQuickteller - Test cards here => Pan:5061040000000000306 Pin:1234 CVV:123 EXP:1901
\nScheduler works great with all of OnePipe existing services be it purchase services, payment services or credit services. You can set up a schedule that works best for you and your customers. With this provider, re-occuring transactions can be scheduled to be processed on a regular basis by using the additional meta tag that is present for all OnePipe services.
This will enable you to process future transactions for different time periods such as daily, weekly, monthly and more! for example, you might want to be able to collect monthly payments from your customers or schedule for automatic transfers to account(s) on a regular basis.
\nFirst, please be familiar with below documentation on OnePipe services...
\nWith this call transact/schedule, you can send a request to be processed in a future date and/or at regular time intervals. You will have to provide your authorisation details and OnePipe will in turn forward to the provider’s dedicated implementation for execution on the specified date. On job complete, transaction notification will be sent to the customer via the client webhook. For example: Buy N1000 airtime every 7 days (weekly) using the buy_airtime purchase service.
Call v2/transact/schedule with the right auth details and request_type.
Provider responds with any of the completion codes Successful or Failed.
Please note:Please refer to OnePipe v2 documentation to understand the several request_types available which are grouped into different segments for example, payment services, messaging services and more!). You will only have to include three extra tags that start with the repeat_ keyword. These tags must be specified within the meta tag of the payload in order to schedule a future request.
For all schedule requests, you'd put a JSON object in the body of your API call. All payloads have the following high level construct:
\n {\n \"request_ref\":\"{{request_ref}}\", \n \"request_type\":\"{{request_type}}\",\n \"auth\": {\n \"type\": \"Basic\", \n \"secure\": \"{{encrypted(password)}}\",\n \"auth_provider\": \"Scheduler\"\n },\n \"transaction\": {\n \"mock_mode\": \"inspect\", \n \"transaction_ref\": \"998383938292\", \n \"transaction_desc\": \"A random scheduled transaction\", \n \"transaction_ref_parent\": null, \n \"amount\": 1000,\n \"customer\":{\n \"customer_ref\": \"DemoApp_Customer007\",\n \"firstname\": \"Demo\",\n \"surname\": \"Demo\",\n \"email\": \"demo@gmail.com\",\n \"mobile_no\": \"234802343132\"\n },\n \"meta\":{\n \"repeat_frequency\":\"once | hourly | daily | weekly | monthly | yearly\",\n \"repeat_start\":\"2021-02-27-18-50-00\"\n \"repeat_target_provider\":\"Payant\",\n \"exclude\":\"Sunday\"\n },\n \"details\": {\n \"a_key\":\"a_value\",\n \"a_key\":\"a_value\"\n }\n }\n }\n\nFor all schedule responses, you'd get a JSON object in the body of the response you receive. All payloads have the following high level construct:
\n {\n \"status\": \"Successful\",\n \"message\": \"Operation was successful\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Scheduler\",\n \"errors\": [],\n \"error\": {},\n \"provider_response\": \"null\"\n }\n }\n\nstatus: The state of the request, whether successful or failed
message: Provides a text description of the state of the request
data: This will contain much more details of the outcome of the request which will include the response code from the provider and any error objects if present
provider_response_code: The actual response code received from the Scheduler provider, e.g. 00 for Successful requests
provider_response: This contains additional response from the provider if any specific to the actual operation being performed.
provider: The provider that was used to process the request. This will always be Scheduler.
errors: In case of a failed transaction, this contains the lists of errors that occurred while processing the transaction
error: This contains the most important error that hinders the successful completion of the transaction.
We highly recommend that developers use the Errors field to determine the result of an API call. As an empty Errors node indicates a successful transaction.
status and messageSuccessful: Success
\n[Anything else]: Error. Read the errors object(s)
\nWith this service v2/transact/schedule/reverse, you can cancel a previously scheduled request. Upon successful response from the Scheduler Provider, the future re-occuring transactions will not be executed on a regular basis. To continue with the schedule after termination, you will have to post a new request.
Now, here's the call sequence specific to this service...
\nCall /transact/schedule/reverse with the right auth details and request_type.
Provider responds with any of the completion codes Successful or Failed.
Please note:Please refer to OnePipe v2 documentation to understand the several request_types available which are grouped into different segments for example, payment services, messaging services and more!). You will only have to include three extra tags that start with repeat_ specified in more detail below inside the meta tag of the payload to schedule a future request.
For all reverse requests, you'd put a JSON object in the body of your API call. All payloads have the following high level construct:
\n {\n \"request_ref\":\"{{request_ref}}\", \n \"request_type\":\"{{request_type}}\",\n \"transaction\": { \n \"transaction_ref\": \"998383938292\", \n \"transaction_desc\": \"A sample transaction to be reversed\"\n }\n }\n\nFor all reverse responses, you'd get a JSON object in the body of the response you receive. All payloads have the following high level construct:
\n {\n \"status\": \"Successful\",\n \"message\": \"Operation was successful\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Scheduler\",\n \"errors\": [],\n \"error\": {},\n \"provider_response\": \"null\"\n }\n }\n\nstatus: The state of the request, whether successful or failed
message: Provides a text description of the state of the request
data: This will contain much more details of the outcome of the request which will include the response code from the provider and any error objects if present
provider_response_code: The actual response code received from the Scheduler provider, e.g. 00 for Successful requests
provider_response: This contains additional response from the provider if any specific to the actual operation being performed.
provider: The provider that was used to process the request. This will always be Scheduler.
errors: In case of a failed transaction, this contains the lists of errors that occurred while processing the transaction
error: This contains the most important error that hinders the successful completion of the transaction.
We highly recommend that developers use the Errors field to determine the result of an API call. As an empty Errors node indicates a successful transaction.
status and messageSuccessful: Success
\n[Anything else]: Error. Read the errors object(s)
\nLog in to your \"Pay with transfer\" dashboard.
\nDepending on your level of access, you can also reach it by logging in to OnePipe and navigating to the \"Pay with transfer\" solution.
\n![\"Launching](\"http://www.onepipe.io/docs/pwt-console.png\")
\n\nExpose a callback url, that will receive a POST message from OnePipe upon a credit activity on an account that you have assigned. Edit your settings to setup your webhook url.
Optionally, you can also configure a lookup_url to be called if you want to dynamically provide feedback on the validity of a customer before settlement processing.
Now, you can start assigning accounts...
\n","_postman_id":"8dd10630-82e4-46a7-9407-7a7fcbbfb3d7"},{"name":"2. Assign accounts","item":[],"id":"3fa5b51c-17fc-4480-a4bb-52e6d94a3806","description":"Once you've got your callback URLs all set up, you'd create a virtual account any time you want to receive payment or on a per customer basis.
\nYou can do that by making the relevant API call.
\nHere are the providers you can set in your auth.auth_provider for this use case.
Please note: This list would increase over time. We are adding more providers on an ongoing basis.
\nNOTE 1: The OnePipe platform supports a scenario such that: If a provider is down or unavailable at any point in time, you could get back account numbers from other supported providers in the interim. This functionality has to be requested before it can be enabled though.
\nNOTE 2: The OnePipe platform supports both static and dynamic virtual accounts.
\nStatic: Virtual accounts attached to a single user. You will always get the same number for the same customer_ref
Dynamic: Virtual accounts attached to a specific order. A different account with an expiry will be generated every time you make an open_account call.
Please inform the OnePipe or bank team what your preference is at the point of sign up.
\nNOTE 3: The OnePipe platform also supports the possibility of sending an SMS to the user (for static virtual accounts) once an account is attached to them. Please inform the OnePipe or bank team if you would like this enabled.
\nAlternatively, if supported by the configuration that was done for your app on OnePipe, you can also bulk upload a list of customers and they'd all get virtual accounts assigned to them.
\nNow that you have provisioned accounts... Here's what happens next.
\n","_postman_id":"3fa5b51c-17fc-4480-a4bb-52e6d94a3806"},{"name":"3. Customers can transfer","item":[],"id":"3b3c540d-960a-433f-803a-bf5fe7343ace","description":"A regular bank transfer on any channel
\nThe OnePipe platform will be notified by the provider once this transfer hits the virtual account. And then the next steps kick in...
\n","_postman_id":"3b3c540d-960a-433f-803a-bf5fe7343ace"},{"name":"4. Respond to a lookup","item":[],"id":"44e241be-4152-4db8-87b8-24517b3ac5fc","description":"[This is an optional step]
\nIf you configured a lookup_url in step 1, OnePipe will connect to your system to verify the customer that is making payment and obtain any details necessary for that payment like Name, amount due, bill_id, etc.
The request will look like what's below:
\nHeaders
\n{{MD5Hash(request_ref;your_app_secret)}}NOTE: Please validate the signature to ensure the request came from OnePipe. See here.
\nBody
\n{\n \"request_ref\": \"{{request_ref}}\",\n \"request_type\": \"transaction_notification\",\n \"requester\": \"{{page_name}}\",\n \"mock_mode\": \"live\",\n \"details\": {\n \"amount\": 10000,\n \"transaction_type\": \"lookup_customer_reference\",\n \"status\": \"Successful\",\n \"provider\": \"FidelityVirtual\",\n \"transaction_ref\": \"23486644\",\n \"customer_ref\": \"9090905\",\n \"customer_email\": \"email@gmail.com\",\n \"customer_firstname\": \"Uju\",\n \"customer_surname\": \"James\",\n \"customer_mobile_no\": \"2349066666544\",\n \"data\": {\n \"biller_id\": \"{{code representing the biller}}\", \n \"biller_item_id\": \"{{code representing the biller's specific product}}\",\n \"meta\":{\n \"a_key\":\"a_meta_value_1\",\n \"another_key\":\"a_meta_value_2\" \n }\n }\n },\n \"app_info\": {\n \"app_code\": \"{{app_code}}\"\n }\n}\n\nWhat each element means
\nYour response should look like what's below:
\nThe body
\n{\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"{{your_app_code}}\", \n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"products\": [\n {\n \"order_reference\": \"101638163628490752\",\n \"biller_item_id\": \"101638163628490752\", \n \"biller_item_code\": \"RAC01\",\n \"biller_item_name\": \"DSTV Premium\",\n \"biller_item_description\": \"This is DSTV Premium that is lovely\",\n \"biller_item_image_url\": \"{{url to an image}}\",\n \"biller_item_prompt\": \"Please neter your smartcard number\",\n \"customer_name\": \"Kola Uju Abubakar Premium\",\n \"biller_item_meta\": {}\n \"amount\": \"500000\",\n \"currency\": \"566\",\n \"terms\": \"{{some HTML content}}\",\n \"terms_url\": \"{{some url}}\"\n },\n {\n \"order_reference\": \"101638163628490752\",\n \"biller_item_id\": \"101638163628490752\",\n \"biller_item_code\": \"RAC01\",\n \"biller_item_name\": \"DSTV Premium\",\n \"biller_item_description\": \"This is DSTV Premium that is lovely\",\n \"biller_item_image_url\": \"{{url to an image}}\",\n \"biller_item_prompt\": \"Please neter your smartcard number\",\n \"customer_name\": \"Kola Uju Abubakar Premium\",\n \"biller_item_meta\": {}\n \"amount\": \"500000\",\n \"currency\": \"566\",\n \"terms\": \"{{some HTML content}}\",\n \"terms_url\": \"{{some url}}\"\n }\n ],\n \"reference\": \"000022200225154318222333334432\",\n \"meta\":{\n \"field_key\":\"field_value\",\n \"field_key\":\"field_value\"\n }\n }\n }\n}\n\nPlease see here for a full breakown of this specification and the fields.
\nNext....
\n","_postman_id":"44e241be-4152-4db8-87b8-24517b3ac5fc"},{"name":"5. Receive payment completion","item":[],"id":"9a5efffe-e7aa-4980-bfb2-349611119076","description":"When the money has been deposited, OnePipe will push a payment completion request to your callback URL so you can perform in-house clean ups and reconciliation.
The request will look like what's below:
\nHeaders
\n{{MD5Hash(request_ref;your_app_secret)}}Please validate the signature to ensure the request came from OnePipe. See here.
\nBody
\n{\n \"request_ref\": \"{{request_ref}}\",\n \"request_type\": \"transaction_notification\",\n \"requester\": \"{{provider}}\",\n \"mock_mode\": \"live\", \n \"details\": {\n \"amount\": 100000,\n \"status\": \"Successful|Failed\",\n \"provider\": \"{{provider}}\",\n \"customer_ref\": \"2349870818\",\n \"customer_email\": \"roqak0@gmail.com\",\n \"transaction_ref\": \"998383938292\",\n \"customer_surname\": \"Adigun\",\n \"transaction_desc\": \"{{transaction_description}}\",\n \"transaction_type\": \"collect\",\n \"customer_firstname\": \"Jonah\",\n \"customer_mobile_no\": \"2349000870818\",\n \"data\": {{{object containing raw data from the payment source}}}\n },\n \"app_info\": {\n \"app_code\": \"{{your_app_code}}\"\n }\n}\n\nWhat each element means
\nSimply respond with a 200- OK. Signalling acknowledgement and treatment. If your system does not respond as such, OnePipe will try again a few minutes later till it gets an OK.
IMPORTANT NOTE: By the time you are receiving this notification, typically money has been moved into your configured destination account in realtime - less fees.
\n","_postman_id":"9a5efffe-e7aa-4980-bfb2-349611119076"},{"name":"6. Settlement process","item":[],"id":"42be892f-a321-4a66-9df8-001611c57f1c","description":"Here's what you need to know about settlements:
\nSettlement is in realtime
\nBy the time you receive a notification, money would have been credited to your account
\nThe credit will be less the agreed fees
\nThere is a new wave of payment approaches that businesses are starting to explore:
\nWe built paywithtransfer.com as a use case on OnePipe to drive this specific scenario.
\nWe adapted it for 2 variants.
\n1. Specific for FMCG use cases
2. For general purpose use cases.
This section talks about the general scenario
\n\n\nWant to see an ideal embedded payments integration that combines virtual accounts with 1-click direct-from-account payments? Play with this demo and see what happens after you register. You can embed an experience just like that
\n
\n\n","_postman_id":"bcb0350d-5f58-4c2f-b64b-9444de7d9056"},{"name":"PaywithAccount","item":[{"name":"0. Getting started","item":[],"id":"dbfa698a-7fad-4649-bfc1-5d78994f4dc0","description":"To get started: Sign up, and after compliance checks and approval, request API access
\n
Here are the preliminary steps before you can use PaywithAccount via APIs
\n\nDoc W.I.P.
\n","_postman_id":"dbfa698a-7fad-4649-bfc1-5d78994f4dc0"},{"name":"1. Setup a callback","item":[],"id":"e129a6cc-eb56-4144-8541-2b61af24e030","description":"On the PaywithAccount dashboard, after your merchant account has been setup, navigate to your business settings and configure your webhook URL.
\nAll notifications & events will be delivered to the endpoint you have set up.
\n\n\n","_postman_id":"e129a6cc-eb56-4144-8541-2b61af24e030"},{"name":"2. Request to link an account","item":[],"id":"d33f6048-6b8d-43aa-8ccc-679a7e6bed3c","description":"NOTE: This is an optional step. In all cases, your back office will receive all notifications by email. The webhook URL is simply to allow further automation on your systems.
\n
To get things started, you'd place a create mandate API call to OnePipe setting \"PaywithAccount\" as the auth.auth_provider. Please see sample payload below.
{\n \"request_ref\": \"111111111\",\n \"request_type\": \"create mandate\",\n \"auth\": {\n \"type\": \"bank.account\",\n \"secure\": \"{{TripleDES.encrypt(\"{accountNumber};{bankCBNCode}\",secretKey)}}\",\n \"auth_provider\": \"PaywithAccount\"\n },\n \"transaction\": {\n \"mock_mode\": \"Inspect\",\n \"transaction_ref\": \"{{transaction-ref}}\",\n \"transaction_desc\": \"Creating a mandate\",\n \"transaction_ref_parent\": null,\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348000021412\",\n \"firstname\": \"Koko\",\n \"surname\": \"Below\",\n \"email\": \"kokobelow@gmail.com\",\n \"mobile_no\": \"2348000021412\"\n },\n \"meta\": {\n \"amount\": \"100000\",\n \"skip_consent\": \"true\",\n \"bvn\": \"{{TripleDES.encrypt(\"{BVN}\",secretKey)}}\",\n \"biller_code\" : \"000019\",\n \"customer_consent\": \"\"//url\n },\n \"details\": {}\n }\n}\n\nYou would receive a PendingValidation or Processing response. Please see here for reference.
The customer would receive an SMS and email informing them to \"Link your account to make payments to XYZ Limited via PaywithAccount\".
\nAn account number will be presented to them
\nThe customer makes a first payment or token to the account
\n#2 above proves their ownership of the account you provided in the auth.secure because they are able to send money from it. The account is immediately tokenized
Once their bank approves the tokenization, they would get an email confirmation
\nWith this approach, you will request a regular bank transfer payment from your customer, and once the transfer is successful, the source account is tokenized and can then be used for future payments.
\nTo get things started, you'd place a send invoice API call to OnePipe setting \"PaywithAccount\" as the auth.auth_provider. Please see sample payload below.
{\n \"request_ref\": \"111111111\",\n \"request_type\": \"send invoice\",\n \"auth\": {\n \"type\": \"bank.account\",\n \"secure\": \"{{TripleDES.encrypt(\"{accountNumber};{bankCBNCode}\",secretKey)}}\",\n \"auth_provider\": \"PaywithAccount\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"{{transaction-ref}}\",\n \"transaction_desc\": \"collect a payment\",\n \"transaction_ref_parent\": null,\n \"amount\": 12200,\n \"customer\": {\n \"customer_ref\": \"2348000021412\",\n \"firstname\": \"Koko\",\n \"surname\": \"Below\",\n \"email\": \"kokobelow@gmail.com\",\n \"mobile_no\": \"2348000021412\"\n },\n \"meta\": {\n \"type\":\"single_payment\",\n \"expires_in\":1,\n \"skip_messaging\": false,\n \"biller_code\": \"000019\"\n },\n \"details\": {}\n }\n}\n\nWhen you make this call, a payment request confirmation would be sent to the customer, including a virtual account for them to make the payment to. If they complete that payment with the same account number you passed in via auth.secure
You will receive a payment notification (standard virtual account notification)
\n#1 above proves their ownership of the account you provided in the auth.secure because they are able to send money from it. The account is immediately tokenized
\nA very important note: In direct-from-account payments, trust is a very crucial factor. It is very highly recommended that you ensure your customer knows to expect the message to link their account before triggering the request.
\n","_postman_id":"d33f6048-6b8d-43aa-8ccc-679a7e6bed3c"},{"name":"3. Receive confirmation of linked account","item":[],"id":"da6d6f0b-caf2-434b-9055-38d9811346b6","description":"Once an account link request has been approved (typically takes <24 hours), you will receive notifications to that effect.
\nVia an email to your configured back office email address
\nAs an API POST to your callback URL
Details of what the callback payload would look like is below
\n{\n \"details\": {\n \"data\": {\n \"id\": 985,\n \"data\": {\n \"id\": 255,\n \"amount\": \"325.00\",\n \"status\": \"active\",\n \"end_date\": \"2024-03-14\",\n \"frequency\": \"daily\",\n \"reference\": \"DD-SUB-ipmmHuznQdTPBtQ\",\n \"start_date\": \"2024-03-13\"\n },\n \"type\": \"subscription\",\n \"timestamp\": \"2024-03-12 08:02:02\"\n },\n \"meta\": {\n \"route\": \"listener\",\n \"amount\": 32500,\n \"cr_account\": null,\n \"cr_bank_code\": null,\n \"pwt_skip_disburse\": true,\n \"originator_cbn_code\": null,\n \"subscription_status\": \"active\",\n \"originator_account_number\": null\n },\n \"amount\": 32500,\n \"status\": \"Successful\",\n \"provider\": \"NIBSS\",\n \"customer_ref\": \"2348000021412\",//customer\n \"customer_email\": \"\",\n \"transaction_ref\": \"DD-SUB-ipmmHuznQdTPBtQ\",\n \"customer_surname\": \"\",\n \"transaction_desc\": \"Subscription notification\",\n \"transaction_type\": \"activate_mandate\", //note this\n \"customer_firstname\": \"\",\n \"customer_mobile_no\": \"2348000021412\"\n },\n \"app_info\": {\n \"app_code\": \"PAYP647540\"\n },\n \"mock_mode\": \"Live\",\n \"requester\": \"NIBSS\",\n \"request_ref\": \"DD-SUB-ipmmHuznQdTPBtQ01\",\n \"request_type\": \"transaction_notification\"\n}\n\nPlease see reference here for more details on notifications on OnePipe.
\n","_postman_id":"da6d6f0b-caf2-434b-9055-38d9811346b6"},{"name":"4. Collect from an account","item":[],"id":"1d9b0506-b9cc-4fc7-bb3a-bbef9745dfef","description":"When an account has been linked, you can then go ahead and use the collect service at any point in time to pull from from it.
\nSee here, details of the collect service for reference.
\n{\n \"request_ref\": \"111111111\",\n \"request_type\": \"collect\",\n \"auth\": {\n \"type\": \"bank.account\",\n \"secure\": \"{{TripleDES.encrypt(\"{accountNumber};{bankCBNCode}\",secretKey)}}\",\n \"auth_provider\": \"PaywithAccount\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"{{transaction-ref}}\",\n \"transaction_desc\": \"A nice narration\",\n \"transaction_ref_parent\": null,\n \"amount\": 15600,\n \"customer\": {\n \"customer_ref\": \"2348000021412\",\n \"firstname\": \"Koko\",\n \"surname\": \"Below\",\n \"email\": \"kokobelow@gmail.com\",\n \"mobile_no\": \"2348000021412\"\n },\n \"meta\": {\n \"biller_code\": \"000019\"\n },\n \"details\": {}\n }\n}\n\nYou will receive a standard OnePipe Successful response if everything went well.
Typically, direct-from-account payments are used to achieve more effecient recurring payments. To make this happen, the collect call can be routed through the standard OnePipe Sheduler.
See here more information about scheduled transactions on OnePipe.
\nFor the specifics of how to combine Scheduler + PaywithAccount please see sample payload below:
{\n \"request_ref\": \"111111111\", \n \"request_type\": \"collect\", \n \"auth\": {\n \"type\": \"bank.account\",\n \"secure\": \"{{TripleDES.encrypt(\"{accountNumber};{bankCBNCode}\",secretKey)}}\",\n \"auth_provider\": \"Scheduler\"\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"{{transaction-ref}}\",\n \"transaction_desc\": \"Data Subscription\",\n \"transaction_ref_parent\": null,\n \"amount\": 32500,\n \"customer\": {\n \"customer_ref\": \"2348000021412\",\n \"firstname\": \"Koko\",\n \"surname\": \"Below\",\n \"email\": \"kokobelow@gmail.com\",\n \"mobile_no\": \"2348000021412\"\n },\n \"meta\": {\n \"repeat_frequency\": \"weekly\",\n \"sub_repeat_frequency\": \"weekly\",\n \"repeat_start\": \"2023-12-07-15-24-27\",\n \"repeat_end\": \"2099-12-12-00-00-00\",\n \"subscription_count\": \"1\",\n \"subscription_date\": \"30/11/2023, 15:24:27\",\n \"expiry_date\": \"12/12/2099, 01:00:00\",\n \"subscription_status\": \"Running\",\n \"subscription_id\": \"kF56i6cb\",\n \"sales_price\": \"32500\",\n \"normal_price\": \"55000\",\n \"biller_id\": \"airtel\",\n \"biller_item_id\": \"599\",\n \"product\": \"1GB\",\n \"repeat_target_provider\": \"PaywithAccount\",\n \"otp_override\": \"true\"\n },\n \"details\": {},\n \"options\": null\n }\n}\n\nYou would receive standard OnePipe responses.
\n","_postman_id":"f84d06cd-9c00-4006-bbd7-3ef449346b95"},{"name":"6. Receive payment confirmations","item":[],"id":"203a3b67-faec-493c-b6ab-024a25dd6d3f","description":"For every completed payment, successful or not, if you have a callback_url configured, you will receive notifications.
\nVia an email to your configured back office email address
\nAs an API POST to your callback URL
Details of what the callback payload would look like is below
\n{\n \"details\": {\n \"data\": {\n \"data\": {\n \"error\": null,\n \"errors\": null,\n \"status\": null,\n \"provider\": \"NIBSS\",\n \"reference\": null,\n \"provider_response\": {\n \"meta\": {\n \"session_id\": \"9098898998098098333\",\n \"subscription_id\": 3546\n },\n \"reference\": \"DD-UFbr7Ki0BG6STbj\",\n \"paymentoptions\": [],\n \"provider_auth_token\": \"2001730400;100\",\n \"transaction_final_amount\": 10000\n },\n \"provider_response_code\": \"00\"\n },\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successfully\"\n },\n \"meta\": {\n \"fee\": \"5100\",\n \"biller_id\": \"3\",\n \"narration\": \"Pay OnePipe Subscription Manag\",\n \"account_no\": \"2001730400\", //Identify customer with this\n \"mandate_id\": \"1995\",\n \"biller_code\": \"000003\", //Identify merchant with this\n \"biller_name\": \"OnePipe Subscription Manager\",\n \"expiry_date\": \"2025-03-02-00-00-00\",\n \"account_name\": \"BELOW KOKO\",\n \"biller_email\": \"kokobiller@below.io\",\n \"biller_status\": \"active\",\n \"pwt_item_code\": \"31557\",\n \"subscription_id\": \"3546\",\n \"biller_rc_number\": \"RC1544100\",\n \"skip_fee_disburse\": \"true\",\n \"biller_account_name\": \"PAYGATEPLUS DATA BUNDLE SALES\",\n \"biller_phone_number\": \"08052000773\",\n \"biller_account_number\": \"9999922570\",\n \"sales_representative_id\": \"\",\n \"mandate_reference_number\": \"RC1544159/1557/0007109012\",\n \"sales_representative_name\": \"\",\n \"pwt_maintain_notification_meta\": \"true\",\n \"event_type\": \"debit\" //note this\n },\n \"amount\": \"10000\",\n \"status\": \"Successful\",\n \"provider\": \"NIBSS\",\n \"customer_ref\": \"2001730400\",\n \"customer_email\": \"\",\n \"transaction_ref\": \"DD-SGLnWjK6ClFonZmCMnschedule1\", // Identify transaction with this\n \"customer_surname\": \"BELOW\",\n \"transaction_desc\": \"Test\",\n \"transaction_type\": \"collect\",\n \"customer_firstname\": \"KOKO\",\n \"customer_mobile_no\": \"\"\n },\n \"app_info\": {\n \"app_code\": \"PAYP396648\"\n },\n \"mock_mode\": \"Live\",\n \"requester\": \"Scheduler\",\n \"request_ref\": \"f6300559bd2e42a0b83369554538a299\",\n \"request_type\": \"transaction_notification\"\n}\n\nPlease see reference here for more details on notifications on OnePipe.
\n","_postman_id":"203a3b67-faec-493c-b6ab-024a25dd6d3f"},{"name":"7. Send invoices via WhatsApp","item":[],"id":"146b1c4f-8969-47c4-a24c-0d018dcac65f","_postman_id":"146b1c4f-8969-47c4-a24c-0d018dcac65f","description":""}],"id":"685c2eb5-fe52-4d94-99ed-19b5269c156a","description":"OnePipe supports direct-from-account payments. This enables money to be pulled from customer bank accounts into your business account. Either as a one-time transaction, or on a recurring basis. We built paywithaccount.com as a use case on OnePipe to drive this specific scenario.
\n[ explainer video | product website | sandbox postman collection ]
\nRequest a customer's consent to link their account to your service
\nWait a bit for their consent and bank approval to be processed
\nYou'd get a notification on your webhook once #2 has happened
\nThen, you can request payments off those accounts at any time
\nYou can also call the scheduler at any time to setup recurring payments
\nListen for notifications informing you of successful or failed transactions
\nFulfil the customer's service request based on #6
\n\n\nWant to see an ideal embedded payments integration that combines virtual accounts with 1-click direct-from-account payments? Play with this demo and see what happens after you register. You can embed an experience just like that
\n
\n\n","_postman_id":"685c2eb5-fe52-4d94-99ed-19b5269c156a"},{"name":"Subscription Manager","item":[{"name":"1. Get the offers","item":[{"name":"Onboard /Options","id":"2cda9108-b6b7-44d7-bddc-30a5fa96bdb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1","type":"text"},{"key":"Signature","value":"3a2b58350e8068507e6b5bff106850a5","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request_ref\":\"111111111\", \n \"request_type\":\"onboard\",\n \"auth\": {\n \"type\": null, \n \"secure\": null,\n \"auth_provider\": \"PolarisSubManager\",\n \"route_mode\":null\n },\n \"transaction\": {\n \"mock_mode\": \"inspect\", \n \"transaction_ref\": \"{{transaction-ref}}\", \n \"transaction_desc\": \"Tell me the products available\", \n \"transaction_ref_parent\": \"\", \n \"amount\": 0,\n \"customer\":{\n \t\"customer_ref\": \"2348098976543\",\n \t\"firstname\": \"MONSURU\",\n \"surname\": \"BANKOLE\",\n \t\"email\": \"monsurubanky123@gmail.com\",\n \t\"mobile_no\": \"2348098976543\"\n },\n \"meta\":null,\n \"details\":{\n \"name_on_account\": \"MONSURU BANKOLE\",\n \"middlename\": \"AYANFE\",\n \"dob\": null,\n \"gender\": null,\n \"title\": null,\n \"address_line_1\": null,\n \"address_line_2\": null,\n \"city\": null,\n \"state\": null,\n \"country\": \"NG\" \n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/options","description":"To get started: Sign up, and after compliance checks and approval, request API access. You can also be provided with a prepared postman collection that you can just import and use if you don't want to construct your collection yourself using the information provided.
\n
Make an options call to OnePipe with the request_type = onboard
First, please be sure to have gone through...
\nsecure elementNow, here's the call sequence specific to this service...
\n/transact/optionsOptionsDelivered if everything went well/transact/querydata.provider_response.products[] array to see the available productsHere are the response body elements worth paying attention to. Any not listed here may be safely ignored.
\n","urlObject":{"path":["v2","transact","options"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"515c4bf3-92a7-4956-b4ba-81c58fa899b6","name":"OptionsDelivered","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1","type":"text"},{"key":"Signature","value":"3a2b58350e8068507e6b5bff106850a5","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request_ref\":\"111111111\", \n \"request_type\":\"onboard\",\n \"auth\": {\n \"type\": null, \n \"secure\": null,\n \"auth_provider\": \"PolarisSubManager\",\n \"route_mode\":null\n },\n \"transaction\": {\n \"mock_mode\": \"inspect\", \n \"transaction_ref\": \"{{transaction-ref}}\", \n \"transaction_desc\": \"Tell me the products available\", \n \"transaction_ref_parent\": \"\", \n \"amount\": 0,\n \"customer\":{\n \t\"customer_ref\": \"2348098976543\",\n \t\"firstname\": \"MONSURU\",\n \"surname\": \"BANKOLE\",\n \t\"email\": \"monsurubanky123@gmail.com\",\n \t\"mobile_no\": \"2348098976543\"\n },\n \"meta\":null,\n \"details\":{\n \"name_on_account\": \"MONSURU BANKOLE\",\n \"middlename\": \"AYANFE\",\n \"dob\": null,\n \"gender\": null,\n \"title\": null,\n \"address_line_1\": null,\n \"address_line_2\": null,\n \"city\": null,\n \"state\": null,\n \"country\": \"NG\" \n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/options"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 16 Dec 2023 15:04:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"3815"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubdomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Xss-Protection","value":"1; mode=block"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OptionsDelivered\",\n \"message\": \"Options processed successfully.\",\n \"data\": {\n \"options\": null,\n \"app_info\": null,\n \"provider_response_code\": \"00\",\n \"provider\": \"SubManager\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"products\": [\n {\n \"order_reference\": \"38363211760260\",\n \"biller_item_id\": 31290,\n \"biller_item_code\": null,\n \"biller_item_name\": \"Test 1GB Data\",\n \"biller_item_description\": \"Test 1GB Data\",\n \"biller_item_image_url\": \"{{url to an image}}\",\n \"biller_item_prompt\": null,\n \"customer_name\": null,\n \"currency\": \"566\",\n \"terms\": \"Subscription will be renewed automatically from your account every week. At 35% discount.\",\n \"terms_url\": \"{{https://onepipe.io/start/terms/subscriptions/l}}\",\n \"biller_item_meta\": {\n \"page_info\": {\n \"id\": 31290,\n \"name\": \"Test 1GB Data\",\n \"slug\": \"test111\",\n \"description\": \"Test 1GB Data\",\n \"status\": \"active\",\n \"pwt_account_number\": null,\n \"pwt_bank_code\": \"--select--\",\n \"pwt_notification_email\": null,\n \"pwt_notification_phone\": null,\n \"pwt_notification_sms_template\": null,\n \"pwt_webhook_url\": \"https://bills.bits.dev.onepipe.io/data-sub/webhook\",\n \"sort_order\": 0,\n \"tags\": null,\n \"created_at\": \"2023-12-08T16:10:42Z\",\n \"updated_at\": \"2023-12-16T03:25:45Z\",\n \"pwt_mandate_phone\": null\n },\n \"pwt_item_description\": \"Test 1GB Data\",\n \"pwt_item_code\": null,\n \"pwt_item_amount\": 32500,\n \"transaction_date\": \"2023-11-30-15-13-19\",\n \"created_date\": \"2023-11-30-15-11-47\",\n \"biller_id\": \"airtel\",\n \"biller_item_id\": \"599\",\n \"processing_method\": \"PWT\",\n \"page_id\": 31290,\n \"activation description\": \"35% if you act now (₦325)\",\n \"subscription description\": \"\",\n \"normal_price\": \"550\",\n \"sales_price\": \"325\",\n \"discount_price\": \"325\",\n \"frequency\": \"weekly\",\n \"product\": \"1GB\",\n \"terms\": \"Subscription will be renewed automatically from your Fidelity account every week. At 35% discount.\",\n \"provider_price\": \"250\",\n \"provider\": \"Ibrolinks\",\n \"product_subcategory\": \"bundle\",\n \"product_savings\": \"Save 35%\",\n \"provider_auth_token\": null,\n \"collect_provider\": \"Polaris\"\n }\n },\n {\n \"order_reference\": \"38363211760260\",\n \"biller_item_id\": 31291,\n \"biller_item_code\": null,\n \"biller_item_name\": \"Test 1GB Data 2\",\n \"biller_item_description\": \"Test 1GB Data 2\",\n \"biller_item_image_url\": \"{{url to an image}}\",\n \"biller_item_prompt\": null,\n \"customer_name\": null,\n \"currency\": \"566\",\n \"terms\": \"Subscription will be renewed automatically from your account every week. At 35% discount.\",\n \"terms_url\": \"{{https://onepipe.io/start/terms/subscriptions/l}}\",\n \"biller_item_meta\": {\n \"page_info\": {\n \"id\": 31291,\n \"name\": \"Test 1GB Data 2\",\n \"slug\": \"test2222\",\n \"description\": \"Test 1GB Data 2\",\n \"status\": \"active\",\n \"pwt_account_number\": null,\n \"pwt_bank_code\": \"--select--\",\n \"pwt_notification_email\": null,\n \"pwt_notification_phone\": null,\n \"pwt_notification_sms_template\": null,\n \"pwt_webhook_url\": \"https://test001.free.beeceptor.com\",\n \"sort_order\": 0,\n \"tags\": null,\n \"created_at\": \"2023-12-08T16:33:19Z\",\n \"updated_at\": \"2023-12-16T11:19:25Z\",\n \"pwt_mandate_phone\": null\n },\n \"pwt_item_description\": \"Test 1GB Data 2\",\n \"pwt_item_code\": null,\n \"pwt_item_amount\": 32500,\n \"transaction_date\": \"2023-11-30-15-13-19\",\n \"created_date\": \"2023-11-30-15-11-47\",\n \"biller_id\": \"airtel\",\n \"biller_item_id\": \"599\",\n \"processing_method\": \"PWT\",\n \"page_id\": 31291,\n \"activation description\": \"35% if you act now (₦325)\",\n \"subscription description\": \"\",\n \"normal_price\": \"550\",\n \"sales_price\": \"325\",\n \"discount_price\": \"325\",\n \"frequency\": \"weekly\",\n \"product\": \"1GB\",\n \"terms\": \"Subscription will be renewed automatically from your Fidelity account every week. At 35% discount.\",\n \"provider_price\": \"250\",\n \"provider\": \"Ibrolinks\",\n \"product_subcategory\": \"bundle\",\n \"product_savings\": \"Save 35%\",\n \"provider_auth_token\": null,\n \"collect_provider\": \"Polaris\"\n }\n }\n ]\n },\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"}],"_postman_id":"2cda9108-b6b7-44d7-bddc-30a5fa96bdb2"}],"id":"17e8a6f3-6f83-4cde-afed-e6dbe831abdd","description":"The very first step is to determine the available offers and promotions at any specific point in time. Offers and their terms may vary from time to time.
\nIdeally, you could get these offers once and cache the results, then refresh them from time to time to keep it updated. You'd be informed any time there's a significant change.
\n","_postman_id":"17e8a6f3-6f83-4cde-afed-e6dbe831abdd"},{"name":"2. Manage the opt-in workflow","item":[],"id":"5ffc1bba-cda5-4276-b7e3-63f007d2dafb","description":"Each offer would look like the below and this view can be constructed based on the following elements from the previous API call
\nIf the user engaes the call-to-action, present the detailed terms for accptance like below. This view can be constructed based on the following elements from the prior API call
\nKEY NOTE: If the customer does not accept the terms by checking the box, do not move forward. A signed contract will be sent to the customer based on the assumption of their agreement and consent.
\n","_postman_id":"5ffc1bba-cda5-4276-b7e3-63f007d2dafb"},{"name":"3. Onboard the user","item":[{"name":"Onboard","id":"ea921ae0-0d1d-4b77-ad1d-7a55fbc7a059","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1","type":"text"},{"key":"Signature","value":"3a2b58350e8068507e6b5bff106850a5","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request_ref\":\"111111111\", \n \"request_type\":\"onboard\",\n \"auth\": {\n \"type\": null, \n \"secure\": null,\n \"auth_provider\": \"{Bank}SubManager\",\n \"route_mode\":null\n },\n \"transaction\": {\n \"mock_mode\": \"inspect\", \n \"transaction_ref\": \"{{transaction-ref}}\", \n \"transaction_desc\": \"AIRTEL 1GB every 7 days\", \n \"transaction_ref_parent\": \"\", \n \"amount\": 0,\n \"customer\":{\n \t\"customer_ref\": \"2349066870818\",\n \t\"firstname\": \"Uju\",\n \"surname\": \"Usmanu\",\n \t\"email\": \"ujuusmanu@gmail.com\",\n \t\"mobile_no\": \"234802343132\"\n },\n \"meta\":{\n \t\"pwt_item_description\": \"kF56i6cb\",\n \"pwt_item_code\": null,\n \"pwt_item_amount\": 32500,\n \"transaction_date\": \"2023-11-30-15-13-19\",\n \"created_date\": \"2023-11-30-15-11-47\",\n \"biller_id\": \"airtel\",\n \"biller_item_id\": \"599\",\n \"processing_method\": \"PWT\",\n \"page_id\": 2305,\n \"activation description\": \"35% if you act now (₦325)\",\n \"subscription description\": \"\",\n \"normal_price\": \"550\",\n \"sales_price\": \"325\",\n \"discount_price\": \"325\",\n \"frequency\": \"weekly\",\n \"product\": \"1GB\",\n \"terms\": \"Subscription will be renewed automatically from your Fidelity account every week. At 35% discount.\",\n \"provider_price\": \"250\",\n \"provider\": \"Ibrolinks\",\n \"product_subcategory\": \"bundle\",\n \"product_savings\": \"Save 35%\",\n \"provider_auth_token\": \"6234784766\",\n \"collect_provider\": \"Polaris\"\n },\n \"details\":{\n \"name_on_account\": \"MONSURU BANKOLE\",\n \"middlename\": \"AYANFE\",\n \"dob\": null,\n \"gender\": null,\n \"title\": null,\n \"address_line_1\": null,\n \"address_line_2\": null,\n \"city\": null,\n \"state\": null,\n \"country\": \"NG\" \n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","description":"Make an transact call to OnePipe with the request_type = onboard
First, please be sure to have gone through...
\nsecure elementNow, here's the call sequence specific to this service...
\n/transactSuccessful if everything went well/transact/querydata.provider_response to determine that the workflow for to complete the customer opt-in has been queued upHere are the response body elements worth paying attention to. Any not listed here may be safely ignored.
\n","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"5ada7177-fc00-453d-ae52-3613da3072d2","name":"Onboard","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1","type":"text"},{"key":"Signature","value":"3a2b58350e8068507e6b5bff106850a5","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request_ref\":\"111111111\", \n \"request_type\":\"onboard\",\n \"auth\": {\n \"type\": null, \n \"secure\": null,\n \"auth_provider\": \"{Bank}SubManager\",\n \"route_mode\":null\n },\n \"transaction\": {\n \"mock_mode\": \"inspect\", \n \"transaction_ref\": \"{{transaction-ref}}\", \n \"transaction_desc\": \"AIRTEL 1GB every 7 days\", \n \"transaction_ref_parent\": \"\", \n \"amount\": 0,\n \"customer\":{\n \t\"customer_ref\": \"2349066870818\",\n \t\"firstname\": \"Uju\",\n \"surname\": \"Usmanu\",\n \t\"email\": \"ujuusmanu@gmail.com\",\n \t\"mobile_no\": \"234802343132\"\n },\n \"meta\":{\n \t\"pwt_item_description\": \"kF56i6cb\",\n \"pwt_item_code\": null,\n \"pwt_item_amount\": 32500,\n \"transaction_date\": \"2023-11-30-15-13-19\",\n \"created_date\": \"2023-11-30-15-11-47\",\n \"biller_id\": \"airtel\",\n \"biller_item_id\": \"599\",\n \"processing_method\": \"PWT\",\n \"page_id\": 2305,\n \"activation description\": \"35% if you act now (₦325)\",\n \"subscription description\": \"\",\n \"normal_price\": \"550\",\n \"sales_price\": \"325\",\n \"discount_price\": \"325\",\n \"frequency\": \"weekly\",\n \"product\": \"1GB\",\n \"terms\": \"Subscription will be renewed automatically from your Fidelity account every week. At 35% discount.\",\n \"provider_price\": \"250\",\n \"provider\": \"Ibrolinks\",\n \"product_subcategory\": \"bundle\",\n \"product_savings\": \"Save 35%\",\n \"provider_auth_token\": \"6234784766\",\n \"collect_provider\": \"Polaris\"\n },\n \"details\":{\n \"name_on_account\": \"MONSURU BANKOLE\",\n \"middlename\": \"AYANFE\",\n \"dob\": null,\n \"gender\": null,\n \"title\": null,\n \"address_line_1\": null,\n \"address_line_2\": null,\n \"city\": null,\n \"state\": null,\n \"country\": \"NG\" \n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Operation was successful\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"{BANK}SubManager\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": null,\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"}],"_postman_id":"ea921ae0-0d1d-4b77-ad1d-7a55fbc7a059"}],"id":"4b865d6c-0ebf-4cb6-a390-17c2b62f5adc","description":"To close up the loop, submit the customer's info and selected offer to OnePipe.
\n","_postman_id":"4b865d6c-0ebf-4cb6-a390-17c2b62f5adc"},{"name":"4. Closing the loop","item":[],"id":"bfd29ab5-3fda-4fac-9d9a-b4567b87e97d","description":"Once the user's opt-in has been submitted to OnePipe, the following will happen:
\nAccount number will be validated (in some cases by OTP, in some by a PIN, in other cases via a PaywithAccount mandate workflow)
\nA minor risk assessment will be performed on the account to ensure that the customer's account can indeed fulfil the terms of the contract
\nThe initial amount for the first subscription (based on offer terms) will be collected from the account
\nIf all goes well, a contract will be delivered to the customer by email for record keeping
\nJust before every renewal the customer would receive a reminder notice
\nAt renewal time, applicable funds will be deducted form the customer's account and renewal will be fulfilled
\nJust after each renewal, the customer would receive a receipt and information on cancellation procedures should they want to cancel
\nCustomer can click the link in the notice to cancel at any time and end the subscription (per the terms of the offer)
\nIf you have a captive audience (an app with lots of users, a network of customers managed by agents, etc.), OnePipe enables you to offer them a convenient option to renew their regular utilities (data bundles, airtime, streaming services, and more) directly from their bank account. On a scheduled, recurring basis.
\nThey'd opt-in to the service directly from your app or channel, specifying their products of interest and the OnePipe subscription manager will manage the rest. Including consent management, scheduled payments, fulfillment, cancellation and customer service.
\nIn return, you'd receive a commission for every renewal done by your customers.
\nTo motivate opt-in, OnePipe offers promotions from time to time (including free renewals, renew-now-pay-later, discounts, and more).
\nHere is a sample of the service paywithtransfer.com/subscribe
\nThe sequence that makes this possible is:
\nonboard /options to see the available offersonboard /transact with the customer's account details and chosen productJust like how banks have current accounts and savings accounts, our partner banks have created a special virtual account type designed specifically to drive increased usage of digital payments, credit and deepen financial inclusion in general.
\nUsing GTP as an example...
\nRegulatory compliance
\nBanking infrastructure
\nCredit and payment relationships
\nAll in the form of APIs
\nTherefore you can
\nIssue accounts to customers
\nOffer payments, savings & credit products to your customers
\nCreate the best experiences for your customers
\nAnd never worry about the underlying plumbing
\nTo drive the objectives of increased usage of financial services, we lined up the following benefits for customers to drive usage:
\nFirst 60 days
\nTo help customers quickly build a credit profile
\nInstant CASH once they sign up
\nNO FEES for account maintenance. No random fees.
\nFREE to Send money
\nFREE to deposit cash at Agents (in partnership with Kudi)
\nInstant CASH to sender and recipient every time a user sends money to someone who doesn't have the account
\n5% DISCOUNT on airtime topup
\nINSTANT LOAN access (in partnership with Migo)
\nEARN POINTS for every deposit, inflow and transaction
\nWEEKLY GIVEAWAYS to redeem the points earned
\nONLY N50 to WITHDRAW CASH at Agents (in partnership with Kudi)
\nGoing forward
\nTo take advantage of a strong credit profile
\nALWAYS ON CREDIT line via Migo. Larger amounts
\nNO FEES for account maintenance. No random fees.
\nLower-than-market fees to send money
\nLow fees to deposit cash at Kudi Agents
\nDiscount on Airtime topup
\nEARN POINTS for every deposit, inflow and transaction
\nWEEKLY GIVEAWAYS to redeem the points earned
\nLowest fees to WITHDRAW CASH at Agents
\nOPTIONAL credit access fee to maintain the credit line
\nMuch more seamless payment processing going forward. Just call this
\nIncrease customer loyalty by presenting all the above benefits under your brand
\nIncreased sales as a result of customer access to credit
\nEarn a share of all financial services revenue going forward
\nThere's a completely out-of-the-box expression you can simply brand for your business, include the services you want on offer, and start promoting to your customers. Your banking experience will simply be enabled and embedded into the OnePipe Benefits app.
\n
And your customers can have experiences like this.
\nThe services that are available in the no-code version (reffered to as \"intents\"), simply wrap the UX around the underlying OnePipe APIs. Prompting the users with the right questions/input to populate the relevant API requests. Here are some of the default intents enabled:
\nYou can also decide to build your own intents by building a microservice that conforms to a standard OnePipe message flow. To learn more about how to do this, please look at this documentation.
\nYou can also book time with our integration specialists to better understand this.
\n","_postman_id":"f5ae5ea5-b6e3-4695-8d54-f7af41305d3d"},{"name":"API integration","item":[],"id":"edfa3bbf-149a-4c63-929c-75190a96c718","description":"If you would rather consume APIs in order to integrate the experiences deeply within your customer touchpoints, below is the list of relevant API endpoints and their documentation.
\nOpen or assign an account. Here.
\nGet the balance on an account. Here.
\nDebit an account (puts money in yours). Here.
\nCredit any account - intra and inter (takes money from yours). Here.
\nRetrieve the statement of an account. Here.
\nRetrieve KYC details of an account. Here.
\nGet loan offers for an account. Here.
\nSubmit a loan application for an account. Here.
\nGet the loan status for an account here
\nThe OnePipe platform makes it possible for you to embed banking services within your own apps and channels. You can start by assigning NUBAN/IBAN compatible accounts to your customers and afterwards:
\nGet balances of any account
\nDebit any account (puts money in yours)
\nCredit any account (takes money from yours)
\nRetrieve the statement of an account
\nRetrieve KYC details of an account
\nSend money outwards to any bank (takes money from yours)
\nRequest a loan for an account
\nPartner banks on this service are:
\nYou can either have all of this done out of the box (OnePipe white labels a digital banking experience for you) or use APIs to handle it directly.
\n","_postman_id":"a06ddcb9-edd3-452f-9ab2-f37b004aa58c"},{"name":"Online payments","item":[],"id":"a9d368c7-fe4e-4c0f-8710-4aefc655bae1","description":"To accept payments on your website using multiple payment providers, please see here
\n","_postman_id":"a9d368c7-fe4e-4c0f-8710-4aefc655bae1"},{"name":"PaywithTransfer [FMCG]","item":[{"name":"1. Setup a callback","item":[],"id":"5d8a8caa-4c5b-47d4-9198-b1ab78073de3","description":"Log in to your OnePipe dashboard and access the \"Pay with transfer\" solution
\n\n\nPay with transfer uses a concept of \"pages\". A page represents a distinct payment workflow per business. And therefore each \"payment page\" has it's own settings which we will describe below. As a business, you can simply map each product or payment item (product or workflow) you have to a \"payment page\". For example: Product 1 can have a payment page dedicated to it - It will have its own settings. Repeat for as many as you have.
\n![\"PWT](\"http://www.onepipe.io/docs/pwt-console-pages.png\")
\n\nExpose a callback url, that will receive a POST message from OnePipe upon a credit or debit activity on an account that you have assigned. Edit a page's settings and setup your webhook url.
![\"Setting](\"http://www.onepipe.io/docs/pwt-console-settings.png\")
\n\nTo be enabled for Pay with transfer, it would be reconstructed as such:
https://{onepipe-fmcg-pwt-handler}/handle/?baseUrl={your-webhook-baseurl}&orderDetailsUrl={a-dedicated-endpoint-to-confirm-due-amount}&paymentNotificationUrl={a-dedicated-endpoint-to-fulfil}&paymentCoverage={payment-coverage-type}\n\nNOTE: The system will automatically take care of this reconstruct. You just need to set your webhook URL for a start.
\nHere's an explanation of each element:
\nPayment Coverage Types
\nBelow is a tabular description of the payment coverage types:
\nNote: In an upcoming enhancement, you will get notified of an overpayment via the payment notification API
\nNow, you can start assigning accounts...
\n","_postman_id":"5d8a8caa-4c5b-47d4-9198-b1ab78073de3"},{"name":"2. Assign accounts","item":[],"id":"83949ffb-2a06-436d-af52-40b6d56cabef","description":"Next, you'd create a virtual account for each customer on your platform.
\nWith your payment page and callback url in place, your customers can simply visit paywithtransfer.com/{yourbusiness}/{page} to get an account assigned to them.
\nSee example here
\nYou can also assign account numbers by making the relevant API call directly.
\nHere are the providers you can set in your auth.auth_provider for this Pay with transfer use case.
Please note: This list would increase over time. We are adding more providers on an ongoing basis.
\nFor documentation on account provisioning, See here.
\nSome providers (CheddaAccount specifically) make it possible to call Open Account just once and receive an array of multiple virtual accounts mapped to a single store of value. This has been described in the open account. documentation.
Now that you have provisioned an account for each customer. Here's what happens next.
\n","_postman_id":"83949ffb-2a06-436d-af52-40b6d56cabef"},{"name":"3. Customers can transfer","item":[],"id":"d83ffa6c-af5b-4847-a1ec-dbd5a9551ae6","description":"A regular bank transfer on any channel
\nThe OnePipe platform will be notified by the provider once this transfer hits the virtual account. And then the next steps kick in...
\n","_postman_id":"d83ffa6c-af5b-4847-a1ec-dbd5a9551ae6"},{"name":"4. Respond to a lookup","item":[],"id":"cde3371d-6163-420b-b5e7-5e2f5cef6d6f","description":"When a payment sequence starts OnePipe needs to connect to your system to verify the customer that is making payment and obtain any details necessary for that payment like Name, amount due, bill_id, etc.
\nTypically you'd maintain a list of pending orders/payments on your system that is awaiting payments from this customer.
\nThe request will look like what's below:
\nHeaders
\n{{MD5Hash(request_ref;your_app_secret)}}NOTE: Please validate the signature to ensure the request came from OnePipe. See here.
\nBody
\n{\n \"request_ref\": \"{{request_ref}}\",\n \"request_type\": \"order_details\",\n \"mock_mode\": \"live\",\n \"details\": {\n \"payer_id\": \"9090905\",\n \"amount\": 1000000, \n \"inflow_status\": \"Successful\",\n \"provider\": \"PolarisVirtual\",\n \"transaction_ref\": \"23486644\",\n \"meta\":{\n \"a_key\":\"a_meta_value_1\",\n \"another_key\":\"a_meta_value_2\" \n }\n },\n \"app_info\": {\n \"app_code\": \"{{app_code}}\"\n }\n}\n\nWhat each element means
\nYour response should look like what's below:
\nThe body
\n{\n \"status\": \"Successful\",\n \"message\": \"Enquiry processed successfully\",\n \"data\": {\n \"errors\": null,\n \"error\": null,\n \"orders\": [\n {\n \"order_id\": \"101638163628490752\",\n \"order_status\": \"PAID-CASH | PAID-TRANSFER | UNPAID | CASH-DEPOSITED\",\n \"order_description\": \"A box of noodles\",\n \"retailer_id\": \"9090905\",\n \"distributor_id\": \"RAC01\",\n \"distributor_name\": \"Olaniyi & Sons\",\n \"distributor_account_number\": \"0987654321\",\n \"distributor_bank_code\": \"038\",\n \"amount_due\": \"500000\",\n \"fee\": 5000,\n \"currency\": \"NGN\",\n \"order_rank\": 1,\n \"meta\": {\n \"narration_prefix\": \"000123\"\n }\n },\n {\n \"order_id\": \"101638163628490752\",\n \"order_status\": \"PAID-CASH | PAID-TRANSFER | UNPAID | CASH-DEPOSITED\",\n \"order_description\": \"A box of noodles\",\n \"retailer_id\": \"101638163628490752\",\n \"distributor_id\": \"RAC01\",\n \"distributor_name\": \"Olaniyi & Sons\",\n \"distributor_account_number\": \"0987654321\",\n \"distributor_bank_code\": \"038\",\n \"amount_due\": \"500000\",\n \"fee\": 5000,\n \"currency\": \"NGN\",\n \"order_rank\": 1,\n \"meta\": {\n \"narration_prefix\": \"000124\"\n }\n }\n ],\n \"reference\": \"000022200225154318222333334432\",\n \"meta\": {\n \"payer_type\": \"RETAILER | DRIVER | UNKNOWN | CUSTOMER | AGENT\",\n \"field_key_2\": \"field_value\"\n }\n }\n}\n\nThis is effectively an array of pending payments known with that payer_id and you are instructing the provider the specific account to deposit the funds.
What each element means
\nNext....
\n","_postman_id":"cde3371d-6163-420b-b5e7-5e2f5cef6d6f"},{"name":"5. Money is deposited","item":[],"id":"7265ec68-b811-447c-8a07-ce7afefaa5b0","description":"The response you have provided above will be used to deposit funds into the account you specified in orders[].distributor_account_number. This can be ANY account in ANY bank.
When the money has been deposited, OnePipe will push a payment completion request to your callback URL so you can perform in-house clean ups and reconciliation.
The request will look like what's below:
\nHeaders
\n{{MD5Hash(request_ref;your_app_secret)}}Please validate the signature to ensure the request came from OnePipe. See here.
\nBody
\n{\n \"request_ref\": \"{{request_ref}}\",\n \"request_type\": \"payment_completion\",\n \"mock_mode\": \"live\",\n \"meta\": {\n \"payer_id\": \"9090905\",\n \"payment_amount\": \"20000\",\n \"payment_transaction_ref\": \"000013210614166777000179813918\"\n }\n \"orders\": [\n {\n \"order_id\": \"101638163628490752\",\n \"remittance_status\": \"Successful | Failed | Processing\",\n \"remittance_amount\": 10000,\n \"remittance_currency\": \"NGN\",\n \"meta\": {}\n },\n {\n \"order_id\": \"101638163628490752\",\n \"remittance_status\": \"Successful | Failed | Processing\",\n \"remittance_amount\": 10000,\n \"remittance_currency\": \"NGN\",\n \"meta\": {}\n }\n ],\n \"app_info\": {\n \"app_code\": \"{{your_app_code}}\"\n }\n}\n\nWhat each element means
\nSimply respond with a 200- OK. Signalling acknowledgement and treatment. If your system does not respond as such, OnePipe will try again a few minutes later till it gets an OK.
If you have received a lookup order details and not received a corresponding payment completion, you can query the OnePipe pay with transfer handler any time to get the status of an order.
The request type here is a GET. The request will look like what's below:
Headers
\n{{Authorization <your-api-key>}}Body
\nBody is empty. Simply address the GET to
\n{{onepipe-pwt-handler}}/v1/order/query/:appCode?order_id={{order_id}}\nWhat each element means
\nYou will receive the exact payload that should have been in a payment completion call.
\n","_postman_id":"c4baff17-a99f-4c73-b93b-e3325c66e7b2"},{"name":"8. Settlement process","item":[],"id":"90ec4d6e-1823-482c-bcda-ae95ad63a30d","description":"Here's what you need to know about settlements:
\nLookup order details, funds are moved from that settlement account to the account you specified. If the virtual account is backed by a store of value, its balance is also depleted with amount + fee.There is a new wave of payment approaches that businesses are starting to explore:
\nWe built paywithtransfer.com as a use case on OnePipe to drive this specific scenario.
\nWe adapted it for 2 variants.
\n1. Specific for FMCG use cases
2. For general use cases.
This section talks about the FMCG scenario
\n","_postman_id":"3a30bb6e-d3b2-40be-a755-ba8835ed0c8d"},{"name":"Benefits banking","item":[{"name":"Back and Forth Messaging","item":[{"name":"Enrolment","item":[{"name":"New User","item":[{"name":"Initiate","event":[{"listen":"test","script":{"id":"e69f7a30-ff2b-4295-be74-e31869f3d1d9","exec":["// const req = pm.request.json();","const res = pm.response.json();","","","// pm.test(\"details.message is encrypted\", function () {","// pm.request.to.have.status(200);","// });","","// pm.test(\"Response time is less than 200ms\", () => {","// pm.expect(pm.response.responseTime).to.be.below(5001);","// });","","if (res.status == 'PendingValidation' && res.data.provider_response?.reference){"," pm.environment.set(\"transaction_ref\", res.data.provider_response.reference);","}","","pm.test(\"200 Http Status\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Return PendingValidation Status\", function () {"," pm.response.to.have.status(200);"," pm.expect(res.status).to.eql('PendingValidation');","});","","pm.test(\"Response has Yes and No button\", function () {"," pm.expect(res.message).to.contains('Do you want to continue?');","});","","const providerResponse = res.data.provider_response;","pm.test(\"provider_response has all necessary object\", () => {"," pm.expect(providerResponse).to.have.all.keys('reference', 'action', 'meta');"," ","});","","pm.test(\"Reference is present in provider_response\", () => {"," pm.expect(providerResponse).to.have.property('reference');","});","","pm.test(\"Action contains all necessary object\", () => {"," const action = providerResponse.action;"," pm.expect(action).to.have.all.keys('message', 'recipientId');"," pm.expect(action.message).to.be.an('object');","});",""],"type":"text/javascript"}}],"id":"f709e541-f92d-49f1-9e3a-6d35d8a05ad5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\": \"benefits_intent\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Benefits\"\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"rddXmpKcVR_b2b9-g57gh6Ukc6Ot_iN\",\n \"transaction_desc\": \"A random transaction\",\n \"transaction_ref_parent\": null,\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"{{customerRef}}\",\n \"firstname\": \"Uju\",\n \"surname\": \"Usmanu\",\n \"email\": \"ujuusmanu@gmail.com\",\n \"mobile_no\": \"{{customerRef}}\"\n },\n \"details\": {\n \"message\": \"{{msgEnrol}}\",\n \"callback_url\": \"{{callbackUrl}}\",\n \"subsequent_messages\": [],\n \"client_id\": \"{{appCode}}\",\n \"sender_id\": \"{{customerRef}}\",\n \"channel\": \"grb-api\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","urlObject":{"protocol":"https","path":["v2","transact"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"f709e541-f92d-49f1-9e3a-6d35d8a05ad5"},{"name":"[Text]: Yes","event":[{"listen":"test","script":{"id":"b34a96dd-c289-4ba2-8807-30b36a0a3181","exec":["const res = pm.response.json();","","pm.test(\"Submit Yes to continue enrolment\", function () {"," pm.expect(res.status).to.eql('PendingValidation');"," pm.expect(res.message).to.contains('Please enter your BVN:');","});",""],"type":"text/javascript"}}],"id":"26003927-7889-4056-90cb-e21c898b3c54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"qMlw1VEOzXI=\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"26003927-7889-4056-90cb-e21c898b3c54"},{"name":"[Text]: BVN","event":[{"listen":"test","script":{"id":"4b3f4321-9ab1-4908-9637-adcc52c809bd","exec":["const res = pm.response.json();","","pm.test(\"BVN was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Enter your date (yyyy-mm-dd) of birth');","});","",""],"type":"text/javascript"}}],"id":"4a33af88-2bdd-4913-af1b-eb3bc43694bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"YYRlS/3GwfE4MP8o0/OnR8UBnUzv59fU\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a33af88-2bdd-4913-af1b-eb3bc43694bd"},{"name":"[Text]: DOB","event":[{"listen":"test","script":{"id":"aa8b11d9-414e-44e8-b669-45686a330179","exec":["const res = pm.response.json();","","pm.test(\"DOB was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Please enter the first name linked to your BVN');","});","",""],"type":"text/javascript"}}],"id":"b3718416-7f98-4cec-b1f1-8efa08ae55ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"K75Ql09uLf9JxKp3tdp3rDyb8meyQECB\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3718416-7f98-4cec-b1f1-8efa08ae55ec"},{"name":"[Text]: Firstname","event":[{"listen":"test","script":{"id":"7c680426-7101-4dc0-9f42-a0d5131058ae","exec":["const res = pm.response.json();","","pm.test(\"Firstname was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Please enter your surname');","});","",""],"type":"text/javascript"}}],"id":"5778087d-6a0c-4888-a04e-5b277f7e6fc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"dtApbWZIzR71/ngMz5xsog==\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"5778087d-6a0c-4888-a04e-5b277f7e6fc7"},{"name":"[Text]: Surname","event":[{"listen":"test","script":{"id":"332c67e1-05fc-48b0-904d-4cd2dba3ef01","exec":["const res = pm.response.json();","","pm.test(\"Surname was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Please enter your middle name');","});","",""],"type":"text/javascript"}}],"id":"ce761034-1dfe-4ef8-be1c-f04714d7c001","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"OM6juXh6yAM=\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce761034-1dfe-4ef8-be1c-f04714d7c001"},{"name":"[Text]: Middlename","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"89ab1b66-edc8-442b-ba49-845219541444","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"M61O1fjs4Vl04JdcBXN82A==\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"89ab1b66-edc8-442b-ba49-845219541444"},{"name":"[Text]: Gender","event":[{"listen":"test","script":{"id":"ed81d29e-58fe-4a14-ab03-b808242733fd","exec":["const res = pm.response.json();","","pm.test(\"Gender was submitted & processed\", function () {"," pm.expect(res.status).to.eql('PendingValidation');","});","","pm.test(\"PIN creation was requested\", function () {"," pm.expect(res.message).to.contains('Enter a 4-digit transaction PIN you would like to use with your');","});",""],"type":"text/javascript"}}],"id":"a473970e-7569-478c-b535-93309351670b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"WHhR9vHnEwRGWKkrLfj/aA==\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"a473970e-7569-478c-b535-93309351670b"},{"name":"[Text]: Pin","event":[{"listen":"test","script":{"id":"3325db46-7638-4d16-9b5f-bee4f27ec257","exec":["const res = pm.response.json();","","pm.test(\"Pin was submitted & processed\", function () {"," pm.expect(res.status).to.eql('PendingValidation');","});","","pm.test(\"Account creation in progress\", function () {"," pm.expect(res.message).to.contains('A moment please... Your account is currently being provisioned.');","});",""],"type":"text/javascript"}}],"id":"50f5b6a7-1e1a-4d41-975f-cabb4e2e551a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"+xYaIIWMdOo40DIvll3r8w==\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"50f5b6a7-1e1a-4d41-975f-cabb4e2e551a"}],"id":"7c46a97e-e564-4042-9910-d965867f391f","_postman_id":"7c46a97e-e564-4042-9910-d965867f391f","description":""},{"name":"New Channel","item":[{"name":"Initiate","event":[{"listen":"test","script":{"id":"6d7c4206-ed34-4288-919b-6ccfc94fa44d","exec":["const res = pm.response.json();","","if (res.status == 'PendingValidation' && res.data.provider_response?.reference){"," pm.environment.set(\"transaction_ref\", res.data.provider_response.reference);","}","","pm.test(\"200 Http Status\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Return PendingValidation Status\", function () {"," pm.response.to.have.status(200);"," pm.expect(res.status).to.eql('PendingValidation');","});","","const providerResponse = res.data.provider_response;","pm.test(\"provider_response has all necessary object\", () => {"," pm.expect(providerResponse).to.have.all.keys('reference', 'action', 'meta');"," ","});","","pm.test(\"Reference is present in provider_response\", () => {"," pm.expect(providerResponse).to.include('reference');","});","","pm.test(\"Action contains all necessary object\", () => {"," const action = providerResponse.action;"," pm.expect(action).to.have.all.keys('message', 'recipientId');"," pm.expect(action.message).to.be.an('object');","});",""],"type":"text/javascript"}}],"id":"22d0b4b1-3f86-4cff-82e3-cf5970b05fa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\": \"benefits_intent\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Benefits\",\n \"route_mode\": null\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"W0oWj6EsBj6PviU-If0_7FTUKcj9fOH\",\n \"transaction_desc\": \"A random transaction\",\n \"transaction_ref_parent\": null,\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"{{customerRef}}\",\n \"firstname\": \"Uju\",\n \"surname\": \"Usmanu\",\n \"email\": \"ujuusmanu@gmail.com\",\n \"mobile_no\": \"{{customerRef}}\"\n },\n \"details\": {\n \"message\": \"Enrol\",\n \"callback_url\": \"{{callbackUrl}}\",\n \"subsequent_messages\": [],\n \"client_id\": \"{{appCode}}\",\n \"sender_id\": \"{{customerRef}}\",\n \"channel\": \"grb-api\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","urlObject":{"protocol":"https","path":["v2","transact"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"22d0b4b1-3f86-4cff-82e3-cf5970b05fa4"},{"name":"[Text]: Yes","id":"446724f0-0dfe-4cd6-84cc-d83b312ab322","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"qMlw1VEOzXI=\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"446724f0-0dfe-4cd6-84cc-d83b312ab322"},{"name":"[Text]: Pin","id":"75c26af0-c74e-44ae-a590-b8a7a4431e8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"+xYaIIWMdOo40DIvll3r8w==\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"75c26af0-c74e-44ae-a590-b8a7a4431e8d"}],"id":"f7c0a6d3-bcd7-42d0-8988-5712676ecafc","_postman_id":"f7c0a6d3-bcd7-42d0-8988-5712676ecafc","description":""}],"id":"add91134-913c-46a2-bacd-596ef2e2ac00","description":"The Enrolment service must be called before accessing the other services available. Enrolment is of two types, Enrolment - New Users, and Enrolment - New Channel.
\nEnrolment - New User is for customers that do not previously have any OnePipe generated virtual accounts.
\nEnrolment - New Channel is for customers that already have an account on OnePipe via our progressive web app on Benefits.chat and Benefits Mobile App. Note: For Enrolment - New Channel, customers will need to have their details reset for enrolment to take place.
\n","_postman_id":"add91134-913c-46a2-bacd-596ef2e2ac00"},{"name":"Pay4me","item":[{"name":"Initiate","id":"d1ca8d34-4b66-448b-8af4-f6ba90af195d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"request_ref\": \"{{requestRef}}\",\r\n \"request_type\": \"benefits_intent\",\r\n \"auth\": {\r\n \"type\": null,\r\n \"secure\": null,\r\n \"auth_provider\": \"Benefits\"\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\",\r\n \"transaction_ref\": \"ni_IH_9C3dTXsFt-k42AoatzkWwrMJw\",\r\n \"transaction_desc\": \"Initiate Pay4Me\",\r\n \"amount\": 0,\r\n \"customer\": {\r\n \"customer_ref\": \"{{customerRef}}\",\r\n \"firstname\": \"Oluwatimilehin\",\r\n \"surname\": \"Alapakristi\",\r\n \"email\": \"samuel@onepipe.io\",\r\n \"mobile_no\": \"{{customerRef}}\"\r\n },\r\n \"details\": {\r\n \"message\": \"{{msgPayToApp}}\",\r\n \"callback_url\": \"{{callbackUrl}}\",\r\n \"subsequent_messages\": [],\r\n \"client_id\": \"{{appCode}}\",\r\n \"sender_id\": \"{{customerRef}}\",\r\n \"channel\": \"grb-api\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","urlObject":{"protocol":"https","path":["v2","transact"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"d1ca8d34-4b66-448b-8af4-f6ba90af195d"},{"name":"Select Option","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"166e6d2b-7a18-4acd-b185-99d640423c79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"7BH+I3/kymASfv8/8gRwuA==\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"166e6d2b-7a18-4acd-b185-99d640423c79"},{"name":"Search Name","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"e4b0b10c-0b00-4422-b6ad-f75124db9900","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"2jffDEDDqBXdpSjnNPpjGnZY3Tq2j4tCWjeuiJDaOXkf7gvuQzWdwg==\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4b0b10c-0b00-4422-b6ad-f75124db9900"},{"name":"Payment Option","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"48af8620-82a7-4b22-979d-7976e2d9a0ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"2jffDEDDqBXdpSjnNPpjGnZY3Tq2j4tCWjeuiJDaOXkf7gvuQzWdwg==\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"48af8620-82a7-4b22-979d-7976e2d9a0ae"},{"name":"Payment Item","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"793b6c6c-b829-41cd-b622-37ae05d1e480","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"pHL/X+IN6qI=\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"793b6c6c-b829-41cd-b622-37ae05d1e480"},{"name":"Select Pay4Me","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"68c89357-6e44-4017-a765-38a7a8c1d090","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"A1Xb3dwEKFWw7AwU691xvQ==\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"68c89357-6e44-4017-a765-38a7a8c1d090"},{"name":"Select OnePipe Pay4Me","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"dd8d5744-c385-4045-b75c-fbfe80951b05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"A1Xb3dwEKFXLhiX6QCOGo+uo5n/du4QEyJScknvRBFzB9thHhXH1Gg==\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd8d5744-c385-4045-b75c-fbfe80951b05"},{"name":"Terms and Conditions","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"665e37b0-d6f3-4776-aaa0-00f3cbf45c6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"ohxUAfOhG8w=\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"665e37b0-d6f3-4776-aaa0-00f3cbf45c6c"},{"name":"DSA Fullname","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"2c7e1b71-19bb-4308-8c45-8be5205cb8b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"tPC8L5JVC9LrthcssjyliEBd5Mcb3hoqbWGxrSrI4IcD0VK8RwvvIg==\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c7e1b71-19bb-4308-8c45-8be5205cb8b4"}],"id":"50432d3a-263b-45d0-a20a-c7b3d430629b","_postman_id":"50432d3a-263b-45d0-a20a-c7b3d430629b","description":""},{"name":"Repay Credit Line","item":[{"name":"Initiate","id":"40a7d9c0-adf0-4997-8eae-119ba7940412","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"request_ref\": \"{{requestRef}}\",\r\n \"request_type\": \"benefits_intent\",\r\n \"auth\": {\r\n \"type\": null,\r\n \"secure\": null,\r\n \"auth_provider\": \"Benefits\"\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\",\r\n \"transaction_ref\": \"4qyL4gVqgyQpq3p-iY7MuGY58NsxBtc\",\r\n \"transaction_desc\": \"Repay Credit Line\",\r\n \"amount\": 0,\r\n \"customer\": {\r\n \"customer_ref\": \"{{customerRef}}\",\r\n \"firstname\": \"Oluwatimilehin\",\r\n \"surname\": \"Alapakristi\",\r\n \"email\": \"samuel@onepipe.io\",\r\n \"mobile_no\": \"{{customerRef}}\"\r\n },\r\n \"details\": {\r\n \"message\": \"{{msgPayToApp}}\",\r\n \"callback_url\": \"{{callbackUrl}}\",\r\n \"subsequent_messages\": [],\r\n \"client_id\": \"{{appCode}}\",\r\n \"sender_id\": \"{{customerRef}}\",\r\n \"channel\": \"grb-api\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","urlObject":{"protocol":"https","path":["v2","transact"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"40a7d9c0-adf0-4997-8eae-119ba7940412"},{"name":"Repay Credit Line","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"f085eaf2-3407-47b4-9a5d-f43979ffe20f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"F4gpafAzroVZ+R8HrLNwSPn+LYgYm5wJfSKlgr0jz7zvy7gQuaIQ+g==\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"f085eaf2-3407-47b4-9a5d-f43979ffe20f"},{"name":"Payment Item","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"c179bb6c-6fd3-4561-9534-2ba980f70678","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"pHL/X+IN6qI=\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"c179bb6c-6fd3-4561-9534-2ba980f70678"},{"name":"Pay Now","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"71191b32-cc83-4938-84ae-803057570421","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"VaAmSIe8y6nnOmIRRXqgcg==\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"71191b32-cc83-4938-84ae-803057570421"},{"name":"PIN","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"10d9bc2b-985c-4a76-a15a-9b95deb50171","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"TIdS9+05Aas=\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"10d9bc2b-985c-4a76-a15a-9b95deb50171"}],"id":"4c9c2768-659c-470f-b214-f81c00710df8","_postman_id":"4c9c2768-659c-470f-b214-f81c00710df8","description":""},{"name":"Upgrade Account","item":[{"name":"Initiate","id":"a565e9ae-8ec7-4161-9b0a-292c78b0a61e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\": \"benefits_intent\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Benefits\"\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"QDzEezz_Il4IQFV-fMloWjLbv7EEcUL\",\n \"transaction_desc\": \"Initiate Upgrade Account\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"{{customerRef}}\",\n \"firstname\": \"Oluwatimilehin\",\n \"surname\": \"Alapakristi\",\n \"email\": \"samuel@onepipe.io\",\n \"mobile_no\": \"{{customerRef}}\"\n },\n \"details\": {\n \"message\": \"{{msgUpgradeAccount}}\",\n \"callback_url\": \"{{callbackUrl}}\",\n \"subsequent_messages\": [],\n \"client_id\": \"{{appCode}}\",\n \"sender_id\": \"{{customerRef}}\",\n \"channel\": \"grb-api\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.iov2/transact","urlObject":{"protocol":"https","path":["transact"],"host":["api","onepipe","iov2"],"query":[],"variable":[]}},"response":[],"_postman_id":"a565e9ae-8ec7-4161-9b0a-292c78b0a61e"}],"id":"53642a9c-b665-45fa-81bd-df7a5b996a12","_postman_id":"53642a9c-b665-45fa-81bd-df7a5b996a12","description":""},{"name":"Upgrade Limit","item":[{"name":"Initiate","id":"15669ff1-6d26-4583-82f3-ad065c2dc230","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\": \"benefits_intent\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Benefits\",\n \"route_mode\": null\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"lwdISzcyQ2TBH5v-rkLNKBj5llst3jb\",\n \"transaction_desc\": \"A random transaction\",\n \"transaction_ref_parent\": null,\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"{{customerRef}}\",\n \"firstname\": \"Uju\",\n \"surname\": \"Usmanu\",\n \"email\": \"ujuusmanu@gmail.com\",\n \"mobile_no\": \"{{customerRef}}\"\n },\n \"details\": {\n \"message\": \"Upgrade Limit\",\n \"callback_url\": \"{{callbackUrl}}\",\n \"subsequent_messages\": [],\n \"client_id\": \"{{appCode}}\",\n \"sender_id\": \"{{customerRef}}\",\n \"channel\": \"grb-api\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","urlObject":{"protocol":"https","path":["v2","transact"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"15669ff1-6d26-4583-82f3-ad065c2dc230"},{"name":"Yes [Valid ID]","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"124de75a-da51-4944-adf4-4be1cce935ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"ohxUAfOhG8w=\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"124de75a-da51-4944-adf4-4be1cce935ee"},{"name":"Yes [Utility Bill]","event":[{"listen":"test","script":{"id":"8235edc5-0904-4e06-905c-63dec17cfefb","exec":["const res = pm.response.json();","","pm.test(\"Middlename was submitted & processed\", function () {"," pm.expect(res.message).to.contains('Select your gender');","});","",""],"type":"text/javascript"}}],"id":"531385c8-55b7-4181-b92f-c6632ee171bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"{{requestRef}}\",\n \"request_type\":\"benefits_intent\",\n\t\"auth\": {\n \"secure\": \"ohxUAfOhG8w=\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"998383938292\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/validate","urlObject":{"protocol":"https","path":["v2","transact","validate"],"host":["api","onepipe","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"531385c8-55b7-4181-b92f-c6632ee171bf"}],"id":"3e4de8b4-3f59-43a0-bf56-e17b2796ff96","_postman_id":"3e4de8b4-3f59-43a0-bf56-e17b2796ff96","description":""}],"id":"4a80d830-6d21-490e-869a-73a761dac737","description":"This is similar to calling any of OnePipe API's but in this instance, the expected response is not returned in real time; responses would be sent to the callback_url provided in your initial transact call payload.
Sequence of Calls
\n/transact with the no auth details.details object, the app inserts the user’s message as text + a callback URL.PendingValidation and an action object corresponding to the message from the underlying intent (text, menu, buttons, attachments). The provider responds via the callback URL./transact/validate to supply the user’s a choice/text.Successful or Failed if it has all it needs to finish off the intent. Otherwise, go back to #3./transact/queryThis is an arrangement such that if a developer already knows the exact set of questions that will follow in order to complete an intent, they can preload it; the provider will hold the array on their behalf and forward to OneChapp as each response is received from OneChapp. See a sample of subsequent messaging feature.
\n\"subsequent_messages\": [\n {\n \"question\": \"Onepipe Benefits\",\n \"answer\": \"Opt in\"\n },\n {\n \"question\": \"Please enter your BVN\",\n \"answer\": \"{{ encrypted BVN }}\"\n },\n {\n \"question\": \"Please enter your date (YYYY-MM-DD) of birth\",\n \"answer\": \"{{ encrypted DOB }}\"\n },\n {\n \"question\": \"do you want to continue?\",\n \"answer\": \"yes\"\n },\n {\n \"question\": \"4-digit transaction pin\",\n \"answer\": \"{{encrypted PIN}}\"\n }\n]\n\nDo note that any sensitive information (such as BVN, DOB, PIN etc) that would be provided in the subsequent messages MUST be encrypted using the calling app’s secret key.
\nSequence of calls
\n/transact with the no auth detailsdetails object, app inserts the user’s message as text , a callback url and the subsequent_messages array have it's content structured as shown above.PendingValidation with a message notifying the user that her callback would be notified once transaction is executed either successfully or otherwise.Successful or Failed if it has all it needs to finish off the intent. Otherwise nothing happens especially transaction that need human intervention such as manual verification of documents etc./transact/queryFind the actual status or the last message for a specific transaction. This request would either return a PendingValidation, Failed or Successful response.
For businesses seeking to embed financial services in their present suite of products for their customers as a way to deepen their relationship without dealing with technical heavy lifting and regulatory risks, Benefits Banking provides a flexible integration approach, that speeds up time to market. Partners will be able open fully tiered KYC accounts for their customers with upgrade service, access buy now pay later credit \"Pay4Me\" as well as other banking services like buy airtime, transfer.
\nThis highlights services that partners can take advantage of with Benefits Banking. This provider supports two different forms of messaging:
\nEnrolment
\nBenefits Banking supports an enrolment service for onboarding customers to partners' platforms by collecting details. The details provided by the customer are used to verify their identity by checking and matching with the supplied BVN in compliance with regulatory. Some of the details required from the customer will include Bank Verification Number (BVN), First Name, Last Name, Middle Name, Gender, and Date of Birth.
\nPay4Me
\nPay4Me is OnePipe's Buy Now Pay Later (BNPL) product. It is a credit infrastructure built to fit into the purchase + fulfilment workflow and designed to support multiple credit providers.
\nUpgrade Account
\nAccount upgrades can be completed simply by calling the OnePipe API. This helps to improve KYC, tighten security - mitigate exposure to fraud and identity theft related occurrences.
\nUpgrade Limit
\nThis service upgrades the transaction limit customers can perform on your channel based on the level at which they have verified their KYC.
\nRefer to this documentation link to understand The OnePipe Header
\nContent-Type
\nApplication/JSON
\nPlease contact support@onepipe.io to set up your dedicated OnePipe app on our platform.
\n{\n \"request_ref\": \"{{request_ref}}\",\n \"request_type\": \"benefits_intent\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Benefits\"\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"998383938292\",\n \"transaction_desc\": \"A random transaction\",\n \"transaction_ref_parent\": null,\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"DemoApp_Customer007\",\n \"firstname\": \"Uju\",\n \"surname\": \"Usmanu\",\n \"email\": \"ujuusmanu@gmail.com\",\n \"mobile_no\": \"234802343132\"\n },\n \"meta\": {\n \"a_key\": \"a_meta_value_1\",\n \"another_key\": \"a_meta_value_2\"\n },\n \"details\": {\n \"message\": \"{{some kain text to trigger the intent or respond to a message}}\",\n \"callback_url\": \"{{a url to post the response to for long running proceses}}\",\n // An array of {{message}} elements. Such that if a developer already knows the EXACT set of questions that will follow in order to complete an intent, they can preload it, the provider will hold on their behalf and forward to OneChapp as each response is received. USE CASE: Making it possible to have one-shot API calls. e.g. We can then have Appsolute built a single USSD string to trigger pay4me in one shot when its time for retailer self-service\n \"subsequent_messages\": [\n {\n \"question\": \"Onepipe Benefits\",\n \"answer\": \"Opt in\"\n },\n {\n \"question\": \"Please enter your BVN\",\n \"answer\": \"{{ encrypted BVN }}\"\n },\n {\n \"question\": \"Please enter your date (YYYY-MM-DD) of birth\",\n \"answer\": \"{{ encrypted DOB }}\"\n },\n {\n \"question\": \"do you want to continue?\",\n \"answer\": \"yes\"\n },\n {\n \"question\": \"4-digit transaction pin\",\n \"answer\": \"{{encrypted PIN}}\"\n }\n ],\n \"client_id\": \"{{app_code of the app}}\", //optional\n \"sender_id\": \"{{customer_ref}}\", //optional\n \"channel\": \"OnePipe\", //optional\n }\n }\n}\n\nTo push this request successfully, encrypt the user's input using the calling app's secret key and fill in the auth.secure with the encrypted value.
{\n \"request_ref\":\"{{request_ref}}\", \n \"request_type\":\"benefits_intent\",\n \"auth\": {\n \"secure\": \"{{the encrypted message or selection from the user}}\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"70713093460718\"\n }\n}\n\nHere are samples of the responses to expect when calling the Benefits Provider.
\n{\n \"status\": \"Successful | Failed | PendingValidation\",\n \"message\": \"{{The same value in provider_response.action.message}}\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Benefits\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\":\"263636363633777\",\n \"action\": {\n \"recipientId\": \"2347083108908\",\n \"message\": {\n \"type\": \"text\",\n \"text\": \"How much do you need?\" \n },\n }\n \"meta\":{}\n }\n }\n}\n\n{\n \"status\": \"Successful | Failed | PendingValidation\",\n \"message\": \"{{The same value in provider_response.action.message}}\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Benefits\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\":\"263636363633777\",\n \"action\": {\n \"recipientId\": \"2347083108908\",\n \"message\": {\n \"type\": \"menu\",\n \"text\": \"Welcome, how can I help you today?\",\n \"menu\": [\n {\n \"id\": \"1\",\n \"item\": \"Account Statement\"\n },\n {\n \"id\": \"2\",\n \"item\": \"Ask A Question\"\n },\n {\n \"id\": \"3\",\n \"item\": \"Balance Enquiry\"\n },\n {\n \"id\": \"4\",\n \"item\": \"Bill Payment\"\n }\n ]\n },\n }\n \"meta\":{}\n }\n }\n}\n\n{\n \"status\": \"Successful | Failed | PendingValidation\",\n \"message\": \"{{The same value in provider_response.action.message}}\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Benefits\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\":\"263636363633777\",\n \"action\": {\n \"recipientId\": \"2347083108908\",\n \"message\": {\n \"type\": \"buttons\",\n \"text\": \"Choose a password:\",\n \"buttons\": [\n {\n \"title\": \"Enter password\",\n \"url\": \"https://f31ac10a.ngrok.io/u/eb087\"\n }\n ]\n },\n }\n \"meta\":{}\n }\n }\n}\n\n{\n \"status\": \"Successful | Failed | PendingValidation\",\n \"message\": \"{{The same value in provider_response.action.message}}\",\n \"data\"jjJSO: {\n \"provider_response_code\": \"00\",\n \"provider\": \"Benefits\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\":\"263636363633777\",\n \"action\": {\n \"recipientId\": \"2347083108908\",\n \"message\": {\n \"type\": \"attachments\",\n \"text\": \"Hi user, here are some sample attachments.\",\n \"attachments\": [\n {\n \"type\": \"pdf\",\n \"url\": \"http://164.100.133.129:81/econtent/Uploads/Session3 Classification of Car by Body Style.pdf\"\n },\n {\n \"type\": \"image\",\n \"url\": \"https://www.summerhilllandscapes.com/wp-content/uploads/2016/10/SFrances_160726_3934_A.jpg\"\n }\n ]\n },\n }\n \"meta\":{}\n }\n }\n}\n\n{\n \"request_ref\":\"{{request_ref}}\", \n \"request_type\":\"benefits_intent\",\n \"auth\": {\n \"secure\": \"{{the message or selection from the user}}\",\n \"auth_provider\": \"Benefits\" \n },\n \"transaction\": {\n \"transaction_ref\": \"70713093460718\"\n }\n}\n\nFor this service, these are the possible responses a client can receive
\n","_postman_id":"92b81c20-b6bf-491a-99de-1ed49010cd78"}],"id":"1de13cb9-68e0-4e93-ae3c-0136c0ba232b","description":"\n\nWant to see an ideal embedded payments integration that combines virtual accounts with 1-click direct-from-account payments? Play with this demo and see what happens after you register. You can embed an experience just like that
\n
In this section, you'd see quick step-by-step integration workflows in rapid fire straight-to-the-point format without any flowery words. Just straight guides on how to mix different APIs to achieve specific objectives.
\nMore information below...
\n","_postman_id":"1de13cb9-68e0-4e93-ae3c-0136c0ba232b"},{"name":"API calatog","item":[{"name":"Account provisioning","item":[{"name":"Open Account","id":"0c2e20f0-e9d8-45e0-b402-d1eb1a9e3e3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\": \"111111111\",\r\n \"request_type\": \"open_account\",\r\n \"auth\": {\r\n \"type\": null,\r\n \"secure\": null,\r\n \"auth_provider\": \"DemoProvider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"inspect\",\r\n \"transaction_ref\": \"{{transaction-ref}}\",\r\n \"transaction_desc\": \"A random transaction\",\r\n \"transaction_ref_parent\": null,\r\n \"amount\": 0,\r\n \"customer\": {\r\n \"customer_ref\": \"DemoApp_Customer007\",\r\n \"firstname\": \"Uju\",\r\n \"surname\": \"Usmanu\",\r\n \"email\": \"ujuusmanu@gmail.com\",\r\n \"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\": {\r\n \"a_key\": \"a_meta_value_1\",\r\n \"another_key\": \"a_meta_value_2\"\r\n },\r\n \"details\": {\r\n \"name_on_account\": \"Tobi Olajide\",\r\n \"middlename\": \"string\",\r\n \"dob\": \"2020-09-20-11-30-30\",\r\n \"gender\": \"M\",\r\n \"title\": \"Mr\",\r\n \"address_line_1\": \"23, Okon street, Ikeja\",\r\n \"address_line_2\": \"Ikeja\",\r\n \"city\": \"lagos\",\r\n \"state\": \"lagos\",\r\n \"country\": \"NG\"\r\n }\r\n }\r\n}"},"url":"https://api.onepipe.io/v2/transact","description":"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.
\nFirst, please be sure to have gone through...
\nNow, here's the call sequence specific to this service...
\nCall /transact with the right auth details. Typically, bvn. See here
Provider responds with WaitingForOTP or PendingValidation if they require OTP verification
Call /transact/validate to supply OTP if needed
Provider responds with any of the completion codes Successful or Failed.
To query the status of a transaction, call /transact/query
Read the reponse
\nRead the provider_response Object
Successful: Success
\nWaitingForOTP: Display the status.message and collect the input from the user, then follow with a /transact/validate
PendingValidation: Display the status.message and collect the input from the user, then follow with a /transact/validate
Processing: The account opening wasn't successful but is probably still executing in the background. Typically, this would have escalated to the back office and the provider's (bank) staff would manually execute the account opening process
\n[Anything else]: Error. Read the errors object(s)
\nQuestion: Why do I need to specify transaction.amountwhen it's irrelevant here?
Answer: OnePipe APIs all try to follow a common standard such that all services require the same exact payload. It's the values within the payload that will then vary, service by service. In this case, just set it to 0.
Question: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
This approach creates a standing debit instruction (debit mandate) against and account. Awaiting inflow.
NOTE 1: To execute the \"pay with transfer\" workflow, simply _open account_ and append mandate details in the _transaction.meta_ object. Details and sample payload further below.
NOTE 2: If you have already assigned an account to a user and just want to create the mandate every time the user places an order on your platform, simply call Open Account again and include the mandate details. Because the account has already been assigned to the user and this endpoint is called again, a new account will not be opened, rather, a new standing instruction will be created against the account
\nIf you are calling this endpoint for the purposes of pay with transfer, there are some values you need to set in the meta object that helps to make this more effective.
NOTE 3: The standing debit instruction being set against these accounts are of three types
Clearing (Deleting) a mandate:
\nTo clear or delete a standing debit instruction on an account, call open account and set pwt_mandate_action as delete, the pwt_item_code should be the id of the mandate to be deleted. See below for an example:
\"meta\": {\n \"grb_status\": \"pwt-active\",\n \"pwt_item_amount\": \"80000\",\n \"pwt_item_code\": \"4546633\",\n \"pwt_item_description\": \"sample\",\n \"pwt_mandate_action\": \"delete\"\n }\n\n\"meta\": {\n \"grb_status\": \"pwt-active\",\n \"pwt_item_description\": \"Order fee\",\n \"pwt_item_code\": \"{{payment-item-code}}\", \n \"pwt_item_amount\": \"5000\" \n}\n\nSome providers on the OnePipe platform (e.g. CheddaAccount - a product of SupportMFB), can yield multiple virtual accounts from various commercial banks, but mapped to the same store of value (a SupportMFB Chedda account). The deposits into any of the virtual accounts will be credited to the individual SupportMFB account, but you can present any of the commercial bank virtual account numbers to the user.
\nThe major advantages of this:
\nSome customers will like a recognizable brand to build trust. You can then display the virtual account of a commercial bank to them.
\nAt times, some banks' virtual accounts platform may experience a downtime, this guarantees that you will always have redundancy in place
\nYou can choose to display multiple account numbers to a user who can then decide which they prefer to identify with
\nIn this scenario the response of your API calls will contain a data.provider_response.meta.alt_accounts array that contains the details of these extra account numbers. You can then decide how best you want to present it.
Each object in the array has exactly the same construct as the standard provider_response for the Open Account call.
\"meta\": {\n \"alt_accounts\": [\n {\n \"reference\": \"MVgGByKV-js-oa\",\n \"account_number\": \"9996879001\",\n \"contract_code\": null,\n \"account_reference\": \"MVgGByKV-js-oa\",\n \"account_name\": \"Raheem Roqeeb\",\n \"currency_code\": \"NGN\",\n \"customer_email\": \"rqbraheem@gmail.com\",\n \"bank_name\": \"Fidelity\",\n \"bank_code\": \"070\",\n \"account_type\": null,\n \"status\": \"ACTIVE\",\n \"created_on\": \"2021-11-01-19-11-55\"\n },\n {\n \"reference\": \"MVgGByKV-js-oa\",\n \"account_number\": \"7656879001\",\n \"contract_code\": null,\n \"account_reference\": \"MVgGByKV-js-oa\",\n \"account_name\": \"Raheem Roqeeb\",\n \"currency_code\": \"NGN\",\n \"customer_email\": \"rqbraheem@gmail.com\",\n \"bank_name\": \"Polaris Bank Limited\",\n \"bank_code\": \"076\",\n \"account_type\": null,\n \"status\": \"ACTIVE\",\n \"created_on\": \"2021-11-01-19-11-55\"\n }, \n {\n \"reference\": \"MVgGByKV-js-oa\",\n \"account_number\": \"8886879001\",\n \"contract_code\": null,\n \"account_reference\": \"MVgGByKV-js-oa\",\n \"account_name\": \"Raheem Roqeeb\",\n \"currency_code\": \"NGN\",\n \"customer_email\": \"rqbraheem@gmail.com\",\n \"bank_name\": \"SunTrust\",\n \"bank_code\": \"100\",\n \"account_type\": null,\n \"status\": \"ACTIVE\",\n \"created_on\": \"2021-11-01-19-11-55\"\n },\n {\n \"reference\": \"MVgGByKV-js-oa\",\n \"account_number\": \"0986879001\",\n \"contract_code\": null,\n \"account_reference\": \"MVgGByKV-js-oa\",\n \"account_name\": \"Raheem Roqeeb\",\n \"currency_code\": \"NGN\",\n \"customer_email\": \"rqbraheem@gmail.com\",\n \"bank_name\": \"VBank\",\n \"bank_code\": \"566\",\n \"account_type\": null,\n \"status\": \"ACTIVE\",\n \"created_on\": \"2021-11-01-19-11-55\"\n },\n {\n \"reference\": \"MVgGByKV-js-oa\",\n \"account_number\": \"5500000123\",\n \"contract_code\": null,\n \"account_reference\": \"MVgGByKV-js-oa\",\n \"account_name\": \"Raheem Roqeeb\",\n \"currency_code\": \"NGN\",\n \"customer_email\": \"rqbraheem@gmail.com\",\n \"bank_name\": \"SUPPORT MFB\",\n \"bank_code\": \"295\",\n \"account_type\": null,\n \"status\": \"ACTIVE\",\n \"created_on\": \"2021-11-01-19-11-55\"\n }\n ]\n }\n\nYou will also be able to determine which bank you prefer to be set as the default. The default will be the one that appears in data.provider_response
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, please prompt for this. Upon the correct details being provided, the provider will respond with account/wallet balance information.
\nPlease be sure to have gone through...
\nsecure elementHere's the call sequence specific to this service...
\n/transact with the right auth details if required. See hereWaitingForOTP or PendingValidation if they require OTP verification/transact/validate to supply OTP if neededSuccessful or Failed. /transact/queryprovider_response Objectstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validateFor a list of providers that have published and implemented this service, please see here
\nQuestion: Why do I need to specify transaction.amountwhen it's irrelevant here?
Answer: OnePipe APIs all try to follow a common standard such that all services require the same exact payload. It's the values within the payload that will then vary, service by service. In this case, just set it to 0.
Question: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
With this service, the calling apps can open Polaris wallets on behalf of their customers
\nauth.secure should be the customer's BVN numbertransaction.meta.account_currency can either be USD or NGN. It defaults to NGN is none is passedWith this service, you can take a customer reference (phone number, unique ID, etc.) and obtain a masked list of accounts known with it by a specific provider. If authorisation details are required by a provider, you will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation.
\nFor example: Get a list of bank accounts for a phone number.
\nPlease be sure to have gone through...
\nsecure elementHere's the call sequence specific to this service...
\n/transact with the right auth details. null is also supported. See hereWaitingForOTP or PendingValidation if they require OTP verification to verify that consent has been given by the customer./transact/validate to supply OTP if neededSuccessful or Failed. /transact/queryprovider_response Objectstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validateFor a list of providers that have published and implemented this service, please see here
\nQuestion: Why do I need to specify transaction.amountwhen it's irrelevant here?
Answer: OnePipe APIs all try to follow a common standard such that all services require the same exact payload. It's the values within the payload that will then vary, service by service. In this case, just set it to 0.
Question: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
With this service, you can take a customer reference (phone number, unique ID, etc.) and obtain a unmasked list of accounts known with it by a specific provider. If authorisation details are required by a provider, you will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation.
\nFor example: Get a list of bank accounts for a phone number.
\nPlease be sure to have gone through...
\nsecure elementHere's the call sequence specific to this service...
\n/transact with the right auth details. null is also supported. See hereWaitingForOTP or PendingValidation if they require OTP verification to verify that consent has been given by the customer./transact/validate to supply OTP if neededSuccessful or Failed. /transact/queryprovider_response Objectstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validateFor a list of providers that have published and implemented this service, please see here
\nQuestion: Why do I need to specify transaction.amountwhen it's irrelevant here?
Answer: OnePipe APIs all try to follow a common standard such that all services require the same exact payload. It's the values within the payload that will then vary, service by service. In this case, just set it to 0.
Question: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
With this service, you can take a customer reference (phone number, unique ID, etc.) and obtain a unmasked list of accounts known with it as well as extended data per account by a specific provider. If authorisation details are required by a provider, you will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation.
\nFor example: Get a list of bank accounts for a phone number and for each account provide information on it's active status.
\nPlease be sure to have gone through...
\nsecure elementHere's the call sequence specific to this service...
\n/transact with the right auth details. null is also supported. See hereWaitingForOTP or PendingValidation if they require OTP verification to verify that consent has been given by the customer./transact/validate to supply OTP if neededSuccessful or Failed. /transact/queryprovider_response Objectstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validateFor a list of providers that have published and implemented this service, please see here
\nQuestion: Why do I need to specify transaction.amountwhen it's irrelevant here?
Answer: OnePipe APIs all try to follow a common standard such that all services require the same exact payload. It's the values within the payload that will then vary, service by service. In this case, just set it to 0.
Question: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
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.
\n","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"60bec54a-9481-4c83-b693-297f709ea239","name":"Lookup Account Min - Successful","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_account_min\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"inspect\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"b_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {}\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Jul 2020 23:26:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"518"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Account details retrieved Sucessfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"DemoProvider\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"customer_id\": \"007935125\",\n \"account_name\": \"BOLA SALAMI\",\n \"account_number\": \"1780161243\",\n \"last_name\": \"SALAMI\",\n \"first_name\": \"BOLA\",\n \"middle_name\": \"-\",\n \"gender\": \"Female\",\n \"account_currency\": \"NGN\",\n \"dob\": \"1989-06-06-10-00-00\",\n \"reference\": \"1228519650461\",\n \"meta\": {\n \"field_key\": \"field_value\"\n }\n },\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"},{"id":"31fef196-29dc-4e3c-a80c-b027594dfd19","name":"Lookup Account Min - Failed","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_account_min\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"b_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {}\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Jul 2020 23:26:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"581"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Failed\",\n \"message\": \"Invalid request mode\",\n \"data\": {\n \"options\": null,\n \"provider_response_code\": null,\n \"provider\": null,\n \"errors\": [\n {\n \"code\": \"01\",\n \"message\": \"You are not yet enabled for go-live\"\n }\n ],\n \"error\": {\n \"code\": \"01\",\n \"message\": \"You are not yet enabled for go-live\"\n },\n \"provider_response\": null,\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"},{"id":"c1c46a94-4c3a-45b4-b9a2-80f21c115e57","name":"Lookup Account Min - WaitingForOTP","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_account_min\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"inspect\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"b_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {}\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Jul 2020 23:26:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"518"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"WaitingForOTP\",\n \"message\": \"Please enter the OTP sent to 2348022****08, use 12345678 as your OTP\",\n \"data\": {\n \"provider_response_code\": \"900T0\",\n \"provider\": \"Demoprovider\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": null,\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"}],"_postman_id":"e51aee2c-6be5-4c25-88ac-64b424487d15"},{"name":"Lookup Account Mid","id":"230efcee-3176-441a-aafe-a0a9d11b4899","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_account_mid\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"inspect\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"b_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {}\r\n }\r\n}"},"url":"https://api.onepipe.io/v2/transact","description":"With this service, the calling apps can do KYC with the customer's account number. This service will return slightly above minimal KYC information
\n","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"2da7e180-423e-4aca-b17a-5f514ba867ea","name":"Lookup Account Mid - Successful","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_account_mid\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"inspect\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"b_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {}\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Jul 2020 23:32:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"518"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Account details received\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"DemoProvider\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"customer_id\": \"007935125\",\n \"account_name\": \"BOLA SALAMI\",\n \"first_name\": \"BOLA\",\n \"last_name\": \"SALAMI\",\n \"middle_name\": \"-\",\n \"gender\": \"Male\",\n \"account_currency\": \"NGN\",\n \"dob\": \"1989-06-06-10-00-00\",\n \"scheme_code\": \"STFCUR\",\n \"account_status\": \"ACCOUNT OPEN\",\n \"account_number\": \"1780161243\",\n \"bvn\": \"22153578379\",\n \"mobile_number\": \"09081690629\",\n \"meta\": {\n \"field_key\": \"field_value\"\n }\n },\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"},{"id":"4387db29-44be-4ec8-b423-e063643b3d3f","name":"Lookup Account Mid - WaitingForOTP","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_account_mid\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"inspect\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"b_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {}\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Jul 2020 23:32:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"518"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"WaitingForOTP\",\n \"message\": \"Please enter the OTP sent to 2348022****08, use 12345678 as your OTP\",\n \"data\": {\n \"provider_response_code\": \"900T0\",\n \"provider\": \"Demoprovider\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": null,\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"},{"id":"8d8086b4-4f74-4c93-8b7b-cb68e553350a","name":"Lookup Account Mid - Failed","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_account_mid\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"b_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {}\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Jul 2020 23:31:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"581"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Failed\",\n \"message\": \"Invalid request mode\",\n \"data\": {\n \"options\": null,\n \"provider_response_code\": null,\n \"provider\": null,\n \"errors\": [\n {\n \"code\": \"01\",\n \"message\": \"You are not yet enabled for go-live\"\n }\n ],\n \"error\": {\n \"code\": \"01\",\n \"message\": \"You are not yet enabled for go-live\"\n },\n \"provider_response\": null,\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"}],"_postman_id":"230efcee-3176-441a-aafe-a0a9d11b4899"},{"name":"Lookup Account Max","id":"5f1616c9-39b4-4935-a349-717c5a594053","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_account_max\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"inspect\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {}\r\n }\r\n}"},"url":"https://api.onepipe.io/v2/transact","description":"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
\n","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"e9570df9-5b05-4809-b85e-1115a7a35b0f","name":"Lookup Account Max - Successful","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_account_max\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"inspect\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {}\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Jul 2020 23:36:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"518"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Validated Sucessfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"DemoProvider\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"customer_id\": \"007935125\",\n \"account_currency\": \"NGN\",\n \"account_number\": \"1020123456\",\n \"account_name\": \"BOLA SALAMI\",\n \"last_name\": \"SALAMI\",\n \"middle_name\": \"-\",\n \"first_name\": \"BOLA\",\n \"gender\": \"Male\",\n \"dob\": \"1971-03-12T00:00:00\",\n \"account_branch\": \"101\",\n \"scheme_code\": \"SAV\",\n \"bvn\": \"22211055555\",\n \"account_status\": \"ACCOUNT OPEN\",\n \"ledger_balance\": 2524.59,\n \"available_balance\": 2524.59,\n \"kyc_level\": \"3\",\n \"name_enquiry_id\": \"0000028301\",\n \"address1\": \"9 LIGALI STREET\",\n \"address2\": \".\",\n \"address3\": \"IBADAN\",\n \"email\": \"BOLASALAMI@yahoo.com\",\n \"mobile_number\": \"080913333333\",\n \"account_type\": \"CURRENT\",\n \"reference\": \"4094029412504\",\n \"meta\": {\n \"field_key\": \"field_value\"\n }\n },\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"},{"id":"a73fba7b-af88-41ef-8487-a57548243c0e","name":"Lookup Account Max - WaitingForOTP","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_account_max\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"inspect\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {}\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Jul 2020 23:36:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"518"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"WaitingForOTP\",\n \"message\": \"Please enter the OTP sent to 2348022****08, use 12345678 as your OTP\",\n \"data\": {\n \"provider_response_code\": \"900T0\",\n \"provider\": \"Demoprovider\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": null,\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"},{"id":"0f46eb1d-98a7-4677-a8b6-c42ca61e811c","name":"Lookup Account Max - Failed","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_account_max\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {}\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Jul 2020 23:36:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"581"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Failed\",\n \"message\": \"Invalid request mode\",\n \"data\": {\n \"options\": null,\n \"provider_response_code\": null,\n \"provider\": null,\n \"errors\": [\n {\n \"code\": \"01\",\n \"message\": \"You are not yet enabled for go-live\"\n }\n ],\n \"error\": {\n \"code\": \"01\",\n \"message\": \"You are not yet enabled for go-live\"\n },\n \"provider_response\": null,\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"}],"_postman_id":"5f1616c9-39b4-4935-a349-717c5a594053"},{"name":"Lookup BVN Min","id":"8be40b94-9ff0-4e49-9d4f-0235a8dc5940","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_bvn_min\",\r\n \"auth\": {\r\n \"type\": \"bvn\", \r\n \"secure\": \"X90WY3DRBQQehrv9FzvA4hlExLEj3eTW\",\r\n \"auth_provider\": \"DemoProvider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"inspect\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"{{customer_mobile_no}}\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"b_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {\r\n \t\"dob\": \"1990-09-12\"\r\n }\r\n }\r\n}"},"url":"https://api.onepipe.io/v2/transact","description":"With this service, the calling apps can KYC a customer's bank verification number. This service will only return a True/False match of the supplied customer details if it matches what is saved against their BVN correctly. 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.
\nPlease be sure to have gone through...
\nsecure elementHere's the call sequence specific to this service...
\n/transact with the right auth details - bvn. See hereWaitingForOTP or PendingValidation if they require OTP verification/transact/validate to supply OTP if neededSuccessful or Failed. /transact/queryprovider_response Objectstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validateFor a list of providers that have published and implemented this service, please see here
\nQuestion: Why do I need to specify transaction.amount when it's irrelevant here?
Answer: OnePipe APIs all try to follow a common standard such that all services require the same exact payload. It's the values within the payload that will then vary, service by service. In this case, just set it to 0.
Question: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
With this service, the calling apps can do KYC with the customer's bvn. This service will return slightly above minimal KYC information. Apps will collect the BVN 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.
\nPlease be sure to have gone through...
\nsecure elementHere's the call sequence specific to this service...
\n/transact with the right auth details - bvn. See hereWaitingForOTP or PendingValidation if they require OTP verification/transact/validate to supply OTP if neededSuccessful or Failed. /transact/queryprovider_response Objectstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validateFor a list of providers that have published and implemented this service, please see here
\nQuestion: Why do I need to specify transaction.amount when it's irrelevant here?
Answer: OnePipe APIs all try to follow a common standard such that all services require the same exact payload. It's the values within the payload that will then vary, service by service. In this case, just set it to 0.
Question: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
With this service, the calling apps can do KYC with the customer's bvn. This service will return maximum KYC information. Apps will collect the account number 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.
\nPlease be sure to have gone through...
\nsecure elementHere's the call sequence specific to this service...
\n/transact with the right auth details - bvn. See hereWaitingForOTP or PendingValidation if they require OTP verification/transact/validate to supply OTP if neededSuccessful or Failed. /transact/queryprovider_response Objectstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validateFor a list of providers that have published and implemented this service, please see here
\nQuestion: Why do I need to specify transaction.amount when it's irrelevant here?
Answer: OnePipe APIs all try to follow a common standard such that all services require the same exact payload. It's the values within the payload that will then vary, service by service. In this case, just set it to 0.
Question: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
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.
\n","event":[{"listen":"prerequest","script":{"id":"d30f2c86-bcd9-4d04-b113-68fff895e207","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"40ec35b7-0fc1-47ee-8e9d-2fd8b100580c","type":"text/javascript","exec":[""]}}],"_postman_id":"071df0f7-aa08-4c4d-b567-286e74603f69"},{"name":"Payments initiation","item":[{"name":"OnePipe.js","item":[{"name":"Sample Page","id":"fa441dbf-b814-40c7-b633-4a2c1183b0c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"Here's a sample.
\nYou can use this as boilerplate for your own implementation.
\nYou can see it in action here.
\n\n<!DOCTYPE html>\n<html>\n<head>\n <title>Sample OnePipe Payment</title>\n <meta charset=\"utf-8\" />\n <script src=\"https://js.onepipe.io/v2\"></script>\n</head>\n<body>\n <h1>This is a demo payment</h1>\n <p>Click the button to pay N10</p>\n <button type=\"button\" onclick=\"OnePipePay()\">Click me!</button>\n <script type=\"text/javascript\">\n function generateUniqueRef() {\n var min = 10000000000000;\n var max = 99999999999999;\n var transRef = (Math.random() * (max - min) + min);\n transRef = Math.round(transRef);\n return transRef.toString(); //var reqRef = transRef + '01';\n }\n\n function OnePipePay() {\n var transRef = generateUniqueRef();\n var handler = OnePipePopup.setup({\n requestData: {\n request_ref: transRef,//generate a unique number\n request_type: 'collect',\n api_key: '7d1IYiOKrm6BvEeMaTzc_bbbb45bf628b40919176ab26f74e5717',//API key from your console\n auth: null,\n transaction: {\n amount: 1000,\n currency: \"NGN\",\n transaction_ref: transRef,//generate a unique number\n transaction_desc: 'Demo payment',\n customer: {\n customer_ref: '12345678800',//how you identify the customer\n firstname: 'Ope',\n surname: 'Adeoye',\n email: 'opeadeoye@gmail.com',\n mobile_no: '2348022454314'\n },\n details:null,\n /*options: {\n default_view : {\n option : 'voucher',\n provider: 'mtn',\n },\n }*/\n },\n \n },\n callback: function (response) {\n \n //let's log the response\n console.log(response);\n \n // Contents of data is based on what OnePipe returns\n let message = (response.message || response.data.message),\n reference = response.reference,\n status = response.status,\n parentTransRef = response.parentTransRef,\n transRef = response.transRef,\n paymentmethod = response.paymentmethod,\n optionsTransRef = response.optionsTransRef,\n data = response.data,\n provider_response_code = data.provider_response_code,\n provider = data.provider,\n charge_status = data.charge_status;\n\n if(data.error){\n error = data.error,\n error_code = error.code,\n error_message = error.message;\n }\n\n\n //lets just see what's passed\n var feedback = '';\n feedback += \"payment method: \" + paymentmethod + \"\\n\";\n feedback += \"message: \" + message + \"\\n\";\n feedback += \"reference: \" + reference + \"\\n\";\n feedback += \"status: \" + status + \"\\n\";\n feedback += \"parentTransRef: \" + parentTransRef + \"\\n\";\n feedback += \"transRef: \" + transRef + \"\\n\";\n\n console.log(feedback);\n alert(feedback);\n },\n onClose: function () {\n alert('You cancelled the payment process');\n }\n });\n\n handler.execute();\n\n }\n </script>\n</body>\n</html>\nThese are additional configurations that gives you the liberty to customize your customer's payment experience in a jiffy. These features are added inside the options object of the JS payload.
This feature gives you the liberty to set the payment option method and provider that should be displayed to your customers whenever the payment popup is shown on your website. See sample integration configuration below.
\ndefault_view : {\n option : 'bank.transfer', // auth_type\n provider: 'CheddaAccount', // Provider\n}\nThe above integration instructs your customer to enter their account number and then process the payment using SunTrust provider.
You can automatically close the payment popup after X number of seconds specified in the configuration payload. See sample integration configuration below.
\nclose_popup: {\n timeout : 5, // in seconds\n status : {\n Successful : [ // Close the popup after a successful bank account, or custom auth_type payment\n 'bank.account', 'custom' // auth_type\n ],\n Failed : [],\n PendingValidation : [ // Close the popup after a PendingValidation on bank.transfer auth_type payment\n 'bank.transfer' // auth_type\n ],\n }\n}\nIn the above sample configuration, whenever a transaction is processed using a bank account or custom payment option (regardless of the provider) and ends as Successful, the payment popup will display the successful response or message for 5 seconds. Then it automatically closes and returns to the merchant site. The same applies to PendingValidation
Click the button to pay N10
\n\t\n\t\n\n\n"}],"_postman_id":"fa441dbf-b814-40c7-b633-4a2c1183b0c9"}],"id":"bac9f39d-888e-450a-a61b-ac978ea8d0bd","description":"If you find the REST APIs too complex, this mechanism is the fastest route to accepting payments on your website via OnePipe.
\nSee it in action here
\n<script src=\"https://js.onepipe.io/v2\"></script> in your page.OnePipePay(). The contents of this function will look like the below:function OnePipePay(){\n var handler = OnePipePopup.setup({\n requestData : {\n request_ref: {{something unique & numeric}},\n request_type : 'collect',\n api_key: '{{your API key}}',\n auth: null,\n transaction: {\n amount: {{amount in kobo}},\n transaction_ref: {{something unique & numeric}},\n transaction_desc: {{A description}},\n customer:{\n customer_ref: {{a customer ID if you have one}},\n firstname: {{first name}},\n surname: {{surname}},\n email: {{email address}},\n mobile_no: {{phone number in 234 format}} \n }\n },\n },\n callback: function(response){\n //response.reference, response.status, response.message, response.paymentmethod\n console.log(response);\n alert('Transaction status: ' + response.status + '. Payment method: ' + response.paymentmethod + '. Ref: ' + response.reference + '. Message: ' + response.message);\n },\n onClose: function(){\n alert('You cancelled the payment process');\n }\n });\n\n handler.execute();\n }\nrequestData, please look at the advanced endpoint $(\"#frmCheckout\").on('submit', function(e){\n e.preventDefault();\n OnePipePay();\n });\ncallback function properly to process your order. The placeholder in the code block above (and extracted below) can serve as boilerplate: callback: function(response){\n console.log(response);//do something more meaningful\n alert('Transaction status: ' + response.status + '. Payment method: ' + response.paymentmethod + '. Ref: ' + response.reference + '. Message: ' + response.message);\n }\nresponse.status then make a call to the query endpoint to validate the true status of the transactionYour callback function will be called with a response object that has the following properties:
\nThis component will be extended in future to suppport/wrap ALL API calls in OnePipe. There's a possiblity of breaking changes (which would be guarded against), but the documentation would be updated.
\n","event":[{"listen":"prerequest","script":{"id":"ebaded27-3cb8-40dc-8faa-4bf63e90698d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"983380fa-c769-4d98-8f05-a60cee1eeea9","type":"text/javascript","exec":[""]}}],"_postman_id":"bac9f39d-888e-450a-a61b-ac978ea8d0bd"},{"name":"WooComerce plugin","item":[],"id":"e238537e-a04d-4e4e-9ee1-5a9990361b02","description":"Several payment processors are an expression of the OnePipe open standard. If your payment gateway is based on the OnePipe open standard and you use WooComerce, then the OnePipe WooComerce plugin is the faster way to accept payments from your WooComerce installation.
\nhttps://wordpress.org/plugins/onepipe-payment-gateway-for-woocommerce
\nhttps://cdn.onepipe.io/plugins/woocoomerce-OnePipe.zip for manual installations
\nTo configure the plugin, go to WooCommerce > Settings from the left hand menu, then click Payments (or Checkout in older versions) from the top tab. You will see OnePipe as part of the available Payments Options. Click on it to configure the payment gateway.
\nhttps://cdn.onepipe.io/plugins/OnePipe-Magento.zip
\nWith OnePipe, it is easy and smooth to use different payments methods in your online store
\n1 - Unzip the module in app/code/Storeplugins/OnePipe\n (create the folder code/Storeplugins if it doesn't exist)
\n2 - On ssh, navigate to your magento installation path.\n e.g: cd public_html/sub_folder_where_magento_is
\n3 - Modify permission: chmod u+x bin/magento
\n4 - Enable module: bin/magento module:enable --clear-static-content Storeplugins_OnePipe
\n5 - Upgrade Database: bin/magento setup:upgrade
\n6 - Re-run Compile Command: bin/magento setup:di:compile
\n7 - Flush caches: bin/magento cache:flush
\n8 - Then, activate the module at: Admin panel > Stores > Settings > Configuration > Sales > Payment Methods > Other Payment Methods
\nIn order to deactivate the module: bin/magento module:disable --clear-static-content Storeplugins_OnePipe
\nIn case you want to disable Magento_Csp: bin/magento module:disable Magento_Csp
\nImportant: make sure that php path is correct in bin/magento file
\nhttps://cdn.onepipe.io/plugins/PrestaShop-OnePipe.zip
\nWith OnePipe, it is easy and smooth to accept different payments method in your online store
\nIn order to deactivate the plugin, delete from the existing modules
\nhttps://cdn.onepipe.io/plugins/OpenCart2.x-OnePipe.zip
\nWith OnePipe, it is easy and smooth to use different payments methods in your online store
\nFrom your admin back-end:
\nIn order to deactivate the plugin, delete the extensions
\nhttps://cdn.onepipe.io/plugins/easy%20digital-onepipe.zip
\nWith OnePipe, it is easy and smooth to use different payments methods in your online store
\nFrom your admin back-end:
\n Click on the \"Upload\" option, then click \"Choose File\" to select the zip file from your computer. Once selected, press \"OK\" and press the \"Install Now\" button.\n Activate the plugin.\nTo configure the plugin, go to Easy Digital Downloads > Settings from the left hand menu, then click Payment Gateways (or Checkout in older versions) from the top tab. You will see OnePipe as part of the available Payments Options. Click on it to configure the payment gateway.
\nIn order to deactivate the plugin, delete the extensions
\nWith this service, the calling app can request or initiate payment from a customer. Apps will collect authorisation details and forward to OnePipe to execute a debit, OnePipe will in turn forward to the provider’s dedicated implementation. Providers will support a wide array of payment methods and optionally prompt for any extra auth details specific to their implementation.
\nPlease be sure to have gone through...
\nsecure elementHere's the call sequence specific to this service...
\n/v2/transactWaitingForOTP or PendingValidation if they require OTP verification/v2/transact/validate to supply OTP if neededSuccessful, Processing or Failed. /v2/transact/queryprovider_response Objectstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validateFor a list of providers that have published and implemented this service, please see here
\nQuestion: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
With this service, the calling apps can do a transfer to a destination account number from a pre-configured account of the app. 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. This is a service that is useful for when a business wants to debit their own account and credit any destination account
\nPlease be sure to have gone through...
\nsecure elementHere's the call sequence specific to this service...
\n/transactWaitingForOTP or PendingValidation if they require OTP verification/transact/validate to supply OTP if neededSuccessful or Failed. /transact/queryprovider_response Objectstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validateFor a list of providers that have published and implemented this service, please see here
\nQuestion: Why do I need to specify transaction.amount when it's irrelevant here?
Answer: OnePipe APIs all try to follow a common standard such that all services require the same exact payload. It's the values within the payload that will then vary, service by service. In this case, just set it to 0.
Question: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
With this service, the calling apps can do a transfer to a destination account number from a given source. Authorisation details (for source of funds) will always be required by the provider, apps will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation. Upon receipt of the auth credentials, a provider may challenge for other input as may be required. Then debit the source of funds to move money to the destination.
\nPlease be sure to have gone through...
\nsecure elementHere's the call sequence specific to this service...
\n/v2/transactWaitingForOTP or PendingValidation if they require OTP verification/v2/transact/validate to supply OTP if neededSuccessful, Processing or Failed. /v2/transact/queryprovider_response Objectstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validateFor a list of providers that have published and implemented this service, please see here
\nQuestion: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
With this service, the calling apps can do a subscription based transaction from a given source to a preconfigured account number (set on the console). Authorisation details (for source of funds) will always be required by the provider, apps will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation. Upon receipt of the auth credentials, a provider may challenge for other input as may be required. Then debit the source of funds to move money to the destination.
\nPlease be sure to have gone through...
\nsecure elementHere's the call sequence specific to this service...
\n/v2/transactSuccessful, Processing or Failed./v2/transact/queryprovider_response ObjectFor a list of providers that have published and implemented this service, please see here
\nQuestion: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
With this, you can KYC a customer's bank verification number.This service unlike LOOKUP BVN MINand LOOKUP BVN MID returns maximum KYC information.
/v2/transactv2/transact/validate to supply OTP if neededSuccessful or Failed.\n*Call /transact/validate to supply OTP if needed/v2/transact/query endpoint.v2/transact/reverse to request a reversalprovider_response ObjectNOTE: Please see information on how to compute the Signature header here
With this service, the calling app can collect a payment and top up a customer’s mobile number with airtime at the same time. Also, it supports the ability to use preconfigured dealer accounts where this is the preference of the provider. Where necessary, apps will collect authorisation details and forward to OnePipe to execute a debit and topup, OnePipe will in turn forward to the provider’s dedicated implementation. Supported auth types vary by provider.
\nPlease be sure to have gone through...
\nsecure elementHere's the call sequence specific to this service...
\n/transact with the right auth details if required. See hereWaitingForOTP or PendingValidation if they require OTP verification/transact/validate to supply OTP if neededSuccessful or Failed. /transact/queryprovider_response Objectstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validateFor a list of providers that have published and implemented this service, please see here
\nQuestion: It looks like I am specifying mobile number in multiple places even though fulfillment_msisdn is the only one that counts. Why is this?
Answer: OnePipe APIs all try to follow a common standard such that all services require the same exact payload. It's the values within the payload that will then vary, service by service. In this case, customer_ref and mobile_no or part of the common standard, while fulfillment_msisdn is what is uniquely used to drive buy airtime
Question: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
With this service, the calling apps can get statements of accounts. Apps will collect 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.
\nPlease be sure to have gone through...
\nsecure elementHere's the call sequence specific to this service...
\n/transact with the right auth details if required. See hereWaitingForOTP or PendingValidation if they require OTP verification/transact/validate to supply OTP if neededSuccessful or Failed. /transact/queryprovider_response Objectstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validateFor a list of providers that have published and implemented this service, please see here
\nQuestion: Why do I need to specify transaction.amountwhen it's irrelevant here?
Answer: OnePipe APIs all try to follow a common standard such that all services require the same exact payload. It's the values within the payload that will then vary, service by service. In this case, just set it to 0.
Question: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
With this service, the calling apps can get available loan offers for a customer. Apps will forward details to OnePipe. Apps will supply the mobile number of the customer it's trying to get the offers for. 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.
\n","urlObject":{"path":["v2","transact","options"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"7e516520-a17b-44f3-9b3e-41056a54c385","name":"Get A Loan - options - WaitingForOTP","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"get_a_loan\",\r\n \"auth\": {\r\n \"type\": null, \r\n \"secure\": null,\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": { }\r\n }\r\n}"},"url":"https://api.onepipe.io/v2/transact/options"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 05 Jul 2020 22:42:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"533"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"WaitingForOTP\",\n \"message\": \"Please enter the OTP sent to 2348022****08, use 12345678 as your OTP\",\n \"data\": {\n \"options\": null,\n \"provider_response_code\": \"900T0\",\n \"provider\": \"Demoprovider\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": null,\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"},{"id":"dc299823-1900-4a96-92e1-37276e1261e1","name":"Get A Loan - options - OptionsDelivered","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"get_a_loan\",\r\n \"auth\": {\r\n \"type\": null, \r\n \"secure\": null,\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": { }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/options"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 05 Jul 2020 22:44:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OptionsDelivered\",\n \"message\": \"Transaction processed successfully\",\n \"data\": {\n \"options\": null,\n \"provider_response_code\": \"00\",\n \"provider\": \"Demoprovider\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"offers\": [\n {\n \"offer_id\": \"offer-019\",\n \"offer_expiry_date\": \"2020-12-09-11-30-12\",\n \"loan_amount\": 1000000,\n \"loan_fees\": 0,\n \"loan_interest_percent\": 15,\n \"loan_interest_amount\": 1500,\n \"loan_due_amount\": 1000000,\n \"loan_due_date\": \"2020-12-09-11-30-12\",\n \"lender_code\": \"Migo\",\n \"lender_product_code\": \"PRODUCT01\",\n \"lender_name\": \"Migo\",\n \"lender_terms\": \"Some content will go here\",\n \"lender_terms_url\": \"https://terms.html\",\n \"extended_data\": {\n \"a_key\": \"a_value\"\n }\n },\n {\n \"offer_id\": \"offer-019\",\n \"offer_expiry_date\": \"2020-12-09-11-30-12\",\n \"loan_amount\": 1000000,\n \"loan_fees\": 0,\n \"loan_interest_percent\": 15,\n \"loan_interest_amount\": 1500,\n \"loan_due_amount\": 1000000,\n \"loan_due_date\": \"2020-12-09-11-30-12\",\n \"lender_code\": \"InstantCash\",\n \"lender_product_code\": \"PRODUCT01\",\n \"lender_name\": \"InstantCash\",\n \"lender_terms\": \"Some content will go here\",\n \"lender_terms_url\": \"https://terms.html\",\n \"extended_data\": {\n \"a_key\": \"a_value\"\n }\n },\n {\n \"offer_id\": \"offer-011\",\n \"offer_expiry_date\": \"2020-12-09-11-30-12\",\n \"loan_amount\": 5000000,\n \"loan_fees\": 0,\n \"loan_interest_percent\": 15,\n \"loan_interest_amount\": 1500,\n \"loan_due_amount\": 5000000,\n \"loan_due_date\": \"2020-12-09-11-30-12\",\n \"lender_code\": \"Ferratum\",\n \"lender_product_code\": \"LOAN01\",\n \"lender_name\": \"Ferratum\",\n \"lender_terms\": \"Some content will go here\",\n \"lender_terms_url\": \"https://terms.html\",\n \"extended_data\": {\n \"a_key\": \"a_value\"\n }\n },\n {\n \"offer_id\": \"offer-022\",\n \"offer_expiry_date\": \"2020-12-09-11-30-12\",\n \"loan_amount\": 1000000,\n \"loan_fees\": 0,\n \"loan_interest_percent\": 15,\n \"loan_interest_amount\": 1500,\n \"loan_due_amount\": 1000000,\n \"loan_due_date\": \"2020-12-09-11-30-12\",\n \"lender_code\": \"Lendaba\",\n \"lender_product_code\": \"LOAN30\",\n \"lender_name\": \"Lendaba\",\n \"lender_terms\": \"Some content will go here\",\n \"lender_terms_url\": \"https://terms.html\",\n \"extended_data\": {\n \"a_key\": \"a_value\"\n }\n },\n {\n \"offer_id\": \"offer-022\",\n \"offer_expiry_date\": \"2020-12-09-11-30-12\",\n \"loan_amount\": 1000000,\n \"loan_fees\": 0,\n \"loan_interest_percent\": 15,\n \"loan_interest_amount\": 1500,\n \"loan_due_amount\": 1000000,\n \"loan_due_date\": \"2020-12-09-11-30-12\",\n \"lender_code\": \"XtraCash\",\n \"lender_product_code\": \"LOAN30\",\n \"lender_name\": \"XtraCash\",\n \"lender_terms\": \"Some content will go here\",\n \"lender_terms_url\": \"https://terms.html\",\n \"extended_data\": {\n \"a_key\": \"a_value\"\n }\n },\n {\n \"offer_id\": \"offer-022\",\n \"offer_expiry_date\": \"2020-12-09-11-30-12\",\n \"loan_amount\": 1000000,\n \"loan_fees\": 0,\n \"loan_interest_percent\": 15,\n \"loan_interest_amount\": 1500,\n \"loan_due_amount\": 1000000,\n \"loan_due_date\": \"2020-12-09-11-30-12\",\n \"lender_code\": \"ILSGeneric\",\n \"lender_product_code\": \"LOAN30\",\n \"lender_name\": \"Quick Teller\",\n \"lender_terms\": \"Some content will go here\",\n \"lender_terms_url\": \"https://terms.html\",\n \"extended_data\": {\n \"a_key\": \"a_value\"\n }\n }\n ],\n \"consent_token\": \"65ggggs$eew\",\n \"consent_token_expiry\": \"2020-12-09-11-30-12\",\n \"reference\": \"8543832380969\",\n \"meta\": {\n \"field_key\": \"field_value\"\n }\n },\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"}],"_postman_id":"3250f9c0-a52c-49df-b62a-9aa4d2b69f65"},{"name":"Get A Loan - transact","id":"9f4b0af1-7953-42d7-9d66-23a11d6c44d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"get_a_loan\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {\r\n \"lender_code\": \"129930093\",\r\n \"lender_product_code\": \"3290039\",\r\n \"lender_offer_id\": \"offer-007\",\r\n \"consent_token\": \"W4236777yxref$12\",\r\n \"destination_account\": \"00001111222\",\r\n \"destination_bank_code\": \"011\"\r\n }\r\n }\r\n}"},"url":"https://api.onepipe.io/v2/transact","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"682c56ad-7786-49ba-921b-d82d495365bb","name":"Get A Loan - transact - Successful","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"get_a_loan\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {\r\n \"lender_code\": \"129930093\",\r\n \"lender_product_code\": \"3290039\",\r\n \"lender_offer_id\": \"offer-007\",\r\n \"consent_token\": \"W4236777yxref$12\",\r\n \"destination_account\": \"00001111222\",\r\n \"destination_bank_code\": \"011\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 05 Jul 2020 22:47:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"571"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Demoprovider\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"transaction_final_amount\": 20000,\n \"reference\": \"5997772321936\",\n \"meta\": {\n \"field_key\": \"field_value\"\n }\n },\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"}],"_postman_id":"9f4b0af1-7953-42d7-9d66-23a11d6c44d3"},{"name":"Get Credit Score","id":"92d35a80-b12b-49f2-a206-ad2649cb51c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"get_credit_score\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": null\r\n }\r\n}"},"url":"https://api.onepipe.io/v2/transact","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"4315e117-c901-4a3a-ba4a-16e0e933b60c","name":"Get Credit Score - WaitingForOTP","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"get_credit_score\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 05 Jul 2020 22:49:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"518"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"WaitingForOTP\",\n \"message\": \"Please enter the OTP sent to 2348022****08, use 12345678 as your OTP\",\n \"data\": {\n \"provider_response_code\": \"900T0\",\n \"provider\": \"Demoprovider\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": null,\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"},{"id":"48be2c13-2efe-443b-883f-6bfb08c32f03","name":"Get Credit Score - Successful","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"get_credit_score\",\r\n \"auth\": {\r\n \"type\": \"bank.account\", \r\n \"secure\": \"s2LsV7Ka2mi6SLbjuDIVmrxANCldBJFxAZ5Y0ckQnXs=\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 05 Jul 2020 22:50:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"621"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Demoprovider\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"loans_score\": 9,\n \"scale_min\": 0,\n \"scale_max\": 10,\n \"offer_amount\": 200000,\n \"confidence\": 90,\n \"reference\": \"4505429583360\",\n \"meta\": {\n \"field_key\": \"field_value\"\n }\n },\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"}],"_postman_id":"92d35a80-b12b-49f2-a206-ad2649cb51c4"},{"name":"Get Loan Status","id":"85047295-7e55-4b92-a6e9-4b71b51b3180","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"get_loan_status\",\r\n \"auth\": {\r\n \"type\": null, \r\n \"secure\": null,\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": null\r\n }\r\n}"},"url":"https://api.onepipe.io/v2/transact","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"e3fff21d-2005-443e-8805-5dee488c5420","name":"Get Loan Status - Successful","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"get_loan_status\",\r\n \"auth\": {\r\n \"type\": null, \r\n \"secure\": null,\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \t\t\"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 05 Jul 2020 22:57:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Demoprovider\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"loans\": [\n {\n \"account_number\": \"00999999000\",\n \"account_name\": \"Ola Waheed\",\n \"bank_name\": \"FBN\",\n \"bank_code\": \"011\",\n \"loan_date\": \"2020-12-09-11-30-12\",\n \"loan_amount\": 1000000,\n \"loan_fees\": 0,\n \"loan_interest_percent\": 15,\n \"loan_interest_amount\": 15,\n \"loan_due_amount\": 1000000,\n \"loan_due_date\": \"2020-12-09-11-30-12\",\n \"lender_code\": \"Migo\",\n \"lender_name\": \"Migo\",\n \"lender_terms\": \"Some content will go here\",\n \"lender_terms_url\": \"https://terms.html\",\n \"extended_data\": {\n \"a_key\": \"a_value\"\n }\n },\n {\n \"account_number\": \"00999999000\",\n \"account_name\": \"Ola Waheed\",\n \"bank_name\": \"FBN\",\n \"bank_code\": \"011\",\n \"loan_date\": \"2020-12-09-11-30-12\",\n \"loan_amount\": 1000000,\n \"loan_fees\": 0,\n \"loan_interest_percent\": 15,\n \"loan_interest_amount\": 15,\n \"loan_due_amount\": 1000000,\n \"loan_due_date\": \"2020-12-09-11-30-12\",\n \"lender_code\": \"ILSGeneric\",\n \"lender_name\": \"Quick Teller\",\n \"lender_terms\": \"Some content will go here\",\n \"lender_terms_url\": \"https://terms.html\",\n \"extended_data\": {\n \"a_key\": \"a_value\"\n }\n },\n {\n \"account_number\": \"00999999000\",\n \"account_name\": \"Ola Waheed\",\n \"bank_name\": \"FBN\",\n \"bank_code\": \"011\",\n \"loan_date\": \"2020-12-09-11-30-12\",\n \"loan_amount\": 1000000,\n \"loan_fees\": 0,\n \"loan_interest_percent\": 15,\n \"loan_interest_amount\": 15,\n \"loan_due_amount\": 1000000,\n \"loan_due_date\": \"2020-12-09-11-30-12\",\n \"lender_code\": \"Ferratum\",\n \"lender_name\": \"Ferratum\",\n \"lender_terms\": \"Some content will go here\",\n \"lender_terms_url\": \"https://terms.html\",\n \"extended_data\": {\n \"a_key\": \"a_value\"\n }\n },\n {\n \"account_number\": \"00999999000\",\n \"account_name\": \"Ola Waheed\",\n \"bank_name\": \"FBN\",\n \"bank_code\": \"011\",\n \"loan_date\": \"2020-12-09-11-30-12\",\n \"loan_amount\": 1000000,\n \"loan_fees\": 0,\n \"loan_interest_percent\": 15,\n \"loan_interest_amount\": 15,\n \"loan_due_amount\": 1000000,\n \"loan_due_date\": \"2020-12-09-11-30-12\",\n \"lender_code\": \"InstantCash\",\n \"lender_name\": \"InstantCash\",\n \"lender_terms\": \"Some content will go here\",\n \"lender_terms_url\": \"https://terms.html\",\n \"extended_data\": {\n \"a_key\": \"a_value\"\n }\n },\n {\n \"account_number\": \"00999999000\",\n \"account_name\": \"Ola Waheed\",\n \"bank_name\": \"FBN\",\n \"bank_code\": \"011\",\n \"loan_date\": \"2020-12-09-11-30-12\",\n \"loan_amount\": 1000000,\n \"loan_fees\": 0,\n \"loan_interest_percent\": 15,\n \"loan_interest_amount\": 15,\n \"loan_due_amount\": 1000000,\n \"loan_due_date\": \"2020-12-09-11-30-12\",\n \"lender_code\": \"XtraCash\",\n \"lender_name\": \"XtraCash\",\n \"lender_terms\": \"Some content will go here\",\n \"lender_terms_url\": \"https://terms.html\",\n \"extended_data\": {\n \"a_key\": \"a_value\"\n }\n },\n {\n \"account_number\": \"00999999000\",\n \"account_name\": \"Ola Waheed\",\n \"bank_name\": \"FBN\",\n \"bank_code\": \"011\",\n \"loan_date\": \"2020-12-09-11-30-12\",\n \"loan_amount\": 1000000,\n \"loan_fees\": 0,\n \"loan_interest_percent\": 15,\n \"loan_interest_amount\": 15,\n \"loan_due_amount\": 1000000,\n \"loan_due_date\": \"2020-12-09-11-30-12\",\n \"lender_code\": \"Lendaba\",\n \"lender_name\": \"Lendaba\",\n \"lender_terms\": \"Some content will go here\",\n \"lender_terms_url\": \"https://terms.html\",\n \"extended_data\": {\n \"a_key\": \"a_value\"\n }\n }\n ],\n \"reference\": \"433236241212\",\n \"meta\": {\n \"field_key\": \"field_value\"\n }\n },\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"}],"_postman_id":"85047295-7e55-4b92-a6e9-4b71b51b3180"},{"name":"Pay4Me - options","id":"1c4b1a2d-974d-47b4-b587-9c4e253a59af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\": \"111111111\",\r\n \"request_type\": \"pay4me\",\r\n \"auth\": {\r\n \"type\": null,\r\n \"secure\": null,\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\",\r\n \"transaction_ref\": \"{{transaction-ref}}\",\r\n \"transaction_desc\": \"A random transaction\",\r\n \"transaction_ref_parent\": null,\r\n \"amount\": 0,\r\n \"customer\": {\r\n \"customer_ref\": \"DemoApp_Customer007\",\r\n \"firstname\": \"Uju\",\r\n \"surname\": \"Usmanu\",\r\n \"email\": \"ujuusmanu@gmail.com\",\r\n \"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\": {\r\n \"order_items\": [\r\n {\r\n \"item_id\": \"101638163628490752\",\r\n \"item_description\": \"A box of noodles\",\r\n \"item_code\": \"RAC01\",\r\n \"item_category\": \"Food\",\r\n \"distributor_name\": \"Olaniyi & Sons\",\r\n \"item_amount\": \"500000\",\r\n \"currency\": \"NGN\",\r\n \"item_meta\": {\r\n \"a_meta_element\": \"***********\"\r\n }\r\n },\r\n {\r\n \"item_id\": \"101638163628490752\",\r\n \"item_description\": \"A box of noodles\",\r\n \"item_code\": \"RAC01\",\r\n \"item_category\": \"Food\",\r\n \"distributor_name\": \"Olaniyi & Sons\",\r\n \"item_amount\": \"500000\",\r\n \"currency\": \"NGN\",\r\n \"item_meta\": {\r\n \"a_meta_element\": \"***********\"\r\n }\r\n }\r\n ],\r\n \"order_history\": [\r\n {\r\n \"order_id\": \"101638163628490752\",\r\n \"order_status\": \"PAID-CASH | PAID-TRANSFER | UNPAID | CASH-DEPOSITED | PAID-PAY4ME\",\r\n \"order_description\": \"A box of noodles\",\r\n \"retailer_id\": \"9090905\",\r\n \"distributor_id\": \"RAC01\",\r\n \"distributor_name\": \"Olaniyi & Sons\",\r\n \"distributor_account_number\": \"0987654321\",\r\n \"distributor_bank_code\": \"038\",\r\n \"amount_due\": \"500000\",\r\n \"fee\": 5000,\r\n \"currency\": \"NGN\",\r\n \"order_rank\": 1,\r\n \"order_meta\": {\r\n \"narration_prefix\": \"000123\",\r\n \"order_timestamp\": \"yyyy-MM-dd-hh-mm-ss\"\r\n }\r\n },\r\n {\r\n \"order_id\": \"101638163628490752\",\r\n \"order_status\": \"PAID-CASH | PAID-TRANSFER | UNPAID | CASH-DEPOSITED | PAID-PAY4ME\",\r\n \"order_description\": \"A box of noodles\",\r\n \"retailer_id\": \"101638163628490752\",\r\n \"distributor_id\": \"RAC01\",\r\n \"distributor_name\": \"Olaniyi & Sons\",\r\n \"distributor_account_number\": \"0987654321\",\r\n \"distributor_bank_code\": \"038\",\r\n \"amount_due\": \"500000\",\r\n \"fee\": 5000,\r\n \"currency\": \"NGN\",\r\n \"order_rank\": 1,\r\n \"order_meta\": {\r\n \"narration_prefix\": \"000124\",\r\n \"order_timestamp\": \"yyyy-MM-dd-hh-mm-ss\"\r\n }\r\n }\r\n ],\r\n \"a_key\": \"a_meta_value_1\",\r\n \"another_key\": \"a_meta_value_2\"\r\n },\r\n \"details\": {\r\n \"order_id\": \"0987654321\",\r\n \"customer_location_state\": \"Lagos\",\r\n \"customer_location_lga\": \"Eti Osa\",\r\n \"customer_location_gps\": \"\",\r\n \"customer_guarantor_id\": \"+448099876543\",\r\n \"app_industry\": \"retail\"\r\n }\r\n }\r\n}"},"url":"https://api.onepipe.io/v2/transact/options","description":"This service can be used to to book a buy now pay later (BNPL) payment for a given customer. A customer is evaluated for eligibility for a particular payment by a provider and and if customer agrees to the terms, the provider will make the payment to the API caller and book the loan (usually with a grace period) against the customer.
\nEvery loan booked in this category will have terms like grace period, service charge, interest, payable amount, tenure, etc.
\nFirst, please be sure to have gone through...
\nsecure elementNow, here's the call sequence specific to this service...
\n/transact/options with the right auth details and details of the payment the customer is about to make. Along with their transaction history with you.WaitingForOTP or PendingValidation if they require OTP verification/transact/validate to supply OTP if neededOptionsDelivered if everything went well. Or responds with Failed otherwise./transact/queryconsent_token/transact (See here) call to accept the offer along with the consent_tokenprovider_response Object/transact/options call/transact call if loan request is approvedstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validatetransaction notification (see various notification types here) for a completed payment, but you can still query the transaction any time[see sample payload]
[see sample payload]
This is the call that follows an original Pay4Me - options call to signal that a customer is willing to accept the terms.
\nSee here.
\nSpecial note 1: The previous call will have given you a consent_token which must be used in this follow up call
Special note 2: The lender will disburse the funds into the account specified in mandate_account_number with the base assumption that you already have a waiting mandate on that account or the account belongs to you and credits to it will trigger an appropriate transaction_notification
First, please be sure to have gone through...
\nsecure elementNow, here's the call sequence specific to this service...
\n/transact with the right auth details and the consent_token from the previous call.Successful or Failed or Processing/transact/querytransaction notification signalling that the transaction is completeprovider_response Objecttransaction notification (see various notification types here) for a completed payment, but you can still query the transaction any time[see sample payload]
[see sample payload]
A set of services with which you can get scores and requests for a loan on behalf of a customer. It covers the Loan Score and the Account Opening Services.
\n","_postman_id":"97868b39-9fc8-49e2-9942-be57f4ed750b"},{"name":"Subcriptions","item":[{"name":"Create Subscription","id":"a1e4cec1-c5ba-44e6-a414-e39dbc15c636","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1","type":"text"},{"key":"Signature","value":"3a2b58350e8068507e6b5bff106850a5","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request_ref\":\"111111111\", \n \"request_type\":\"subscribe\",\n \"auth\": {\n \"type\": \"bank.account\", \n \"secure\": \"O6aPUXSsgOZV+MlTm1LSbnPNLYQU0Q5SiISKEZ9wjt8=\",\n \"auth_provider\": \"Scheduler\"\n },\n \"transaction\": {\n \"mock_mode\": \"live\", \n \"transaction_ref\": \"{{transaction-ref}}\", \n \"transaction_desc\": \"A random scheduled transaction\", \n \"transaction_ref_parent\": null, \n \"amount\": 1000,\n \"customer\":{\n \"customer_ref\": \"2349066870818\",\n \"firstname\": \"Demo\",\n \"surname\": \"Demo\",\n \"email\": \"demo@gmail.com\",\n \"mobile_no\": \"234802343132\"\n },\n \"meta\":{\n \"repeat_frequency\":\"hourly\",\n \"repeat_start\":\"2022-07-30-11-39-00\",\n \"repeat_target_provider\":\"OnePipePOS\"\n },\n \"details\": {\n \n }\n }\n }\n","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/schedule","urlObject":{"path":["v2","transact","schedule"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"5f894ca1-3391-4934-b83d-cccade91b118","name":"Create Subscription","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1","type":"text"},{"key":"Signature","value":"3a2b58350e8068507e6b5bff106850a5","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request_ref\":\"111111111\", \n \"request_type\":\"subscribe\",\n \"auth\": {\n \"type\": \"bank.account\", \n \"secure\": \"nfly3XRLYBO7DjbdrnQq/HxJ0KJYrdeexxfRptqH7bY=\",\n \"auth_provider\": \"Scheduler\"\n },\n \"transaction\": {\n \"mock_mode\": \"live\", \n \"transaction_ref\": \"998383938292\", \n \"transaction_desc\": \"A random scheduled transaction\", \n \"transaction_ref_parent\": null, \n \"amount\": 1000,\n \"customer\":{\n \"customer_ref\": \"DemoApp_Customer007\",\n \"firstname\": \"Demo\",\n \"surname\": \"Demo\",\n \"email\": \"demo@gmail.com\",\n \"mobile_no\": \"234802343132\"\n },\n \"meta\":{\n \"repeat_frequency\":\"hourly\",\n \"repeat_start\":\"2022-07-30-11-25-00\",\n \"repeat_target_provider\":\"FizidoCollect\"\n },\n \"details\": {\n \n }\n }\n }\n","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/schedule"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 30 Jul 2022 10:23:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"465"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Xss-Protection","value":"1; mode=block"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Operation was successful\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Scheduler\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": null,\n \"client_info\": {\n \"name\": null,\n \"id\": null,\n \"bank_cbn_code\": null,\n \"bank_name\": null,\n \"console_url\": null,\n \"js_background_image\": null,\n \"css_url\": null,\n \"logo_url\": null,\n \"footer_text\": null,\n \"show_options_icon\": false,\n \"paginate\": false,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}"}],"_postman_id":"a1e4cec1-c5ba-44e6-a414-e39dbc15c636"},{"name":"Listen for Notification","id":"a2d6c887-f62d-435d-85c3-ca384e7f3d2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"details\": {\n \"data\": {\n \"data\": {\n \"error\": null,\n \"errors\": null,\n \"status\": null,\n \"provider\": \"OnePipePOS\",\n \"reference\": null,\n \"provider_response\": {\n \"meta\": {},\n \"reference\": \"10070458762635schedule1\",\n \"transaction_final_amount\": \"1000\"\n },\n \"provider_response_code\": \"00\"\n },\n \"status\": \"Successful\",\n \"message\": \"Request processed successfully\"\n },\n \"amount\": \"1000\",\n \"status\": \"Successful\",\n \"provider\": \"OnePipePOS\",\n \"customer_ref\": \"DemoApp_Customer007\",\n \"customer_email\": \"demo@gmail.com\",\n \"transaction_ref\": \"10070458762635schedule1\",\n \"customer_surname\": \"Demo\",\n \"transaction_desc\": \"A random scheduled transaction\",\n \"transaction_type\": \"subscribe\",\n \"customer_firstname\": \"Demo\",\n \"customer_mobile_no\": \"234802343132\"\n },\n \"app_info\": {\n \"app_code\": \"CHEC461133\"\n },\n \"mock_mode\": \"Live\",\n \"requester\": \"Scheduler\",\n \"request_ref\": \"751eca3671a54b4aabc086b8cc2e63fd\",\n \"request_type\": \"transaction_notification\"\n}","options":{"raw":{"language":"json"}}},"url":"","urlObject":{"query":[],"variable":[]}},"response":[{"id":"cf16abd0-97fe-43af-8d98-807dbfde186d","name":"Listen for Notification - Successgul","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"details\": {\n \"data\": {\n \"data\": {\n \"error\": null,\n \"errors\": null,\n \"status\": null,\n \"provider\": \"OnePipePOS\",\n \"reference\": null,\n \"provider_response\": {\n \"meta\": {},\n \"reference\": \"10070458762635schedule1\",\n \"transaction_final_amount\": \"1000\"\n },\n \"provider_response_code\": \"00\"\n },\n \"status\": \"Successful\",\n \"message\": \"Request processed successfully\"\n },\n \"amount\": \"1000\",\n \"status\": \"Successful\",\n \"provider\": \"OnePipePOS\",\n \"customer_ref\": \"DemoApp_Customer007\",\n \"customer_email\": \"demo@gmail.com\",\n \"transaction_ref\": \"10070458762635schedule1\",\n \"customer_surname\": \"Demo\",\n \"transaction_desc\": \"A random scheduled transaction\",\n \"transaction_type\": \"subscribe\",\n \"customer_firstname\": \"Demo\",\n \"customer_mobile_no\": \"234802343132\"\n },\n \"app_info\": {\n \"app_code\": \"CHEC461133\"\n },\n \"mock_mode\": \"Live\",\n \"requester\": \"Scheduler\",\n \"request_ref\": \"751eca3671a54b4aabc086b8cc2e63fd\",\n \"request_type\": \"transaction_notification\"\n}","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"de559945-a01b-46b5-8fdb-06f7c5a6017b","name":"Listen for Notification - Failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"details\": {\n \"data\": {\n \"data\": {\n \"error\": null,\n \"errors\": [\n {\n \"Code\": \"96\",\n \"Message\": \"Operation not allowed. KYC requirements incomplete.\"\n }\n ],\n \"status\": null,\n \"provider\": \"OnePipePOS\",\n \"reference\": null,\n \"provider_response\": null,\n \"provider_response_code\": null\n },\n \"status\": \"Failed\",\n \"message\": \"Invalid request body\"\n },\n \"amount\": \"1000\",\n \"status\": \"Failed\",\n \"provider\": \"OnePipePOS\",\n \"customer_ref\": \"DemoApp_Customer007\",\n \"customer_email\": \"demo@gmail.com\",\n \"transaction_ref\": \"998383938292schedule1\",\n \"customer_surname\": \"Demo\",\n \"transaction_desc\": \"A random scheduled transaction\",\n \"transaction_type\": \"subscribe\",\n \"customer_firstname\": \"Demo\",\n \"customer_mobile_no\": \"234802343132\"\n },\n \"app_info\": {\n \"app_code\": \"CHEC461133\"\n },\n \"mock_mode\": \"Live\",\n \"requester\": \"Scheduler\",\n \"request_ref\": \"2dd0cbf84d0c4f09bd888453112cfb3d\",\n \"request_type\": \"transaction_notification\"\n}","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"a2d6c887-f62d-435d-85c3-ca384e7f3d2d"},{"name":"Cancel Subscription","id":"b65d8663-fce1-4026-ad3b-4bc5a8429534","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1","type":"text"},{"key":"Signature","value":"3a2b58350e8068507e6b5bff106850a5","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"111111111\",\n \"request_type\": \"subscribe\",\n \"transaction\": {\n \"transaction_ref\": \"10070458762635\",\n \"transaction_desc\": \"A sample transaction to be reversed\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact/schedule/reverse","urlObject":{"path":["v2","transact","schedule","reverse"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"b65d8663-fce1-4026-ad3b-4bc5a8429534"}],"id":"9775274a-70e7-40fa-a456-27b0b4297e0b","description":"Please read this first.
\n","_postman_id":"9775274a-70e7-40fa-a456-27b0b4297e0b"},{"name":"Others","item":[{"name":"General Services","item":[{"name":"Lookup NUBAN","id":"62d03f00-d313-459b-8394-92d5042d8ba5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_nuban\",\r\n \"auth\": {\r\n \"type\": null,\r\n \"secure\": null,\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {\r\n \t\"account_number\":\"3065570057\"\r\n }\r\n }\r\n}"},"url":"https://api.onepipe.io/v2/transact","description":"This service returns the list of banks an account probably domiciled in.
\n/v2/transactSuccessful or Failedprovider_response ObjectNOTE: Please see information on how to compute the Signature header here
With this, you can get Nigerian Banks and their CBN Bank Codes
\n/v2/transactSuccessful or Failed.provider_response ObjectNOTE: Please see information on how to compute the Signature header here
With this, you can KYC a customer's bank verification number.This service unlike LOOKUP BVN MINand LOOKUP BVN MID returns maximum KYC information.
/v2/transactv2/transact/validate to supply OTP if neededSuccessful or Failed.\n*Call /transact/validate to supply OTP if needed/v2/transact/query endpoint.v2/transact/reverse to request a reversalprovider_response ObjectNOTE: Please see information on how to compute the Signature header here
This is useful for a new wave of payment approaches that businesses are starting to explore:
\nWith this, you'd expose a webhook url, that will receive a POST message from OnePipe upon a credit or debit activity on an account that you have access to.
First, you have to setup your webhook url on the OnePipe console.
\n![\"Setting](\"http://www.onepipe.io/docs/webhook.png\")
Upon receiving the message, please respond with a 200 - OK.
Here is the explanation of the fields you would receive.
\nNOTE: You will also recieve Signature header with which you can authenticate that the call came from OnePipe. Please see information on how the Signature header is computed here
Notifications are useful for a new wave of payment approaches that businesses are starting to explore:
\nWith this, you'd expose a webhook url, that will receive a POST message from OnePipe upon a credit or debit activity on an account that you have access to.
On OnePipe, we have created several solutions like our SImple Payments platform and our Grassroots Banking platform. On these solutions, customers can make payment to you. This notification is used to inform your system that such payments have just been completed so you can take necessary action. You can see this scenario at play here.
\nFor this, you'd expose a webhook url, that will receive a POST message from OnePipe upon a credit or debit activity on an account that you have access to.
First, you have to setup your webhook url on the OnePipe console.
\n
Upon receiving the message, please respond with a 200 - OK.
Here is the explanation of the fields you would receive.
\nNOTE: You will also recieve Signature header with which you can authenticate that the call came from OnePipe. Please see information on how the Signature header is computed here
On OnePipe, we have created several solutions like our SImple Payments platform and our Grassroots Banking platform. On this solutions, customers can make payment to you. In some cases, when such a payment sequence starts OnePipe needs to connect to your system to verify the customer that is making payment and obtain any details necessary for that payment like Name, amount due, bill_id, etc.
\nYou will receive a notification of this type and respond with the necessary information.
\nFirst, you have to setup your webhook url on the OnePipe console.
\n
Upon receiving the message, please respond with the sample payload below:
\n{\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"{{your_app_code}}\", \n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"products\": [\n {\n \"order_reference\": \"101638163628490752\",\n \"biller_item_id\": \"101638163628490752\", \n \"biller_item_code\": \"RAC01\",\n \"biller_item_name\": \"DSTV Premium\",\n \"biller_item_description\": \"This is DSTV Premium that is lovely\",\n \"biller_item_image_url\": \"{{url to an image}}\",\n \"biller_item_prompt\": \"Please neter your smartcard number\",\n \"customer_name\": \"Kola Uju Abubakar Premium\",\n \"biller_item_meta\": {}\n \"amount\": \"500000\",\n \"currency\": \"566\",\n \"terms\": \"{{some HTML content}}\",\n \"terms_url\": \"{{some url}}\"\n },\n {\n \"order_reference\": \"101638163628490752\",\n \"biller_item_id\": \"101638163628490752\",\n \"biller_item_code\": \"RAC01\",\n \"biller_item_name\": \"DSTV Premium\",\n \"biller_item_description\": \"This is DSTV Premium that is lovely\",\n \"biller_item_image_url\": \"{{url to an image}}\",\n \"biller_item_prompt\": \"Please neter your smartcard number\",\n \"customer_name\": \"Kola Uju Abubakar Premium\",\n \"biller_item_meta\": {}\n \"amount\": \"500000\",\n \"currency\": \"566\",\n \"terms\": \"{{some HTML content}}\",\n \"terms_url\": \"{{some url}}\"\n }\n ],\n \"reference\": \"000022200225154318222333334432\",\n \"meta\":{\n \"field_key\":\"field_value\",\n \"field_key\":\"field_value\"\n }\n }\n }\n}\nPlease see here for a full breakown of this specification and the fields.
\nHere is the explanation of the fields you would receive.
\nNOTE: You will also recieve Signature header with which you can authenticate that the call came from OnePipe. Please see information on how the Signature header is computed here
Applications on OnePipe can set a webhook to receive callbacks and notifications from Providers where supported. You'd implement and expose a webhook url, that will receive a POST message from OnePipe whenever an event that you have subscribed to occurs.
First, you have to setup your webhook url on the OnePipe console.
\n\n\nUpon receiving the message, please respond with a 200 - OK.
NOTE: By default, OnePipe creates a webhook for every application that forwards events to the app admin by email. If you do not override this webhook URL, this would be the default implementation.
\n","event":[{"listen":"prerequest","script":{"id":"4e39296f-87ba-49ee-aa86-8b387544f532","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2d42a0f3-3d80-41c8-980d-5d5a3a83b4b1","type":"text/javascript","exec":[""]}}],"_postman_id":"60695d18-6d30-468f-ae5f-edee46d8c017"},{"name":"_Utils","item":[{"name":"Validate OTP","event":[{"listen":"prerequest","script":{"id":"54d575f7-ff3b-465b-8b55-bb4714765988","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"280552a5-ace4-4cda-a1f3-5d6b57fb6163","exec":[""],"type":"text/javascript"}}],"id":"b294a37e-e131-4fd3-931b-7868bec36e34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":" 3a2b58350e8068507e6b5bff106850a5"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"lookup_account_min\",\r\n\t\"auth\": {\r\n \"secure\": \"X90WY3DRBQQehrv9FzvA4hlExLEj3eTW\",\r\n \"auth_provider\": \"DemoProvider\" \r\n },\r\n \"transaction\": {\r\n \"transaction_ref\": \"36846438403442\"\r\n }\r\n}"},"url":"https://api.onepipe.io/v2/transact/validate","description":"With this you can debit a customer's card for a payment and obtain a token for future use if it works.
\n/v2/transactWaitingForOTP. If so, prompt the user for OTP using the message field in the response you gotValidate OTP Service/v2/transact/query to check statusValidate OTP Serviceauth.typeNOTE: Please see information on how to compute the Signature header here
Use this endpoint for querying transactions. Specify the transaction ref of the transaction to be queried in the transaction.transaction_ref field.
Specify the service name in the request_type field.
With this you can debit a customer's card for a payment and obtain a token for future use if it works.
\n/v2/transactWaitingForOTP. If so, prompt the user for OTP using the message field in the response you gotValidate OTP Service/v2/transact/query to check statusValidate OTP Serviceauth.typeNOTE: Please see information on how to compute the Signature header here
These are endpoints that serve a \"utility\" purpose and can be re-used across all services.
\n","event":[{"listen":"prerequest","script":{"id":"e69326a9-c74b-4e0c-bd60-cc03fe078a34","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5a20e0a0-0dc3-43b5-add8-f08420779e8b","type":"text/javascript","exec":[""]}}],"_postman_id":"30e025c8-156f-46fb-96ec-2fc729ee8b0b"},{"name":"_UPCOMING","item":[{"name":"Messaging Services","item":[{"name":"Send OTP","id":"eb61a4c2-cc07-45a8-8632-cb72441103ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer dthEjKlKSL30mNVwbpne_0e1a5973b7a2430bbc6d2f6032ea17f1"},{"key":"Signature","type":"text","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"request_ref\":\"111111111\", \r\n \"request_type\":\"send_otp\",\r\n \"auth\": {\r\n \"type\": \"card\", \r\n \"secure\": \"zmy+k26tJMpjYuFfRUMCcJTAlWQVSKu8Vr9fhbfP1fo9toqiTLdp+UU1Kj7Y0HYAvS36BNL/zux8jFkPHX0vlYBiaqdXXS2E\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"{{transaction-ref}}\", \r\n \"transaction_desc\": \"A random transaction\", \r\n \"transaction_ref_parent\": null, \r\n \"amount\": 0,\r\n \"customer\":{\r\n \t\"customer_ref\": \"DemoApp_Customer007\",\r\n \t\"firstname\": \"Uju\",\r\n \"surname\": \"Usmanu\",\r\n \t\"email\": \"ujuusmanu@gmail.com\",\r\n \t\"mobile_no\": \"234802343132\"\r\n },\r\n \"meta\":{\r\n \t\"a_key\":\"a_meta_value_1\",\r\n \t\"another_key\":\"a_meta_value_2\"\r\n },\r\n \"details\": {\r\n \"type\": \"sms\",\r\n \"app_name\": \"My App\",\r\n \"expiry_mins\": 5 \r\n }\r\n }\r\n}"},"url":"https://api.onepipe.io/v2/transact","description":"With this, you can KYC a customer's bank verification number.This service unlike LOOKUP BVN MINand LOOKUP BVN MID returns maximum KYC information.
/v2/transactv2/transact/validate to supply OTP if neededSuccessful or Failed.\n*Call /transact/validate to supply OTP if needed/v2/transact/query endpoint.v2/transact/reverse to request a reversalprovider_response ObjectNOTE: Please see information on how to compute the Signature header here
With this, you can KYC a customer's bank verification number.This service unlike LOOKUP BVN MINand LOOKUP BVN MID returns maximum KYC information.
/v2/transactv2/transact/validate to supply OTP if neededSuccessful or Failed.\n*Call /transact/validate to supply OTP if needed/v2/transact/query endpoint.v2/transact/reverse to request a reversalprovider_response ObjectNOTE: Please see information on how to compute the Signature header here
With this, you can KYC a customer's bank verification number.This service unlike LOOKUP BVN MINand LOOKUP BVN MID returns maximum KYC information.
/v2/transactv2/transact/validate to supply OTP if neededSuccessful or Failed.\n*Call /transact/validate to supply OTP if needed/v2/transact/query endpoint.v2/transact/reverse to request a reversalprovider_response ObjectNOTE: Please see information on how to compute the Signature header here
With this, you can KYC a customer's bank verification number.This service unlike LOOKUP BVN MINand LOOKUP BVN MID returns maximum KYC information.
/v2/transactv2/transact/validate to supply OTP if neededSuccessful or Failed.\n*Call /transact/validate to supply OTP if needed/v2/transact/query endpoint.v2/transact/reverse to request a reversalprovider_response ObjectNOTE: Please see information on how to compute the Signature header here
With this, you can KYC a customer's bank verification number.This service unlike LOOKUP BVN MINand LOOKUP BVN MID returns maximum KYC information.
/v2/transactv2/transact/validate to supply OTP if neededSuccessful or Failed.\n*Call /transact/validate to supply OTP if needed/v2/transact/query endpoint.v2/transact/reverse to request a reversalprovider_response ObjectNOTE: Please see information on how to compute the Signature header here
With this, you can KYC a customer's bank verification number.This service unlike LOOKUP BVN MINand LOOKUP BVN MID returns maximum KYC information.
/v2/transactv2/transact/validate to supply OTP if neededSuccessful or Failed.\n*Call /transact/validate to supply OTP if needed/v2/transact/query endpoint.v2/transact/reverse to request a reversalprovider_response ObjectNOTE: Please see information on how to compute the Signature header here
With this, you can KYC a customer's bank verification number.This service unlike LOOKUP BVN MINand LOOKUP BVN MID returns maximum KYC information.
/v2/transactv2/transact/validate to supply OTP if neededSuccessful or Failed.\n*Call /transact/validate to supply OTP if needed/v2/transact/query endpoint.v2/transact/reverse to request a reversalprovider_response ObjectNOTE: Please see information on how to compute the Signature header here
With this, you can KYC a customer's bank verification number.This service unlike LOOKUP BVN MINand LOOKUP BVN MID returns maximum KYC information.
/v2/transactv2/transact/validate to supply OTP if neededSuccessful or Failed.\n*Call /transact/validate to supply OTP if needed/v2/transact/query endpoint.v2/transact/reverse to request a reversalprovider_response ObjectNOTE: Please see information on how to compute the Signature header here
NOTE: This service will soon be deprecated in favour of Open Account
\nWith this call, customers can supply their name, phone number and BVN to open a bank account.
\n/v2/transactdata objectdata.provider is the provider that processed the account opening requestdata.provider_response is the response object from the provider(Bank) that processed the account opening requestdata.provider_response.accountReference is the account reference from the bankdata.provider_response.accountName is the name attached to the new accountdata.provider_response.currencyCode is the Currency Code of the accountdata.provider_response.customerEmail is the email attached to the new accountdata.provider_response.accountNumber is the generated account numberdata.provider_response.bankName is the name of the bank which the account was createddata.provider_response.bankCode is the CBN code of the new account created. You can see CBN Codes here.data.provider_response.status is the status of the account created either it's ACTIVE or INACTIVE.data.provider_response.createdOn the day in which the account was createdNOTE: Please see information on how to compute the Signature header here
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.
\nFirst, please be sure to have gone through...
\nsecure elementNow, here's the call sequence specific to this service...
\n/transact with the right auth details. Typically, bvn. See hereWaitingForOTP or PendingValidation if they require OTP verification/transact/validate to supply OTP if neededSuccessful or Failed. /transact/queryprovider_response Objectstatus.message and collect the input from the user, then follow with a /transact/validatestatus.message and collect the input from the user, then follow with a /transact/validateFor a list of providers that have published and implemented this service, please see here
\nQuestion: Why do I need to specify transaction.amountwhen it's irrelevant here?
Answer: OnePipe APIs all try to follow a common standard such that all services require the same exact payload. It's the values within the payload that will then vary, service by service. In this case, just set it to 0.
Question: What is the meta object in the request and response?
Answer: Some providers at times require or return special fields not covered by the standard. If you know what some of these fields and their values are you can set them in the request meta object and read them from the response meta object. Typically though, null is perfectly fine in most cases.
Notifications are useful for a new wave of payment approaches that businesses are starting to explore:
\nWith this, you'd expose a webhook url, that will receive a POST message from OnePipe upon a credit or debit activity on an account that you have access to.
On OnePipe, we have created several solutions like our SImple Payments platform and our Grassroots Banking platform. On these solutions, customers can make payment to you. This notification is used to inform your system that such payments have just been completed so you can take necessary action. You can see this scenario at play here.
\nFor this, you'd expose a webhook url, that will receive a POST message from OnePipe upon a credit or debit activity on an account that you have access to.
First, you have to setup your webhook url on the OnePipe console.
\n
Upon receiving the message, please respond with a 200 - OK.
Here is the explanation of the fields you would receive.
\nNOTE: You will also recieve Signature header with which you can authenticate that the call came from OnePipe. Please see information on how the Signature header is computed here
For a detailed breakdown of all the services published on OnePipe, see below
\nIn the future, as long as a bank has implemented a standard (let's call this standard the Universal Banking Interface), any merchant globally can call the bank's UBI interface directly with the payload below.
{\n \"request_ref\": \"111111111\",\n \"request_type\": \"collect\",\n \"auth\": {\n \"type\": \"bank.account\",\n \"secure\": \"{{TripleDES.encrypt(\"{accountNumber};{bankUBICode}\",secretKey)}}\",\n \"auth_provider\": \"PaywithAccount | {bankProvider} | {bankUBICode}\"\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"{{transaction-ref}}\",\n \"transaction_desc\": \"Checkout #12098 at Koko Below\",\n \"transaction_ref_parent\": null,\n \"amount\": 111,\n \"customer\": {\n \"customer_ref\": \"2349060070818\",\n \"firstname\": \"Akin\",\n \"surname\": \"Olunloye\",\n \"email\": \"akin@kokobelow.io\",\n \"mobile_no\": \"2349066000818\"\n },\n \"meta\": {\n \"transaction_currency\": \"USD\",\n \"transaction_order_ref\": \"0987654321\",\n \"transaction_custom_info\": \"The shoes you ordered on Jan 14th\",\n \"transaction_source\": \"kokobelow.com\",\n \"transaction_callback_url\": \"kokobelow.com/callback?ref=0987654321\",\n \"transaction_source_longitude\": \"123455.09\",\n \"transaction_source_latitude\": \"123455.09\",\n \"customer_name_on_account\": \"Akin Olunloye\",\n \"merchant_business_name\": \"Koko Below Inc.\",\n \"merchant_address_apartment_number\": \"2b\",\n \"merchant_address_building_number\": \"189\",\n \"merchant_address_street\": \"Fenway Street\",\n \"merchant_address_area\": \"Fenway County\",\n \"merchant_address_city\": \"Fenway\",\n \"merchant_address_postcode\": \"100822\",\n \"merchant_address_country_code\": \"USA\",\n \"merchant_business_registration_number\": \"0987654321\",\n \"merchant_contact_email\": \"who@globalmerchant.com\",\n \"merchant_phone_number\": \"+1234543234\"\n },\n \"details\": {}\n }\n}\n\nThe transaction will be processed from the bank's customer's bank account and credited to the merchant's store of value in that bank.
\nThe UBI standard will also require banks to provide a web interface through which merchants can request access to UBI and track all payments they have received into their store of value. Merchants will also be able to request payout from the balances in their store of value to their own bank account in any other bank or country (subject to their host bank's risk rules and pricing).
\nThis would require such merchants to be onboarded by the bank, following whatever processes they define, but the API and workflow would be uniform.
\nFor merchants not willing to go through the hassle of onboarding with every bank of interest, they can onboard on Paywithaccount.com, enable UBI payments and then direct their calls to PaywithAccount's UBI endpoint for onwards routing. This will cost a bit more and has different rules for settlement and risk assessment.
\nThis is the ultimate expression of the original OnePipe vision - as adapted for payments processing. PLEASE NOTE: This is still in concept stage...
\nBanks will get customers' consents for the debit using any method they find suitable. Including, but not limited to:
\nPush notification, so customers' can authorize
\nIVR call, so customers' can authorize
\nOTP, so customers' can authorize
\nInstant authorization without dedicated realtime consent request based on risk parameters or a standing mandate with the customer
\nEtc
\nMerchants will receive a standard OnePipe Successful response if everything went well in realtime.
Merchants will receive a standard OnePipe Failed response if it fails outright.
For everything else in between, e.g. Processing, (because consent request has been sent to the customer of the bank) merchants will listen on their transaction_callback_url for events and next action.
The response merchants receive will include further information like:
\nExpected settlement timelines
\nApplied exchange rates
\nAuthorization method that was used by the customer
\nRisk assessment
\nEtc.
\nOnePipe will partner with banks to help them deploy a UBI implementation with which they can service and acquire customers directly
\nAll banks will have rules, pricing and onboarding processes that may not be the fastest.
\nPaywithAccount is a product of OnePipe that fully expresses the proposition of a2a payments and integrates to UBI endpoints.
\nTherefore, OnePipe will onboard PaywithAccount as a merchant aggregator with every bank that partners with us. Which will result in the following:
\nPaywithAccount will fulfil all their risk assessment parameters
\nMerchants will onboard on PaywithAccount
\nMerchants will send their API calls to PaywithAccount's UBI endpoint for onward routing
\nPaywithAccount will provide merchants with a store of value to show their collection balances
\nMerchants will be able to payout to their own account from PaywithAccount
\n