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\nTo 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
Here are the preliminary steps before you can use PaywithAccount via APIs
\nSign up on PaywithAccount [guide]
\nRequest API access [guide]
\nOnce approved, you will receive 2 emails:
\nThat contains the postman collection
\nAnother with a link to set up your password. After setting your password, log in and retrieve your credentials.
\nAll requests to the API are made through a single base URL:
\nhttps://api.onepipe.io\n\nThere are no separate URLs for sandbox and production. Instead, the environment is controlled by the mock_mode field in the request payload.
mock_mode = inspect → Sandbox Mode
Requests are processed in test mode.
\nYou receive mock responses that simulate the expected behavior of the endpoint.
\nRecommended for development and early-stage integration testing.
\nmock_mode = live → Production Mode
Requests are processed in live mode.
\nYou receive real-time responses based on actual inputs and live transaction flows.
\nUse this mode only after successful sandbox testing.
\nDuring the integration phase, you will be provided with limited access to the mock_mode = live setting.
This allows you to preview real-time responses and perform end-to-end testing of your workflows.
\nAccess is controlled and monitored to ensure stability and compliance.
\nFull unrestricted access to production (mockmode = live) is granted only after your integration is fully tested and approved.
Every API call must include specific headers for authentication, security, and proper request handling. Below is a breakdown of the required headers and their purposes:
\nContent-Type: application/json\n\nInforms the server that the body of the request is in JSON format
\nRequired for all request
\n2. Authorization
\nAuthorization: Bearer {api_key}\n\nThis header contains the API key assign to you
\nIt authenticates the request and confirms that the call is made by an authorized client
\nFormat: Bearer {{your_api_key}}
3. Signature
Signature: {{MD5Hash(request_ref;client_secret)}}\n\nEnsures integrity and security of the request.
\nGenerated using an MD5 hash function
\nTo compute the signature:
\nConcatenate the request_ref (a unique reference for every API call) and your client_secret separated by a semi colon (;).
Apply the MD5 hashing function to the concatenated string.
\nThis hashed value is then sent as the Signature header.
Purpose:
\nTo verify that the request originates from a trusted source.
\nServes as a second layer of security by “signing” the request.
\nExample Header format
Your complete header for evey single call will look like
Content-Type:application/json\nAuthorization:Bearer {{api_key}}\nSignature:{{MD5Hash(request_ref;client_secret)}}\n\nrequest_ref: A unique identifier generated for every API call. No two requests should have the same reference.
\nThe server validates the Signature by regenerating the hash internally and comparing it with the one provided.
If the values do not match, the request will be rejected.
\nEvery API request uses a common payload structure. This ensures consistency across services and reduces integration effort. The payload is divided into standard objects, each serving a specific purpose.
\nThis defines the authentication type and varies depending on the service being called.
\nFor get banks service → the value is null.
For mandate creation → the value is \"bank.account\", because a mandate is being placed on a specific account.
If type has a value, then secure must also have a value.
\nTripleDES.encrypt(\"{account_number};{cbn_bankcode}\", secretKey)\n\nUsing the formula, the full object looks like this:
\n\"type\": \"bank.account\",\n\"secure\": TripleDES.encrypt(\"{account_number};{cbn_bankcode}\", secretKey),\n\"auth_provider\": \"paywithaccount\"\n\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 $source = mb_convert_encoding($encryption_key, 'UTF-16LE', 'UTF-8');\n $key = md5($source, true);\n $key .= substr($key, 0, 8);\n // a 128 bit (16 byte) key\n // append the first 8 bytes onto the end\n //Pad for PKCS7\n $block = mcrypt_get_block_size('tripledes', 'cbc');\n $len = strlen($data);\n $padding = $block - ($len % $block);\n $data .= str_repeat(chr($padding),$padding);\n $iv = \"\\0\\0\\0\\0\\0\\0\\0\\0\";\n $encData = mcrypt_encrypt('tripledes', $key, $data, 'cbc',$iv);\n echo base64_encode($encData);\n}\n\nconst crypto = require('crypto');\nfunction encrypt(sharedKey, plainText) {\n const bufferedKey = Buffer.from(sharedKey, '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\nCustomer Object
\nThe customer object stores information to uniquely identify and contact the customer. Fields are optional depending on the service being called. If not required, they can be left as empty strings (\"\")
The meta object is optional and can contain extra contextual information for the transaction depending on the service.
Details Object
\nThe details object can contain additional information relevant to the transaction.
It can be empty ({}) if no extra details are needed.
Doc W.I.P.
Check ACtive Mandate (Get Account Max)
\nThis service checks whether a customer has any active mandates linked to their customer_ref.
The customer_ref is the key identifier used for lookup.
It is always advised to be the customer’s 13-digit phone number starting with 234 (e.g., 2348022221412).
Other customer fields (firstname, surname, email, mobile_no) are optional for this service. They may be provided, but can also be left as empty strings (\"\").
Since this service does not involve payments, the amount field is set to 0.
Send Invoice PWT
\nThe Send Invoice service generates a virtual account for a single payment collection. This account can then be shared with the customer for settlement.
\nThe type and secure fields in the auth object are set to null since this service allows transfers from any bank.
Other customer fields (firstname, surname) are optional for this service. They may be provided, but can also be left as empty strings (\"\")
The meta.type field must be \"single_payment\", which indicates this is a one-time virtual account.
An expires_in value must be specified (in minutes) to determine how long the virtual account remains active.
The skip_messaging field is a boolean that controls whether the system sends payment details to the customer via WhatsApp, email, or SMS:
false → Notifications will be sent.
true → No notifications will be sent.
Send Invoice (Installment Payment)
\ntype: \"bank.account\" → specifies that the payment is tied to a specific customer bank account.
secure: contains the encrypted account details (e.g., {account_number};{cbn_bankcode} encrypted with TripleDES and your secret key)
auth_provider: \"PaywithAccount\".
Transaction Object
\namount: the total amount to be collected across the instalments. Must be in kobo (e.g., 30000 = ₦300).
transaction_ref: unique reference for this collection.
\ntransaction_desc: description of the payment (free text).
\ncustomer_ref: the 13-digit customer phone number starting with 234.
firstname, surname, email, mobile_no → optional; they can be populated or left as empty strings.
\ntype: \"instalment\" → instructs the system this is an instalment-based payment.
down_payment: upfront amount to be collected immediately (in kobo).
\nrepeat_frequency: how often subsequent payments occur (daily, weekly, monthly).
repeat_start_date: the date and time when instalment deductions begin. Must follow the format: yyyy-MM-dd-hh-mm-ss.
number_of_payments: total number of instalment payments (excluding the down payment).
\nbiller_code: mandatory; identifies the biller on whose behalf the collection is being made.
\nWhen this request is made, the API responds with a virtual account where the customer must pay the down payment.
\nThe transfer for the down payment must come from the same bank account linked in the secure field. If payment is made from another account, it will be disputed.
Once the down payment is settled, all subsequent instalments are debited automatically from the customer’s mandate-linked account, based on the schedule (repeat_frequency and repeat_start_date).
Send Invoice (subscription payment)
\ntype: \"bank.account\" → ties the subscription to a specific customer bank account.
secure: contains the encrypted account details (e.g., {account_number};{cbn_bankcode} encrypted with TripleDES and your secret key)
auth_provider: \"PaywithAccount\".
amount: the recurring amount to be debited at each cycle. Must be in kobo (e.g., 10500 = ₦105).
transaction_ref: unique reference for this subscription request.
\ntransaction_desc: description of the subscription (free text).
\ncustomer_ref: must always be the 13-digit phone number starting with 234.
firstname, surname, email, mobile_no: optional; they can be populated or left as empty strings.
\nDefines the subscription plan:
\ntype: \"subscription\" indicates this request is setting up a recurring debit.
repeat_frequency: how often the debit should occur (daily, weekly, monthly).
repeat_start_date: the date and time when the subscription debits should begin. Format: yyyy-MM-dd-hh-mm-ss.
repeat_end_date: the date and time when the subscription should automatically stop. Format: yyyy-MM-dd-hh-mm-ss.
biller_code: mandatory; identifies the biller on whose behalf the subscription is being set up.
\nSubscription Flow
\nRequest Initiation
\nWhen you send a subscription request, the response you receive depends on the activation method agreed with the business (either first payment or transfer).
\nThis first action serves as customer consent to allow recurring debits on their account.
\nFirst Payment (Virtual Account Route)
\nEvery time a new subscription is initiated, a virtual account is generated.
\nThe customer is required to make a transfer to this account for the first billing cycle (e.g., paying for the first month of a subscription).
\nOnce this payment is received, the subscription becomes active.
\nSubsequent debits will then occur automatically from the customer’s linked account, according to the start date, end date, and repeat frequency defined in the request.
\nTransfer (Activation URL Route)
\nAlternatively, the response will include an activation_url.
You can either:
\nDisplay the content of the URL directly in your own platform (skipping external messaging), or
\nSend the URL to the customer via SMS, WhatsApp, or any other channel.
\nThe customer follows the instructions and gives consent by sending a transfer (via NIBSS).
\nOnce the transfer is completed and confirmed, the subscription is activated.
\nFuture recurring debits then proceed automatically from the authorized account.
\nSubsequent Debits
\nAfter activation (via first payment or transfer), the system handles debits automatically:
\nBased on the repeat_frequency (daily, weekly, monthly, etc.).
Continuing until the repeat_end_date or when the subscription is cancelled.
Check Active Mandate On An Account(Get Account Max)
\nThis service allows you to verify if a customer already has an active mandate on a specific account. The account details are the same ones encrypted into the secure field of the auth object.
type: \"bank.account\" → indicates the mandate check is being done against a bank account.
secure: encrypted account details (token or account identifier tied to mandate).
auth_provider: \"PaywithAccount\".
amount: 0 → since this is only a mandate verification, no debit occurs.
Create Mandate
\nThe Create Mandate endpoint is used to tokenize a customer’s account so you can directly debit it.
\nThis is an account-to-account mandate managed by the bank. Once a mandate is successfully created, it takes up to 24 hours to become active.
\nStartFragment
\ntype: \"bank.account\" → specifies that the mandate is being set up on a bank account.
secure: contains the encrypted account details
auth_provider: \"PaywithAccount\".
transaction_desc: \"Creating a mandate\".
amount: 0 → no funds are moved during mandate creation.
customer:
customer_ref: must be the customer’s 13-digit phone number (e.g., 2348022221412).
firstname, surname, email, mobile_no: should be filled in.
amount: Maximum single debit limit allowed on the customer’s account for this mandate.
skip_consent:
falsebvn: Customer’s BVN encrypted with TripleDES.
biller_code: Your biller code.
customer_consent: This will be communicated based on you integration settings
When this request is made, the system verifies:
\nAccount details (from secure).
BVN (must match account details).
\nPhone number (customer_ref) against the primary number linked to the customer’s NIN.
Name matching:
\nFirst, the system checks if the account name matches the BVN name → contributes 50% score.
\nThen it cross-checks the phone number linked to NIN .
\nThe minimum required score is 50% to create a mandate.If the score falls below 50%, the mandate creation request fails with an error.
\nThe response contains an activation URL. You can:
\nDisplay the content of the URL directly on your platform, or
\nLet PaywithAccount deliver it via WhatsApp, Email, or SMS (depending on your integration settings).
\nIf skip messaging is enabled, you are responsible for presenting the URL to the customer.
\nAccept Account for Tokenization
\nThe customer sees the account details that will be tokenized.
\nClicking Continue confirms their acceptance.
\nCreate / Input PIN
\nTransfer to NIBSS Virtual Account
\nA NIBSS-controlled virtual account is displayed.
\nThe customer must transfer funds from the same account being tokenized.
\nThis transfer does not go to your business. Instead, it acts as a consent signal to NIBSS to confirm mandate creation.
\nCollect (Direct Debit)
\nThis service is used to initiate a single payment debit from a customer’s bank account. This method requires the payer’s account details to be provided explicitly.
For this request to succeed, the customer must already have an active mandate on their account. In other words, their account had to be tokenized beforehand. Without a valid mandate, the debit attempt will fail.
Auth Object
\ntype: \"bank.account\" → specifies that the debit is being done on a bank account.
secure: contains the encrypted token (linked to the customer’s account) that was created when the mandate was set up. This token is what authorizes the debit.
\nauth_provider: \"PaywithAccount\".
Amount: the amount to be debited from the customer’s account.
\nMeta Object
\nbiller_code → identifies the biller on whose behalf the debit is being made.
\nThis request is not an instruction for the customer to initiate payment. Instead, the debit is initiated directly on the customer’s tokenized account.
\nThe secure field is critical, as it ensures the debit is tied to the correct customer mandate.
\nThis endpoint allows you to initiate a transaction for creating a new merchant.
\nrequest_ref (string): A unique reference for the request.
request_type (string): Indicates the type of request, in this case, \"create merchant\".
auth (object): Authentication details including the provider and security settings.
auth_provider (string): The authentication provider, e.g., \"PaywithAccount\".transaction (object): Details of the transaction.
mock_mode (string): The mode for mocking the transaction, e.g., \"Inspect\".
transaction_ref (string): Reference for the transaction.
transaction_desc (string): Description of the transaction.
amount (number): The transaction amount.
customer (object): Details of the customer initiating the transaction.
customer_ref (string): Reference for the customer.
firstname (string): Customer's first name.
surname (string): Customer's surname.
email (string): Customer's email address.
mobile_no (string): Customer's mobile number.
meta (object): Additional meta information for the transaction.
beta (string): Indicates if beta features are enabled.
biller_sector (string): Sector of the biller.
simple_payment (string): Indicates if simple payment is enabled.
webhook_url (string): URL for webhook notifications.
whatsapp_contact_name (string): Name of the WhatsApp contact.
whatsapp_contact_no (string): WhatsApp contact number.
business_short_name (string): Short name of the business.
details (object): Details related to the business.
business_name (string): Name of the business.
rc_number (string): Registration number of the business.
settlement_account_no (string): Account number for settlement.
settlement_bank_code (string): Bank code for settlement.
tax_id (string): Tax identification number.
address_line_1 (string): Address line 1 for the business.
notification_phone (string): Notification phone numbers.
notification_email (string): Notification email addresses.
options (null): Additional options for the transaction.
The response for this request is a JSON object with the following schema:
\n{\n \"status\": \"\",\n \"message\": \"\",\n \"data\": {\n \"provider_response_code\": \"\",\n \"provider\": \"\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\": 0,\n \"account_number\": \"\",\n \"contract_code\": null,\n \"account_reference\": \"\",\n \"account_name\": \"\",\n \"currency_code\": \"\",\n \"customer_email\": \"\",\n \"bank_name\": null,\n \"bank_code\": null,\n \"account_type\": null,\n \"status\": \"\",\n \"created_on\": \"\",\n \"meta\": {\n \"biller_code\": \"\"\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\": true,\n \"paginate\": true,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}\n\nThe response includes various fields such as status, message, data, provider_response_code, provider, and client_info.
Update Merchant
\nThe Update Merchant endpoint is used to update a merchant’s profile or configuration details.
\nThe customer_ref and email in the customer object are required.
All other fields (both in customer and meta) are optional.
Only include the fields you want to update in the request.
\ntransaction_desc: \"Update merchant information\".
amount: always 0 (no funds are moved).
Customer Object
\ncustomer_ref → required. Must be the merchant’s registered customer reference (13-digit phone number).
email → required. Merchant’s email address.
firstname, surname, mobile_no → optional;
Meta Object
\nHolds the fields you want to update. All fields are optional. Common examples:
\nstatus: \"active\" or \"inactive\".
biller_name: Merchant’s display or business name.
webhook_url: URL to receive transaction notifications.
notification_phone_number: Comma-separated list of phone numbers for alerts.
notification_email: Email address for notifications.
Lookup Merchant
\nThe Lookup Merchant endpoint is used to check if a merchant already exists on the platform.
The unique identifier for lookup is passed in the customer_ref field, which is the biller code assigned to the merchant when created, or the email address, which is unique per merchant
transaction_desc → \"Get merchant details\".
amount → always 0 (no monetary value is involved).
Customer Object
\ncustomer_ref → required (biller code or email).
Other fields (firstname, surname, email, mobile_no) → optional and not used for this check (should be null or empty).
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 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":"0b489e55-4179-46b3-b772-7c52351dea5b","name":"Lookup Account Min - Successful","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer hSk84fnb2GeOVZ4JbUcu_ca608e4d33b2408e90b3a97157b581d7"},{"key":"Signature","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","value":"application/json"}],"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\": \"{{auth.bank.account}}\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"inspect\", \r\n \"transaction_ref\": \"998383938292\", \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\": \"{{customer_id}}\",\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":"7b24b8c7-2225-455a-b04a-aafb3b33c1f0","name":"Lookup Account Min - Failed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer hSk84fnb2GeOVZ4JbUcu_ca608e4d33b2408e90b3a97157b581d7"},{"key":"Signature","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","value":"application/json"}],"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\": \"{{auth.bank.account}}\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"live\", \r\n \"transaction_ref\": \"998383938292\", \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\": \"{{customer_id}}\",\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":"0b640d91-ae70-4415-9f6d-5acf24bd0570","name":"Lookup Account Min - WaitingForOTP","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer hSk84fnb2GeOVZ4JbUcu_ca608e4d33b2408e90b3a97157b581d7"},{"key":"Signature","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","value":"application/json"}],"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\": \"{{auth.bank.account}}\",\r\n \"auth_provider\": \"Demoprovider\",\r\n \"route_mode\": null\r\n },\r\n \"transaction\": {\r\n \"mock_mode\": \"inspect\", \r\n \"transaction_ref\": \"998383938292\", \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\": \"{{customer_id}}\",\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":"781ee01a-64e0-4cfd-be5c-f2d81cb5e6aa"},{"name":"5.1 Send SMS","id":"c4e69f7e-762c-4553-a27d-42400718e4d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer hSk84fnb2GeOVZ4JbUcu_ca608e4d33b2408e90b3a97157b581d7"},{"key":"Signature","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"111111111\",\n \"request_type\": \"send sms\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"PaywithAccount\"\n },\n \"transaction\": {\n \"mock_mode\": \"Inspect\",\n \"transaction_ref\": \"998383938292\",\n \"transaction_desc\": \"Send SMS\",\n \"transaction_ref_parent\": null,\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"Koko\",\n \"surname\": \"Below\",\n \"email\": \"kokobelow@gmail.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"meta\": {\n \"biller_code\": \"000019\"\n },\n \"details\": {\n \"message_body\": \"Dear OYAWOYE ABIOLA OLUKAYODE,\\nThis is a reminder that you are about to make a payment of 119000 to OnePipe Employees Loan from your account based on a previous mandate.\",\n \"message_title\": \"Subscription Debit Reminder\",\n \"sender_id\": \"PWT\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"832a34d9-9c32-4073-91e6-a81f3df4e482","name":"Send SMS","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer hSk84fnb2GeOVZ4JbUcu_ca608e4d33b2408e90b3a97157b581d7"},{"key":"Signature","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"111111111\",\n \"request_type\": \"send sms\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"PaywithAccount\"\n },\n \"transaction\": {\n \"mock_mode\": \"Inspect\",\n \"transaction_ref\": \"998383938292\",\n \"transaction_desc\": \"Send SMS\",\n \"transaction_ref_parent\": null,\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"Koko\",\n \"surname\": \"Below\",\n \"email\": \"kokobelow@gmail.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"meta\": {\n \"biller_code\": \"000019\"\n },\n \"details\": {\n \"message_body\": \"Dear OYAWOYE ABIOLA OLUKAYODE,\\nThis is a reminder that you are about to make a payment of 119000 to OnePipe Employees Loan from your account based on a previous mandate.\",\n \"message_title\": \"Subscription Debit Reminder\",\n \"sender_id\": \"PWT\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Message delivered successfully!\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"PaywithAccount\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\": \"DD-SUB-pTksB9I4EccwYEC_rmdschedule4-SMS\",\n \"delivery_status\": \"delivered\",\n \"cost\": null,\n \"meta\": {}\n },\n \"client_info\": null\n }\n}"}],"_postman_id":"c4e69f7e-762c-4553-a27d-42400718e4d2"},{"name":"6.1 Create Support Ticket","id":"2d2805f1-5fc5-4f54-9779-d51bbe6dd598","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer hSk84fnb2GeOVZ4JbUcu_ca608e4d33b2408e90b3a97157b581d7"},{"key":"Signature","value":"3a2b58350e8068507e6b5bff106850a5"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"111111111\",\n \"request_type\": \"create ticket\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"PaywithAccount\"\n },\n \"transaction\": {\n \"mock_mode\": \"Inspect\",\n \"transaction_ref\": \"998383938292\",\n \"transaction_desc\": \"Send Support Ticket\",\n \"transaction_ref_parent\": null,\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"Koko\",\n \"surname\": \"Below\",\n \"email\": \"kokobelow@gmail.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"meta\": {\n \"biller_code\": \"000019\",\n \"reciepient\": \"help@paywithaccount.com\"\n },\n \"details\": {\n \"message_body\": \"Dear OYAWOYE ABIOLA OLUKAYODE,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, 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 endpoint allows you to initiate a transaction for creating a new merchant.
\nrequest_ref (string): A unique reference for the request.
request_type (string): Indicates the type of request, in this case, \"create merchant\".
auth (object): Authentication details including the provider and security settings.
auth_provider (string): The authentication provider, e.g., \"PaywithAccount\".transaction (object): Details of the transaction.
mock_mode (string): The mode for mocking the transaction, e.g., \"Inspect\".
transaction_ref (string): Reference for the transaction.
transaction_desc (string): Description of the transaction.
amount (number): The transaction amount.
customer (object): Details of the customer initiating the transaction.
customer_ref (string): Reference for the customer.
firstname (string): Customer's first name.
surname (string): Customer's surname.
email (string): Customer's email address.
mobile_no (string): Customer's mobile number.
meta (object): Additional meta information for the transaction.
beta (string): Indicates if beta features are enabled.
biller_sector (string): Sector of the biller.
simple_payment (string): Indicates if simple payment is enabled.
webhook_url (string): URL for webhook notifications.
whatsapp_contact_name (string): Name of the WhatsApp contact.
whatsapp_contact_no (string): WhatsApp contact number.
business_short_name (string): Short name of the business.
details (object): Details related to the business.
business_name (string): Name of the business.
rc_number (string): Registration number of the business.
settlement_account_no (string): Account number for settlement.
settlement_bank_code (string): Bank code for settlement.
tax_id (string): Tax identification number.
address_line_1 (string): Address line 1 for the business.
notification_phone (string): Notification phone numbers.
notification_email (string): Notification email addresses.
options (null): Additional options for the transaction.
The response for this request is a JSON object with the following schema:
\n{\n \"status\": \"\",\n \"message\": \"\",\n \"data\": {\n \"provider_response_code\": \"\",\n \"provider\": \"\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\": 0,\n \"account_number\": \"\",\n \"contract_code\": null,\n \"account_reference\": \"\",\n \"account_name\": \"\",\n \"currency_code\": \"\",\n \"customer_email\": \"\",\n \"bank_name\": null,\n \"bank_code\": null,\n \"account_type\": null,\n \"status\": \"\",\n \"created_on\": \"\",\n \"meta\": {\n \"biller_code\": \"\"\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\": true,\n \"paginate\": true,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}\n\nThe response includes various fields such as status, message, data, provider_response_code, provider, and client_info.
This endpoint allows you to initiate a transaction for creating a new merchant.
\nrequest_ref (string): A unique reference for the request.
request_type (string): Indicates the type of request, in this case, \"create merchant\".
auth (object): Authentication details including the provider and security settings.
auth_provider (string): The authentication provider, e.g., \"PaywithAccount\".transaction (object): Details of the transaction.
mock_mode (string): The mode for mocking the transaction, e.g., \"Inspect\".
transaction_ref (string): Reference for the transaction.
transaction_desc (string): Description of the transaction.
amount (number): The transaction amount.
customer (object): Details of the customer initiating the transaction.
customer_ref (string): Reference for the customer.
firstname (string): Customer's first name.
surname (string): Customer's surname.
email (string): Customer's email address.
mobile_no (string): Customer's mobile number.
meta (object): Additional meta information for the transaction.
beta (string): Indicates if beta features are enabled.
biller_sector (string): Sector of the biller.
simple_payment (string): Indicates if simple payment is enabled.
webhook_url (string): URL for webhook notifications.
whatsapp_contact_name (string): Name of the WhatsApp contact.
whatsapp_contact_no (string): WhatsApp contact number.
business_short_name (string): Short name of the business.
details (object): Details related to the business.
business_name (string): Name of the business.
rc_number (string): Registration number of the business.
settlement_account_no (string): Account number for settlement.
settlement_bank_code (string): Bank code for settlement.
tax_id (string): Tax identification number.
address_line_1 (string): Address line 1 for the business.
notification_phone (string): Notification phone numbers.
notification_email (string): Notification email addresses.
options (null): Additional options for the transaction.
The response for this request is a JSON object with the following schema:
\n{\n \"status\": \"\",\n \"message\": \"\",\n \"data\": {\n \"provider_response_code\": \"\",\n \"provider\": \"\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\": 0,\n \"account_number\": \"\",\n \"contract_code\": null,\n \"account_reference\": \"\",\n \"account_name\": \"\",\n \"currency_code\": \"\",\n \"customer_email\": \"\",\n \"bank_name\": null,\n \"bank_code\": null,\n \"account_type\": null,\n \"status\": \"\",\n \"created_on\": \"\",\n \"meta\": {\n \"biller_code\": \"\"\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\": true,\n \"paginate\": true,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}\n\nThe response includes various fields such as status, message, data, provider_response_code, provider, and client_info.
This endpoint allows you to initiate a transaction for creating a new merchant.
\nrequest_ref (string): A unique reference for the request.
request_type (string): Indicates the type of request, in this case, \"create merchant\".
auth (object): Authentication details including the provider and security settings.
auth_provider (string): The authentication provider, e.g., \"PaywithAccount\".transaction (object): Details of the transaction.
mock_mode (string): The mode for mocking the transaction, e.g., \"Inspect\".
transaction_ref (string): Reference for the transaction.
transaction_desc (string): Description of the transaction.
amount (number): The transaction amount.
customer (object): Details of the customer initiating the transaction.
customer_ref (string): Reference for the customer.
firstname (string): Customer's first name.
surname (string): Customer's surname.
email (string): Customer's email address.
mobile_no (string): Customer's mobile number.
meta (object): Additional meta information for the transaction.
beta (string): Indicates if beta features are enabled.
biller_sector (string): Sector of the biller.
simple_payment (string): Indicates if simple payment is enabled.
webhook_url (string): URL for webhook notifications.
whatsapp_contact_name (string): Name of the WhatsApp contact.
whatsapp_contact_no (string): WhatsApp contact number.
business_short_name (string): Short name of the business.
details (object): Details related to the business.
business_name (string): Name of the business.
rc_number (string): Registration number of the business.
settlement_account_no (string): Account number for settlement.
settlement_bank_code (string): Bank code for settlement.
tax_id (string): Tax identification number.
address_line_1 (string): Address line 1 for the business.
notification_phone (string): Notification phone numbers.
notification_email (string): Notification email addresses.
options (null): Additional options for the transaction.
The response for this request is a JSON object with the following schema:
\n{\n \"status\": \"\",\n \"message\": \"\",\n \"data\": {\n \"provider_response_code\": \"\",\n \"provider\": \"\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\": 0,\n \"account_number\": \"\",\n \"contract_code\": null,\n \"account_reference\": \"\",\n \"account_name\": \"\",\n \"currency_code\": \"\",\n \"customer_email\": \"\",\n \"bank_name\": null,\n \"bank_code\": null,\n \"account_type\": null,\n \"status\": \"\",\n \"created_on\": \"\",\n \"meta\": {\n \"biller_code\": \"\"\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\": true,\n \"paginate\": true,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}\n\nThe response includes various fields such as status, message, data, provider_response_code, provider, and client_info.
This endpoint allows you to initiate a transaction for creating a new merchant.
\nrequest_ref (string): A unique reference for the request.
request_type (string): Indicates the type of request, in this case, \"create merchant\".
auth (object): Authentication details including the provider and security settings.
auth_provider (string): The authentication provider, e.g., \"PaywithAccount\".transaction (object): Details of the transaction.
mock_mode (string): The mode for mocking the transaction, e.g., \"Inspect\".
transaction_ref (string): Reference for the transaction.
transaction_desc (string): Description of the transaction.
amount (number): The transaction amount.
customer (object): Details of the customer initiating the transaction.
customer_ref (string): Reference for the customer.
firstname (string): Customer's first name.
surname (string): Customer's surname.
email (string): Customer's email address.
mobile_no (string): Customer's mobile number.
meta (object): Additional meta information for the transaction.
beta (string): Indicates if beta features are enabled.
biller_sector (string): Sector of the biller.
simple_payment (string): Indicates if simple payment is enabled.
webhook_url (string): URL for webhook notifications.
whatsapp_contact_name (string): Name of the WhatsApp contact.
whatsapp_contact_no (string): WhatsApp contact number.
business_short_name (string): Short name of the business.
details (object): Details related to the business.
business_name (string): Name of the business.
rc_number (string): Registration number of the business.
settlement_account_no (string): Account number for settlement.
settlement_bank_code (string): Bank code for settlement.
tax_id (string): Tax identification number.
address_line_1 (string): Address line 1 for the business.
notification_phone (string): Notification phone numbers.
notification_email (string): Notification email addresses.
options (null): Additional options for the transaction.
The response for this request is a JSON object with the following schema:
\n{\n \"status\": \"\",\n \"message\": \"\",\n \"data\": {\n \"provider_response_code\": \"\",\n \"provider\": \"\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\": 0,\n \"account_number\": \"\",\n \"contract_code\": null,\n \"account_reference\": \"\",\n \"account_name\": \"\",\n \"currency_code\": \"\",\n \"customer_email\": \"\",\n \"bank_name\": null,\n \"bank_code\": null,\n \"account_type\": null,\n \"status\": \"\",\n \"created_on\": \"\",\n \"meta\": {\n \"biller_code\": \"\"\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\": true,\n \"paginate\": true,\n \"paginate_count\": 0,\n \"options\": null,\n \"merchant\": null,\n \"colors\": null,\n \"meta\": null\n }\n }\n}\n\nThe response includes various fields such as status, message, data, provider_response_code, provider, and client_info.
Accepts customer's data to onboard customer on PayWithAccount. This onboard process makes use of NIN.
\n","urlObject":{"path":["pay4me","onboard"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"fb263edf-3654-4bac-a4f0-96ebe1be4258","name":"Onboard","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"DiYgSAxsBGD4okA\",\n \"request_type\": \"onboard\",\n \"auth\": {\n \"type\": \"nin\",\n \"secure\": \"12345678901\", //secured nin\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"PWA-ONB-HaEVwUfAT0UpSjD\",\n \"transaction_desc\": \"PayWithAccount Onboard\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"12345678\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"12345678\"\n },\n \"details\": {\n \"name_on_account\": \"John Does\",\n \"middlename\": \"\",\n \"dob\": \"01-01-2025\",\n \"gender\": \"Male\",\n \"title\": \"Mr\",\n \"address_line_1\": \"Address link 1\",\n \"address_line_2\": \"\",\n \"city\": \"Ikeja\",\n \"state\": \"Lagos\",\n \"country\": \"Nigeria\"\n },\n \"meta\": {\n \"channel\": \"mobile-app|schedule|ussd\", // how the onboard was initiated\n \"photo\": \"\",\n \"phone_numbers\": \"\", // phone number in csvs\n \"account_number\": \"12232323223\",\n \"account_name\": \"John Doe\",\n \"bank_code\": \"002\",\n\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/onboard"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"PendingValidation\",\n \"message\": \"Transaction is currently being reviewed.\",\n \"data\": {\n \"provider_response_code\": \"01\",\n \"provider\": \"Pay4Me\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\": \"PWA-ONB-1323399596\",\n \"meta\": {\n \"uuid\": \"4c656776-6914-4252-912a-9adbfedea3aa\"\n }\n },\n \"client_info\": null\n }\n}"},{"id":"1ce54341-af3f-4f18-80b6-6cc53341fb09","name":"Onboard Approved","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"4scpzIpaDsUgNFv\",\n \"request_type\": \"onboard\",\n \"auth\": {\n \"type\": \"nin\",\n \"secure\": \"{{nin}}\", //secured nin\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"PWA-ONB-0Jiii5igx3qkoq7\",\n \"transaction_desc\": \"PayWithAccount Onboard\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"details\": {\n \"name_on_account\": \"John Does\",\n \"middlename\": \"\",\n \"dob\": \"01-01-2025\",\n \"gender\": \"Male\",\n \"title\": \"Mr\",\n \"address_line_1\": \"Address link 1\",\n \"address_line_2\": \"\",\n \"city\": \"Ikeja\",\n \"state\": \"Lagos\",\n \"country\": \"Nigeria\"\n },\n \"meta\": {\n \"channel\": \"mobile-app|schedule|ussd\", // how the onboard was initiated\n \"photo\": \"\",\n \"phone_numbers\": \"\", // phone number in csvs\n \"account_number\": \"12232323223\",\n \"account_name\": \"John Doe\",\n \"bank_code\": \"002\",\n\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/onboard-approved"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Onboard have been reviewed and approved\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Pay4Me\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\": \"PWA-ONB-1323399596\",\n \"meta\": {\n \"understands_product\": \"Yes\",\n \"uuid\": \"4c656776-6914-4252-912a-9adbfedea3aa\"\n }\n },\n \"client_info\": null\n }\n}"}],"_postman_id":"29759b25-d3ad-4397-b237-612289d7b43a"},{"name":"Onboard - PWT","id":"8b61d42e-6575-43a0-9ccd-af7c68b036a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"Ht5vHAocNKQfxDY\",\n \"request_type\": \"onboard\",\n \"auth\": {\n \"type\": \"pwt\",\n \"secure\": \"\", //secured nin\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"PWA-ONB-W3FQaEC6y92CepF\",\n \"transaction_desc\": \"PayWithAccount Onboard\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"details\": {\n \"name_on_account\": \"John Does\",\n \"middlename\": \"\",\n \"dob\": \"\",\n \"gender\": \"Male\",\n \"title\": \"Mr\",\n \"address_line_1\": \"Address link 1\",\n \"address_line_2\": \"\",\n \"city\": \"Ikeja\",\n \"state\": \"Lagos\",\n \"country\": \"Nigeria\"\n },\n \"meta\": {\n \"firstname\": \"John\",\n \"surname\": \"Does\",\n \"name\": \"John Doe \",\n \"description\": \"\",\n \"pwt_account_number\": \"orinator bank account\",\n \"pwt_bank_code\": \"orinator bank code\",\n \"pwt_notification_phone\": \"customer_ref\",\n \"pwt_notification_email\": \"customer email | nin email\",\n \"pwt_webhook_url\": \"\",\n \"pwt_notification_sms_template\": \"\",\n \"benefits_login\": \"customer_ref\",\n \"benefits_login_email\": \"customer email | nin email\",\n \"store_address\": \"business address\",\n \"store_state\": \"Lagos\",\n \"store_lga\": \"Surulere\",\n \"status\": \"active\",\n \"tags\": \"source=mobile-app|ussd,membership_plan=premium\",\n \"extra_page_fields\": {\n \"benefits_login\": \"customer_ref\",\n \"benefits_login_email\": \"customer email | nin email\",\n \"dsa_name\": \"Nchedo Vincent\",\n \"dsa_phone_number\": \"2348068660576\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/onboard/pwt","description":"Accepts customer's data to onboard customer on PayWithAccount. This onboard process makes use of NIN.
\n","urlObject":{"path":["pay4me","onboard","pwt"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"a2e83cf8-6298-4365-a9c4-bb64efeb2c63","name":"Onboard","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"AFLEYGs9jMw3eYR\",\n \"request_type\": \"onboard\",\n \"auth\": {\n \"type\": \"pwt\",\n \"secure\": \"\", //secured nin\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"PWA-ONB-snynM5WnHUFINhR\",\n \"transaction_desc\": \"PayWithAccount Onboard\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"details\": {\n \"name_on_account\": \"John Does\",\n \"middlename\": \"\",\n \"dob\": \"\",\n \"gender\": \"Male\",\n \"title\": \"Mr\",\n \"address_line_1\": \"Address link 1\",\n \"address_line_2\": \"\",\n \"city\": \"Ikeja\",\n \"state\": \"Lagos\",\n \"country\": \"Nigeria\"\n },\n \"meta\": {\n \"firstname\": \"John\",\n \"surname\": \"Does\",\n \"name\": \"John Doe \",\n \"description\": \"\",\n \"pwt_account_number\": \"orinator bank account\",\n \"pwt_bank_code\": \"orinator bank code\",\n \"pwt_notification_phone\": \"customer_ref\",\n \"pwt_notification_email\": \"customer email | nin email\",\n \"pwt_webhook_url\": \"\",\n \"pwt_notification_sms_template\": \"\",\n \"benefits_login\": \"customer_ref\",\n \"benefits_login_email\": \"customer email | nin email\",\n \"store_address\": \"business address\",\n \"store_state\": \"Lagos\",\n \"store_lga\": \"Surulere\",\n \"status\": \"active\",\n \"tags\": \"source=mobile-app|ussd,membership_plan=premium\",\n \"extra_page_fields\": {\n \"benefits_login\": \"customer_ref\",\n \"benefits_login_email\": \"customer email | nin email\",\n \"dsa_name\": \"Nchedo Vincent\",\n \"dsa_phone_number\": \"2348068660576\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/onboard/pwt"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Distributor Created Successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Pay4Me\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\": \"PWA-ONB-1323399596\",\n \"meta\": {\n \"business_name\": \"My Buisness name\",\n \"account_number\": \"0987654321\",\n \"bank_code\": \"000\"\n }\n }\n }\n}"}],"_postman_id":"8b61d42e-6575-43a0-9ccd-af7c68b036a1"},{"name":"Pay4Me","id":"ca6bb649-90d7-4b58-a6aa-0063d8c60841","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"u4V_upNNMUhfMOa\",\n \"request_type\": \"pay4me\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"zTi1BCfErA8sA3Y\",\n \"transaction_desc\": \"\",\n \"amount\": 50000, //Pay4me Amount\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"details\": {\n \"destination_account\": \"0987654321\",\n \"destination_bank_code\": \"000\",\n \"destination_account_name\": \"John Doe\",\n \"destination_bank_name\": \"Fidelity Bank Nigeria\"\n },\n \"meta\": {\n // DETAILS INJECT BY GROUPMONI..\n \"loyalty_amount_used\": \"0\",\n \"customer_version\": \"2\",\n \"average_daily_sales\": \"1747900\",\n \"inventory_forecast\": \"10487400\",\n \"growth_rate\": \"200000\",\n \"eligible_credit\": \"2000000\",\n \"customer_level\": \"cycle_50_times\",\n \"groupmoni_transaction_type\": \"pay4me\",\n \"loan_id\": \"LN64807159080\",\n \"loan_amount\": \"11240000\",\n \"loan_status\": \"requested\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"93d27634-76b7-4b34-b79f-60f1454c1a52","name":"Pay4Me","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"K5rfwTkzrJFtQTj\",\n \"request_type\": \"pay4me\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"NhlHrJFrhReJspR\",\n \"transaction_desc\": \"\",\n \"amount\": 50000, //Pay4me Amount\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"details\": {\n \"destination_account\": \"0987654321\",\n \"destination_bank_code\": \"000\",\n \"destination_account_name\": \"John Doe\",\n \"destination_bank_name\": \"Fidelity Bank Nigeria\"\n },\n \"meta\": {\n // DETAILS INJECT BY GROUPMONI..\n \"loyalty_amount_used\": \"0\",\n \"customer_version\": \"2\",\n \"average_daily_sales\": \"1747900\",\n \"inventory_forecast\": \"10487400\",\n \"growth_rate\": \"200000\",\n \"eligible_credit\": \"2000000\",\n \"customer_level\": \"cycle_50_times\",\n \"groupmoni_transaction_type\": \"pay4me\",\n \"loan_id\": \"LN64807159080\",\n \"loan_amount\": \"11240000\",\n \"loan_status\": \"requested\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Request processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Pay4Me\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\": \"QO22vVmddP\",\n \"transaction_final_amount\": \"3600000\",\n \"meta\": {\n \"narration\": \"Deposit_D9oT2MIe13-DIS\",\n \"loan_id\": \"LN21018694812\",\n \"loan_disbursement_date\": \"2025-07-03 16:51:42\",\n \"repayment_due_date\": \"2025-07-10 16:51:41\"\n }\n },\n \"client_info\": null\n }\n}"}],"_postman_id":"ca6bb649-90d7-4b58-a6aa-0063d8c60841"},{"name":"Get a Loan","id":"04587716-3235-4aaf-a55f-5428a5bf4fda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"vyYPLYcX7eckBqm\",\n \"request_type\": \"get a loan\",\n \"auth\": {\n \"type\": null,\n \"secure\": null, // maybe we can add the destination account as auth secure\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"FrxxhzrcUw7IukU\",\n \"transaction_desc\": \"\",\n \"amount\": 50000, //Pay4me Amount\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"details\": {\n \"destination_account\": \"0987654321\",\n \"destination_bank_code\": \"000\",\n \"destination_account_name\": \"John Doe\",\n \"destination_bank_name\": \"Fidelity Bank Nigeria\"\n },\n \"meta\": {\n \"skip_disburse\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"72554a36-671c-42df-b68a-18b5f66fe7b7","name":"Get a Loan","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"benvccnzodXOyv1\",\n \"request_type\": \"pay4me\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"4nyUFFYeGBziofB\",\n \"transaction_desc\": \"\",\n \"amount\": 50000, //Pay4me Amount\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"details\": {\n \"destination_account\": \"0987654321\",\n \"destination_bank_code\": \"000\",\n \"destination_account_name\": \"John Doe\",\n \"destination_bank_name\": \"Fidelity Bank Nigeria\"\n },\n \"meta\": {\n \"skip_disburse\": true\n \n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/get-a-loan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Request processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Pay4Me\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\": \"QO22vVmddP\",\n \"transaction_final_amount\": \"3600000\",\n \"meta\": {\n \"narration\": \"Deposit_D9oT2MIe13-DIS\",\n \"loan_id\": \"LN21018694812\",\n \"loan_disbursement_date\": \"2025-07-03 16:51:42\",\n \"repayment_due_date\": \"2025-07-10 16:51:41\"\n }\n },\n \"client_info\": null\n }\n}"}],"_postman_id":"04587716-3235-4aaf-a55f-5428a5bf4fda"},{"name":"Lookup Account Min (for distributor)","id":"f35f9765-ece1-4886-a81b-212e0ba6d15e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"3gOeI2RCwseDijT\",\n \"request_type\": \"lookup account min\",\n \"auth\": {\n \"type\": \"custom\", \n \"secure\": \"secure(pwt;customer-ref;distributor-account-number;distributor-account-bank-code)\", \n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"wvNL7IuP3Lj8lhd\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"meta\": null,\n \"details\": null,\n \"options\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/lookup-account-min","description":"Check if a recipient is a growtrade distributor. This service has 3 types of requests
\nSuccessful : Recipient is a growtrade distributor
\nInvalidID: Recipient is NOT a growtrade distributor
\nFailed: An error occured while processing request. You can try again here
\nCall Listbranches under the hood and do a validation against teh data returned from
\n","urlObject":{"path":["pay4me","lookup-account-min"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"3b20f091-aba2-4982-a0a9-82431986b75c","name":"Lookup Account Min (type Pwt) - Successful","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"DZguCELiYr1EYo9\",\n \"request_type\": \"lookup account min\",\n \"auth\": {\n \"type\": \"pwt\",\n \"secure\": \"secure(distro-page-ref;page-account-number;page-bank-code)\", // secure distributor's page-ref ; page account number ; page bankcode Example 23470111111;2332323243;944\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"xHha0y9v3MWB9k5\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"meta\": null,\n \"details\": null,\n \"options\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/lookup-account-min"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Pay4Me\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"customer_id\": 23232,\n \"account_name\": \"Boyaz Inc\",\n \"account_number\": \"2233305555\",\n \"first_name\": null,\n \"last_name\": null,\n \"gender\": null,\n \"account_currency\": \"NGN\",\n \"dob\": null,\n \"reference\": \"PWAM-feca1c81-bbbd-4c91-9889-b612f74b62b6-24137364\",\n \"meta\": {\n \"id\": 232323,\n \"name\": \"Boyaz Inc\",\n \"status\": \"active\",\n \"pwt_page_tags\": \"sector=,lga=Ikeja,region=Lagos\"\n }\n },\n \"client_info\": null\n }\n}"},{"id":"3ada5451-00d4-4ba0-9075-52f388888216","name":"Lookup Account Min (type Pwt) - InvalidID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"lnAqIuAAWoWkOpg\",\n \"request_type\": \"lookup account min\",\n \"auth\": {\n \"type\": \"pwt\",\n \"secure\": \"secure(distro-page-ref;page-account-number;page-bank-code)\", // secure distributor's page-ref ; page account number ; page bankcode Example 23470111111;2332323243;944\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"7vctfvUgUUXL2gF\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"meta\": null,\n \"details\": null,\n \"options\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/lookup-account-min2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"InvalidID\",\n \"message\": \"Account not found.\",\n \"data\": {\n \"provider_response_code\": \"91\",\n \"provider\": \"Pay4Me\",\n \"errors\": [\n {\n \"code\": \"91\",\n \"message\": \"Account not found.\"\n }\n ],\n \"error\": {\n \"code\": \"91\",\n \"message\": \"Account not found.\"\n },\n \"provider_response\": {\n \"error\": \"Account not found.\"\n },\n \"client_info\": null\n }\n}"}],"_postman_id":"f35f9765-ece1-4886-a81b-212e0ba6d15e"},{"name":"Lookup Account Min (for Onboard verification)","id":"848db87f-d982-4ef0-bc4c-2d0ed5a26b6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n{\n \"request_ref\": \"DvSqVPh_FnOrogG\",\n \"request_type\": \"lookup account min\",\n \"auth\": {\n \"type\": \"custom\", \n \"secure\": \"secure(onboard;customer-ref)\", \n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"tH79CF8mfZJpSF1\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"meta\": null,\n \"details\": null,\n \"options\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/lookup-account-min","description":"Check if a recipient is a growtrade distributor. This service has 3 types of requests
\nSuccessful : Recipient is a growtrade distributor
\nInvalidID: Recipient is NOT a growtrade distributor
\nFailed: An error occured while processing request. You can try again here
\nCall Listbranches under the hood and do a validation against teh data returned from
\n","urlObject":{"path":["pay4me","lookup-account-min"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"367f8304-c209-40a6-ac87-05bccd77d558","name":"Lookup Account Min (type Pwt) - Successful","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"NW5K5ljbitbjUhv\",\n \"request_type\": \"lookup account min\",\n \"auth\": {\n \"type\": \"pwt\",\n \"secure\": \"secure(distro-page-ref;page-account-number;page-bank-code)\", // secure distributor's page-ref ; page account number ; page bankcode Example 23470111111;2332323243;944\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"NrGXr5pHwTnG8lx\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"meta\": null,\n \"details\": null,\n \"options\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/lookup-account-min"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Pay4Me\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"customer_id\": null,\n \"account_name\": \"John Doe Smith\",\n \"account_number\": \"0023232323\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"gender\": \"Male\",\n \"account_currency\": \"NGN\",\n \"dob\": null,\n \"reference\": \"PWAM-ade4a9d2-c1a5-4ccb-b01e-759fbde3ee5d\",\n \"meta\": {\n \"approval_status\": \"Approved\"\n }\n },\n \"client_info\": null\n }\n}"},{"id":"c9f69fd7-3fc1-41a6-baed-ec4b104383bb","name":"Lookup Account Min (type Pwt) - InvalidID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"e0ttfYLC38aD5F4\",\n \"request_type\": \"lookup account min\",\n \"auth\": {\n \"type\": \"pwt\",\n \"secure\": \"secure(distro-page-ref;page-account-number;page-bank-code)\", // secure distributor's page-ref ; page account number ; page bankcode Example 23470111111;2332323243;944\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"gFEeKommk9tGgJ2\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"meta\": null,\n \"details\": null,\n \"options\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/lookup-account-min2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"InvalidID\",\n \"message\": \"Account not found.\",\n \"data\": {\n \"provider_response_code\": \"91\",\n \"provider\": \"Pay4Me\",\n \"errors\": [\n {\n \"code\": \"91\",\n \"message\": \"Account not found.\"\n }\n ],\n \"error\": {\n \"code\": \"91\",\n \"message\": \"Account not found.\"\n },\n \"provider_response\": {\n \"error\": \"Account not found.\"\n },\n \"client_info\": null\n }\n}"}],"_postman_id":"848db87f-d982-4ef0-bc4c-2d0ed5a26b6e"},{"name":"Get Customer","id":"76916805-83e0-467e-b3ea-2417b78bee6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"ZzQNXWFlnncvFPn\",\n \"request_type\": \"get customer\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"kif_sLvjgCw5wUf\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"details\": null,\n \"meta\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/get-customer","urlObject":{"path":["pay4me","get-customer"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"01d0127b-cdb9-4dc0-9330-ee83ffd0ba74","name":"Get Customer - Successful","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"W4qGOvejjfawieD\",\n \"request_type\": \"get customer\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"I1_xOqp2CHaL2Xb\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"details\": null,\n \"meta\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/get-customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successful\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Pay4Me\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"approval_status\": \"pending|approved\", //approved means customer understands products\n \"membership_status\": \"inactive|active\",\n \"membership_plan\": \"Premium\",\n \"lender_terms_url\": null,\n \"loan_terms\": {\n \"tenure\": \"12\",\n \"interest_rate\": \"10%\",\n \"repayment_frequency\": \"monthly\" \n },\n \"running_loans\": [\n { // would be null when there's no running loan\n \"amount\": \"N500,000\",\n \"due_date\": \"29-03-2025\"\n },\n { // would be null when there's no running loan\n \"amount\": \"N500,000\",\n \"due_date\": \"29-03-2025\"\n }\n ],\n \"pay4me_limit\": \"N500,000.00\",\n \"is_pwa_biller\": \"true|false\",\n \"is_pay4me_distro\": \"true|false\",\n \"meta\": {\n \"reference\": \"pm7bakvHNBoHQCU\"\n }\n }\n }\n}"}],"_postman_id":"76916805-83e0-467e-b3ea-2417b78bee6d"},{"name":"Get many Utilities","id":"309f7ff8-68c1-4ec4-bd84-4d57ba963ae4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"Lxhv2izrRVm7ug1\",\n \"request_type\": \"utility\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"27WY2dKndgASXNm\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"details\": null,\n \"meta\": {\n \"utilities\": [\n \"get_tnc\",\n \"get_splash_screens\"\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/utility-many","description":"Support utilities are
\nSplash screens: get_splash_screens
\nMembership Plans: get_plans
\nTerms and Conditions: get_tnc
\nGet splash screens from configured database or storage
\n","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"b6a28fa4-9feb-4be9-95e2-8cbb70950757","name":"Succesful","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"S6AErRj8GyX_2yg\",\n \"request_type\": \"utility\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"wpw0dUERONDynRW\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"12345678\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"12345678\"\n },\n \"details\": null,\n \"meta\": {\n \"utilities\": [\"get_splash_screens\"]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/splash-screen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Pay4Me\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"utilities\": {\n \"splash_screens\": [\n {\n \"image\": \"https://example.com/images/welcome.jpg\",\n \"title\": \"Welcome to Pay4Me\",\n \"description\": \"Experience seamless transactions and manage your payments effortlessly.\"\n },\n {\n \"image\": \"https://example.com/images/features.jpg\",\n \"title\": \"Features\",\n \"description\": \"Discover our range of features designed to simplify your payment process.\"\n }\n ]\n }\n }\n }\n}"}],"_postman_id":"d656f0be-8760-49c5-ab9f-9e36c5535eb7"},{"name":"Utility (Get Plans)","id":"de56c9ca-04c7-44c5-b8c8-6c16ee327bc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"Y0Su2kJagY4AnKZ\",\n \"request_type\": \"utility\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"90VBPLrJA48giTw\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"details\": null,\n \"meta\": {\n \"utilities\": [\"get_plans\"]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"81cdb635-6e54-43af-8a07-904f1e2f79a9","name":"Utility (Get Plans) - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"YG3OeoacG3akSmv\",\n \"request_type\": \"utility\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"zxkK4Nbo5bk9nyS\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"12345678\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"12345678\"\n },\n \"details\": null,\n \"meta\": {\n \"utilities\": [\"get_plans\"]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/plans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Pay4Me\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"utilities\": {\n \"plans\": [\n {\n \"name\": \"Premium\",\n \"amount\": \"N950\",\n \"savings\": \"N700\",\n \"duration\": \"weekly\",\n \"features\": [\n \"Start at N20,000 credit line\",\n \"Grow up to N3,000,000\",\n \"Interest: 3%\",\n \"N700 in your weekly savings\"\n ]\n },\n {\n \"name\": \"Regular\",\n \"amount\": \"N500\",\n \"savings\": \"N300\",\n \"duration\": \"weekly\",\n \"features\": [\n \"Start at N10,000 credit line\",\n \"Grow up to N1,000,000\",\n \"Interest: 3%\",\n \"N300 in your weekly savings\"\n ]\n }\n ]\n }\n }\n }\n}"}],"_postman_id":"de56c9ca-04c7-44c5-b8c8-6c16ee327bc4"},{"name":"Utility (TnC)","id":"4c4c04b5-e292-4c22-a18e-ce5a38312d11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"RGa2BzsPIy14Ude\",\n \"request_type\": \"utility\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"jnJfIyz44kUWfCi\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2348022222222\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"2348022222222\"\n },\n \"details\": null,\n \"meta\": {\n \"utilities\": [\"get_tnc\"] //terms and conditions\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"8385284e-9718-45c1-b1d3-ec56d727c2a0","name":"Utility (T n C) - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"Ea8y8s2f4Gw1yHy\",\n \"request_type\": \"utility\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Pay4Me\"\n },\n \"transaction\": {\n \"mock_mode\": \"Live\",\n \"transaction_ref\": \"ik_lDFxaOsBMjMG\",\n \"transaction_desc\": \"\",\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"12345678\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"johndoe@exmaple.com\",\n \"mobile_no\": \"12345678\"\n },\n \"details\": null,\n \"meta\": {\n \"utilities\": [\"get_tnc\"] //terms and conditions\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/pay4me/tnc"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"Pay4Me\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"utilities\": {\n \"tnc\": \"https://onepipe.io/start/terms\"\n }\n }\n }\n}"}],"_postman_id":"4c4c04b5-e292-4c22-a18e-ce5a38312d11"}],"id":"e6070d94-6bbd-4400-80c9-27d68a8afbde","_postman_id":"e6070d94-6bbd-4400-80c9-27d68a8afbde","description":""},{"name":"_pwt","item":[{"name":"Create Payment - PWT","id":"3812a4b2-3f1e-4922-9e19-bb288a936448","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"/**\nAllos you create a pending payment on PWT\n*/\n\n{\n \"request_ref\": \"256c8074-4889-47b2-ade0-0a8500220bd6\",\n \"request_type\": \"create payment\",\n \"auth\": {\n \"type\": \"custom\",\n \"secure\": null,\n \"auth_provider\": \"PWT\"\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"PWA-INST-e918-e399-4f39-a319-4f3a7eaac1-gal-037-Y2AS\",\n \"transaction_desc\": \"Create a payment for 2348123232323\",\n \"transaction_ref_parent\": null,\n \"amount\": 5000,\n \"customer\": {\n \"customer_ref\": \"2348123232323\",\n \"firstname\": \"Default\",\n \"surname\": \"User\",\n \"email\": \"name@exmaple.com\",\n \"mobile_no\": \"2348123232323\"\n },\n \"meta\": {\n \"cancel_pending_transaction\": \"true\"\n },\n \"details\": {\n \"page_id\": \"40543\"\n }\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"a0c33243-8542-42c9-b3eb-8d1e7dab9dd3","name":"Create Payment - PWT","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"/**\nAllos you create a pending payment on PWT\n*/\n\n{\n \"request_ref\": \"256c8074-4889-47b2-ade0-0a8500220bd6\",\n \"request_type\": \"create payment\",\n \"auth\": {\n \"type\": \"custom\",\n \"secure\": null,\n \"auth_provider\": \"PWT\"\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"PWA-INST-e918-e399-4f39-a319-4f3a7eaac1-gal-037-Y2AS\",\n \"transaction_desc\": \"Create a payment for 2348123232323\",\n \"transaction_ref_parent\": null,\n \"amount\": 5000,\n \"customer\": {\n \"customer_ref\": \"2348123232323\",\n \"firstname\": \"Default\",\n \"surname\": \"User\",\n \"email\": \"name@exmaple.com\",\n \"mobile_no\": \"2348123232323\"\n },\n \"meta\": {\n \"cancel_pending_transaction\": \"true\"\n },\n \"details\": {\n \"page_id\": \"40543\"\n }\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"PendingValidation\",\n \"message\": \"Transaction pending.\",\n \"data\": {\n \"provider_response_code\": \"90TP\",\n \"provider\": \"Pay4Me\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"company_id\": 23,\n \"page_id\": 1232723,\n \"reference\": \"PWAM-a86cd1c9-077f-4bf0-8e67-acbaccb6049d-gal-406-0CrTv\",\n \"quantity\": 1,\n \"amount\": 60,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": null,\n \"phone\": \"234702323232323\",\n \"status\": \"pending\",\n \"updated_at\": \"2025-12-08T13:44:15Z\",\n \"created_at\": \"2025-12-08T13:44:15Z\",\n \"id\": 621114,\n \"name\": \"John Doe\",\n \"can_retry_settlement\": false\n },\n \"client_info\": null\n }\n}"}],"_postman_id":"3812a4b2-3f1e-4922-9e19-bb288a936448"}],"id":"e4c479e9-5267-45bf-ae97-768521c0fafb","_postman_id":"e4c479e9-5267-45bf-ae97-768521c0fafb","description":""},{"name":"_onepipe","item":[{"name":"Validate ID","id":"a2a6ae87-f4bf-4143-89b3-094938f03352","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"256c8074-4889-47b2-ade0-0a8500220bd6\",\n \"request_type\": \"validate id\",\n \"auth\": {\n \"type\": \"nin\",\n \"secure\": \"encrypted-nin\",\n \"auth_provider\": \"OnePipe\"\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"rOI2dSlTa86TX73\",\n \"transaction_desc\": \"Validate NIN\",\n \"transaction_ref_parent\": null,\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"234702323232\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"name@exmaple.com\",\n \"mobile_no\": \"234702323232\"\n },\n \"details\": {\n \"dob\": \"YYYY-MM-DD\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"ba858ca8-c19a-46a3-9203-770d2c5995e1","name":"Validate ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"256c8074-4889-47b2-ade0-0a8500220bd6\",\n \"request_type\": \"validate id\",\n \"auth\": {\n \"type\": \"nin\",\n \"secure\": \"encrypted-nin\",\n \"auth_provider\": \"OnePipe\"\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"JirJ222LsHmcRuZ\",\n \"transaction_desc\": \"Validate NIN\",\n \"transaction_ref_parent\": null,\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"234702323232\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"name@exmaple.com\",\n \"mobile_no\": \"234702323232\"\n },\n \"details\": {\n \"dob\": \"YYYY-MM-DD\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"NIN verification successful\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"GRB\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"meta\": {\n \"reference\": \"ttRlR5MQMM0a3p4\"\n },\n \"nin\": \"21121212122\",\n \"first_name\": \"John\",\n \"middle_name\": \"Smith\",\n \"surname\": \"Doe\",\n \"gender\": \"m\"\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":"a2a6ae87-f4bf-4143-89b3-094938f03352"},{"name":"Get Data","id":"88d6ba2f-ab8a-444f-8a5f-e6a0699484e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"f98f4afb-f8b7-4ae7-bd11-79234c11a69d\",\n \"api_key\": \"*********************************\",\n \"request_type\": \"get data\",\n \"request_mode\": null,\n \"ParsedRequestType\": \"get data\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Onepipe\",\n \"route_mode\": null\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"PWAM-b8e262a1-a11d-4d35-959c-62ed2b1c45f4\",\n \"transaction_desc\": \"Get customer pay4me history\",\n \"transaction_ref_parent\": null,\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2347023232323\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"name@exmaple.com\",\n \"mobile_no\": \"2347023232323\"\n },\n \"meta\": {\n \"limit_per_page\": \"100\",\n \"card_id\": \"metabase-card-id\",\n \"parameters\": \"type=text|field=customer_ref|value=23445343434|target_value=variable\"\n },\n \"details\": {},\n \"options\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact","urlObject":{"path":["v2","transact"],"host":["https://api.onepipe.io"],"query":[],"variable":[]}},"response":[{"id":"7defbd3d-586e-4fe7-9461-1c73dfd86ba7","name":"Get Data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"f98f4afb-f8b7-4ae7-bd11-79234c11a69d\",\n \"api_key\": \"*********************************\",\n \"request_type\": \"get data\",\n \"request_mode\": null,\n \"ParsedRequestType\": \"get data\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"Onepipe\",\n \"route_mode\": null\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"PWAM-b8e262a1-a11d-4d35-959c-62ed2b1c45f4\",\n \"transaction_desc\": \"Get customer pay4me history\",\n \"transaction_ref_parent\": null,\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"2347023232323\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"name@exmaple.com\",\n \"mobile_no\": \"2347023232323\"\n },\n \"meta\": {\n \"limit_per_page\": \"100\",\n \"card_id\": \"card-id\",\n \"parameters\": \"type=text|field=customer_ref|value=23445343434|target_value=variable\"\n },\n \"details\": {},\n \"options\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Transaction processed successfully\",\n \"data\": {\n \"options\": null,\n \"app_info\": null,\n \"provider_response_code\": \"00\",\n \"provider\": \"Onepipe\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"customer_ref\": \"234702323223\",\n \"meta\": {\n \"data\": [\n {\n \"due_date\": \"2025-12-09 15:12:33\",\n \"loan_id\": \"LN3530406306\",\n \"paid_on\": \"\",\n \"marketplace\": \"PAYWITHACCOUNT INSTORE\",\n \"cycle\": \"cycle_3_times\",\n \"amount_financed\": \"60\",\n \"biller_name\": \"Boyaz Inc\",\n \"biller_code\": \"000000\",\n \"disbursed_on\": \"2025-12-08 15:12:41\",\n \"status\": \"disbursed\",\n \"duration\": \"2\",\n \"distributor\": \"Boyaz Inc\",\n \"repayment_outstanding\": \"92\"\n },\n {\n \"due_date\": \"2025-12-09 09:47:21\",\n \"loan_id\": \"LN24712570974\",\n \"paid_on\": \"2025-12-09 12:17:42\",\n \"marketplace\": \"PAYWITHACCOUNT INSTORE\",\n \"cycle\": \"cycle_4_times\",\n \"amount_financed\": \"50\",\n \"biller_name\": \"Boyaz Inc\",\n \"biller_code\": \"000000\",\n \"disbursed_on\": \"2025-12-08 09:47:28\",\n \"status\": \"repaid\",\n \"duration\": \"0\",\n \"distributor\": \"Boyaz Inc\",\n \"repayment_outstanding\": \"0\"\n },\n {\n \"due_date\": \"2025-10-08 16:16:17\",\n \"loan_id\": \"LN8799250885\",\n \"paid_on\": \"2025-10-07 18:54:47\",\n \"marketplace\": \"PAYWITHACCOUNT INSTORE\",\n \"cycle\": \"cycle_3_times\",\n \"amount_financed\": \"50\",\n \"biller_name\": \"Test Business\",\n \"biller_code\": \"001280\",\n \"disbursed_on\": \"2025-10-07 16:16:24\",\n \"status\": \"repaid\",\n \"duration\": \"0\",\n \"distributor\": \"Test Business\",\n \"repayment_outstanding\": \"0\"\n },\n {\n \"due_date\": \"2025-10-08 15:25:56\",\n \"loan_id\": \"LN103830982204\",\n \"paid_on\": \"2025-10-07 16:15:47\",\n \"marketplace\": \"PAYWITHACCOUNT INSTORE\",\n \"cycle\": \"cycle_3_times\",\n \"amount_financed\": \"50\",\n \"biller_name\": \"Test Business\",\n \"biller_code\": \"001280\",\n \"disbursed_on\": \"2025-10-07 15:26:03\",\n \"status\": \"repaid\",\n \"duration\": \"0\",\n \"distributor\": \"Test Business\",\n \"repayment_outstanding\": \"0\"\n },\n {\n \"due_date\": \"2025-09-19 20:02:51\",\n \"loan_id\": \"LN42199405704\",\n \"paid_on\": \"2025-09-24 14:54:21\",\n \"marketplace\": \"PAYWITHACCOUNT INSTORE\",\n \"cycle\": \"cycle_3_times\",\n \"amount_financed\": \"50\",\n \"biller_name\": \"\",\n \"biller_code\": \"\",\n \"disbursed_on\": \"2025-09-19 20:02:58\",\n \"status\": \"repaid\",\n \"duration\": \"4\",\n \"distributor\": \"Test Business\",\n \"repayment_outstanding\": \"0\"\n }\n ]\n },\n \"errors\": null,\n \"error\": null\n },\n \"client_info\": null\n }\n}"}],"_postman_id":"88d6ba2f-ab8a-444f-8a5f-e6a0699484e4"}],"id":"4dc807f1-0a65-4828-8cc6-aacb6c7e73c5","_postman_id":"4dc807f1-0a65-4828-8cc6-aacb6c7e73c5","description":""},{"name":"_grb","item":[{"name":"Lookup Account Min - GRB","id":"3dd4b62b-c3b3-470b-93e7-06b992b63925","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"256c8074-4889-47b2-ade0-0a8500220bd6\",\n \"request_type\": \"create payment\",\n \"auth\": {\n \"type\": \"custom\",\n \"secure\": null,\n \"auth_provider\": \"PWT\"\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"PWA-INST-e918-e399-4f39-a319-4f3a7eaac1-gal-037-Y2AS\",\n \"transaction_desc\": \"Create a payment for 2348123232323\",\n \"transaction_ref_parent\": null,\n \"amount\": 5000,\n \"customer\": {\n \"customer_ref\": \"2348123232323\",\n \"firstname\": \"Default\",\n \"surname\": \"User\",\n \"email\": \"team-wakanda@onepipe.io\",\n \"mobile_no\": \"2348123232323\"\n },\n \"meta\": {\n \"cancel_pending_transaction\": \"true\"\n },\n \"details\": {\n \"page_id\": \"40543\"\n }\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":[{"id":"2ab6167f-68d0-49a5-83b8-a4adf24cdbdd","name":"Lookup Account Min - GRB","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_ref\": \"8409f31a-3758-4ea9-9dfa-c0c9bd2c07ba\",\n \"request_type\": \"lookup account min\",\n \"ParsedRequestType\": \"lookup account min\",\n \"auth\": {\n \"type\": null,\n \"secure\": null,\n \"auth_provider\": \"GRB\",\n \"route_mode\": null\n },\n \"transaction\": {\n \"mock_mode\": \"live\",\n \"transaction_ref\": \"PWAM-feca1c81-bbbd-4c91-9889-b612f74b62b6-89058128\",\n \"transaction_desc\": \"Lookup account\",\n \"transaction_ref_parent\": null,\n \"amount\": 0,\n \"customer\": {\n \"customer_ref\": \"23470232323232\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"name@example.com\",\n \"mobile_no\": \"070232323232\"\n },\n \"meta\": null,\n \"details\": null,\n \"options\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.onepipe.io/v2/transact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Successful\",\n \"message\": \"Request processed successfully\",\n \"data\": {\n \"provider_response_code\": \"00\",\n \"provider\": \"GRB\",\n \"errors\": null,\n \"error\": null,\n \"provider_response\": {\n \"reference\": \"PWAM-feca1c81-bbbd-4c91-9889-b612f74b62b6-89058128\",\n \"customer_id\": \"200000000\",\n \"account_name\": \"Test Business\",\n \"account_number\": \"200000000\",\n \"bank_code\": \"070\",\n \"bank_name\": \"Fidelity Bank Nigeria\",\n \"last_name\": \"Doe\",\n \"first_name\": \"John\",\n \"middle_name\": null,\n \"gender\": null,\n \"account_currency\": \"NGN\",\n \"dob\": null,\n \"meta\": {}\n },\n \"client_info\": null\n }\n}"}],"_postman_id":"3dd4b62b-c3b3-470b-93e7-06b992b63925"}],"id":"e9a071a9-119d-4f4f-9365-a83edbc433aa","_postman_id":"e9a071a9-119d-4f4f-9365-a83edbc433aa","description":""}],"id":"e0fef58e-0c32-4c31-833b-d188fdeaded2","_postman_id":"e0fef58e-0c32-4c31-833b-d188fdeaded2","description":""}],"event":[{"listen":"prerequest","script":{"id":"5fa3a85e-6fa5-4f62-965c-b83b5a4c492f","type":"text/javascript","exec":["const cheerio = require('cheerio');","//import the MD5 hashing function","eval(pm.variables.get(\"md5\"));","const sendEncryptRequest = async (text, key, operation) => {"," return new Promise((resolve, reject) => {"," const formData = {"," text: text,"," key: key,"," operation: operation"," };",""," // Send the request"," pm.sendRequest({"," url: 'https://onepipe.io/tools/encryptor/Home/Encrypt',"," method: 'POST',"," header: {"," 'Content-Type': 'application/x-www-form-urlencoded'"," },"," body: {"," mode: 'urlencoded',"," urlencoded: Object.keys(formData).map(key => ({"," key: key,"," value: formData[key]"," }))"," }"," }, function (err, response) {"," if (err) {"," reject(err); // Reject the promise if there's an error"," } else {"," const $ = cheerio.load(response.text());"," resolve($('textarea').text()); // Resolve the promise with the response"," }"," });"," });","};","","const main = async () => {"," //Autogenerate request-ref and transaction-ref"," var min = 10000000000000;"," var max = 99999999999999;",""," var transRef = (Math.random() * (max - min) + min).round().toString();"," var reqRef = transRef + '01';"," pm.environment.set(\"request-ref\", reqRef);"," pm.environment.set(\"transaction-ref\", transRef);"," pm.environment.set(\"signature\", MD5(reqRef + ';' + pm.variables.get(\"secret-key\")));",""," if(pm.collectionVariables.get(\"_encryption_help\") === \"true\"){"," const enc_account = await sendEncryptRequest(`${pm.variables.get(\"plain_account_number\")};${pm.variables.get(\"plain_bank_code\")}`, pm.variables.get(\"secret-key\"), 'Encrypt');"," console.log('Response 1:', enc_account);"," pm.variables.set(\"encrypted_secure\",enc_account)"," const enc_bvn = await sendEncryptRequest(pm.variables.get(\"plain_bvn\"), pm.variables.get(\"secret-key\"), 'Encrypt');"," console.log('Response 2:', enc_bvn);"," pm.variables.set(\"encrypted_bvn\",enc_bvn)"," }","}","// TTTTTTTTTTTTTTTT","","main();","","","","","",""]}},{"listen":"test","script":{"id":"af34c567-8f19-48b0-b778-f0fae5b2903d","type":"text/javascript","exec":[""]}}],"variable":[{"id":"a06ef22b-bb93-43d6-98c8-0a21d5416dc3","key":"request-ref","value":"111111111"},{"id":"da7f1700-f059-41e9-8ca6-f67431b8bf44","key":"transaction-ref","value":"998383938292"},{"id":"6bf1ac18-aa93-42df-a06f-9684175bd8c0","key":"signature","value":"3a2b58350e8068507e6b5bff106850a5"},{"id":"d0ba7d40-8fea-4985-a71e-45fe1dc0fab2","key":"md5","value":"/**\n*\n* MD5 (Message-Digest Algorithm)\n* http://www.webtoolkit.info/\n*\n**/\n \nvar MD5 = function (string) {\n function RotateLeft(lValue, iShiftBits) {\n return (lValue<