Zank's API will extend your application capabilities by providing point of sale financing for your customers.
\nThe first step in your process towards integrating with Zank's POS solution is understanding how it works.
\nYou should see Zank as an additional payment method for your customers. After your customer has selected the products or services he/she is willing to buy and has already confirmed the order, you can present Zank to your customer as a financing method for his order.
\nAfter your customer selects Zank as his preferred payment method, you should ask your customer to follow Zank's application steps. Once Zank has finished evaluating your customer application he can return back to your webpage to get the final confirmation on your site.
\nIf you provide a notifications Url when creating a loan, we will send push notifications to inform you when a loan changes its status.
\nThe structure of the notification is the following:
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Start here","slug":"start-here"}],"owner":"10170509","collectionId":"ed1235c1-42d1-4156-9669-dae8f2e86185","publishedId":"SWTG6FVn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-02-13T18:05:30.000Z"},"item":[{"name":"Authorization","item":[{"name":"login_check","event":[{"listen":"prerequest","script":{"id":"673ec321-186b-4c4d-871d-919f3d0e26e6","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"babcd360-9be0-4172-9e23-bf231d03d7e3","exec":["var jsonData = JSON.parse(responseBody);","pm.globals.set(\"token\", jsonData.token);"],"type":"text/javascript"}}],"id":"ddb39f10-89a2-4db2-b1fa-885e010776ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"Required Your backoffice username
Required Your backoffice password
Start by login in into the API with your backoffice user and password.
\nThere are two types of users in Zank: administrators and sales agents. You can login with the credentials belonging to any user but bear in mind that the methods available in this API will be restricted depending on the role of the user.
\n","urlObject":{"path":["api","login_check"],"host":[" https://dev.zank.com.es"],"query":[],"variable":[]}},"response":[{"id":"69a1a36f-78d6-4f12-a2d0-c282b51157af","name":"login_check","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"`Required` Your backoffice username","key":"_username","type":"text","value":"A47DF32BD3527D"},{"description":"`Required` Your backoffice password","key":"_password","type":"text","value":"sd4f9kj3st"}]},"url":" https://dev.zank.com.es/api/login_check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJhbGciOiJSUzI1NiJ9.eyJyb2xlcyI6WyJST0xFX1NVUEVSX0FETUlOIiwiUk9MRV9VU0VSIl0sImVtYWlsIjoieG1hcmphbEBnbWFpbC5jb20iLCJpYXQiOjE1MzczNDY5MTEsImV4cCI6MTUzNzM1MDUxMX0.MHAfVvr9C0MLSZgCCMrjpPz-JnPJaKaB9CfhFWMPsdwFajIdwm8qVI-k3HrTgqduNIugZkEEnHqwLBunQEhMLb6LgxjK8nHAdOA0oqNZ6zktNJcIUcraXtPPrVf_206PfIOF3UC0ieB5yp7uhoM6fAdwveo0AVNFoc_09jaexJN6WT5VvV2uHr_w_aH49yp_v6l8W4CwVxqXAT2y-8veW3ImVkijkDgCfnzOvzugFJ-y6ckYMjOiVggxX4j2az3-yJ88OzVj9wZka_MGnvktxr-94R6xRW2OYQUH12icTvz9F0Ts0z_-CZkD9U-HnC0TSudsh2woAVOrY22sxkfEVBiBqQjPrHIBuZUhXTA4WQMm6bwgCMTSwQNsQck0nvRZfPo7V1eckRiByWdEDWHCY7jKJ3WtsBLvbuYavJEH0jPBuk4g6ABgKqLeWd2Rer6AkhGC8rHMlP4J7eZDuH_kDLxTeTGR3EL8jjVMdIhGPZZ2Ax8z5fWE9sv4MCxQELKnqel9MMR84IAy-Y1G-xyTxrWbkJa3UGzelSjbWAN5sj6sc-u6VA1Ew--0SCQaNnn343-YKAWxX5zGt_ijhr0XTiFI8lBpconayHIDhSrLD-ya8buChAvo0TbZD6IqnpE8cNc1QfQsfdHOzjGmGCJMJ4mllyUcoRPeA-RhZqYXZLc\"\n}"}],"_postman_id":"ddb39f10-89a2-4db2-b1fa-885e010776ef"}],"id":"071262a4-d020-470c-8ddb-4b5aca93e98b","event":[{"listen":"prerequest","script":{"id":"cdbe35ba-fff7-49ed-af74-3efeaa33d656","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"db926ecf-e8db-4740-8da2-900c28776409","type":"text/javascript","exec":[""]}}],"_postman_id":"071262a4-d020-470c-8ddb-4b5aca93e98b","description":""},{"name":"Creating a Loan","item":[{"name":"Reasons","id":"1b038449-db72-4e98-897b-8201a14dbdd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"bearer token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":" https://dev.zank.com.es/api/reasons?prescriber=prescriber_username","description":"Get all possible reasons assigned to your user.
\nIt is also possible to get the reasons assigned to another username that belong to you in the company hierarchy.
\n","urlObject":{"path":["api","reasons"],"host":[" https://dev.zank.com.es"],"query":[{"description":{"content":"[optional] prescriber username
\n","type":"text/plain"},"key":"prescriber","value":"prescriber_username"}],"variable":[]}},"response":[{"id":"4883c945-b593-4bd6-b90d-eb988da2aa2e","name":"Reasons - Not authorized (403)","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"bearer token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":" https://dev.zank.com.es/api/reasons"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.7"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 20 Feb 2020 12:15:06 GMT"},{"key":"Link","value":"Get all possible installment options calculated for an amount that you provide. You can use the response to show your customer the possible payment durations. For each duration you also get all pricing details including monthly installments and study fees.
\nFor each duration you will get:
\n[optional] duration of the loan
\n","type":"text/plain"},"key":"duration","value":"integer"},{"description":{"content":"[optional] borrower opening fee
\n","type":"text/plain"},"key":"borrowerOpeningFee","value":"float"},{"description":{"content":"[optional] borrower interest rate
\n","type":"text/plain"},"key":"borrowerNIR","value":"float"},{"description":{"content":"[optional] prescriber opening fee
\n","type":"text/plain"},"key":"prescriberOpeningFee","value":"float"},{"description":{"content":"[optional] prescriber username
\n","type":"text/plain"},"key":"prescriber","value":"prescriber username"}],"variable":[]}},"response":[{"id":"1a4abe9f-8406-4475-a3c3-3a93ab8b628b","name":"Pricing configurations - Not Authorized (403)","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"bearer token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":{"raw":" https://dev.zank.com.es/api/pricingConfigurations/{{reason}}/{{amount}}?duration=integer&borrowerOpeningFee=float&borrowerNIR=float&prescriberOpeningFee=float","host":[" https://dev.zank.com.es"],"path":["api","pricingConfigurations","{{reason}}","{{amount}}"],"query":[{"key":"duration","value":"integer","description":"duration of the loan"},{"key":"borrowerOpeningFee","value":"float","description":"borrowe opening fee"},{"key":"borrowerNIR","value":"float","description":"borrower interest rate"},{"key":"prescriberOpeningFee","value":"float","description":"prescriber opening fee"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.7"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 20 Feb 2020 11:42:17 GMT"},{"key":"Link","value":"Creates a new loan and a user associated to it. The new user will be created in Zank with the email provided as his username.
\nYou will always need to get two different parameters in advance before calling this request, in order to indicate the API what monthly plan you wish to apply to your loan. To do so:
\nreason value: the id of the reason selected in the call you made to GET Reasonsconfig value: the id of the pricing configuration selected by your customer out of the different configurations you received when calling GET PricingConfigurationspdta value:Aceptación de transferencia de datos personales\nAcepto que mis datos personales sean transferidos a Zank Financial SL con el fin de estudiar la viabilidad de mi solicitud de préstamo.\n\nreference value:reference parameter so you can use it as a search parameter in other methods.amount value:amount, always use a double decimal notation with a dot separator. Do not separate thousands digits. Example: if you need to create the loan for an amount of 1234.56 € insert 1234.56, or if you want to create a loan for an amount of 540 € use 540.00 to avoid errors.emailvalue: provide the email of your customermobilePhone: provide the mobile phone number of your customer. This number will need to be validated by Zank during the process.firstname: provide the first name of your customer.lastname: provide the last name of your customer.lastname2: provide the second last name of your customer (not required).idNumber: provide a valid official id number: dni number or nie number.startingDate [optional]:startingDate for the loan using the standard YYYY-mm-dd format. The starting date can span a maximum of 3 months from today's date. If you don't set a starting date, once the customer is approved and all requirements are met (i.e. contract signed, id verified, etc) the transfer will be made ASAP to your bank account and the amortization period will start immediately. If you set a starting date, this will be the date the amortization period will start for your customer and the date you will receive your transfer.notificationsUrl [optional]:notificationURL field is optional, but convenient in order to receive changes in loan status' and create reactive experiences for your customers. See details of its use in the Webhooks section.returnUrl [optional]:returnUrl so we can redirect your customer to a URL that you select in your website once the process has finished.prescriber[optional]:waitingPeriod[optional]:carType [optional]: if it's a vehicle's loan, you have to indicate the car fields. It has to be one of this: tourism, motorcycle, moped, van, truck, bus, tractor, quad or boat.carBrand [optional]: if it's a vehicle's loan, you have to indicate the car fields. The vehicle's brand.carChassis [optional]: if it's a vehicle's loan, you have to indicate the car fields. The vehicle's chassis.carPlateNumber [optional]: if it's a vehicle's loan, you have to indicate the car fields. The vehicle's plate number.carPlateNumberDate [optional]: if it's a vehicle's loan, you have to indicate the car fields. The vehicle's plate number date.carEurotax [optional]: if it's a vehicle's loan, you have to indicate the car fields. The vehicle's eurotax if you have it.After a successfull call to the createLoan method, you will receive the idLoan field with the id of the loan that you can use to refer to this loan in the rest of methods, as well as an autologin url that you can hand out to your customer so he can complete the loan application.
Create a faster experience for your customer by providing us with a set of information we need from your customer.
\nWe suggest creating a form in your webpage to collect all information missing in your order.
\nThe options you need to send us are:
\nUnique Id of the loan
\n","type":"text"},{"key":"type","value":"dniFront","description":"Should be one of the following: dniFront, dniBack, nieFront, nieBack, passport, incomeProof, irpf, bill
\n","type":"text"},{"key":"file","description":"source of file to be uploaded
\n","type":"file","value":null}]},"url":" https://dev.zank.com.es/api/uploadDocument","description":"Upload a document to the loan application.
\nYou should make a request per each document that you want to upload.
\nIn order to use this functionality you must ask your account manager to activate it for your account.
\nYou can check the documents still required for your account as well as the documents you have already submitted by using the GET Loan Details request
\n","urlObject":{"path":["api","uploadDocument"],"host":[" https://dev.zank.com.es"],"query":[],"variable":[]}},"response":[{"id":"85bc9066-e9fa-4681-880d-91d39f310249","name":"Upload Document [optional]","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"loanId","value":"{{loanId}}","description":"Unique Id of the loan","type":"text"},{"key":"type","value":"dniFront","description":"Should be one of the following: dniFront, dniBack, nieFront, nieBack, passport, incomeProof, irpf, bill","type":"text"},{"key":"file","description":"source of file to be uploaded","type":"file","value":null}]},"url":" https://dev.zank.com.es/api/uploadDocument"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"98bd71e5-f3b1-489b-9cd8-7790ece0be97"},{"name":"Verify Loan","id":"70283baf-8a1d-4855-ad6c-3f86b511f452","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[]},"url":" https://dev.zank.com.es/api/loanVerified/{{loanId}}","description":"Verifies a loan whenever needed.
\n","urlObject":{"path":["api","loanVerified","{{loanId}}"],"host":[" https://dev.zank.com.es"],"query":[],"variable":[]}},"response":[{"id":"3f4ff72d-9162-4129-8ff3-83eec51d2dcd","name":"Verify Loan - Internal error (5001)","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[]},"url":" https://dev.zank.com.es/api/loanVerified/{{loanId}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.7"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 20 Feb 2020 14:39:19 GMT"},{"key":"Link","value":"Lists all loans associated with the user that is logged in.
\nYou can get the response paginated.
\nFor every loan you will receive:
\nsets the maximum number of elements per page. Allows 10 to 500 elements per page.
\n","type":"text/plain"},"key":"limit","value":"integer"},{"description":{"content":"Page number to retrieve
\n","type":"text/plain"},"key":"page","value":"integer"},{"description":{"content":"Retrieve loans created starting in this date. Set it with YYYY-mm-dd format
\n","type":"text/plain"},"key":"from","value":"string"},{"description":{"content":"Retrieve loans created until this date. Set it with YYYY-mm-dd format
\n","type":"text/plain"},"key":"to","value":"string"}],"variable":[]}},"response":[{"id":"5e77fd5c-10be-4dd8-829e-86e8c9e53c53","name":"List Loans - Internal error (5001)","originalRequest":{"method":"GET","header":[],"url":{"raw":" https://dev.zank.com.es/api/createdLoans","host":[" https://dev.zank.com.es"],"path":["api","createdLoans"],"query":[{"key":"limit","value":"integer","description":"sets the maximum number of elements per page. Allows 10 to 500 elements per page.","disabled":true},{"key":"page","value":"integer","description":"Page number to retrieve","disabled":true},{"key":"from","value":"string","description":"Retrieve loans created starting in this date. Set it with YYYY-mm-dd format","disabled":true},{"key":"to","value":"string","description":"Retrieve loans created until this date. Set it with YYYY-mm-dd format","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.7"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 20 Feb 2020 14:45:57 GMT"},{"key":"Link","value":"Lists all prescribers (users) that are below your hierarchical level.
\nFor every prescriber you will receive:
\nYou can then use the prescriber username to create a new loan application for this prescriber.
\n","urlObject":{"path":["api","prescribers"],"host":[" https://dev.zank.com.es"],"query":[],"variable":[]}},"response":[{"id":"1efb1323-c8c4-43fe-9de1-b61de1fbba72","name":"List Prescribers - OK (200)","originalRequest":{"method":"GET","header":[],"url":" https://dev.zank.com.es/api/prescribers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"prescriber\": \"A5CEBBCC7C4952\",\n \"name\": \"Dental Balmes\"\n },\n {\n \"prescriber\": \"A5CF6AB756D027\",\n \"name\": \"Dental Montaner\"\n },\n {\n \"prescriber\": \"A5CF5AD6A06F85\",\n \"name\": \"Dental Diagonal\"\n },\n {\n \"prescriber\": \"A5CF6AE4C75D3D\",\n \"name\": \"Dental Horta\"\n },\n {\n \"prescriber\": \"A5CF6AFF779D38\",\n \"name\": \"Dental Eixample\"\n }\n]"}],"_postman_id":"3fee49a4-6663-4311-81e0-4a10e8a0cde6"},{"name":"Get Loan Details","id":"15357f69-a936-45fe-a4ad-3dfebb1eefa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":" https://dev.zank.com.es/api/loanDetail/{{loanId}}","description":"Plug in a loanId and receive extended information about it:
\nid: id of the loanemail: email of user associated to the loanstatus: loan statusamount: loan amountduration: loan durationborrowerNIR: nominal interest rate of the loan for the borrowerborrowerAPR: APR (spanish:TAE) of the loan for the borrowerprescriberOpeningFee: opening fee to be paid by the affiliate (you)borrowerOpeningFee: opening fee to be paid by the borrowerownInvestment: set to 1 if you are the investor of the loanriskStatus: one of the following values: notStarted, analyzing, preapproved, approved, denieddocumentsUploaded: list of documents uploaded with the status of each documentdocumentsNeeded: list of documents still neededborrowerMessages: array of strings with information regarding the status of the application for the borrowerurl: autologin url that you can hand out to your customer so he can complete the loan applicationThe diferent status' of the documents are the following:
\nuploaded: document is uploaded but needs to be checked. This is the initial status.accepted: the document has been acceptedonhold: the document is part of a group and needs the rest of documents to verify it.rejected: the document has been rejected without an explicit reason.rejected_unreadable: the document is unreadable and cannot be used.rejected_expired: the document has expired and cannot be usedrejected_wrongtype: the document uploaded is different from the one needed and cannot be usedrejected_duplicated: the document is duplicatedPlug in a loanId and receive details concerning the programmed installments:
\nThe list of available status for loans invested by the prescriber is the following:
\n","urlObject":{"path":["api","loanInstallmentsDetail","{{loanId}}"],"host":[" https://dev.zank.com.es"],"query":[],"variable":[]}},"response":[{"id":"03375c5d-0b25-4263-9e98-b1533f04a21f","name":"Loan Installments Details - Not authorized (403)","originalRequest":{"method":"GET","header":[],"url":" https://dev.zank.com.es/api/loanInstallmentsDetail/{{loanId}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.7"},{"key":"Content-Type","value":"application/ld+json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 20 Feb 2020 15:03:24 GMT"},{"key":"Link","value":"This methods allow you to get deeper information about the loan applications that were created in your environment.
\n","event":[{"listen":"prerequest","script":{"id":"d42e634e-1049-45c3-941a-e6af73fc5d9e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"98e22f72-32a8-46ab-abbe-af756c65516b","type":"text/javascript","exec":[""]}}],"_postman_id":"ce4264d6-0aab-48e0-acc5-01e59636e31e"},{"name":"Webhooks","item":[],"id":"d2ceb2b1-3e60-4b0d-b186-56fb7bbaf28f","description":"The Zank REST API uses webhooks for event notification. Webhooks are HTTP callbacks that contain notification messages for events.
\nWe do not guarantee that you get these notifications in the order they occurred. Please use the eventTimestamp property for each notification to determine when the notification occurred.
\nWe do not guarantee that you will only get a single notification for an event. Though this should be rare, it is possible that we will send you the same notification multiple times.
\nUse the notificationURL field in the POST Create Loan to subscribe to changes in the loan to create reactive experiences for your customers.
After receiving the status notification you should call the GET Loan Details to confirm the status of the loan as well as to receive extra information for the loan.
\nThe structure of the notification sent contains the following fields:
\n{\n\"code\": the notification type, in this case Z001\n\"id\": loan id,\n\"status\": loan new status\n\"message\": states if there is a problem\n\"updatedAt\": loan update timestamp\n\"eventTimestamp\": timestamp for the notification\n}\nEvery status change in any document uploaded will create an event that will be sent to the notificationURL informed in the POST Create Loan
It is always advisable to call the GET Loan Details to confirm the information coming in the notification.
\nThe notification received follows this structure:
\n{\n\"code\": the notification type, in this case Z002\n\"id\": document id,\n\"status\": document new status\n\"eventTimestamp\": timestamp for the notification\n}\n