The Prunny Platform APIs allows application providers leverage the Prunny platform to build mobile and web applications for their customers.
\nAll data presented here are dummy values.
\nSuggestions and comments are welcomed. To contribute or know more, kindly email support@prunny.com or visit Prunny Platform
\nWe provide multiple sandboxes that allow you to explore, develop and integrate with your applications, before progressing to test against your Prunny LIVE profile. Kindly note the following specifications:
\nAuthentication to the Prunny Platform API is performed via Bearer Authentication. Every endpoint requires authentication, so you will need to add the following header to each request:
\nAuthorization: Bearer <APIKey>
All of the API responses returned are in JSON format, with these data types defined below:
For endpoints that provide several records, the response may be paged depending on the total number of records that the server can return at a time. This means that to retrieve the full set of items for a given resource you may be required to make several requests.
\nErrors in the API are expressed as a combination of HTTP status codes and an accompanying JSON body providing required detail where possible. You should be able to rely on the HTTP status code alone to determine the cause of the problem.
\nThis would help to pass on proprietary information or additional processing directives unique to the specific implementation.
\nThe expansionFields are optional and are a collection which means multiple instances of these fields may be included in any message.
For this documentation, the expansionFields will not be included in the Response Body Fields
Find in the table below the possible response codes usually formatted as status and their respective descriptions. They follow the 8583 standards.
The time stamp (or expiration time) you use in the request must be a dateTime object, with the complete date plus hours, minutes, and seconds (for more information, see http://www.w3.org/TR/xmlschema-2/#da- teTime).\n
\nFor example: 2007-01-31T23:59:59Z .\n
Although it's not required, we recommend you provide the time stamp in the Coordinated Universal Time (Greenwich Mean Time) time zone.\nThe request automatically expires 5 minutes after the time stamp (in other words, Punny does not process a request if the request time stamp is more than 5 minutes earlier than the current time on Punny servers). Make sure your server's time is set correctly.
\n\n\nImportant\n
\n
\nIf you're using.NETyou must not send overly specific time stamps, due to different interpretations of how extra time precision should be dropped.\n
\nTo avoid overly specific time stamps, manually construct dateTime objects with no more than millisecond precision.
Punny Platform API supports idempotency for safely retrying POST transactions without accidentally performing the same operation twice. This is useful when an API call is disrupted, and you do not receive a response. For example, request_time_out or response_received_too_late. Therefore, if you do not get a response message for a transaction, you can retry the request with the same idempotency key, and you are guaranteed that no more than one transaction would be posted.
To perform an idempotent request, provide an additional Idempotency-Key: header to the request.
\nPunny Platform API idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key should return the same result, including Server (500) errors.
Idempotency keys would never expire, so a new request that is generated if a key is reused outside of that time frame would fail.
\nResults are only saved if an API endpoint started executing. If incoming parameters failed validation, or the request conflicted with another that was executing concurrently, no idempotent result is saved because no API endpoint began execution. It is safe to retry these requests.
\nAll POST requests accept idempotency keys and all transaction API calls must have idempotency keys. Sending idempotency keys in GET and DELETE requests has no effect and should be avoided, as these requests are idempotent by definition.
This endpoints retrieves a customer by customer ID
\nThis endpoints retrieves a customer by customer ID
\nThis endpoints retrieves a customer by customer ID
\nThese endpoints retrieve the customer information from a bank by specifying the customer ID or other forms of unique identifiers such as BVN, phone, and email. \nAll the endpoints return the same response payload.
\nThis endpoint is used to open an account with the bank.
\nThis endpoint gets the balance of a specified account.
\nThis endpoint is used to enable an account with the bank by setting the status to active.
\nThis endpoint is used to disable an account with the bank by setting the status to inactive.
\nSent on Sign up.I dentifies your merchant profile on Remita
\n"},{"key":"API_KEY","value":"{{apiKey}}","type":"text","description":"Sent on Sign up.Identifies your api profile on Remita
\n"},{"key":"REQUEST_ID","value":"{{requestId}}","type":"text","description":"Value uniquely identifies this request.This comes from your platform
\n"},{"key":"REQUEST_TS","value":"1778837615","type":"text","description":"For example: 2007-01-31T23:59:59Z
\n"},{"key":"API_DETAILS_HASH","value":"{{apiHash}}","type":"text","description":"Request signature is calculated using HMACSHA256(API_KEY+REQUEST_ID+API_TOKEN)
\n"}],"body":{"mode":"raw","raw":"{\n\t\"requestId\":\"RRR080917144777\",\n \"firstName\": \"Kelvin\",\n \"surname\": \"Peters\",\n \"otherName\": \"Oni\",\n \"email\": \"kelvian@email.com\",\n \"phone\": \"080917144777\",\n \"dateOfBirth\": \"13-01-1995\",\n \"customerId\": \"2234567890\",\n \"accountTypeId\": \"PERSONAL\",\n \"gender\": \"MALE\",\n \"schemeCode\": \"598\",\n \"transactionPin\": \"12345\",\n \"secretKey\": \"12345\",\n \"isRestrictedWallet\":false\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/account/open","description":"This endpoint will enable you create a new Remita Wallet account at KYC level 1 ONLY.
\nIf a profile exists on Remita the new account will be added to the profile.
\n\n\nNOTE: \n
\n
\nAll Remita wallet accounts created via this endpoint are fully compliant with the guidelines of the Central Bank of Nigeria (CBN) Know Your Customer (KYC) Requirement.
Sent on Sign up.I dentifies your merchant profile on Remita
\n","key":"MERCHANT_ID","type":"text","value":"{{merchantId}}"},{"description":"Sent on Sign up.Identifies your api profile on Remita
\n","key":"API_KEY","type":"text","value":"{{apiKey}}"},{"description":"Value uniquely identifies this request.This comes from your platform
\n","key":"REQUEST_ID","type":"text","value":"{{requestId}}"},{"description":"For example: 2007-01-31T23:59:59Z
\n","key":"REQUEST_TS","type":"text","value":"1778837615"},{"description":"Request signature is calculated using HMACSHA256(API_KEY+REQUEST_ID+API_TOKEN)
\n","key":"API_DETAILS_HASH","type":"text","value":"{{apiHash}}"}],"body":{"mode":"raw","raw":"{\n\t\"requestId\":\"0814131176111541111111116\",\n \"firstName\": \"James\",\n \"surname\": \"Peters\",\n \"otherName\": \"Oni\",\n \"email\": \"0814137116511111111111146@email.com\",\n \"phone\": \"59800000123\",\n \"dateOfBirth\": \"17-12-1980\",\n \"customerId\": \"5980000012\",\n \"accountTypeId\": \"SYSTEM\",\n \"gender\": \"MALE\",\n \"schemeCode\": \"598\",\n \"transactionPin\": \"12345\",\n \"secretKey\": \"12345\",\n \"isRestrictedWallet\":false\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/account/addNew","description":"This endpoint will enable you create a new Remita Wallet account at KYC level 1 ONLY.
\nIf a profile exists on Remita the new account will be added to the profile.
\n\n\nNOTE: \n
\n
\nAll Remita wallet accounts created via this endpoint are fully compliant with the guidelines of the Central Bank of Nigeria (CBN) Know Your Customer (KYC) Requirement.
This endpoint will enable you update the kyc details on an account.
\n\n\nNOTE: \n
\n
\nAll Remita wallet accounts created via this endpoint are fully compliant with the guidelines of the Central Bank of Nigeria (CBN) Know Your Customer (KYC) Requirement.
This endpoint will enable you update the kyc details on an account.
\n\n\nNOTE: \n
\n
\nAll Remita wallet accounts created via this endpoint are fully compliant with the guidelines of the Central Bank of Nigeria (CBN) Know Your Customer (KYC) Requirement.
This endpoint returns the customer or company name attached to the account number specified.
\nThis is particularly useful in detecting situations where the originating customer specifies a wrong beneficiary account.
\nThis endpoint will enable you update the kyc details on an account.
\n\n\nNOTE: \n
\n
\nAll Remita wallet accounts created via this endpoint are fully compliant with the guidelines of the Central Bank of Nigeria (CBN) Know Your Customer (KYC) Requirement.
This endpoint will enable you update the kyc details on an account.
\n\n\nNOTE: \n
\n
\nAll Remita wallet accounts created via this endpoint are fully compliant with the guidelines of the Central Bank of Nigeria (CBN) Know Your Customer (KYC) Requirement.
This endpoint will enable you update the kyc details on an account.
\n\n\nNOTE: \n
\n
\nAll Remita wallet accounts created via this endpoint are fully compliant with the guidelines of the Central Bank of Nigeria (CBN) Know Your Customer (KYC) Requirement.
This endpoint will enable you update the kyc details on an account.
\n\n\nNOTE: \n
\n
\nAll Remita wallet accounts created via this endpoint are fully compliant with the guidelines of the Central Bank of Nigeria (CBN) Know Your Customer (KYC) Requirement.
These endpoints retrieve account information depending on the request parameters for specific account or getting all accounts for a specific user.
\nThese endpoints support paging
This endpoint retrieves customer transactions specified by a start and end date.
\nThis endpoint supports paging
(optional) Datetime to filter transactions from in the format DDMMYYYY. Default is the earliest transaction available
(optional) Datetime to filter transactions from in the format DDMMYYYY. Default is the date of the request
This endpoint retrieves customer transactions specified by a last number of transactions.
\nThis endpoint supports paging
(optional) Number of transactions to fetch. Default is the pagesize defined by pagination
\n","type":"text/plain"},"key":"limit","value":"{{limit}}"}],"variable":[]}},"response":[{"id":"bc3ed7d1-6301-4bf8-b448-2e3512414a48","name":"Get Statement Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":" Bearer {{api-key}}","type":"text"},{"key":"Signature","value":" MD5Hash(requestRef;{{api-secret}})","type":"text"}],"url":{"raw":"/v1/transaction/{accountId}/statement?from={startDate}&to={endDate}&limit={limit}","path":["v1","transaction","{accountId}","statement"],"query":[{"key":"from","value":"{startDate}"},{"key":"to","value":"{endDate}"},{"key":"limit","value":"{limit}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"00\",\r\n \"message\": \"The process was completed successully\",\r\n \"data\": [\r\n {\r\n \"accountNumber\": \"1234567890\",\r\n \"amount\": 1000,\r\n \"currency\": \"NGN\",\r\n \"channel\": \"ATM\",\r\n \"debitOrCredit\": \"DR\",\r\n \"narration\": \"ATM Withdrawal/Karaole LANG\",\r\n \"referenceId\": \"WDS12345678909987\",\r\n \"transactionTime\": \"2019-01-02T19:58:47.1234567\",\r\n \"transactionType\": \"ATM Withdrawal\",\r\n \"valueDate\": \"2019-01-02\",\r\n \"balanceAfter\": 1200,\r\n \"expansionFields\": [\r\n {\r\n \"id\": \"Some random ID\",\r\n \"description\": \"Some random text\",\r\n \"type\": \"Some random type\",\r\n \"value\": \"Some value\"\r\n }\r\n ]\r\n }\r\n ]\r\n}\r\n"}],"_postman_id":"e00c960e-e122-4192-8d2e-a9d15f959247"},{"name":"Single Transfer within Bank","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var baseUrl = 'http://localhost:8080/remita/exapp/api/v1/wallet/services/core-banking';\r","postman.setGlobalVariable('baseUrl', baseUrl);"],"id":"d8253034-0b66-48be-b43e-04fe4231ea91"}}],"id":"db617d68-74cf-405e-93a5-42f79af5a9f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"amount\": 200,\r\n \"channel\": \"string\",\r\n \"currency\": \"NGN\",\r\n \"destinationAccount\": \"081413768683\",\r\n \"destinationAccountName\": \"Kelvin John Femi\",\r\n \"destinationNarration\": \"A sample transfer\",\r\n \"referenceId\": \"ABCD123456789012345678901139\",\r\n \"sourceAccount\": \"0000000000\",\r\n \"sourceAccountName\": \"Solomon Grundy\",\r\n \"sourceAmount\": \"200\",\r\n \"sourceCurrency\": \"NGN\",\r\n \"sourceNarration\": \"Transfer to Kelvin\",\r\n \"statusWebHook\": \"https://merchantfeedback.merchant.com/status/ABCD12345678901234567890/\"\r\n}"},"url":"{{baseUrl}}/v1/transaction/singletransfer","description":"This endpoint processes a single transfer to an account within the bank.
\nThis endpoint processes a single transfer to an account within the bank.
\nThis endpoint return the name of attached to an account number. it is useful to detect situations where the originating customer specifies a wrong beneficiary account.
\nThis endpoint processes a single interbank to an account in another bank or financial institution.
\nThis endpoints returns the status of a transaction through the reference. This endpoint is able to confirm any type of transaction.
\nThis endpoint is called to complete any transaction that requires extra authoriztion such as OTP authorization.
This endpoint holds a specified amount in a customer's account.
\nThis endpoint releases a specified amount in a customer's account that have been previously held by the SP.
\nThis endpoints returns the status of a fund held on an account through the reference.
\nThis endpoint allows the customer to directly give feedback to the bank or financial institution.
\nThis endpoint processes multiple transfer to an account within the bank.
\nThis endpoint allows the customer to directly give feedback to the bank or financial institution.
\nThese endpoints are used to get transaction data, mostly known as account statement, for customers who have authorized their accounts to be accessed by the service provider. The endpoints also support transactions such as transfer to accounts within the same bank or to other banks.
\nInterbank transfers are routed through whatever back-haul Payment Service Provider, PSP, the bank or financial institution may decide to use.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2773b2a9-065c-4a59-a4cc-adae14e719f4"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5e9ca2cf-70ec-4cbb-9d4e-904e3eccedb2"}}],"_postman_id":"0ad1defe-1221-433c-a3b0-8d09eaf0775a","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"cf64e20c-fbe2-4dae-a989-527c52f0dc06","id":"cf64e20c-fbe2-4dae-a989-527c52f0dc06","name":"Prunny Platform","type":"collection"}}}],"id":"7fa88a0f-7247-4bba-b93f-e5e754c415eb","description":"PiPex Core banking
\n","_postman_id":"7fa88a0f-7247-4bba-b93f-e5e754c415eb","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"cf64e20c-fbe2-4dae-a989-527c52f0dc06","id":"cf64e20c-fbe2-4dae-a989-527c52f0dc06","name":"Prunny Platform","type":"collection"}}},{"name":"Symphony (Billing/Invoicing)","item":[{"name":"Billers","id":"50449584-a15e-422d-a01b-6c667fd62963","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":true,"connection":true,"content-type":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Unified Billing service
\n","_postman_id":"d349e483-3829-4e6c-97a0-21f3e8b7ed6f","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"cf64e20c-fbe2-4dae-a989-527c52f0dc06","id":"cf64e20c-fbe2-4dae-a989-527c52f0dc06","name":"Prunny Platform","type":"collection"}}},{"name":"Notification API","item":[{"name":"Send Email (Non Templated)","id":"e2e478d1-6b1f-462f-bb54-85d977e73820","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"content\":\"hello\",\n \"contentType\": \"HTML\",\n \"templateCode\": \"customerProfileCreation\",\n \"subject\": \"Welcome to your new Account\",\n \"emailTos\": [{\"email\":\"Nestor@mailinator.com\"}]\n }\n","options":{"raw":{"language":"json"}}},"url":"localhost:8085/api/v1/send/email","urlObject":{"port":"8085","path":["api","v1","send","email"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"e2e478d1-6b1f-462f-bb54-85d977e73820"}],"id":"c7a106ab-08c5-4426-b4b1-a098b60e74d8","_postman_id":"c7a106ab-08c5-4426-b4b1-a098b60e74d8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"cf64e20c-fbe2-4dae-a989-527c52f0dc06","id":"cf64e20c-fbe2-4dae-a989-527c52f0dc06","name":"Prunny Platform","type":"collection"}}},{"name":"Appendix","item":[],"id":"74ce1409-f05f-4cfa-b802-8cc3a4123933","_postman_id":"74ce1409-f05f-4cfa-b802-8cc3a4123933","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"cf64e20c-fbe2-4dae-a989-527c52f0dc06","id":"cf64e20c-fbe2-4dae-a989-527c52f0dc06","name":"Prunny Platform","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"47e91582-ee28-49d5-a85a-2081c211cc08"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"91e1bd38-50cb-4ddb-8ebd-411ecbabe4c3"}}]}