\n\nWhat is Direct Debit?
\n
Direct debit is a process by which you can automatically trigger payments from an enrolled bank account without a debit card or having the account owner do a transfer.
Consent to debit accounts is granted through a contract called a Mandate.
The Neocollect API enables you to:
\nDiscover your clients' bank accounts with various banks
\nSetup and manage paper or electronic direct debit mandates
\nDirectly Debit your customer's bank accounts at variable or scheduled intervals
\nTo charge your customers' bank accounts you have do the following:
\nAdd them as a customer using the Create Customer endpoint.
\n(Optional) Call the Account Number Discovery endpoint to discover all their bank accounts if you want to create a global mandate. This step isn't required if you already know the account(s) you wish to debit. A good use case for account discovery is lending.
\nCreate one or more mandates on the accounts you want to debit using the Create Mandate endpoint.
\nDebit the customers account(s) using the Charge Mandate endpoint
\n\n\n✋🏾Before you begin!
\n
You should create a free Neocollect account that you can test the API against. We will provide you with test keys that you can use to make API calls.
Requests to the Neocollect api are authenticated with session tokens. Every request you make to the api must include a session token passed in an X-Auth-Token header. To get your session token, you should call the Get Token endpoint with your assigned secret key and key id. You are encouraged to persist this token using a secret manager or KV store.
\n\n⚠️ KEYS MUST BE KEPT SECRET AT ALL TIMES ⚠️
\n
Please note that your key-id, secret-key and any auth tokens generated by them must be kept secret at all times. We strongly advise that you do not store these keyes in plain text.
Permissions-Based Access Control (PBAC) is used to manage access to resources. Features not included in the API resources list can only be accessed through your dashboard.
\nErrors from this api will either be in the form of a 500 - Our fault, or 4** - your fault. 4** errors will usually provide more context about the error in the message field of the response object. If the message field contains the string \"field errors\" then you may parse the \"data\" field of the response object to get even more detail about which specific field in your request object was invalid.
{\n \"message\": \"field errors\",\n \"data\": {\n \"first_name\": \"Customer's first name is required\",\n \"email\": \"This email address already belongs to an existing user\"\n }\n}\n\nA customer is an individual with one or more bank accounts which you want to be able to collect direct payments from. Customer's must have a bvn and must provide consent before you can succesfuly create mandates for them.
\nThe first step to charging users with NeoCollect is to profile them on our service. You can do this easily using the Create Customer endpoint. After succesfully adding a customer, you will be able to do an Account Number Discovery or Create Mandates for later debit.
\nYou can view all added customers using the List Customers endpoint or a specific customer using the Get Customer endpoint.
\nYou only need to add a customer once. There is no limit to the number of mandates you can create per customer.
\nAccount discovery is a process that allows you to view a list of all bank accounts you customer has as long as you know their BVN and have their consent.
\nYour customers must complete an authorization flow before this information can be provided to you. To begin, simply call the Account Discovery endpoint. The endpoint will return a url which you can pass to your customer through your application or by email. The link allows the customer to complete a 2FA process which confirms that they have given you authority to view their account numbers.
\nOnce they complete the process their account numbers will now be visible from the dashboard or in the bank_accounts field of the Get Customer response. You can now initiate electronic or paper mandate creation on one or all of the customer's bank accounts.
A mandate represents the authority a customer has given you to debit their account(s). Mandates can be authorized electronically (by transfer) or manually (by signature).
\nMandates go through three stages:
\nInitiation by you. This is when you create the mandate for the customer to authorize.
\nAuthentication by the customer: Customers can authorize mandates in two ways
\nElectronically: by doing a transfer of N50.00 from the account they want to give you authority to debit. This instantly authorizes the mandate and you can begin to debit the account within a few hours.
\nManually: by signing a paper mandate and uploading a picture of the signed mandate to our system (this can be done by api or through our dashboard by you)
\nAuthorization by the client's bank:
\nInstant for electronic mandates.
\nFor paper mandates: we immedaitely share the mandate with your customer's bank to verify the signature. If the bank takes more than three days to respond, the mandate is aoutomatically approved. When this happens, we send you a webhook notification.
\nYou can charge a mandate in two ways:
\nDirect Charge:
Use the Charge Mandate endpoint via the dashboard or API to directly debit a customer's account.
Schedules:
Automate your mandate charges by creating schedules. Using the Update Mandate endpoint, you can set up and configure charge schedules. Note that mandates can only be charged within the Start Date and End Date of the selected mandate.
Single Charge Limit:
Each mandate charge is capped at the Amount specified when the mandate was created. This amount represents the maximum that can be deducted in a single charge, not the total deductible amount. You can process charges for variable amounts and intervals, as long as they remain within the mandate’s validity period and the set limit.
Fraud Prevention:
To safeguard against fraud, any amount debited via direct debit remains in the organization's account and cannot be withdrawn for 24 hours.
The create-session endpoint is used to generate a session token for authentication. This API returns the details of an org's session auth configuration. The session token will remain valid for a short period of time.
{\n \"message\": \"Auth creation successful\",\n \"data\": {\n \"token\": \"token-string\"\n }\n}\n\nThe generated token can be used to authorize subsequent requests by including it in the X-AUTH-TOKEN header.
Request and retrieve authentication token
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"27455c65-7d8d-4eba-b86b-338cac3a4876","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"57823e22-be84-4ea0-adc1-eb1e6790e583","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"10c5d3ee-6893-442b-a614-7f01e4382e11"},{"name":"Customers","item":[{"name":"Create Customer","id":"83ef0eaa-1230-49f5-aaac-1a99fb87dc52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Auth-Token","value":""},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n //\"first_name\": \"thomas\",\n \"last_name\": \"jerry\",\n \"address\": {\n \"street\": \"99, Sam magbagbeolu crecent\",\n \"town\": \"Akowonjo\",\n \"state\": \"Lagos\"\n },\n \"phone_number\": \"081144756\", // 02\n \"email\": \"tcat5@wb.com\",\n \"bvn\": \"11122244156\"\n}","options":{"raw":{"language":"json"}}},"url":"/customer","description":"Create a new customer. This customer shall be added to a company and can only be managed by an authorixed person in the company
\nThis endpoint retrieves customer information based on the ID provided.
\n","urlObject":{"path":["customer",":id"],"host":[""],"query":[],"variable":[{"id":"b5e329b9-d5f6-4117-9fab-c9913f5ef4be","description":{"content":"required
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"64019107-1ce3-4621-9a8a-584069b6aac4","name":"200","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Token","value":""}],"url":{"raw":"/customer/:id","host":[""],"path":["customer",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"dksdujsw-323-frs\",\n \"first_name\": \"Jennifer\",\n \"last_name\": \"Garner\",\n \"phone\": \"+2348103236508\",\n \"email\": \"omfals@api.co\",\n \"bank_accounts\": [\n {\n \"bank\": \"Wema Bank\",\n \"bank_code\": \"013\",\n \"nuban\": \"9023224475\",\n \"ref\": \"unique_ne_ref\"\n }\n ]\n}"}],"_postman_id":"7a666e42-df51-4a9f-9d5a-180f9329687b"},{"name":"List Customers","id":"41ce1008-0217-46e6-b78c-e6741c6e0d55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Token","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"/customer","description":"This endpoint retrieves a paginated list of all the customers in a company
\n","urlObject":{"path":["customer"],"host":[""],"query":[{"disabled":true,"description":{"content":"Maximum results per page (if empty all results will be returned)
\n","type":"text/plain"},"key":"rpp","value":"number"},{"disabled":true,"description":{"content":"Page to return (ignored if rpp is empty or 0)
\n","type":"text/plain"},"key":"p","value":"number"}],"variable":[]}},"response":[{"id":"59b9fbdf-c768-48c6-b245-e23632766659","name":"200","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Token","value":""}],"url":{"raw":"/customer?rpp=50&p=1","host":[""],"path":["customer"],"query":[{"key":"rpp","value":"50","description":"maximum results per page"},{"key":"p","value":"1","description":"page to return"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"pagination\": {\n \"results\": 384,\n \"results_per_page\": 94,\n \"total_pages\": 5,\n \"returned_page\": 3\n },\n \"data\": [\n {\n \"id\": \"dksdujsw-323-frs\",\n \"first_name\": \"Jennifer\",\n \"last_name\": \"Garner\",\n \"phone\": \"+2348103236508\",\n \"email\": \"omfals@api.co\"\n }\n ]\n}"}],"_postman_id":"41ce1008-0217-46e6-b78c-e6741c6e0d55"},{"name":"Get Bank Account Query Consent","id":"5a573fe0-a9e9-41a8-90ac-379b677eb3f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Token","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"/customer/:id/icad","description":"This endpoint generates a link to a consent flow which your customer must complete before you can get access to all their bank accounts.
\nNeocollect will also send the link with instructions to your customer's registered phone number.
\n","urlObject":{"path":["customer",":id","icad"],"host":[""],"query":[],"variable":[{"id":"a3e1a65d-f7c8-4e3b-be69-e47ac04a874e","description":{"content":"required
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6fe52a73-40cc-4300-a754-68681793b42c","name":"200","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Token","value":""}],"url":{"raw":"/customer/:id/icad","host":[""],"path":["customer",":id","icad"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"customer consent requested\",\n \"data\": {\n \"consent_url\": \"https://www.dsdscdsc.sdcsdc.dc\"\n }\n}"}],"_postman_id":"5a573fe0-a9e9-41a8-90ac-379b677eb3f3"}],"id":"c201af78-47b1-480d-b2ff-3d3c7942b63f","description":"Create and manage customer profile.
\n","event":[{"listen":"prerequest","script":{"id":"6dc61f96-d161-4e77-bc9a-8bcdd5fc941b","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"cb2bf2a7-c8c1-4c4a-ad23-4f32bea44356","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"c201af78-47b1-480d-b2ff-3d3c7942b63f"},{"name":"Mandates","item":[{"name":"Schedules","item":[{"name":"List Schedules","id":"1fca0e33-84f3-4044-8731-fd04e791f50a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.neocollect.ng/test/mandate-schedules/:mandateId","urlObject":{"path":["mandate-schedules",":mandateId"],"host":["https://api.neocollect.ng/test"],"query":[],"variable":[{"type":"any","value":"mandate-id","key":"mandateId"}]}},"response":[{"id":"6e1fdb69-ff01-4a73-a88d-0b7431f6b826","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.neocollect.ng/test/mandate-schedules/:mandateId","host":["https://api.neocollect.ng/test"],"path":["mandate-schedules",":mandateId"],"variable":[{"key":"mandateId","value":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, X-Auth-Token, ngrok-skip-browser-warning"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS, GET, PUT, PATCH, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 27 Nov 2024 08:34:29 GMT"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"id\": \"ORGPDChUKNqMkshSQbfJEZUYG\",\n \"mandate_id\": \"4fdb0d7f-b6c1-40f3-9bf8-bd21b9d03e8e\",\n \"date\": \"2254-02-23T23:52:22.337433185+01:00\",\n \"amount\": 2700,\n \"retry_on_fail\": true,\n \"narration\": \"Sapiente dolore et omnis doloremque ullam.\",\n \"executed\": false\n },\n {\n \"id\": \"ZZlWUxxygVwXDfitcUrXujVaU\",\n \"mandate_id\": \"1de0ceb7-2c3f-49e2-9462-78c29a135fa1\",\n \"date\": \"2060-08-26T16:44:17.696443059+01:00\",\n \"amount\": 4300,\n \"retry_on_fail\": false,\n \"narration\": \"Amet voluptatem beatae sed aut sed.\",\n \"executed\": true\n },\n {\n \"id\": \"UIxesOtxkFnCuPcGSAMbHeTkL\",\n \"mandate_id\": \"7e1e8cbe-5941-4ec3-9ecc-281086c2aff4\",\n \"date\": \"2124-06-23T11:39:34.160997213+01:00\",\n \"amount\": 7200,\n \"retry_on_fail\": true,\n \"narration\": \"Hic voluptatem aut voluptatem labore quis.\",\n \"executed\": false\n },\n {\n \"id\": \"WukVOmGBWdeEFQtUdgByYTqGQ\",\n \"mandate_id\": \"81d0a97d-6fb8-40df-bbab-fcdc3fffeb5c\",\n \"date\": \"2059-10-10T09:40:43.893598215+01:00\",\n \"amount\": 7100,\n \"retry_on_fail\": true,\n \"narration\": \"Ratione quis culpa aut autem dolor.\",\n \"executed\": true\n },\n {\n \"id\": \"fMpvKvggclxXIVpeTflwXaYLg\",\n \"mandate_id\": \"aa138017-bfac-4473-8fd2-c44ef87f60e9\",\n \"date\": \"2089-06-07T17:14:48.943570189+01:00\",\n \"amount\": 8700,\n \"retry_on_fail\": true,\n \"narration\": \"Sapiente autem sint voluptatem est molestiae.\",\n \"executed\": false\n },\n {\n \"id\": \"yJUNwCyjQTYFiCKMUqMPddWxW\",\n \"mandate_id\": \"f09d9fbc-d472-448d-9199-d251511bc8b2\",\n \"date\": \"2282-03-24T18:32:30.474273329+01:00\",\n \"amount\": 6300,\n \"retry_on_fail\": true,\n \"narration\": \"Itaque distinctio deserunt est voluptatem perspiciatis.\",\n \"executed\": false\n },\n {\n \"id\": \"wJnscFoWYIhBoVSiVgRhRlkmh\",\n \"mandate_id\": \"fde723ef-41b6-43b6-a735-5149473ae242\",\n \"date\": \"2201-09-13T23:25:45.286925339+01:00\",\n \"amount\": 3300,\n \"retry_on_fail\": true,\n \"narration\": \"Deleniti et enim est autem quas.\",\n \"executed\": true\n },\n {\n \"id\": \"nwGRwdhDRdTvpQVwuNiZeJtHw\",\n \"mandate_id\": \"b4dab563-e1b4-4f92-a2d2-b88d91830bab\",\n \"date\": \"2236-12-26T20:54:11.203072095+01:00\",\n \"amount\": 0,\n \"retry_on_fail\": false,\n \"narration\": \"Soluta voluptas quia animi tempore tenetur.\",\n \"executed\": true\n },\n {\n \"id\": \"BsrKvelddXReMpYlEFHDjPvyt\",\n \"mandate_id\": \"2e7c50f3-42b4-4bfc-a1d5-2b7acb1b3231\",\n \"date\": \"2083-02-22T12:04:13.378098282+01:00\",\n \"amount\": 4800,\n \"retry_on_fail\": true,\n \"narration\": \"Laboriosam magni porro consequatur voluptatem inventore.\",\n \"executed\": true\n },\n {\n \"id\": \"SLafmaPkLhlktTyNqGKTkipSL\",\n \"mandate_id\": \"e2a3591a-7505-43fc-8e40-d9b89e54c156\",\n \"date\": \"2059-04-12T23:00:22.179522366+01:00\",\n \"amount\": 9800,\n \"retry_on_fail\": true,\n \"narration\": \"Dolor ipsam odio ut molestiae consequuntur.\",\n \"executed\": false\n },\n {\n \"id\": \"VbwenGvRRwBdBWqOIkofFhHwO\",\n \"mandate_id\": \"cf9d293f-4cfd-448c-b1fc-217877d2a059\",\n \"date\": \"2272-06-06T21:28:11.923166313+01:00\",\n \"amount\": 9900,\n \"retry_on_fail\": true,\n \"narration\": \"Harum ea voluptatem totam vel et.\",\n \"executed\": true\n },\n {\n \"id\": \"cQYhOhNmfsuQRCxvXfBTSUbQg\",\n \"mandate_id\": \"38bae3fb-f0de-4386-830e-55dd29a6e8ee\",\n \"date\": \"2077-09-07T16:21:49.332586002+01:00\",\n \"amount\": 5200,\n \"retry_on_fail\": false,\n \"narration\": \"Tempore et alias asperiores architecto inventore.\",\n \"executed\": true\n },\n {\n \"id\": \"tcVPfxvBdxgtrlbwDJWZxrjhU\",\n \"mandate_id\": \"e667d120-f8b1-4064-9c0e-1d0361632527\",\n \"date\": \"2220-12-23T09:39:36.478950387+01:00\",\n \"amount\": 4800,\n \"retry_on_fail\": true,\n \"narration\": \"Commodi ullam eum et consequuntur aut.\",\n \"executed\": false\n },\n {\n \"id\": \"IruMTquJAylqPBQULGIammllJ\",\n \"mandate_id\": \"e162d1b0-4541-4c0f-a8e1-59aa1587802b\",\n \"date\": \"2260-02-27T13:01:41.878937093+01:00\",\n \"amount\": 5500,\n \"retry_on_fail\": false,\n \"narration\": \"Adipisci ut hic voluptatum commodi dolor.\",\n \"executed\": false\n },\n {\n \"id\": \"jwsVvgTbEOPsAtuEhuDEitssy\",\n \"mandate_id\": \"8ff5de96-e0fb-427e-abc9-257bc609ef37\",\n \"date\": \"2204-04-26T14:49:26.485552968+01:00\",\n \"amount\": 5700,\n \"retry_on_fail\": false,\n \"narration\": \"Iusto ullam occaecati veniam saepe nihil.\",\n \"executed\": true\n }\n ]\n}"},{"id":"98c340e0-c9b9-4548-8890-bd7f974f1f16","name":"400","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.neocollect.ng/test/mandate-schedules/:mandateId","host":["https://api.neocollect.ng/test"],"path":["mandate-schedules",":mandateId"],"variable":[{"key":"mandateId","value":"mandate-id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, X-Auth-Token, ngrok-skip-browser-warning"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS, GET, PUT, PATCH, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 27 Nov 2024 10:10:12 GMT"},{"key":"Content-Length","value":"49"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"message\": \"No mandate id specified\"\n}"}],"_postman_id":"1fca0e33-84f3-4044-8731-fd04e791f50a"},{"name":"Create Schedules","id":"50be8be5-897b-428d-b173-9fe33b4e3079","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"ORGPDChUKNqMkshSQbfJEZUYG\",\n \"mandate_id\": \"4fdb0d7f-b6c1-40f3-9bf8-bd21b9d03e8e\",\n \"date\": \"2254-02-23T23:52:22.337433185+01:00\",\n \"amount\": 2700,\n \"retry_on_fail\": true,\n \"narration\": \"Sapiente dolore et omnis doloremque ullam.\",\n \"executed\": false\n }","options":{"raw":{"language":"json"}}},"url":"https://api.neocollect.ng/test/mandate-schedules/:mandateId","urlObject":{"path":["mandate-schedules",":mandateId"],"host":["https://api.neocollect.ng/test"],"query":[],"variable":[{"type":"any","value":"","key":"mandateId"}]}},"response":[{"id":"4242e990-78d8-4793-a330-3f64e9160873","name":"400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.neocollect.ng/test/mandate-schedules/:mandateId","host":["https://api.neocollect.ng/test"],"path":["mandate-schedules",":mandateId"],"variable":[{"key":"mandateId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, X-Auth-Token, ngrok-skip-browser-warning"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS, GET, PUT, PATCH, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 27 Nov 2024 10:11:49 GMT"},{"key":"Content-Length","value":"71"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"schedules\": \"schedules is required\"\n },\n \"message\": \"field errors\"\n}"},{"id":"816232f1-d911-40c4-93eb-a2cddef9fe29","name":"400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"schedules\": [\n {\n \"id\": \"ORGPDChUKNqMkshSQbfJEZUYG\",\n \"mandate_id\": \"\",\n \"date\": \"2254-02-23T23:52:22.337433185+01:00\",\n \"amount\": 2700,\n \"retry_on_fail\": true,\n \"narration\": \"Sapiente dolore et omnis doloremque ullam.\",\n \"executed\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.neocollect.ng/test/mandate-schedules/:mandateId","host":["https://api.neocollect.ng/test"],"path":["mandate-schedules",":mandateId"],"variable":[{"key":"mandateId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, X-Auth-Token, ngrok-skip-browser-warning"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS, GET, PUT, PATCH, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 27 Nov 2024 10:12:26 GMT"},{"key":"Content-Length","value":"73"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"mandate_id\": \"mandate_id is required\"\n },\n \"message\": \"field errors\"\n}"},{"id":"cec27777-ebc7-4656-bb5b-fc0d6174685e","name":"201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"schedules\": [\n {\n \"id\": \"ORGPDChUKNqMkshSQbfJEZUYG\",\n \"mandate_id\": \"4fdb0d7f-b6c1-40f3-9bf8-bd21b9d03e8e\",\n \"date\": \"2254-02-23T23:52:22.337433185+01:00\",\n \"amount\": 2700,\n \"retry_on_fail\": true,\n \"narration\": \"Sapiente dolore et omnis doloremque ullam.\",\n \"executed\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.neocollect.ng/test/mandate-schedules/:mandateId","host":["https://api.neocollect.ng/test"],"path":["mandate-schedules",":mandateId"],"variable":[{"key":"mandateId","value":""}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, X-Auth-Token, ngrok-skip-browser-warning"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS, GET, PUT, PATCH, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 27 Nov 2024 10:13:02 GMT"},{"key":"Content-Length","value":"21"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"}],"_postman_id":"50be8be5-897b-428d-b173-9fe33b4e3079"},{"name":"Update Schedules","id":"fedff2cd-e2ce-44df-a1d1-65feae071390","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"ORGPDChUKNqMkshSQbfJEZUYG\",\n \"mandate_id\": \"4fdb0d7f-b6c1-40f3-9bf8-bd21b9d03e8e\",\n \"date\": \"2254-02-23T23:52:22.337433185+01:00\",\n \"amount\": 2700,\n \"retry_on_fail\": true,\n \"narration\": \"Sapiente dolore et omnis doloremque ullam.\",\n \"executed\": false\n }","options":{"raw":{"language":"json"}}},"url":"https://api.neocollect.ng/test/mandate-schedules","urlObject":{"path":["mandate-schedules"],"host":["https://api.neocollect.ng/test"],"query":[],"variable":[]}},"response":[{"id":"4246916f-0bcd-4557-a2f1-1a79a0811c85","name":"201","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"ORGPDChUKNqMkshSQbfJEZUYG\",\n \"mandate_id\": \"4fdb0d7f-b6c1-40f3-9bf8-bd21b9d03e8e\",\n \"date\": \"2254-02-23T23:52:22.337433185+01:00\",\n \"amount\": 2700,\n \"retry_on_fail\": true,\n \"narration\": \"Sapiente dolore et omnis doloremque ullam.\",\n \"executed\": false\n }","options":{"raw":{"language":"json"}}},"url":"https://api.neocollect.ng/test/mandate-schedules"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, X-Auth-Token, ngrok-skip-browser-warning"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS, GET, PUT, PATCH, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 27 Nov 2024 10:19:56 GMT"},{"key":"Content-Length","value":"21"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"},{"id":"9aa8a6c1-b8a1-4856-a2af-80cb2d8019b1","name":"400","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"ORGPDChUKNqMkshSQbfJEZUYG\",\n \"date\": \"2254-02-23T23:52:22.337433185+01:00\",\n \"amount\": 2700,\n \"retry_on_fail\": true,\n \"narration\": \"Sapiente dolore et omnis doloremque ullam.\",\n \"executed\": false\n }","options":{"raw":{"language":"json"}}},"url":"https://api.neocollect.ng/test/mandate-schedules"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, X-Auth-Token, ngrok-skip-browser-warning"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS, GET, PUT, PATCH, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 27 Nov 2024 10:20:31 GMT"},{"key":"Content-Length","value":"73"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"mandate_id\": \"mandate_id is required\"\n },\n \"message\": \"field errors\"\n}"}],"_postman_id":"fedff2cd-e2ce-44df-a1d1-65feae071390"},{"name":"Delete Schedule","id":"b9f2e6af-3900-4e3e-a0f1-3e6257a013e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"ORGPDChUKNqMkshSQbfJEZUYG\",\n \"mandate_id\": \"4fdb0d7f-b6c1-40f3-9bf8-bd21b9d03e8e\",\n \"date\": \"2254-02-23T23:52:22.337433185+01:00\",\n \"amount\": 2700,\n \"retry_on_fail\": true,\n \"narration\": \"Sapiente dolore et omnis doloremque ullam.\",\n \"executed\": false\n }","options":{"raw":{"language":"json"}}},"url":"https://api.neocollect.ng/test/mandate-schedules","urlObject":{"path":["mandate-schedules"],"host":["https://api.neocollect.ng/test"],"query":[],"variable":[]}},"response":[{"id":"891a8160-9568-43b4-885d-2167f2c10099","name":"403 - Forbidden","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.neocollect.ng/test/mandate-schedules/:id","host":["https://api.neocollect.ng/test"],"path":["mandate-schedules",":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, X-Auth-Token, ngrok-skip-browser-warning"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS, GET, PUT, PATCH, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 27 Nov 2024 10:23:13 GMT"},{"key":"Content-Length","value":"120"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"message\": \"You do not have permission to update mandate schedules. Please speak to your admin about this.\"\n}"},{"id":"d6d196ff-9b22-4262-b7a8-0e6bff05c23b","name":"404 - Not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.neocollect.ng/test/mandate-schedules/:id","host":["https://api.neocollect.ng/test"],"path":["mandate-schedules",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, X-Auth-Token, ngrok-skip-browser-warning"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS, GET, PUT, PATCH, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 27 Nov 2024 10:25:55 GMT"},{"key":"Content-Length","value":"44"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"message\": \"Schedule not found\"\n}"},{"id":"361f8144-50c1-46a9-a3e4-dc8824752f66","name":"200 - Success","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.neocollect.ng/test/mandate-schedules/:id","host":["https://api.neocollect.ng/test"],"path":["mandate-schedules",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, X-Auth-Token, ngrok-skip-browser-warning"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS, GET, PUT, PATCH, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 27 Nov 2024 10:27:23 GMT"},{"key":"Content-Length","value":"21"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"}],"_postman_id":"b9f2e6af-3900-4e3e-a0f1-3e6257a013e8"}],"id":"b1ed20ae-a5c0-4ff3-b078-bf9d0819273a","_postman_id":"b1ed20ae-a5c0-4ff3-b078-bf9d0819273a","description":""},{"name":"Name Enquiry","id":"451e9876-25f1-4eb0-9639-26b6546088e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-auth-token","value":"","type":"text"}],"url":"/name-enquiry?bank-code=number&nuban=number","description":"Comfirm the name of the customer by running a name query request. This is required to ensure the correctness and accuracy of the information provided.
\n","urlObject":{"path":["name-enquiry"],"host":[""],"query":[{"description":{"content":"required
\n","type":"text/plain"},"key":"bank-code","value":"number"},{"description":{"content":"required
\n","type":"text/plain"},"key":"nuban","value":"number"}],"variable":[]}},"response":[{"id":"14689adb-ec8c-498b-9151-ecf9bff51132","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/name-enquiry?bank-code=013&nuban=0192283322","host":[""],"path":["name-enquiry"],"query":[{"key":"bank-code","value":"013"},{"key":"nuban","value":"0192283322"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": {\n \"bank_code\": \"013\",\n \"nuban\": \"0192283322\",\n \"account_name\": \"THOMAS OLUWOLE JEFFERSSON\",\n \"ref\": \"ne-ref-232-\"\n }\n}"},{"id":"7b47b41f-1404-4d9b-bc2b-f1e7c147d4d5","name":"400","originalRequest":{"method":"GET","header":[],"url":{"raw":"/name-enquiry?bank-code=013&nuban=0192283322","host":[""],"path":["name-enquiry"],"query":[{"key":"bank-code","value":"013"},{"key":"nuban","value":"0192283322"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid account number\"\n}"}],"_postman_id":"451e9876-25f1-4eb0-9639-26b6546088e9"},{"name":"Create Mandates","id":"6998968b-3942-4eab-9cd9-048d009678a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Auth-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"mandates\": [\n {\n \"ref\": \"sdsadkhdsd_sdsdsd\",\n \"customer_id\": \"3806e504-2959-4408-83fd-4fccaae1656a\",\n \"amount\": 5900000,\n \"start_date\": \"2025-07-12T15:04:05Z07:00\",\n \"end_date\": \"2026-08-12T15:04:05Z07:00\",\n // \"name_enquiry_ref\": \"540724143536367482826660\",\n \"purpose\": \"monthly subscription\",\n \"auth_type\": \"transfer-auth\" // transfer-auth, sig-auth\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.neocollect.ng/test/mandate?auth_type=sig-auth","description":"Add mandate to customer account.
\ntransfer-auth, sig-auth
\n","type":"text/plain"},"key":"auth_type","value":"sig-auth"}],"variable":[]}},"response":[{"id":"c28d1f41-4649-4ba8-8ee1-3ba48b846669","name":"207","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"mandates\": [\n {\n \"customer_id\": \"dsdsds\",\n \"amount\": 5900000,\n \"start_date\": \"01/01/2024\",\n \"end_date\": \"01/01/2025\",\n \"bank_code\": \"0913\",\n \"name_enquiry_ref\": \"unadsgd-s24f-ds\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/mandate"},"status":"Multi-Status (WebDAV) (RFC 4918)","code":207,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"partial success\",\n \"data\": {\n \"mandates\": [\n {\n \"customer_id\": \"dsdsds\",\n \"amount\": 5900000,\n \"start_date\": \"01/01/2024\",\n \"end_date\": \"01/01/2025\",\n \"bank_code\": \"0913\",\n \"name_enquiry_ref\": \"unadsgd-s24f-ds\",\n \"mandate_id\": \"dsjksfjdafsdfdsca\",\n \"status\": \"success\",\n \"message\": \"Please transfer N50.00 to Titan Trust Bank: 9182127423 from your GTB 01212121 account\",\n \"auth_details\": {\n \"amount\": 5000,\n \"nuban\": \"039393842\",\n \"bank_name\": \"Titan Trust Bank\"\n }\n },\n {\n \"customer_id\": \"dsdsds\",\n \"amount\": 5900000,\n \"start_date\": \"01/01/2024\",\n \"end_date\": \"01/01/2025\",\n \"bank_code\": \"0913\",\n \"name_enquiry_ref\": \"unadsgd-s24f-ds\",\n \"mandate_id\": \"dsjksfjdafsdfdsca\",\n \"status\": \"failed\",\n \"message\": \"This bank doesn't allow mandates\",\n \"auth_details\": {\n \"amount\": 5000,\n \"nuban\": \"039393842\",\n \"bank_name\": \"Titan Trust Bank\"\n }\n }\n ]\n }\n}"},{"id":"c64252fc-1fde-4635-b528-763bd6856697","name":"Create Mandates - Failed with message","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"mandates\": [\n {\n \"ref\": \"540724143536367482826660\",\n \"customer_id\": \"dsdsds\",\n \"amount\": 5900000,\n \"start_date\": \"01/01/2024\",\n \"end_date\": \"01/01/2025\",\n \"name_enquiry_ref\": \"unadsgd-s24f-ds\",\n \"purpose\": \"monthly subscription\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/mandate"},"status":"Multi-Status","code":207,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 24 Jul 2024 13:58:17 GMT"},{"key":"Content-Length","value":"231"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"partial success\",\n \"data\": {\n \"mandates\": [\n {\n \"mandate_id\": \"\",\n \"customer_id\": \"\",\n \"bank_code\": \"\",\n \"amount\": 0,\n \"start_date\": \"0001-01-01T00:00:00Z\",\n \"end_date\": \"0001-01-01T00:00:00Z\",\n \"status\": \"failed\",\n \"message\": \"customer not found\"\n }\n ]\n }\n}"},{"id":"e3a86418-ee12-4823-b647-3bbe9795d798","name":"Create Mandates - 200 success","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"mandates\": [\n {\n \"ref\": \"sdsadkhdsd\",\n \"customer_id\": \"0711b6e5-9764-4631-9299-3fac839e60c1\",\n \"amount\": 5900000,\n \"start_date\": \"20240101\",\n \"end_date\": \"20250101\",\n \"name_enquiry_ref\": \"540724143536367482826660\",\n \"purpose\": \"monthly subscription\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/mandate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 24 Jul 2024 14:23:07 GMT"},{"key":"Content-Length","value":"325"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": {\n \"mandates\": [\n {\n \"mandate_id\": \"2f84f34d-f49c-44f5-9e98-70bd909dfa67\",\n \"customer_id\": \"0711b6e5-9764-4631-9299-3fac839e60c1\",\n \"bank_code\": \"033\",\n \"amount\": 5900000,\n \"start_date\": \"2024-01-01T00:00:00Z\",\n \"end_date\": \"2025-01-01T00:00:00Z\",\n \"status\": \"authorization-needed\",\n \"message\": \"Mock response description\"\n }\n ]\n }\n}"},{"id":"46b1c1ef-83a6-40d7-bd68-0b75fd092cf6","name":"Create Mandates - 400","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"mandates\": [\n {\n \"ref\": \"sdsadkhdsd\",\n \"customer_id\": \"0711b6e5-9764-4631-9299-3fac839e60c1\",\n \"amount\": 5900000,\n \"start_date\": \"2025-01-02T15:04:05Z\",\n \"end_date\": \"2026-01-02T15:04:05Z\",\n \"name_enquiry_ref\": \"540724143536367482826660\",\n \"purpose\": \"monthly subscription\",\n \"auth_type\": \"transfer-auth\" // transfer-auth\n },\n {\n \"ref\": \"sdsadkhdsdlklk\",\n \"customer_id\": \"0711b6e5-9764-4631-9299-3fac839e60c1\",\n \"amount\": 5900000,\n \"start_date\": \"2025-01-02T15:04:05Z\",\n \"end_date\": \"2026-01-02T15:04:05Z\",\n \"name_enquiry_ref\": \"540724143536367482826660\",\n \"purpose\": \"monthly subscription\",\n \"auth_type\": \"transfer-auth\" // transfer-auth\n },\n {\n \"ref\": \"sdsadkhdsdkl\",\n \"customer_id\": \"0711b6e5-9764-4631-9299-3fac839e60c1\",\n \"amount\": 5900000,\n \"start_date\": \"2025-01-02T15:04:05Z\",\n \"end_date\": \"2026-01-02T15:04:05Z\",\n \"name_enquiry_ref\": \"540724143536367482826660\",\n \"purpose\": \"monthly subscription\",\n \"auth_type\": \"transfer-auth\" // transfer-auth\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.neocollect.ng/test/mandate?auth_type=sig-auth","host":["https://api.neocollect.ng/test"],"path":["mandate"],"query":[{"key":"auth_type","value":"sig-auth","description":"transfer-auth, sig-auth"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, X-Auth-Token, ngrok-skip-browser-warning"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS, GET, PUT, PATCH, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 26 Nov 2024 13:02:27 GMT"},{"key":"Content-Length","value":"96"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"message\": \"Sorry, you can only assign 1 customer to global mandates at this time.\"\n}"},{"id":"7314fa5b-79ef-46e6-a1bc-3738f49948d4","name":"Create Mandates - Partial Success","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"mandates\": [\n {\n \"ref\": \"sdsadkhdsd\",\n \"customer_id\": \"0711b6e5-9764-4631-9299-3fac839e60c1\",\n \"amount\": 5900000,\n \"start_date\": \"2025-01-02T15:04:05Z\",\n \"end_date\": \"2026-01-02T15:04:05Z\",\n \"name_enquiry_ref\": \"540724143536367482826660\",\n \"purpose\": \"monthly subscription\",\n \"auth_type\": \"transfer-auth\" // transfer-auth\n },\n {\n \"ref\": \"sdsadkhdsdlklk\",\n \"customer_id\": \"0711b6e5-9764-4631-9299-3fac839e60c1\",\n \"amount\": 5900000,\n \"start_date\": \"2025-01-02T15:04:05Z\",\n \"end_date\": \"2026-01-02T15:04:05Z\",\n \"name_enquiry_ref\": \"540724143536367482826660\",\n \"purpose\": \"monthly subscription\",\n \"auth_type\": \"transfer-auth\" // transfer-auth\n },\n {\n \"ref\": \"sdsadkhdsdkl\",\n \"customer_id\": \"0711b6e5-9764-4631-9299-3fac839e60c1\",\n \"amount\": 5900000,\n \"start_date\": \"2025-01-02T15:04:05Z\",\n \"end_date\": \"2026-01-02T15:04:05Z\",\n \"name_enquiry_ref\": \"540724143536367482826660\",\n \"purpose\": \"monthly subscription\",\n \"auth_type\": \"transfer-auth\" // transfer-auth\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.neocollect.ng/test/mandate?auth_type=transfer-auth","host":["https://api.neocollect.ng/test"],"path":["mandate"],"query":[{"key":"auth_type","value":"transfer-auth","description":"transfer-auth, sig-auth"}]}},"status":"Multi-Status","code":207,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, X-Auth-Token, ngrok-skip-browser-warning"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS, GET, PUT, PATCH, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 26 Nov 2024 14:28:14 GMT"},{"key":"Content-Length","value":"1477"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"partial success\",\n \"data\": {\n \"mandates\": [\n {\n \"mandate_id\": \"e42274dd-a222-4bb1-b932-2bf7b13956bb\",\n \"batch_id\": null,\n \"signing_doc_url\": null,\n \"product_id\": \"521\",\n \"customer_id\": \"0711b6e5-9764-4631-9299-3fac839e60c1\",\n \"customer_name\": \"Dr. Myah Runolfsson\",\n \"bank_code\": \"053\",\n \"bank_name\": \"UBA\",\n \"amount\": 59000,\n \"start_date\": \"2025-01-02T15:04:05Z\",\n \"end_date\": \"2026-01-02T15:04:05Z\",\n \"status\": \"failed\",\n \"message\": \"bank details not found\",\n \"created_at\": \"2024-11-26T15:28:14.153496+01:00\",\n \"updated_at\": \"2024-11-26T15:28:14.153496+01:00\"\n },\n {\n \"mandate_id\": \"d3cc9252-2f1f-4740-9b4f-1cdd27689442\",\n \"batch_id\": null,\n \"signing_doc_url\": null,\n \"product_id\": \"521\",\n \"customer_id\": \"0711b6e5-9764-4631-9299-3fac839e60c1\",\n \"customer_name\": \"Dr. Myah Runolfsson\",\n \"bank_code\": \"053\",\n \"bank_name\": \"UBA\",\n \"amount\": 59000,\n \"start_date\": \"2025-01-02T15:04:05Z\",\n \"end_date\": \"2026-01-02T15:04:05Z\",\n \"status\": \"failed\",\n \"message\": \"failed to get customer\",\n \"created_at\": \"2024-11-26T15:28:14.153743+01:00\",\n \"updated_at\": \"2024-11-26T15:28:14.153743+01:00\"\n },\n {\n \"mandate_id\": \"73d169f0-1e4d-45e0-8658-451f179a9656\",\n \"batch_id\": null,\n \"signing_doc_url\": null,\n \"product_id\": \"521\",\n \"customer_id\": \"0711b6e5-9764-4631-9299-3fac839e60c1\",\n \"customer_name\": \"Dr. Myah Runolfsson\",\n \"bank_code\": \"053\",\n \"bank_name\": \"UBA\",\n \"amount\": 59000,\n \"start_date\": \"2025-01-02T15:04:05Z\",\n \"end_date\": \"2026-01-02T15:04:05Z\",\n \"status\": \"failed\",\n \"message\": \"Unknown financial institution\",\n \"created_at\": \"2024-11-26T15:28:14.153759+01:00\",\n \"updated_at\": \"2024-11-26T15:28:14.153759+01:00\"\n }\n ]\n }\n}"}],"_postman_id":"6998968b-3942-4eab-9cd9-048d009678a7"},{"name":"Get/Refresh Mandate","id":"5b1df8de-dcb5-4910-9f3d-07a40a375c24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Token","value":""},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/mandate/:id?refresh=boolean","description":"This endpoint attempts to retrieve the latest information on a direct debit mandate.
\n\n\n","urlObject":{"path":["mandate",":id"],"host":[""],"query":[{"key":"refresh","value":"boolean"}],"variable":[{"id":"b36d5f2f-3ad0-4af3-955e-5a5369652d65","description":{"content":"When the query parameter
\nrefreshis set tofalse, the endpoint only retrieves the mandate information from the last update. Setting the value ofrefreshtotrueforces the endpoint to update the records with the latest information/update on the endpoint.
required
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f848a89c-7162-4fd9-b981-c54563fd2d21","name":"200","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Token","value":""}],"url":{"raw":"/mandate/:id?refresh=false","host":[""],"path":["mandate",":id"],"query":[{"key":"refresh","value":"false"}],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": {\n \"id\": \"sadhfdhsd\",\n \"customer_id\": \"fsdvsdv\",\n \"amount\": 759888,\n \"start_date\": \"01/01/2024\",\n \"end_date\": \"02/02/2024\",\n \"bank_code\": \"013\",\n \"bank_name\": \"Zenti Bank\",\n \"customer_name\": \"Segun Agbafe\",\n \"nuban\": \"6334343434\",\n \"status\": \"kfjshd\",\n \"scheduled\": true,\n \"schedule\": [\n {\n \"date\": \"01/01/2024\",\n \"amount\": 504444,\n \"retry_on_fail\": false,\n \"narrattion\": \"January debit\"\n },\n {\n \"date\": \"02/01/2024\",\n \"amount\": 504444,\n \"retry_on_fail\": false,\n \"narrattion\": \"feb debit\"\n }\n ]\n }\n}"}],"_postman_id":"5b1df8de-dcb5-4910-9f3d-07a40a375c24"},{"name":"Check Mandate Balance","id":"5d2c5c6d-54de-49d4-9fc1-4d6acde2e023","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Token","value":""},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/mandate/:id/balance","description":"This endpoint retrieves the customer's account balance on a selected account.
\n\n\n","urlObject":{"path":["mandate",":id","balance"],"host":[""],"query":[],"variable":[{"id":"6cc606f1-c0ec-405e-9447-634b5a9ef2c9","description":{"content":"Note that a fee of 10 naira only is charged for this request.
\n
required
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"9111d7aa-a347-4b12-8d36-7ff80719ba1e","name":"200","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Token","value":""}],"url":{"raw":"/mandate/:id/balance","host":[""],"path":["mandate",":id","balance"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": {\n \"balance\": 94885343,\n \"date\": \"01/01/2023\"\n }\n}"}],"_postman_id":"5d2c5c6d-54de-49d4-9fc1-4d6acde2e023"},{"name":"List Mandates","id":"72fc1f0e-4184-463e-8223-e259283e270b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Token","value":""}],"url":"/mandate?rpp=50&p=4","description":"This endpoint returns a paginated list of all mandates on every customer.
\n","urlObject":{"path":["mandate"],"host":[""],"query":[{"key":"rpp","value":"50"},{"key":"p","value":"4"}],"variable":[]}},"response":[{"id":"b53b2acd-3368-44fd-b305-673a3989e284","name":"200","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Token","value":""}],"url":{"raw":"https://api.neocollect.ng/test/mandate","host":["https://api.neocollect.ng/test"],"path":["mandate"],"query":[{"key":"rpp","value":"50","disabled":true},{"key":"p","value":"4","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With, X-Auth-Token, ngrok-skip-browser-warning"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS, GET, PUT, PATCH, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 27 Nov 2024 01:30:25 GMT"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"id\": \"5799520d-28ad-46e8-97b5-4f4fba9bfac2\",\n \"mandate_code\": \"dfbmIIjPLTyLsTRQCqpVDPQOI\",\n \"customer_id\": \"551896b0-2513-4460-89fa-f465b91fb0f4\",\n \"batch_id\": \"97ef60ea-e9d2-4fc0-8522-87e1063cd296\",\n \"signing_doc_url\": \"https://kddsxad.biz/kqyORGC.js\",\n \"amount\": 47463,\n \"start_date\": \"11/27/2024\",\n \"end_date\": \"11/27/2024\",\n \"bank_code\": \"101\",\n \"bank_name\": \"Balogun Gambari Microfinance Bank\",\n \"customer_name\": \"Dr. Bulah Schulist\",\n \"nuban\": \"QsGbNEapwbGEcQXpLsGYUUBKE\",\n \"status\": \"pending\",\n \"message\": \"Qui voluptatem aut aut sint voluptatem.\",\n \"scheduled\": false,\n \"schedule\": [\n {\n \"id\": \"UVrVjjlGvPeIVgNxdPpjnDtxt\",\n \"mandate_id\": \"eQucqEUnNNbHMHNAvrxWmhEKD\",\n \"date\": \"2216-04-23T09:59:22.568768459+01:00\",\n \"amount\": 5,\n \"retry_on_fail\": true,\n \"narration\": \"wTHPUdqRyVmuXfSfNcQcQssIK\",\n \"executed\": true\n },\n {\n \"id\": \"OpsxyBucHKpuBnSIgQHPeAFsH\",\n \"mandate_id\": \"GCtdxLUtRfHnEZvvStIGTMRUO\",\n \"date\": \"2266-01-08T03:17:00.687131778+01:00\",\n \"amount\": 13,\n \"retry_on_fail\": true,\n \"narration\": \"xKhJULNFAyVrjDZFQVyEdxYee\",\n \"executed\": true\n }\n ]\n },\n {\n \"id\": \"172c998c-dd2e-42be-94e6-1f45bbc6c0e5\",\n \"mandate_code\": \"eEdiMCGsBScCFBqxjyXTIDaHr\",\n \"customer_id\": \"c5be6f8e-14ef-4168-9b11-b649d215e2cf\",\n \"batch_id\": \"1df38f27-9fa4-4795-a634-5491a25ad2c2\",\n \"signing_doc_url\": \"https://www.tkmpwub.net/\",\n \"amount\": 11131997,\n \"start_date\": \"11/27/2024\",\n \"end_date\": \"11/27/2024\",\n \"bank_code\": \"101\",\n \"bank_name\": \"Balogun Gambari Microfinance Bank\",\n \"customer_name\": \"Ms. Alia Ondricka\",\n \"nuban\": \"FKvepinrtIldwsenvDAGjhDox\",\n \"status\": \"failed\",\n \"message\": \"Id voluptas facilis rerum animi labore.\",\n \"scheduled\": true,\n \"schedule\": []\n },\n {\n \"id\": \"8ff5b885-5113-4eea-ae76-d370c02a9a92\",\n \"mandate_code\": \"kPktAnfiixZAZQFXRNuhZWZuw\",\n \"customer_id\": \"6313cae8-4b64-4a99-8abe-206413362452\",\n \"batch_id\": \"b4950f31-cacd-4685-9a24-9d53bbc22309\",\n \"signing_doc_url\": \"http://nrqzfup.ru/OsWpHwC.js\",\n \"amount\": 993747,\n \"start_date\": \"11/27/2024\",\n \"end_date\": \"11/27/2024\",\n \"bank_code\": \"123\",\n \"bank_name\": \"Broadview Microfinance Bank\",\n \"customer_name\": \"Dr. Stephania Friesen\",\n \"nuban\": \"wMphdaOCcBgCiAQhCNJSlDFkV\",\n \"status\": \"failed\",\n \"message\": \"Quod mollitia officiis excepturi velit ullam.\",\n \"scheduled\": true,\n \"schedule\": [\n {\n \"id\": \"NuabAosjUslnXCgjWMRtObQJs\",\n \"mandate_id\": \"lhYZwyxwMoCDqTZqHnfuymEew\",\n \"date\": \"2101-02-20T17:36:02.048305744+01:00\",\n \"amount\": 40,\n \"retry_on_fail\": true,\n \"narration\": \"tiHvUhbcXXqkJpJIUaUbPOpYw\",\n \"executed\": false\n }\n ]\n },\n {\n \"id\": \"4c177130-15b8-4be3-879d-0f72d8841a67\",\n \"mandate_code\": \"WYYArRkDYIruIThQSgNFJBEHT\",\n \"customer_id\": \"f336354c-b5f7-4b72-98aa-1d6c9c7b194e\",\n \"batch_id\": \"361bf052-2198-4ade-aad8-937a5a43354a\",\n \"signing_doc_url\": \"https://egoyifk.info/oXCcmId.webp\",\n \"amount\": 11131997,\n \"start_date\": \"11/27/2024\",\n \"end_date\": \"11/27/2024\",\n \"bank_code\": \"456\",\n \"bank_name\": \"Royal Exchange Microfinance Bank\",\n \"customer_name\": \"Princess Vicky Hegmann\",\n \"nuban\": \"ldoMAnnZEXnefCYDApFBFZBcq\",\n \"status\": \"pending\",\n \"message\": \"Omnis impedit voluptatem et odit vel.\",\n \"scheduled\": false,\n \"schedule\": [\n {\n \"id\": \"jCvjFjPqqHlTGVDieCOPYmnvC\",\n \"mandate_id\": \"mtgCYmcSknPYovxMAxSQMNFju\",\n \"date\": \"2095-06-18T11:54:43.756323218+01:00\",\n \"amount\": 50,\n \"retry_on_fail\": false,\n \"narration\": \"uBqhFFpDSrhAoiDbDafWMvNJZ\",\n \"executed\": false\n },\n {\n \"id\": \"wwCdYLRiiMQdCYJfRjbvgjSml\",\n \"mandate_id\": \"RGclTupHlXRoFoWohjeVQOagp\",\n \"date\": \"2041-07-21T00:41:57.884526296+01:00\",\n \"amount\": 6,\n \"retry_on_fail\": true,\n \"narration\": \"uNoUVrZqoaNJSVErraNbeoOjM\",\n \"executed\": false\n }\n ]\n },\n {\n \"id\": \"0ed784f0-55b1-4fad-97c1-7c721405f3f1\",\n \"mandate_code\": \"OudFQBcVTdYUwXHOHUjDnfXvf\",\n \"customer_id\": \"8a01a643-2667-4aad-93a1-b6317769b126\",\n \"batch_id\": \"b4affee2-7588-4bc2-91ae-44c0d8fef594\",\n \"signing_doc_url\": \"http://akjhitb.info/WUsrZRo.jpg\",\n \"amount\": 11131997,\n \"start_date\": \"11/27/2024\",\n \"end_date\": \"11/27/2024\",\n \"bank_code\": \"456\",\n \"bank_name\": \"Royal Exchange Microfinance Bank\",\n \"customer_name\": \"Queen Mossie Reynolds\",\n \"nuban\": \"rMTQJxspLKJrNmvcEKGLQgHEa\",\n \"status\": \"pending\",\n \"message\": \"Itaque voluptatibus dolorum laboriosam distinctio aut.\",\n \"scheduled\": true,\n \"schedule\": []\n },\n {\n \"id\": \"a68628ae-9ea9-4e1c-a6af-d91ff63d5fb5\",\n \"mandate_code\": \"KwXEwSOppsJhbaeNRJrkQXsjx\",\n \"customer_id\": \"bde8c989-9d7e-4fa8-8d07-bb69b84ab83d\",\n \"batch_id\": \"7e750136-48d1-425d-a6b9-0a642f98fe5c\",\n \"signing_doc_url\": \"http://www.bqkiwul.org/bGLTSKv\",\n \"amount\": 993747,\n \"start_date\": \"11/27/2024\",\n \"end_date\": \"11/27/2024\",\n \"bank_code\": \"123\",\n \"bank_name\": \"Broadview Microfinance Bank\",\n \"customer_name\": \"Miss April Roberts\",\n \"nuban\": \"clsrRNjQeufwRExYnnAkxQaYw\",\n \"status\": \"pending\",\n \"message\": \"Ipsum facilis maiores nisi unde commodi.\",\n \"scheduled\": false,\n \"schedule\": []\n },\n {\n \"id\": \"27ea1578-6ca4-4526-a527-500d76d4bf3c\",\n \"mandate_code\": \"dLofgFAHAJGkqZxvoVGtTbrjO\",\n \"customer_id\": \"77922c14-5cfd-462e-a598-a5f233126216\",\n \"batch_id\": \"fe169435-91c1-4539-b195-ba962b32e654\",\n \"signing_doc_url\": \"https://zcwtjdf.org/\",\n \"amount\": 11131997,\n \"start_date\": \"11/27/2024\",\n \"end_date\": \"11/27/2024\",\n \"bank_code\": \"123\",\n \"bank_name\": \"Broadview Microfinance Bank\",\n \"customer_name\": \"Miss Roslyn Zemlak\",\n \"nuban\": \"FYdoPcTvnSFQyOlLalMhTmWBr\",\n \"status\": \"pending\",\n \"message\": \"Quia deserunt dolorem ipsam nihil veritatis.\",\n \"scheduled\": true,\n \"schedule\": []\n },\n {\n \"id\": \"b229fab9-1ad2-470e-a91d-597048cef2f1\",\n \"mandate_code\": \"WkvsEihTlbkMkayYEIWSOexpc\",\n \"customer_id\": \"cd41bb76-d2d6-49e3-b8ce-74ad4e663fb9\",\n \"batch_id\": \"1b3ff9d0-6ff5-42f5-99f9-cf1802289207\",\n \"signing_doc_url\": \"https://lowwdwj.com/bgkZCJC.php\",\n \"amount\": 993747,\n \"start_date\": \"11/27/2024\",\n \"end_date\": \"11/27/2024\",\n \"bank_code\": \"456\",\n \"bank_name\": \"Royal Exchange Microfinance Bank\",\n \"customer_name\": \"Dr. Myrtle Beer\",\n \"nuban\": \"aMcdOtYIyrJcAJaXAhcsxMHkO\",\n \"status\": \"failed\",\n \"message\": \"Et excepturi est necessitatibus dolor repellat.\",\n \"scheduled\": true,\n \"schedule\": [\n {\n \"id\": \"aMXYKiaaSeaOjXptvPfWYRvxQ\",\n \"mandate_id\": \"yGsuKNMcCjupghBZlEDWvsMnC\",\n \"date\": \"2129-09-08T17:22:33.336947026+01:00\",\n \"amount\": 72,\n \"retry_on_fail\": true,\n \"narration\": \"ZtFtaIjAOxYlUHokSXuvNxMep\",\n \"executed\": false\n },\n {\n \"id\": \"OuVAMbMxoQbnQEaGHhBTaqKIW\",\n \"mandate_id\": \"pWBVdJFXfHAYDJufFqayrjZMD\",\n \"date\": \"2204-10-04T09:38:57.36044778+01:00\",\n \"amount\": 92,\n \"retry_on_fail\": true,\n \"narration\": \"ZGMxwqsoReACsqHDlEBMynaFi\",\n \"executed\": false\n }\n ]\n },\n {\n \"id\": \"24b9e2e3-f0a4-4963-9e54-a90083f15178\",\n \"mandate_code\": \"FplfrXhyqoQaoKMUemwgZbCHm\",\n \"customer_id\": \"dbec2fa7-2630-4875-b848-4129dafe1ef2\",\n \"batch_id\": \"dc63cdfb-def0-4aeb-8aee-222b11e1a664\",\n \"signing_doc_url\": \"https://www.nrtrkvr.ru/\",\n \"amount\": 47463,\n \"start_date\": \"11/27/2024\",\n \"end_date\": \"11/27/2024\",\n \"bank_code\": \"123\",\n \"bank_name\": \"Broadview Microfinance Bank\",\n \"customer_name\": \"Ms. Helga Pacocha\",\n \"nuban\": \"RDkYlvpMmynXtnesapLsCeeOb\",\n \"status\": \"pending\",\n \"message\": \"Aut praesentium odit et qui tempore.\",\n \"scheduled\": true,\n \"schedule\": [\n {\n \"id\": \"KIipoMgUSAJVNdwdGAPILgglu\",\n \"mandate_id\": \"thCgDrgSeLIcVUJWqUlcMIFmZ\",\n \"date\": \"2218-02-28T07:40:33.633298156+01:00\",\n \"amount\": 94,\n \"retry_on_fail\": true,\n \"narration\": \"mMHNyLWaotmTZycBNnFqGqKrF\",\n \"executed\": false\n },\n {\n \"id\": \"SWVFggTQuRlXTVHemyjhODevK\",\n \"mandate_id\": \"InGWohefLTntdjIiOvZwQfIIm\",\n \"date\": \"2194-10-10T12:16:54.977106748+01:00\",\n \"amount\": 80,\n \"retry_on_fail\": false,\n \"narration\": \"LAkjKErLqcdYdBlKydIVYPGLt\",\n \"executed\": true\n }\n ]\n },\n {\n \"id\": \"de02b07a-9fce-4c88-bb3f-db2fdfdf5520\",\n \"mandate_code\": \"EGBIIxwPErGyYPlNimPStIrrR\",\n \"customer_id\": \"847871e3-b480-4187-8f50-10abc0b4ae33\",\n \"batch_id\": \"dd9e6147-2fc4-492a-9fd3-7c6398d859f3\",\n \"signing_doc_url\": \"https://rabbpib.ru/FXsEaEO.php\",\n \"amount\": 993747,\n \"start_date\": \"11/27/2024\",\n \"end_date\": \"11/27/2024\",\n \"bank_code\": \"456\",\n \"bank_name\": \"Royal Exchange Microfinance Bank\",\n \"customer_name\": \"Princess Mae Botsford\",\n \"nuban\": \"hdRQxkaTdksjefQwNDNxtXwkV\",\n \"status\": \"failed\",\n \"message\": \"Labore saepe illum vel quis qui.\",\n \"scheduled\": false,\n \"schedule\": [\n {\n \"id\": \"RjaTQkhtyoGGiiMcFvPiOMKNv\",\n \"mandate_id\": \"OrVHwZVYTWDJJGQailhEmNKiQ\",\n \"date\": \"2247-05-25T07:00:20.784873425+01:00\",\n \"amount\": 47,\n \"retry_on_fail\": true,\n \"narration\": \"sApcLLsabfJSDNnbyoAQuqlww\",\n \"executed\": false\n },\n {\n \"id\": \"hpydudKWChBioYGhJuGgZcARC\",\n \"mandate_id\": \"lxqNTiWPqARNZMRmRGkiLDKlx\",\n \"date\": \"2242-02-13T06:28:35.364199245+01:00\",\n \"amount\": 19,\n \"retry_on_fail\": true,\n \"narration\": \"jEaeAqYWoUrNluLoFRBRKjwgo\",\n \"executed\": false\n }\n ]\n },\n {\n \"id\": \"2797879b-f7fa-4a2b-b304-cd766eb48642\",\n \"mandate_code\": \"rDZJvjNuCGheMxCNlxhEdJsFP\",\n \"customer_id\": \"b3d6c457-7c1c-47d2-ba1f-5ee2ec72b79e\",\n \"batch_id\": \"ebda8d08-41f3-43b1-8c9e-0e62024081c0\",\n \"signing_doc_url\": \"http://www.qwnesuh.biz/\",\n \"amount\": 47463,\n \"start_date\": \"11/27/2024\",\n \"end_date\": \"11/27/2024\",\n \"bank_code\": \"123\",\n \"bank_name\": \"Broadview Microfinance Bank\",\n \"customer_name\": \"Princess Priscilla Koelpin\",\n \"nuban\": \"IvPZnKUndpqApZUbTIVbVVayM\",\n \"status\": \"failed\",\n \"message\": \"Atque hic rem voluptatem blanditiis veniam.\",\n \"scheduled\": false,\n \"schedule\": [\n {\n \"id\": \"qGpVodPMafgmxQxpCiEsONcaj\",\n \"mandate_id\": \"IfIQyCemZdhiHXglCUKIRBEqs\",\n \"date\": \"2175-09-28T06:02:28.05379509+01:00\",\n \"amount\": 14,\n \"retry_on_fail\": false,\n \"narration\": \"WRmUEMaSuayuZWHyayRgiEHvZ\",\n \"executed\": true\n }\n ]\n }\n ]\n}"}],"_postman_id":"72fc1f0e-4184-463e-8223-e259283e270b"},{"name":"Delete Mandate","id":"bc225f61-1afe-44de-965b-7f8851e1778b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Auth-Token","value":""}],"url":"/mandate/:id","description":"This endpoint deletes a mandate on a customer's account.
\n","urlObject":{"path":["mandate",":id"],"host":[""],"query":[],"variable":[{"id":"8ad93b22-c415-4d27-b713-59f6edc07af6","type":"any","value":"","key":"id"}]}},"response":[{"id":"8e09618f-dfa4-439e-a53c-e38c7676dbda","name":"200","originalRequest":{"method":"DELETE","header":[{"key":"X-Auth-Token","value":""}],"url":{"raw":"/mandate/:id","host":[""],"path":["mandate",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"bc225f61-1afe-44de-965b-7f8851e1778b"},{"name":"Charge Mandate","id":"12d30af8-5369-440d-8825-6de05f17033a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Auth-Token","value":""}],"url":"/mandate/:id/charge?amount=80000","description":"This endpoint charges a certain amount on a customer's account.
\n","urlObject":{"path":["mandate",":id","charge"],"host":[""],"query":[{"description":{"content":"kobo
\nrequired
\n","type":"text/plain"},"key":"amount","value":"80000"}],"variable":[{"id":"cba52c02-0a78-4ff7-b025-6637da7b8695","description":{"content":"required
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"a86ad8a5-f70d-4f8d-9647-44c14d2744bc","name":"200","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Token","value":""}],"url":{"raw":"/mandate/:id/charge?amount=80000","host":[""],"path":["mandate",":id","charge"],"query":[{"key":"amount","value":"80000"}],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"}],"_postman_id":"12d30af8-5369-440d-8825-6de05f17033a"},{"name":"Update Mandate","id":"03ebd6ec-c542-49b5-b048-167f8deca1d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-Auth-Token","value":""}],"body":{"mode":"raw","raw":"{\n \"schedule\": [\n {\n \"date\": \"01/01/2024\",\n \"amount\": 504444,\n \"retry_on_fail\": false,\n \"narrattion\": \"January debit\"\n },\n\n {\n \"date\": \"02/01/2024\",\n \"amount\": 504444,\n \"retry_on_fail\": true,\n \"narrattion\": \"feb debit\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/mandate/:id","description":"This endpoint updates the payment/charge schedule on a mandate
\nList, create and manage all direct debit mandates on customers
\n","_postman_id":"f1ef4ce8-7127-4c6a-9cd9-a1ac41eee55a"},{"name":"Webhooks","item":[{"name":"New Request","id":"893b8a13-d138-41fd-89e7-eb551b260995","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"893b8a13-d138-41fd-89e7-eb551b260995"}],"id":"65eeed73-19bd-46af-8fbe-87718448c6f7","description":"Overview
\nTo ensure effective communication between our services and yours, we have set up webhooks to notify you of updates, even when you are not actively waiting.
\n