This guide will provide you with a clear and user-friendly overview of the available endpoints and services for your use case.
\nEnvironments
\nThis collection provides you with a partially-configured environment, named BaseEnv. The token and referal code values are automatically set upon sending a Login request. However, the apiKey needs to be set manually. We will provide you with the specific apiKey when it is required.
Base-URLs
\nAs you consume the endpoints here, you will be interacting with URLs from different environments: Staging and Production. The distinction between these lies in the URL structure, like so:
\nProduction - agentauthapi.errandpay.com/
\nStaging - staging.agentauthapi.errandpay.com/
\nTo switch between environments, you can simply add or remove the word 'staging' in the URL.
\nIt is important to note that the variables (token, apiKey and referalCode) mentioned earlier are specific to their respective environments. In other words, staging variables will only function correctly within the staging environment, while production variables are meant for use in the production environment.
\nAPI Services Overview
\nDepending on your usecase, these services may be of interest to you:
\nFor Cashout, Bill Payments and Fund Transfers we require an endpoint to which notifications, in JSON, will be sent. The structure of these notifications is described in the POS Transaction Notifications folder.
In the event that agent account information is stored on your end, we'd require an endpoint to verify an agent's balance, PIN and account status before a transaction.
\nThe nuances are discussed in the Balance Check folder. In the event that any of the checks fail, ErrandPay will not proceed with the transaction.
This service allows you to generate unique bank account numbers for your agents. Once a customer transfers funds to the assigned bank account number, you will receive instant payment in the collections account. This streamlines reconciliation and allows you to receive payments instantly. This service is further discussed in the Virtual Account Service folder
Our KYC profiling module enables you to validate your customers' information. BVN, Account, or NIN can be used for customer validation. This service is further discussed in the KYC folder.
This is the endpoint required for getting the authentication bearer token.
\nThe loginToken is the email of the user.
There are a lot of fields in the response, but the only fields you need are the accessToken, tokenType, expiresIn and referalCode fields.
The referal code is also called the institution or business code.
\n","urlObject":{"protocol":"https","path":["api","v1","login"],"host":["staging","agentauthapi","errandpay","com"],"query":[],"variable":[]}},"response":[{"id":"0394af59-5dfd-455d-9a0d-acaeb7d16555","name":"Login Endpoint","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"loginToken\": \"janedoe.test@gmail.com\",\n \"password\": \"yEZofQbW7f!\"\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentauthapi.errandpay.com/api/v1/login"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apiVersion\": \"v1\",\n \"referenceId\": \"\",\n \"code\": \"200\",\n \"message\": \"Successful\",\n \"data\": {\n \"id\": \"e114286c-3342-4ecc-aff9-057d6d15b3cb\",\n \"firstName\": \"Test\",\n \"lastName\": \"User\",\n \"userName\": \"test.user@test.com\",\n \"email\": \"test.user@test.com\",\n \"phoneNumber\": \"+2348012345987\",\n \"status\": \"Active\",\n \"roleCode\": \"Mfb\",\n \"referalCode\": \"A90934\",\n \"userReferalCode\": \"A90934\",\n \"countryCode\": null,\n \"isPINSet\": true,\n \"isKycCompleted\": false,\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6InRlc3QudXNlckB0ZXN0LmNvbSIsIm5iZiI6MTY3MTUzMjU2NiwiZXhwIjoxNjcxNTM5NzY2LCJpYXQiOjE2NzE1MzI1NjZ9.HZgDs_JRl_m8KH4-0jkD4paw7AiQB2tDogO4M5KfX9U\",\n \"tokenType\": \"Bearer\",\n \"expiresIn\": \"2022-12-20T12:36:06.7342186Z\",\n \"refreshToken\": \"I6vf7dwOQNJsAv2s4dw+Vy7XeAr0qxFrhfTGSGlGvok=\",\n \"agentCode\": null,\n \"isEmailConfirmed\": true,\n \"isPhoneNumberConfirmed\": true,\n \"lga\": null,\n \"address\": null,\n \"state\": null,\n \"isSecurityQuestionSet\": false,\n \"isPushNotificationSet\": true,\n \"isDeviceTokenValidated\": false,\n \"isDefaultPassword\": false,\n \"tierCode\": null,\n \"isKycSentToThirdParty\": true\n },\n \"error\": {\n \"message\": null\n }\n}"}],"_postman_id":"f8f0d7da-9119-4319-b9e4-e94306e6292d"}],"id":"deb20939-9173-45a8-ae63-ffbe765a981a","_postman_id":"deb20939-9173-45a8-ae63-ffbe765a981a","description":""},{"name":"POS Transaction Notifications","item":[{"name":"CashOut Notification Body","id":"444f4395-f348-4e4f-b899-501bd4428027","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"StatusCode\": \"00\",\n \"StatusDescription\": \"Successful\",\n \"SerialNumber\": \"82912785\",\n \"Amount\": 10.00,\n \"TransactionReference\": \"384345838903\",\n \"Currency\": \"NGN\",\n \"TransactionDate\": \"07/03/2022\",\n \"TransactionTime\": \"10:44:03 AM\",\n \"TransactionType\": \"CashOut\",\n \"ServiceCode\": \"C01\",\n \"Fee\": 0.05,\n \"PostingType\": \"Cr\",\n \"AdditionalDetails\": {\n \"MaskedPAN\": \"506110xxxxxxxxx0460\",\n \"Stan\": \"838903\",\n \"CardExpiry\": \"2404\",\n \"TerminalID\": \"2033CXFD\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is a sample of the notification we send to your webhook for a cash out transaction.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"444f4395-f348-4e4f-b899-501bd4428027"},{"name":"BillPayment Notification body","id":"3982c66b-569e-4fe9-9c7c-7d0d077b3225","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"StatusCode\": \"00\",\n \"StatusDescription\": \"Approvedorcompletedsuccessfully\",\n \"SerialNumber\": \"82912785\",\n \"Amount\": 100,\n \"Fee\": 0,\n \"TransactionReference\": \"B385060290088\",\n \"Currency\": \"NGN\",\n \"TransactionDate\": \"03/15/2022\",\n \"TransactionTime\": \"17:11:29\",\n \"TransactionType\": \"BillsPayment\",\n \"PostingType\": \"Dr\",\n \"ServiceCode\": \"BAT1\",\n \"AdditionalDetails\": {\n \"BillCategory\": \"Airtime\",\n \"BillService\": \"MTN\",\n \"Beneficiary\": \"09062058992 MTN\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is a sample of the notification we send to your webhook for a bill payment transaction.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"3982c66b-569e-4fe9-9c7c-7d0d077b3225"},{"name":"FundTransfer Notification body","id":"a74c5382-0c60-445b-bf24-804d50a66a3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"StatusCode\": \"00\",\n \"StatusDescription\": \"Approvedorcompletedsuccessfully\",\n \"SerialNumber\": \"82912785\",\n \"Amount\": 120,\n \"Fee\": 10,\n \"TransactionReference\": \"T385060576806\",\n \"Currency\": \"NGN\",\n \"TransactionDate\": \"03/15/2022\",\n \"TransactionTime\": \"17:16\",\n \"TransactionType\": \"FundTransfer\",\n \"PostingType\": \"Dr\",\n \"ServiceCode\": \"FT1\",\n \"AdditionalDetails\": {\n \"DestinationAccountName\": \"Oladipupo Peter Durojaiye\",\n \"DestinationAccountNumber\": \"0775845583\",\n \"DestinationBankName\": \"Access Bank\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is a sample of the notification we send to your webhook for a fund transfer transaction.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"a74c5382-0c60-445b-bf24-804d50a66a3f"},{"name":"Purchase Notification Body","id":"ffcb7565-a480-4454-ba86-c138e5ad314d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"StatusCode\": \"00\",\r\n \"StatusDescription\": \"Successful\",\r\n \"SerialNumber\": \"82912785\",\r\n \"Amount\": 10.00,\r\n \"TransactionReference\": \"384345838903\",\r\n \"Currency\": \"NGN\",\r\n \"TransactionDate\": \"07/03/2022\",\r\n \"TransactionTime\": \"10:44:03 AM\",\r\n \"TransactionType\": \"Purchase\",\r\n \"ServiceCode\": \"PU1\",\r\n \"Fee\": 0.05,\r\n \"PostingType\": \"Cr\",\r\n \"AdditionalDetails\": {\r\n \"MaskedPAN\": \"506110xxxxxxxxx0460\",\r\n \"Stan\": \"838903\",\r\n \"CardExpiry\": \"2404\",\r\n \"TerminalID\": \"2033CXFD\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"description":"This is an example of the notification sent to your webhook for Purchase transactions.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"ffcb7565-a480-4454-ba86-c138e5ad314d"}],"id":"abd13c06-f23c-4255-afda-0d35df54475e","_postman_id":"abd13c06-f23c-4255-afda-0d35df54475e","description":""},{"name":"Balance Check","item":[{"name":"Suggested Balance Check Endpoint","id":"f8a2ef85-bd56-4fa4-bcf9-f56b7d5436e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"serial_number\": \"82912785\",\n \"pin\": \"1234\",\n \"transaction_type\": \"outward\",\n \"debitAgent\": true,\n \"serviceCode\": \"FT1\",\n \"amount\": 1234.56,\n \"reference\": \"T405679888597\"\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an example of how to structure your balance check endpoint.
\nThe specifics are up to you, but we require that we can send the serial number of the POS terminal and the pin of the agent to the endpoint, then get a response that validates the pin, and returns the balance of the agent.
\nIf you would also like to prevent agents from transacting, that is, if the agents are blocked on your system, you need to inform us in the response body of the endpoint that the agent is not allowed to transact. Hence, the \"agent_status\" field in the suggested response body.
\nAdditionally, if you also require that we confirm the status of the agent for a cashout transaction (inward), you need to modify your balance endpoint to not validate pin for cashout transactions. In that scenario, the request body would be something like this
\nREQUEST:
\n{\n \"serial_number\": \"82912785\",\n \"pin\": \"\",\n \"transaction_type\": \"inward\"\n}\n\nAnd if the response resembles this below, we would not proceed with the cashout transaction
\nRESPONSE:
\n{\n \"is_pin_valid\": true,\n \"balance\": 3000.00,\n \"agent_status\": \"InActive\"\n}\n\nBill payments and Fund transfers are outward transactions and always need pin validation. If you would also like to initiate a debit on an agent's balance for certain transactions like bill payments or fund transfers prior to when we process the transaction, you can modify your endpoint to match this request body below, with debitAgent property as a boolean. When it is true, you need to debit that agent after validating the pin. When it is false, you may or may not validate the pin, depending on whether the transaction is inward or outward.
\nEXAMPLE FUND TRANSFER REQUEST:
\n{\n \"serial_number\": \"82912785\",\n \"pin\": \"1234\",\n \"transaction_type\": \"outward\",\n \"debitAgent\": true,\n \"serviceCode\": \"FT1\",\n \"amount\": 1234.56\n}\n\nEXAMPLE BALANCE ENQUIRY REQUEST:
\n{\n \"serial_number\": \"82912785\",\n \"pin\": \"1234\",\n \"transaction_type\": \"outward\",\n \"debitAgent\": false,\n \"serviceCode\": \"BLE1\",\n \"amount\": 0\n}\n\nEXAMPLE CASHOUT AGENT REQUEST:
\n{\n \"serial_number\": \"82912785\",\n \"pin\": \"\",\n \"transaction_type\": \"inward\",\n \"debitAgent\": false,\n \"serviceCode\": \"CO1\",\n \"amount\": 0\n}\n\nOptionally, for requests, we can add a reference field, in case you are choosing to pre debit your agent and want to track the transaction with the reference.
\nEXAMPLE FUND TRANSFER REQUEST WITH REFERENCE:
\n{\n \"serial_number\": \"82912785\",\n \"pin\": \"1234\",\n \"transaction_type\": \"outward\",\n \"debitAgent\": true,\n \"serviceCode\": \"FT1\",\n \"amount\": 1234.56,\n \"reference\": \"T405679888597\"\n}\n\nThings to take note of:
transaction_type of inward indicates that whatever is added in the pin field should not be validated
debitAgent as false indicates that the agent should not be debited.
Things to take note of:
transaction_type of outward indicates that whatever is added in the pin field should definitely be validated
debitAgent as true indicates that the agent should be pre-debited, if you so wish.
Things to take note of:
transaction_type of outward indicates that whatever is added in the pin field should definitely be validated
debitAgent as true indicates that the agent should be pre-debited, if you so wish.
Things to take note of:
transaction_type of outward indicates that whatever is added in the pin field should definitely be validated
debitAgent as false indicates that the agent should not be debited.
This is a sample of the notification we send to your webhook for a cash pickup transaction.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"eb195817-7629-482f-a848-a3d1dc3855aa"}],"id":"d2c5f092-1744-4f9c-9bbe-dd2ede00591b","_postman_id":"d2c5f092-1744-4f9c-9bbe-dd2ede00591b","description":""},{"name":"Transaction Status","item":[{"name":"Check Transaction Status","id":"4ef7502b-645f-4ac1-a9b8-6a25a8695d2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://staging.agentserviceapi.errandpay.com/api/v1/GetStatus?reference=FT12345681dev&businessCode={{referalCode}}","description":"This endpoint can be used to retrieve the current status of a transaction.
\nThe request requires a bearer token from the login endpoint for authorization. It also requires the business code of the institution. This business code does not change after onboarding and is a unique identifier for the institution. From the login endpoint, the business code is value of the \"referalCode\" field.
Possible example responses below:
\nSucccessful check
\n{\n \"apiVersion\": \"v1\",\n \"referenceId\": \"\",\n \"code\": \"200\",\n \"message\": \"Successful\",\n \"data\": {\n \"status\": \"Successful\",\n \"statusCode\": \"00\"\n },\n \"error\": {\n \"message\": null\n }\n}\n\nSuccessful check, but transaction failed:
\n{\n \"apiVersion\": \"v1\",\n \"referenceId\": \"\",\n \"code\": \"200\",\n \"message\": \"Successful\",\n \"data\": {\n \"status\": \"Failed\",\n \"statusCode\": \"400\"\n },\n \"error\": {\n \"message\": null\n }\n}\n\nSuccessful check, but transaction pending:
\n{\n \"apiVersion\": \"v1\",\n \"referenceId\": \"\",\n \"code\": \"200\",\n \"message\": \"Successful\",\n \"data\": {\n \"status\": \"Pending\",\n \"statusCode\": \"200\"\n },\n \"error\": {\n \"message\": null\n }\n}\n\nAny error occurred while checking the transaction status:
\n{\n \"apiVersion\": \"v1\",\n \"referenceId\": \"\",\n \"code\": \"400\",\n \"message\": \"Unsuccessful\",\n \"data\": null,\n \"error\": {\n \"message\": \"Error message here\"\n }\n}\n\nThis is an endpoint for creating Virtual Accounts. The virtual account service allows you to generate a bank account number for the customer. From the assigned account number, you will easily get paid once the customer transfers to their given bank account number. This would streamline reconciliation and allow you to receive payment instantly.
\nIt uses the \"customerBvn\" for verification of the customer before generating an account number for the customer.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"3d7ac698-65e7-42fd-a6f7-55a2958fb8d6","id":"3d7ac698-65e7-42fd-a6f7-55a2958fb8d6","name":"Virtual Account Service","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","CreateVirtualAccount"],"host":["staging","agentserviceapi","errandpay","com"],"query":[],"variable":[]}},"response":[{"id":"c46d4fb1-5221-42ec-9d8d-a809f84315c6","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\":\"\",\n \"customerBvn\": \"\",\n \"phoneNumber\": \"\",\n \"customerName\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/CreateVirtualAccount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '10/26/2022 15:26:14'\""},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 21 Jun 2023 09:21:45 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apiVersion\": \"v1\",\n \"code\": \"200\",\n \"data\": {\n \"AccountName\": \"\",\n \"AccountNumber\": \"\",\n \"AccountOfficer\": \"\",\n \"Balance\": 0,\n \"Bvn\": \"\",\n \"CountryCode\": \"\",\n \"Currency\": \"\",\n \"Status\": \"\",\n \"ThirdPartyAccountDetail\": {\n \"AccountName\": \"\",\n \"Bank\": \"\",\n \"ThirdPartyAccountNumber\": \"\"\n },\n \"TierCode\": \"\",\n \"UserId\": \"\"\n },\n \"error\": {\n \"message\": null\n },\n \"message\": \"Successful\",\n \"referenceId\": \"\"\n}"}],"_postman_id":"67ee7b51-df51-40f3-a8c4-1b06f6890fe6"},{"name":"Get Created Accounts","id":"db96e711-f062-4a87-ba36-a650070c5ffb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://staging.agentserviceapi.errandpay.com/api/v1/GetSubAccounts?businessCode={{referalCode}}","description":"This is an endpoint for retrieving details of created Virtual Accounts.
\nThe business code is required and can be gotten from the ReferalCode field in the response of the authentication endpoint.
The business code
\n","type":"text/plain"},"key":"businessCode","value":"{{referalCode}}"}],"variable":[]}},"response":[],"_postman_id":"db96e711-f062-4a87-ba36-a650070c5ffb"},{"name":"Get Account History","id":"eac68ad8-16aa-4c0d-b479-b3e30461fbcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://staging.agentserviceapi.errandpay.com/api/v1/GetSubAccountHistory?businessCode={{referalCode}}&accountNumber&pageNumber=1&pageSize=50","description":"This is an endpoint for retrieving transaction details of created Virtual Accounts.
\nThe business code is required and can be gotten from the ReferalCode field in the response of the authentication endpoint.
The account number refers to the virtual account number whose history is to be retrieved. It is also required.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"3d7ac698-65e7-42fd-a6f7-55a2958fb8d6","id":"3d7ac698-65e7-42fd-a6f7-55a2958fb8d6","name":"Virtual Account Service","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","GetSubAccountHistory"],"host":["staging","agentserviceapi","errandpay","com"],"query":[{"description":{"content":"The value of the business code
\n","type":"text/plain"},"key":"businessCode","value":"{{referalCode}}"},{"description":{"content":"The account number to retrieve history for
\n","type":"text/plain"},"key":"accountNumber","value":null},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"50"}],"variable":[]}},"response":[],"_postman_id":"eac68ad8-16aa-4c0d-b479-b3e30461fbcf"},{"name":"VirtualAccount Credit Notification Body","id":"4746e7a4-8540-455b-9829-f6578f589644","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"StatusCode\": \"00\",\n \"StatusDescription\": \"Successful\",\n \"VirtualCustomerName\": \"Ene Paul\",\n \"VirtualCustomerAccount\": \"2619943920\",\n \"Amount\": 120,\n \"Fee\": 10,\n \"TransactionReference\": \"VAST385060576806\",\n \"Currency\": \"NGN\",\n \"TransactionDate\": \"03/15/2022\",\n \"TransactionTime\": \"17:16\",\n \"TransactionType\": \"FundWallet\",\n \"PostingType\": \"Cr\",\n \"ServiceCode\": \"VAS1\"\n}","options":{"raw":{"language":"json"}}},"url":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"3d7ac698-65e7-42fd-a6f7-55a2958fb8d6","id":"3d7ac698-65e7-42fd-a6f7-55a2958fb8d6","name":"Virtual Account Service","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"4746e7a4-8540-455b-9829-f6578f589644"}],"id":"3d7ac698-65e7-42fd-a6f7-55a2958fb8d6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"4e9506eb-272a-4987-94b6-c1de6c30f5ea","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"95750b96-97c9-41c4-b7f0-c9caf5dbdb91","type":"text/javascript","exec":[""]}}],"_postman_id":"3d7ac698-65e7-42fd-a6f7-55a2958fb8d6","description":""},{"name":"KYC","item":[{"name":"KYC check endpoint","id":"6b9dadb5-894f-436a-bcd0-7cfcedce6e4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"bearer-token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"\",\n \"kycType\": \"bvn\",\n \"token\": \"\",\n \"bankCode\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/GetKycDetails","description":"This endpoint is used to get the KYC(Know your Customer) details used to verify a customer.
\nIt takes the userId of the customer, and the type of KYC used by the customer for verification. The available KYC types are: \"BVN\", \"NIN\", and \"NUBAN\".
\nThe endpoint returns the details of the customer. Below are sample request bodies
\nGet KYC details using BVN:
\n{\n \"userId\": \"\",\n \"kycType\": \"BVN\",\n \"token\": \"\",\n \"bankCode\": null\n}\n\nGet KYC Details using NIN
\n{\n \"userId\": \"\",\n \"kycType\": \"NIN\",\n \"token\": \"\",\n \"bankCode\": null\n}\n\nGet KYC details using NUBAN
\n{\n \"userId\": \"\",\n \"kycType\": \"NUBAN\",\n \"token\": \"\",\n \"bankCode\": null\n}\n\nPass the apiKey in a header named epKey to send notifications to this endpoint. For non-BankOne businesses, use the request body below as a reference.
\nOriginatorBank - the bank making the transfer.
\nRecipientAccountNumber - The account number tied to the POS terminal. This property must have a value.
\n","urlObject":{"protocol":"https","path":["api","v1","Webhook","Notify"],"host":["staging","agentserviceapi","errandpay","com"],"query":[],"variable":[]}},"response":[{"id":"93d6ed7b-1e8c-4896-82f3-ead78ff62a59","name":"Success","originalRequest":{"method":"POST","header":[{"key":"epKey","value":"{{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Amount\": 23000.00,\r\n \"DateOfTransaction\": \"2023-03-31T13:51:26.9656662+01:00\",\r\n \"SenderAccountNumber\": \"1234500000\",\r\n \"SenderAccountName\": \"Mr Man\",\r\n \"OriginatorBank\": \"Big Bank\",\r\n \"RecipientAccountNumber\": \"0000012345\",\r\n \"RecipientAccountName\": \"Mrs Man\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/Webhook/Notify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"BillerReference\": \"6d5b78e7-14a3-4e7b-9b63-2489b7ccbc2f\"\n}"}],"_postman_id":"43b52227-e338-4ed3-841c-2f1bb56c40c7"}],"id":"16772199-0492-44d0-8fab-b46f65c23017","description":"Using the apiKey for your business, send funding notifications to ErrandPay using this endpoint.
\n","_postman_id":"16772199-0492-44d0-8fab-b46f65c23017"},{"name":"Third-Party Users","item":[{"name":"AddThirdPartyAgent","id":"91893a7d-763d-4591-9283-049e1299dee6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"epKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"User-Role","value":"SuperAgent","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Doe\",\r\n \"Email\": \"johndoe@example.com\",\r\n \"PhoneNumber\": \"+1234567890\",\r\n \"BVN\": \"1234567890\",\r\n \"Nin\": \"1234567890\",\r\n \"dateOfBirth\": \"yyyy-mm-dd\",\r\n // Optional Properties\r\n \"AccountNumber\": \"1234567890\",\r\n \"BankName\": \"Bank of America\",\r\n \"BusinessName\": \"Acme Corporation\",\r\n \"BusinessAddress\": \"123 Main Street, Anytown, USA\",\r\n \"RCNumber\": \"1234567890\",\r\n \"serialNumber\": \"00000\",\r\n \"terminalId\": \"00000\",\r\n \"businessCategory\": \"\", // Business || Individual\r\n \"agentCategory\": \"\" //AgencyBanking || Merchant\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentauthapi.errandpay.com/api/v1/AddThirdPartyAgent","description":"This API endpoint is used by partners who have their own platforms to manage agents. When an agent is onboarded on their end, the information in the model must be sent to this endpoint.
\nIt can also be used to onboard agents via API, instead of through the backoffice.
\nRequest:
\nThe request must include the following parameters:
\nmodel: The JSON body containing details about the new agent. This is a required parameter.
DateOfBirth: The agent's date of birth. Required and must be in this format: yyyy-mm-dd.
epKey: The API authentication key for the business associated with the new agent. This is a required parameter and should be passed in a header named epKey.
The following properties in the model parameter are optional and can be omitted:
AccountNumber: The agent's account number.
BankName : The bank the account number is attached to.
BusinessName: The name of the agent's business.
BusinessAddress: The address of the agent's business.
RCNumber: The RC number of the agent's business.
SerialNumber: The serial number of the POS you wish to assign.
TerminalId: The terminal ID of the POS you wish to assign. Both serialNumber and terminalId must be present to map a terminal.
These optional properties should only be provided when the agent has a custom name and address attached to their POS.
\nResponse:
\nThe response is an ApiResponse object that shows whether the operation was successful or not.
\n","urlObject":{"protocol":"https","path":["api","v1","AddThirdPartyAgent"],"host":["staging","agentauthapi","errandpay","com"],"query":[],"variable":[]}},"response":[{"id":"f9f1fc7e-51b3-4bc2-ad75-b106686d5a05","name":"Success","originalRequest":{"method":"POST","header":[{"key":"epKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"User-Role","value":"SuperAgent","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Doe\",\r\n \"Email\": \"johndoe@example.com\",\r\n \"PhoneNumber\": \"+1234567890\",\r\n \"BVN\": \"1234567890\",\r\n \"dateOfBirth\": \"yyyy-mm-dd\",\r\n // Optional Properties\r\n \"AccountNumber\": \"1234567890\",\r\n \"BankName\": \"Bank of America\",\r\n \"BusinessName\": \"Acme Corporation\",\r\n \"BusinessAddress\": \"123 Main Street, Anytown, USA\",\r\n \"RCNumber\": \"1234567890\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentauthapi.errandpay.com/api/v1/AddThirdPartyAgent"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"385"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 09 Aug 2023 10:29:43 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"apiVersion\": \"v1\",\n \"referenceId\": \"\",\n \"code\": \"200\",\n \"message\": \"Successful\",\n \"data\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"phoneNumber\": \"+1234567890\",\n \"accountNumber\": \"1234567890\",\n \"bankName\": \"Bank of America\",\n \"bvn\": \"1234567890\",\n \"businessName\": \"Acme Corporation\",\n \"businessAddress\": \"123 Main Street, Anytown, USA\",\n \"rcNumber\": \"1234567890\",\n \"dateOfBirth\": \"yyyy-mm-dd\"\n },\n \"error\": {\n \"message\": null\n }\n}"},{"id":"167ecc51-a064-4da1-8354-308fb44673c0","name":"API Key Missing","originalRequest":{"method":"POST","header":[{"key":"epKey","value":"{{apikey}}","type":"text","disabled":true},{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"User-Role","value":"SuperAgent","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Doe\",\r\n \"Email\": \"johndoe@example.com\",\r\n \"PhoneNumber\": \"+1234567890\",\r\n \"BVN\": \"1234567890\",\r\n \"dateOfBirth\": \"yyyy-mm-dd\",\r\n // Optional Properties\r\n \"AccountNumber\": \"1234567890\",\r\n \"BankName\": \"Bank of America\",\r\n \"BusinessName\": \"Acme Corporation\",\r\n \"BusinessAddress\": \"123 Main Street, Anytown, USA\",\r\n \"RCNumber\": \"1234567890\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentauthapi.errandpay.com/api/v1/AddThirdPartyAgent"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"160"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 09 Aug 2023 10:30:15 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"apiVersion\": \"v1\",\n \"referenceId\": null,\n \"code\": \"400\",\n \"message\": \"Unsuccessful\",\n \"data\": null,\n \"error\": {\n \"message\": \"Invalid API Key, the business could not be found.\"\n }\n}"}],"_postman_id":"91893a7d-763d-4591-9283-049e1299dee6"},{"name":"GetThirdpartyUserDetails","id":"08c636ef-09c1-418f-b8d9-374c3df93527","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"epKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"User-Id","value":"{{userId}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/GetThirdpartyUserInfo?email","urlObject":{"protocol":"https","path":["api","v1","GetThirdpartyUserInfo"],"host":["staging","agentserviceapi","errandpay","com"],"query":[{"key":"email","value":null}],"variable":[]}},"response":[],"_postman_id":"08c636ef-09c1-418f-b8d9-374c3df93527"}],"id":"21fef792-45cf-4549-afd1-11de501d82e8","_postman_id":"21fef792-45cf-4549-afd1-11de501d82e8","description":""},{"name":"Transaction History","item":[{"name":"GetThirdPartyTransactions","id":"4a8e9f12-add2-40bb-8996-9edee5a074bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"epKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"User-Id","value":"{{userId}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/GetThirdPartyTransactions?userId","urlObject":{"protocol":"https","path":["api","v1","GetThirdPartyTransactions"],"host":["staging","agentserviceapi","errandpay","com"],"query":[{"key":"userId","value":null}],"variable":[]}},"response":[],"_postman_id":"4a8e9f12-add2-40bb-8996-9edee5a074bd"}],"id":"72d8a206-37bc-4712-9797-3117582b8794","_postman_id":"72d8a206-37bc-4712-9797-3117582b8794","description":""},{"name":"Bills Payment","item":[{"name":"GetCategories","id":"5aab1c15-b6ce-4184-89c8-2ea10fa5368f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"epKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/bills/GetCategories?userId","urlObject":{"protocol":"https","path":["api","v1","bills","GetCategories"],"host":["staging","agentserviceapi","errandpay","com"],"query":[{"key":"userId","value":null}],"variable":[]}},"response":[],"_postman_id":"5aab1c15-b6ce-4184-89c8-2ea10fa5368f"},{"name":"GetServices","id":"7201f713-9dec-4765-8ae0-5731f634c772","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"epKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/bills/GetServices?userId=&BpCategoryCode=","urlObject":{"protocol":"https","path":["api","v1","bills","GetServices"],"host":["staging","agentserviceapi","errandpay","com"],"query":[{"key":"userId","value":""},{"key":"BpCategoryCode","value":""}],"variable":[]}},"response":[],"_postman_id":"7201f713-9dec-4765-8ae0-5731f634c772"},{"name":"Get Packages","id":"8e71f14a-144a-45b8-b8ce-7dc3d37b0e1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"epKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://staging.agentserviceapi.errandpay.com/api/v1/bills/GetPackages?userId=&BpPackageCode=","urlObject":{"protocol":"https","path":["api","v1","bills","GetPackages"],"host":["staging","agentserviceapi","errandpay","com"],"query":[{"key":"userId","value":""},{"key":"BpPackageCode","value":""}],"variable":[]}},"response":[],"_postman_id":"8e71f14a-144a-45b8-b8ce-7dc3d37b0e1a"},{"name":"PayBillsAirtime","id":"92f8b6e7-1cb6-42f3-87bf-8436a7522922","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"epKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"bpPackageCode\": \"PWQgmm\",\r\n \"userId\": \"\",\r\n \"payload\": {\r\n \"amount\": 100,\r\n \"recipient\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/bills/PayBillsAirtime","urlObject":{"protocol":"https","path":["api","v1","bills","PayBillsAirtime"],"host":["staging","agentserviceapi","errandpay","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"92f8b6e7-1cb6-42f3-87bf-8436a7522922"},{"name":"PayBillsMobileData","id":"900743b8-3656-40c9-bff6-d850f3469867","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"epKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"bpPackageCode\": \"PWQgmm\",\r\n \"userId\": \"\",\r\n \"payload\": {\r\n \"amount\": 100,\r\n \"recipient\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/bills/PayBillsMobileData","urlObject":{"protocol":"https","path":["api","v1","bills","PayBillsMobileData"],"host":["staging","agentserviceapi","errandpay","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"900743b8-3656-40c9-bff6-d850f3469867"},{"name":"PayBillsCable","id":"59e688ed-9a30-4585-8f3a-4f787600706f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"epKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"bpPackageCode\": \"string\",\r\n \"userId\": \"string\",\r\n \"payload\": {\r\n \"amount\": 100,\r\n \"smartCardNumber\": \"string\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/bills/PayBillsCable","urlObject":{"protocol":"https","path":["api","v1","bills","PayBillsCable"],"host":["staging","agentserviceapi","errandpay","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"59e688ed-9a30-4585-8f3a-4f787600706f"},{"name":"PayBillsElectricity","id":"3927e3c5-0d68-4c6d-b87b-cbc135d61885","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"epKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"bpPackageCode\": \"PWQgmm\",\r\n \"userId\": \"\",\r\n \"payload\": {\r\n \"amount\": 100,\r\n \"meter\": \"string\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/bills/PayBillsElectricity","urlObject":{"protocol":"https","path":["api","v1","bills","PayBillsElectricity"],"host":["staging","agentserviceapi","errandpay","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3927e3c5-0d68-4c6d-b87b-cbc135d61885"},{"name":"PayBillsBetting","id":"d341170c-52ed-4b4c-a510-4de1cf1ad12b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"epKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"bpPackageCode\": \"PWQgmm\",\r\n \"userId\": \"\",\r\n \"payload\": {\r\n \"amount\": 100,\r\n \"customerId\": \"string\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/bills/PayBillsBetting","urlObject":{"protocol":"https","path":["api","v1","bills","PayBillsBetting"],"host":["staging","agentserviceapi","errandpay","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d341170c-52ed-4b4c-a510-4de1cf1ad12b"}],"id":"04269f98-5f16-4ab1-a594-3bd425f1057c","_postman_id":"04269f98-5f16-4ab1-a594-3bd425f1057c","description":""},{"name":"Funds Transfer","item":[{"name":"Get Banks","id":"96fa346b-10a9-44d3-8126-a0c59dbdaa10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"epKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"User-Id","value":"{{userId}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/GetBanks","urlObject":{"protocol":"https","path":["api","v1","GetBanks"],"host":["staging","agentserviceapi","errandpay","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"96fa346b-10a9-44d3-8126-a0c59dbdaa10"},{"name":"Name Enquiry","id":"27d36d87-51b3-4406-b872-4bc888e7ffdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"EpKey","value":"{{apikey}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"AccountNumber\":\"1130230300\",\n \"InstitutionCode\":\"76\",\n \"Channel\":\"Bank\"\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/AccountNameVerification\"","urlObject":{"protocol":"https","path":["api","v1","AccountNameVerification\""],"host":["staging","agentserviceapi","errandpay","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"27d36d87-51b3-4406-b872-4bc888e7ffdd"},{"name":"Fund Transfer","id":"e895e1bf-bdd1-4906-916d-8cd3bc67414e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"EpKey","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"8cf9c1b3-e725-4bb8-be18-6ac827185f9b\",\n \"description\": \"transfer for a friend\",\n \"amount\": 82000,\n \"destinationAccountNumber\": \"1130230300\",\n \"destinationBankCode\": \"76\",\n \"destinationAccountName\": \"Recipient Account Name\",\n \"longitude\": \"3.5\",\n \"latitude\": \"1.8\",\n \"depositorPhone\": \"08012334556\"\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.agentserviceapi.errandpay.com/api/v1/InitiateExternalFundTransfer","urlObject":{"protocol":"https","path":["api","v1","InitiateExternalFundTransfer"],"host":["staging","agentserviceapi","errandpay","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e895e1bf-bdd1-4906-916d-8cd3bc67414e"},{"name":"Status Query","id":"4c5a7f7d-a0ff-4db5-8aa6-14b611a5431f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"EpKey","value":"","type":"text"}],"url":"https://staging.agentserviceapi.errandpay.com/api/v1/ApiGetTransactionDetails?reference","urlObject":{"protocol":"https","path":["api","v1","ApiGetTransactionDetails"],"host":["staging","agentserviceapi","errandpay","com"],"query":[{"key":"reference","value":null}],"variable":[]}},"response":[],"_postman_id":"4c5a7f7d-a0ff-4db5-8aa6-14b611a5431f"}],"id":"9f69f046-ba97-475f-a807-3c617b15ab65","_postman_id":"9f69f046-ba97-475f-a807-3c617b15ab65","description":""}],"event":[{"listen":"prerequest","script":{"id":"82c90176-e825-4820-bd65-82f215d1b0fc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"40aca704-e680-42c3-9fe2-a1e8a8d74dd9","type":"text/javascript","exec":[""]}}],"variable":[{"key":"bearertoken","value":"bearer-token"},{"key":"agentAuth","value":"https://api.errandpay.com/epagentauth"},{"key":"stagingAuth","value":"https://stagingapi.errandpay.com/epagentauth","type":"string"}]}