Sarepay is a payment processor, offering a comprehensive suite of financial services tailored specifically for fintech companies and innovators. Our primary objective is to facilitate the delivery of best-in-class user experiences.
\nTo get started, sign up on https://staging-app.sarepay.com to obtain you API Keys.
\nIn order to initiate a request to the endpoints, it is essential to authorize each request using a bearer token. This bearer token is derived from API Keys section of the Sarepay dashboard.
\n\n\ne.g Authorization Bearer SECRET_KEY
\n
These services are currently available and are set to expand as we incorporate more integrations.
\nThese APIs facilitates fund transfer from your Sarepay wallet to any bank account within Nigeria. With these APIs at your disposal, you can seamlessly initiate and complete transactions, ensuring your funds are securely and promptly transferred to the designated bank account within the Nigerian financial landscape.
\nThese APIs facilitates virtual account generation for merchants and their customers. This service allows virtual account for both personal and corporate accounts as well as one time account in case of facilitating payment via transfer in a payment gateway.
\nThese APIs are the driving force behind Sarepay's checkout page. If you want to personalize your checkout page, you can achieve that by utilizing this specific set of APIs.
\n200: A successful request occurred, do note that the description field on the response can contain further steps to be carried on this transaction
\n400: Data validation error occurred due to inconsistent data supplied by the client
\n401: Invalid request authorization, which might be due to invalid API key or the client is not registered for the service being accessed.
\n500: An internal server error at our End, this should be reported if it persists.
\nThese are ways we notify our merchants of difference asynchronous events. A sample webhook is seen below
\n{\"event\":\"collection.virtualaccount.successful\",\"data\":{\"customer_reference\":\"wls_FKBYSX51LVR6AEM1693813825\",\"transaction_reference\":\"wls_FKBYSX51LVR6AEM1693813825\",\"processorReference\":\"hjfgkdlkjfhgdkswwwq\",\"amount\":\"2000.00\",\"charge\":\"20.00\",\"netAmount\":\"2020.00\",\"expectedAmount\":\"2000.00\",\"channel\":\"Virtual Account\",\"sender\":{\"originatorBank\":\"UBA\",\"originatorName\":\"Test\",\"originatorAccountNumber\":\"123456789\"},\"recipient\":null,\"status\":\"Successful\",\"createdAt\":\"2023-09-04T07:50:25.000000Z\",\"updatedAt\":\"2023-09-04T07:50:25.000000Z\",\"meta\":{\"customerMeta\":null,\"notification\":{\"amount\":\"2000\",\"bankcode\":\"058\",\"bankname\":\"UBA\",\"craccount\":\"8941011002\",\"narration\":\"Test Notification\",\"sessionid\":\"bjkxlkdjhgfdksawwwq\",\"craccountname\":\"Test Account\",\"originatorname\":\"Test\",\"paymentreference\":\"hjfgkdlkjfhgdkswwwq\",\"originatoraccountnumber\":\"123456789\"}}},\"hash\":\"BkLUHqnU\\/2tpejYhBCGOo8WKcUnwIneWnv3WybMRLBc=\"}\n\nPlease note the following updates regarding the creation of corporate virtual accounts:
\nVirtual account creation is no longer an instant process.
\nIt will now be processed shortly via the selected channels.
\nTo receive your account details, ensure you listen to the webhook URL provided on your Sarepay dashboard.
\nKindly note, processing timeline only applys to Globus, Mozfin, Parallex & Fidelity
\nYou can now choose the desired channel for creating virtual accounts. The currently available channels are:
\nWema
\nGlobus
\nMuzfin
\nParallex
\nFidelity
\nHillpost
\nThe following additional parameters are now required:
\nFirst Name (Mandatory)
\nLast Name (Mandatory)
\nOther Name (Optional)
\nBVN (Mandatory)
\nDate of Birth (Optional)
\nCity (Optional)
\nState (Optional)
\nGender (Optional)
\nMarital Status (Optional)
\nAddress (Optional)
\nEmail (Optional)
\nCorporate Account Type (Mandatory)
\nThe available corporate account types are:
\nCOMPANY
\nBUSINESS_NAME
\nINCORPORATED_TRUSTEES
\nLIMITED_PARTNERSHIP
\nLIMITED_LIABILITY_PARTNERSHIP
\nShould you have any questions or require further clarification, please do not hesitate to reach out.
\n","urlObject":{"path":["virtual-accounts","permanents"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c3de7af0-360d-43a4-a38f-7c3d236ffc86","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{secret_key}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"business_name\" : \"Test Business\",\n \"bvn\" : \"12345678912\",\n \"phone_number\" : \"08167097793\",\n \"business_type\" : \"Main\",\n \"type\" : \"Corporate\",\n \"rc_number\" : \"123456\",\n \"currency\" : \"NGN\" \n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/virtual-accounts/permanents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:9008"},{"key":"Date","value":"Sun, 03 Sep 2023 22:31:10 GMT"},{"key":"Date","value":"Sun, 03 Sep 2023 22:31:10 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.9"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=2592000; includeSubDomains"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"account_number\": \"8941011003\",\n \"account_name\": \"Test Business\",\n \"bank\": \"Wema\",\n \"status\": \"Active\",\n \"expires_at\": \"2023-09-03 23:31:10\",\n \"validity_type\": \"Permanent\"\n }\n}"},{"id":"c809e4a0-337a-4afa-9ede-89d895ef9902","name":"Error Validation","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{secret_key}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"business_name\" : \"Test Business\",\n \"bvn\" : \"12345678912\",\n \"phone_number\" : \"08167097793\",\n \"business_type\" : \"Main\",\n \"type\" : \"Corporatedd\",\n \"rc_number\" : \"123456\",\n \"currency\" : \"NGN\" \n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/virtual-accounts/permanents"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:9008"},{"key":"Date","value":"Sun, 03 Sep 2023 22:44:35 GMT"},{"key":"Date","value":"Sun, 03 Sep 2023 22:44:35 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.9"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=2592000; includeSubDomains"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Validation error\",\n \"data\": {\n \"type\": [\n \"The selected type is invalid.\"\n ]\n }\n}"}],"_postman_id":"e7f2cf91-894d-4ab2-b532-83e48f4655c2"},{"name":"Generate Permanent Virtual Account (Personal)","id":"2418be6b-8910-4f2a-999f-0f86babc468c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{secret_key}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\" : \"Test\",\n \"last_name\" : \"Test\",\n \"other_name\": \"Tester\",\n \"bvn\" : \"12345678912\",\n \"dob\" : \"1999-01-01\",\n \"phone_number\" : \"08000000000\",\n \"city\": \"Victoria Island\",\n \"state\": \"Lagos\",\n \"gender\": \"MALE\",\n \"marital_status\": \"MARRIED\",\n \"address\": \"21, Water Carinto Victoria Island\",\n \"email\": \"test@hotmail.com\",\n \"business_type\" : \"Main\",\n \"type\" : \"Personal\",\n \"currency\" : \"NGN\",\n \"channel\": \"Wema\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/virtual-accounts/permanents","description":"Please note the following updates regarding the creation of personal virtual accounts:
\nVirtual account creation is no longer an instant process.
\nIt will now be processed shortly via the selected channels.
\nTo receive your account details, ensure you listen to the webhook URL provided on your Sarepay dashboard.
\nKindly note, processing timeline only applys to Globus & Mozfin
\nYou can now choose the desired channel for creating virtual accounts. The currently available channels are:
\nWema
\nGlobus
\nMozfin
\nParallex
\nFidelity
\nHillpost
\nThe following additional parameters are now required:
\nBVN (Mandatory)
\nDate of Birth (Optional)
\nCity (Optional)
\nState (Optional)
\nGender (Optional)
\nMarital Status (Optional)
\nAddress (Optional)
\nEmail (Optional)
\nShould you have any questions or require further clarification, please do not hesitate to reach out.
\n","urlObject":{"path":["virtual-accounts","permanents"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9b37c3a3-07af-4e23-8921-948a062ad751","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{secret_key}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\" : \"Test\",\n \"last_name\" : \"Test\",\n \"other_name\": \"Tester\",\n \"bvn\" : \"12345678912\",\n \"dob\" : \"1999-01-01\",\n \"phone_number\" : \"08000000000\",\n \"business_type\" : \"Main\",\n \"type\" : \"Personal\",\n \"currency\" : \"NGN\" \n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/virtual-accounts/permanents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:9008"},{"key":"Date","value":"Sun, 03 Sep 2023 22:45:35 GMT"},{"key":"Date","value":"Sun, 03 Sep 2023 22:45:35 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.9"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=2592000; includeSubDomains"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"account_number\": \"8941011006\",\n \"account_name\": \"Test Test\",\n \"bank\": \"Wema\",\n \"status\": \"Active\",\n \"expires_at\": \"2023-09-03 23:45:35\",\n \"validity_type\": \"Permanent\"\n }\n}"}],"_postman_id":"2418be6b-8910-4f2a-999f-0f86babc468c"},{"name":"Generate One Time Account","id":"c33a124f-ae50-46b3-8203-e88e22ca270f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{secret_key}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"account_name\" : \"Test Onetime\",\n \"amount\" : 200,\n \"meta\" : {\n \"reference\" : \"tryueidwjlgfgdyjhjk\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/virtual-accounts/onetime","urlObject":{"path":["virtual-accounts","onetime"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"bedabe77-0525-409e-81ef-d7824d737039","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{secret_key}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\" : \"3000\",\n \"account_name\" : \"Test Onetime\",\n \"meta\" : {\n \"reference\" : \"tryueidwjlgfgdyjhjk\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/virtual-accounts/onetime"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:9008"},{"key":"Date","value":"Sun, 03 Sep 2023 22:51:48 GMT"},{"key":"Date","value":"Sun, 03 Sep 2023 22:51:48 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.9"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=2592000; includeSubDomains"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"account_number\": \"8945011010\",\n \"account_name\": \"Aufderhar, Stroman and Lehner - Test Onetime\",\n \"bank\": \"Wema\",\n \"status\": \"Active\",\n \"type\": \"Corporate\",\n \"expires_at\": \"2023-09-04 00:21:48\",\n \"validity_type\": \"Onetime\"\n }\n}"},{"id":"c8af034e-6df8-4d33-8bd3-70ca24fd41fa","name":"Error Vaildation","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{secret_key}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"account_name\" : \"Test Onetime\",\n \"meta\" : {\n \"reference\" : \"tryueidwjlgfgdyjhjk\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/virtual-accounts/onetime"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:9008"},{"key":"Date","value":"Sun, 03 Sep 2023 22:52:05 GMT"},{"key":"Date","value":"Sun, 03 Sep 2023 22:52:05 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.9"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=2592000; includeSubDomains"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Validation error\",\n \"data\": {\n \"amount\": [\n \"The amount field is required.\"\n ]\n }\n}"}],"_postman_id":"c33a124f-ae50-46b3-8203-e88e22ca270f"},{"name":"Get Permanent Virtual Account Channels","id":"c54dec99-15f7-4edf-9461-da557717a789","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-key","value":"{{secret_key}}","type":"text"}],"url":"{{base_url}}/api/virtual-accounts/channels","urlObject":{"path":["api","virtual-accounts","channels"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"d42466c2-7911-4bf6-bee0-800b29f07dc8","name":"Success","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{secret_key}}","type":"text"}],"url":{"raw":"{{base_url}}/api/virtual-accounts/channels","host":["{{base_url}}"],"path":["api","virtual-accounts","channels"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Oct 2024 16:22:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d3126932c6a671a-AMS"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Virtual account channels\",\n \"data\": [\n \"Wema\",\n \"Mozfin\",\n \"Globus\"\n ]\n}"}],"_postman_id":"c54dec99-15f7-4edf-9461-da557717a789"},{"name":"Get Corporate Account Types","id":"63b7ff5d-adfb-47de-8725-22baf742c423","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-key","value":"{{secret_key}}","type":"text"}],"url":"{{base_url}}/api/virtual-accounts/corporate-account-types","urlObject":{"path":["api","virtual-accounts","corporate-account-types"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"c2227e30-6e0c-44f6-a693-55a48a54721e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{secret_key}}","type":"text"}],"url":{"raw":"{{base_url}}/api/virtual-accounts/corporate-account-types","host":["{{base_url}}"],"path":["api","virtual-accounts","corporate-account-types"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Oct 2024 09:11:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d36ec398dbc0bc0-AMS"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Corporate account type\",\n \"data\": [\n \"BUSINESS_NAME\",\n \"COMPANY\",\n \"INCORPORATED_TRUSTESS\",\n \"LIMITED_PARTNERSHIP\",\n \"LIMITED_LIABILITY_PARTNERSHIP\"\n ]\n}"}],"_postman_id":"63b7ff5d-adfb-47de-8725-22baf742c423"},{"name":"Sample Virtual Account Web Hook Response","id":"221bac69-930e-49ec-b798-4fb4c4317e85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"description":"For the purpose of ensuring data integrity, please ensure you use your secret key to hash the MAC (Message Authentication Code) of the data. This will guarantee accuracy and protect against any potential tampering.
\nSample :
\n$calculated_hmac = hash_hmac('sha256', 'data', 'secret-key', true);
\nhash_equals($calculated_hmac, 'webhook-hash');
\nKindly find below sample virtual account webhook response
\n{\n \"event\": \"generate.virtualaccount.successful\",\n \"data\": {\n \"status\": \"Successful\",\n \"response_message\": \"successful\",\n \"account_name\": \"TONNY BRASTON\",\n \"account_number\": \"6215245058\",\n \"account_type\": \"Personal\",\n \"bank\": \"Globus\",\n \"bank_code\": \"103\",\n \"customer_reference\": \"6458904bfhfhhhh4676345\",\n \"reference\": \"674831452e42e959861732784453\",\n \"createdAt\": \"2024-11-28T09:00:58.366021Z\",\n \"updatedAt\": \"2024-11-28T09:00:58.366027Z\"\n },\n \"hash\": \"VK+2p+ps4yJuIHZszOiLdiQrMfHc4sw2XoDFJ0Y+2/c=\"\n}\n\nTo safeguard your card information, it is essential that you encrypt the card details before transmitting them. Our method of choice is AES-256 encryption, renowned for its robustness in fortifying the data payload. You can get encryption keys and IV from the API keys section of the Sarepay dashboard.
\n\n\nNOTE: The cipher mode of Encryption is CBC and the output format should be a Base64 string.
\n
Encrypt the card PAN, CVV, expiry month, and expiry year using the specified method for the charge endpoint. Then, ensure that these encrypted values are placed within the \"card_data\" field in the payload according to the given format.
\nTo achieve this, concatenate the values using empty spaces as separators and then proceed to encrypt the concatenated string. For instance, the encryption process would involve encrypting the string \"pan cvv expiry_month expiry_year\" to generate an encrypted string, as shown in the example:
\n\n\nE.g encryptedString = encrypt(\"5060990580000217499 111 03 50\")
\n
In situations where the PIN is necessary for confirmation, it is mandatory to encrypt the PIN and subsequently include it in the designated \"pin\" field within the request payload.
\n\n\nE.g encryptedString = encrypt(\"1111\")
\n
Make use of the test credentials provided below. These credentials are designed to help you generate responses from the API. By using these credentials in your testing, you can see how the API reacts in different situations. This practical approach will give you a better understanding of how the API works and how it responds to different inputs.
\n4084084084084081 408 12 27
\n507850785078507812 081 12 27
PIN: 1111
5060666666666666666 123 12 27
PIN: 1234
OTP: 123456
4084080000000409 000 12 27
\n4084080000005408 001 12 27
\n507850785078507853 082 12 27
\nUpon initiating a call to the charge endpoint, the ensuing response serves as a compass guiding your subsequent actions. Within this response lies the potential for several transaction statuses, namely \"approved,\" \"send_pin,\" \"send_otp,\" or \"require_auth\" (3D Secure). Each status serves as a navigational marker, directing your decision-making towards the appropriate next steps.
\napproved:
\nThis means that the transction is sucessful, and there is no need for any additional actions.
\n\n\nNote: You are advised to re-query the transaction to verify the status of the transaction.
\n
send_pin:
\nThis indicates that the transaction necessitates the user's PIN for further processing. To move forward with the transaction, simply initiate an API call to the Submit Pin endpoint.
\n\n\nRemember to encrypt the pin before making the request
\n
send_otp:
\nThis signifies that the transaction mandates an OTP (One-Time Password) sent to the user's device to move forward. To proceed with the transaction, simply make an API call to the Submit OTP endpoint.
\n\n\nNote: You do not need to encrypt the OTP
\n
require_auth:
\nMost transactions require a redirection to the card issuer authentication page to continue processing, this is also called 3D Secure.
The flow starts when the response from the charge endpoint returns a \"require_auth\" status.
{\n \"status\": true,\n \"message\": \"Charge Attempted\",\n \"data\": {\n \"status\": \"require_auth\",\n \"reference\": \"8f51168b-41a9-4274-ba9f-bf6a9b534146\",\n \"redirect_auth_data\": {\n \"url\": \"https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp\",\n \"token\": \"eyJhbGciOiJIUzI1NiJ9...\",\n \"md\": \"474549480\",\n \"body\": \"<body onload=\\\"form1.submit()\\\"><form id=\\\"form1\\\" action=\\\"https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp\\\" method=\\\"POST\\\"></form></body>\"\n }\n }\n}\n\nIt is recommended to load the contents of the body(data > redirect_auth_data > body) on an iframe over your payment page using the srcdoc attribute.
\n%3C!DOCTYPE%20html%3E\n<html lang=\"en\">\n<head>\n <meta charset=\"UTF-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n <title>Payment</title>\n</head>\n<body>\n <iframe id=\"myIframe\" width=\"100%\" height=\"900\"></iframe>\n</body>\n<script>\n%20%20%20%20const%20iframe%20%3D%20document.getElementById(%26%23x27%3BmyIframe%26%23x27%3B)%3B\n%20%20%20%20iframe.srcdoc%20%3D%20%7B%7B%20body%20content%20%7D%7D%3B\n</script>\n</html>\n\nAfter the payment is completed. Make a call to Redirect Auth Validate endpoint to validate the transaction and give value.
\nPlease use your secret key as Bearer Token when calling the endpoints.
\n","_postman_id":"4aeb71f5-b8ea-43a3-b33d-cb305c7bd7b9"},{"name":"Wallet","item":[{"name":"Wallet Balance","id":"e1390a98-cc75-4f5b-a076-9e08645c76da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-key","value":"{{secret_key}}","type":"text"}],"url":"{{base_url}}/wallets/balance","urlObject":{"path":["wallets","balance"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e1390a98-cc75-4f5b-a076-9e08645c76da"}],"id":"0751cd17-3df4-453a-89fc-7b8b69201efb","_postman_id":"0751cd17-3df4-453a-89fc-7b8b69201efb","description":""},{"name":"Transaction","item":[{"name":"Transaction History","id":"d602934e-183a-4e8f-b5c3-3fffc48e4eea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-key","value":"{{secret_key}}","type":"text"}],"url":"{{base_url}}/transactions?reference=wls_VSQHYC814E2A73K1695455806","urlObject":{"path":["transactions"],"host":["{{base_url}}"],"query":[{"key":"reference","value":"wls_VSQHYC814E2A73K1695455806"}],"variable":[]}},"response":[],"_postman_id":"d602934e-183a-4e8f-b5c3-3fffc48e4eea"}],"id":"cc47ea07-c59c-4f27-9ab5-c90ded5b9906","_postman_id":"cc47ea07-c59c-4f27-9ab5-c90ded5b9906","description":""},{"name":"Subaccount","item":[{"name":"List Request","id":"6af1f839-7845-48a3-a800-4d830ced236f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"{{secret_key}}","type":"text"}],"url":"{{base_url}}/api/subaccounts","urlObject":{"path":["api","subaccounts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b1741bb8-333a-4e53-96bc-7c3f7685f5be","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"{{secret_key}}","type":"text"}],"url":"{{base_url}}/api/subaccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Oct 2023 16:46:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=51%2F3cdpG06rCq5QQIjoMA8FA8%2BvMx7Ln7Q8xcJzyY6cO%2FrikbyzGhJmI4vzcpx2ptunanfLKVhXqS5bV6a9ZPsBHnDfEWzdtQS%2BNnHJkkKLJaYXs8578c8yEPhdib2fD7Jz%2FG%2B4N634K7g%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"80fe6b80eced8879-LHR"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Action was successful\",\n \"data\": [\n {\n \"name\": \"Fisi microfinance\",\n \"percentage\": 0,\n \"token\": \"UkLURlfVM1UvoD2vAsJFCvJmWiV0TJQ0\"\n },\n {\n \"name\": \"HelloWorld\",\n \"percentage\": 0,\n \"token\": \"HaUIIbEqHPdPXcBOK50HlJUa1nA38C6d\"\n },\n {\n \"name\": \"Lake departmental stores\",\n \"percentage\": 0,\n \"token\": \"Pom0XGGjJh6IAyDbGjLumPQSQLVVIXv5\"\n },\n {\n \"name\": \"Lekki deep sea port\",\n \"percentage\": 0,\n \"token\": \"iCG99sBy7tYae8jGCLLNiIzv8oJFsUjp\"\n },\n {\n \"name\": \"Suleman generator repairs ltd\",\n \"percentage\": 0,\n \"token\": \"zWRRlinebbXTiAS1IotQp9P991XEiYyT\"\n }\n ]\n}"}],"_postman_id":"6af1f839-7845-48a3-a800-4d830ced236f"}],"id":"92434c8b-106e-4fbd-8153-3c8198e96604","_postman_id":"92434c8b-106e-4fbd-8153-3c8198e96604","description":""},{"name":"Hosted Payment","item":[{"name":"Initialize Transaction","id":"678924c7-250b-460b-b870-8dbd68c4de16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Pub-Key","value":"PUBLIC-Gl9tSYZTGAWDuR5XPD9ePe5LzHmyudji","type":"text"}],"body":{"mode":"raw","raw":"{\n \"key\": \"PUBLIC-Gl9tSYZTGAWDuR5XPD9ePe5LzHmyudji\",\n \"token\": \"UkLURlfVM1UvoD2vAsJFCvJmWiV0TJQ0\",\n \"amount\": 200,\n \"currency\": \"NGN\",\n \"feeBearer\": \"merchant\",\n \"defaultPaymentMethod\" : \"card\",\n \"paymentMethods\" : [\"transfer\", \"card\"],\n \"customer\": { \n \"name\": \"Demo Customer\", \n \"email\": \"test@test.com\" \n },\n \"containerId\": \"payment-container\",\n \"metadata\": {\n \"taxIs\": \"1234567\", \n \"customerId\": \"0000000\",\n \"redirect_url\" : \"https://google.com\" // specify this to redirect your customers after payment\n },\n \"reference\": \"hjfkdsbhjaks\"\n}"},"url":"{{base_url}}/payments/initialize","urlObject":{"path":["payments","initialize"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"678924c7-250b-460b-b870-8dbd68c4de16"}],"id":"30bcd033-03e3-4c19-9ea0-11272a92e472","description":"Sample Inline implementation
\nNOTE: To get the token value, Generate a subaccount on your sarepay dashboard.
\nSandbox Js script : \"https://uniswitch-public-assets.s3.amazonaws.com/inline.staging.min.js\"
\nLive Js script = \"https://uniswitch-public-assets.s3.amazonaws.com/inline-prod.min.js\"
\n<html>\n<body>\n<script src=\"https://uniswitch-public-assets.s3.amazonaws.com/inline-prod.min.js\"> </script><script>\nwindow.Sarepay.initialize({\n key: \"PUBLIC-C3yCwvIiNmwE9pqIR3jG3TcRuiU7\",\n token: \"lV6KiEcG2BBKWmyT1UVqYtvL7ilxp3M6\",\n amount: 7106,\n currency: \"NGN\",\n feeBearer: \"customer\",\n customer: { name: \"Demo Customer\", email: \"hlo@gmail.com\" },\n containerId: \"payment-container\",\n reference: \"customer-reference-tes110jjcccj0jjjdd0ccssss9\",\n metadata: {tester: \"Me\"},\n onClose: function () {\n console.log(\":weary:, you are gone\");\n },\n onSuccess: function (data) {\n console.log(data);\n },\n onFailed: function (data) {\n console.log(data);\n },\n});\n</script>\n</body>\n</html>\n\nDirect Debit (also called NDD – NIBSS Direct Debit) is a payment method that allows a merchant to automatically collect funds from a customer’s bank account based on an agreed schedule and frequency.
\nKey Features:
\nCustomer Authorization – The customer must authorize the debit via a mandate.
\nScheduled Transactions – Debits happen automatically according to the mandate (monthly).
\nTraceable & Reversible – All transactions are logged and auditable, mandates can be revoked by the customer.
\nSecure & Standardized – The process is regulated by NIBSS to ensure reliability across banks in Nigeria.
\nThe biller is created with NIBSS to record the merchant for Direct Debit.
\nOne merchant can have only one biller.
\nAuthentication: API key only.
\nDuplicate creation returns \"Biller already exists\"
Products define the purpose of an NDD transaction.Each product corresponds to a type of recurring payment (e.g., “Electricity Payment,” Loan repayment”)
\nA Mandate authorizes a merchant to debit a customer’s account for a specific product on a recurring schedule
\nCreated by the merchant.
\nA Mandate authorizes a merchant to debit a customer’s account for a specific product on a recurring schedule.
\nFrequency is Monthly
\nThe Mandate Status API allows merchants and systems to check the current status of a mandate. Mandates go through different states to indicate their progress from creation to authorization or rejection. Once mandate is authorized, debits occur automatically according to the frequency.
\ninitiated – Mandate created, waiting for payment authorization
authorized – Payment received and mandate approved
rejected – Mandate automatically rejected if payment is not received within 30 minutes
The Mandate List API allows merchants to retrieve all mandates received under their biller, It Fetch all mandates created under the merchant’s API key.Merchants can only see mandates associated with their API key.
\nThis endpoint allows merchants to retrieve all transactions executed under a specific mandate.
\nTransactions are triggered automatically according to the mandate’s schedule.
\nFailed transactions due to issues like insufficient funds are retried automatically.
\nMandates tied to closed accounts will not process transactions.
\nThis endpoint allows merchants to retrieve all NDD products created under their biller.
\n(Required) The customer reference
\n","type":"text/plain"},"type":"any","value":"494ABD4E-9503-4F4E-916A-5AF871E82534","key":"reference"}]}},"response":[],"_postman_id":"724fbc4e-426d-4c5b-8f9f-932128a6eb2d"}],"event":[{"listen":"prerequest","script":{"id":"d84a811f-9e44-483e-a682-9e4dff52b843","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d582551e-0273-43c1-bf23-d3f583a6039d","type":"text/javascript","exec":[""]}}],"variable":[{"key":"checkout-url","value":"https://staging-app.sarepay.com/api","type":"string"},{"key":"public-key","value":"PUBLIC-Ym9goyBwbBhCDQt1oEPtT6c45mclNuty","type":"string"},{"key":"pub-key","value":"PUBLIC-wyJXNJ8oSjBGdG9Nu4BWnm4Py8wDAMJS"}]}