The Tammim API provides a comprehensive set of endpoints that enable merchants, freelancers, and companies to seamlessly integrate registration, authentication, checkout, payment, and webhook management capabilities into their systems.
\nTammim API is designed to simplify the full transaction lifecycle — from seller onboarding to payment completion — while offering secure authentication, flexible checkout initiation, and real-time event notifications via webhooks. The API supports both freelancer and company seller models, each with tailored validation rules and document requirements, ensuring compliance with regulatory and business standards.
\nThrough the Tammim API, integrators can:
\nRegister sellers with detailed identity, banking, address, and document verification
\nAuthenticate users and manage access securely using access and refresh tokens
\nInitiate checkout sessions and generate hosted payment pages
\nTrack payment status and transaction outcomes
\nConfigure and manage webhooks for real-time checkout and payment notifications
\nAll endpoints follow RESTful principles, use standard HTTP status codes, and exchange data in JSON format (with multipart support where required). Security best practices such as HTTPS enforcement, token-based authentication, and controlled webhook access are integral to the platform.
\nThe Tammim API is built to be scalable, reliable, and easy to integrate, enabling businesses to focus on growth while Tammim handles the underlying payment and checkout infrastructure.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"29568745","collectionId":"44f1d74e-9491-4086-a27f-87cfa05bc849","publishedId":"2sBXcEkg4f","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-03-02T08:06:11.000Z"},"item":[{"name":"Supported Banks","item":[],"id":"e7936339-13e2-4c2b-aa73-d92196e07060","description":"","_postman_id":"e7936339-13e2-4c2b-aa73-d92196e07060"},{"name":"Register","item":[{"name":"Register Company / Freelance","id":"bf332566-963f-4e5f-ad00-74ae94e1f931","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"civilFile","type":"file","uuid":"5f55df87-5764-4d06-a574-da49608940c1","src":"/Users/ibrahim/Downloads/files_%2F414%2FcompanyFile%2F8d0a92ea-acc2-42a0-996b-a2f4212ee12a.docx"},{"key":"companyFile","type":"file","uuid":"27a3f8b2-73c8-4a18-93bb-aa59e5bb9b14","src":"/Users/ibrahim/Downloads/files_%2f414%2FcivilFile%2F3d14cc2a-d00d-468a-b922-347fc9b654e5.docx"},{"key":"data","value":"{\n \"email\": \"i.sahin.tammim.1184@gmail.com\",\n \"password\": \"Qw123456\",\n \"phoneNumber\": \"9665113323252\",\n \"firstName\": \"ibrahim\",\n \"lastName\": \"sahin\",\n \"invoiceType\": \"company\",\n \"VATNumber\": \"312391230912390\",\n \"CRNumber\": \"5646546545\",\n \"unifiedNumber\": \"7321231231\",\n \"nationalId\": null,\n \"bankId\": 40,\n \"BankIban\": \"SA2312312123132132312123123\",\n \"BankHolderName\": \"bank holfe\",\n \"address\": {\n \"addressText\": \"Riyadh Front Exhibition & Conference Center, Riyadh\",\n \"city\": null,\n \"stateName\": \"Riyadh Province\",\n \"districtName\": \"King Khalid International Airport\",\n \"neighbourhoodName\": \"King Khalid International Airport\",\n \"street\": \"RPPH+7PH\",\n \"buildingName\": \"5544\",\n \"zipCode\": \"13413\",\n \"lat\": 24.8356823,\n \"lng\": 46.729356,\n \"shortAddressCode\": null,\n \"secondary\": \"1secc12\"\n }\n}","type":"text","uuid":"272d4132-dac1-4d86-bcfa-b09478420efc"}]},"url":"{{tammim-url}}/api/v1/register","description":"The seller type is determined by the invoiceType field:
freelancer – Individual seller registration
company – Business entity registration
Required documents and validation rules vary based on the selected invoiceType.
Upon successful validation, a new seller account is created in the system.
\nBusiness Logic
\nRegistration Process Flow
\nValidate invoice type (freelancer or company).
Validate all required fields based on the selected invoice type.
\nVerify that the provided city exists in the system.
\nValidate file uploads (civilFile and companyFile).
Create the authentication account.
\nRegister the user in the system with seller privileges.
\nUpload and securely store document files.
\nUpdate account settings and bank information.
\nGenerate and return authentication tokens.
\nInvoice Type Differences
\nFreelancer
\n· Requires only common fields
\n· companyFile should contain freelance document
\n· No VAT or CR number required
\nCompany
\n· Requires VATNumber and CRNumber in addition to common fields
\n· companyFile should contain Commercial Registration document
\n· Must be VAT registered
\nAuthentication
\nNo authentication required - This is a public endpoint for new company/ freelancer registration.
\nFile Upload Requirements
\n· Civil ID document upload
\n· Accepted formats: PDF, JPG, PNG
\n· Maximum file size: 10MB
\n· Must be clear and readable
\n· For Freelancers: Freelance document
\n· For Companies: Commercial Registration (CR) document
\n· Accepted formats: PDF, JPG, PNG
\n· Maximum file size: 10MB
\n· Must be clear and readable
\nCurrently no additional required fields for freelancers.
\n\"company\")Response Fields
\n","urlObject":{"path":["api","v1","register"],"host":["{{tammim-url}}"],"query":[],"variable":[]}},"response":[{"id":"9a2cceab-ca5d-4747-8531-9d8baa75dbab","name":"200-Register Company","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Cookie","value":"session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjE2MiwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjM5MSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTUyNTIwNSwidXNlcl9pZCI6Ikdza3B6WDJGc1hTOE1NbFcyeVZpYVhkTnJKNzMiLCJzdWIiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwiaWF0IjoxNzY5NTI1MjA2LCJleHAiOjE3Njk3ODQ0MDYsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTI0QGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJpLnNhaGluLnRhbW1pbS4xMjRAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoiY3VzdG9tIn19.TR9gfSJrK47K4NAXKVoqbz9E9hHmgUBIQwoWAuhzodmpfScuUPDMNz_JxieIn7M2niLwnNCkEqjO7LQJdDAz677IbCG5mg_rJpTjbjH4i3Hbsco8avCFr2_8BGCgwLFIc7QUn30uJhL4fsyUw4-FVV3srhWVBX3WKqIg5moPITfwd9cBpenY9n0oeSQqWX4zCFChOgDtQtrAc7DgYQpSfpppz0es2hI16XnBtRAU29JycTdpLxQg6RZd80yez0wghtJM7vI45KelvLSA0Y6tsXWjz8ZsKzo7IWo58_gfJQ8AD4dqnljOpvINI1VN1ozBbvzTTZrzxJaa35JsYzMgsA; session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjE2MiwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjM5MSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTUyNTIwNSwidXNlcl9pZCI6Ikdza3B6WDJGc1hTOE1NbFcyeVZpYVhkTnJKNzMiLCJzdWIiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwiaWF0IjoxNzY5NTI1MjA2LCJleHAiOjE3Njk3ODQ0MDYsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTI0QGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJpLnNhaGluLnRhbW1pbS4xMjRAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoiY3VzdG9tIn19.TR9gfSJrK47K4NAXKVoqbz9E9hHmgUBIQwoWAuhzodmpfScuUPDMNz_JxieIn7M2niLwnNCkEqjO7LQJdDAz677IbCG5mg_rJpTjbjH4i3Hbsco8avCFr2_8BGCgwLFIc7QUn30uJhL4fsyUw4-FVV3srhWVBX3WKqIg5moPITfwd9cBpenY9n0oeSQqWX4zCFChOgDtQtrAc7DgYQpSfpppz0es2hI16XnBtRAU29JycTdpLxQg6RZd80yez0wghtJM7vI45KelvLSA0Y6tsXWjz8ZsKzo7IWo58_gfJQ8AD4dqnljOpvINI1VN1ozBbvzTTZrzxJaa35JsYzMgsA; session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjE2MiwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjM5MSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTUyNTIwNSwidXNlcl9pZCI6Ikdza3B6WDJGc1hTOE1NbFcyeVZpYVhkTnJKNzMiLCJzdWIiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwiaWF0IjoxNzY5NTI1MjA2LCJleHAiOjE3Njk3ODQ0MDYsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTI0QGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJpLnNhaGluLnRhbW1pbS4xMjRAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoiY3VzdG9tIn19.TR9gfSJrK47K4NAXKVoqbz9E9hHmgUBIQwoWAuhzodmpfScuUPDMNz_JxieIn7M2niLwnNCkEqjO7LQJdDAz677IbCG5mg_rJpTjbjH4i3Hbsco8avCFr2_8BGCgwLFIc7QUn30uJhL4fsyUw4-FVV3srhWVBX3WKqIg5moPITfwd9cBpenY9n0oeSQqWX4zCFChOgDtQtrAc7DgYQpSfpppz0es2hI16XnBtRAU29JycTdpLxQg6RZd80yez0wghtJM7vI45KelvLSA0Y6tsXWjz8ZsKzo7IWo58_gfJQ8AD4dqnljOpvINI1VN1ozBbvzTTZrzxJaa35JsYzMgsA","disabled":true},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"civilFile","type":"file","uuid":"5f55df87-5764-4d06-a574-da49608940c1","src":"/Users/ibrahim/Downloads/files_%2F414%2FcivilFile%2F33125566-4572-4893-b72e-9e7ae18504a3.docx"},{"key":"companyFile","type":"file","uuid":"27a3f8b2-73c8-4a18-93bb-aa59e5bb9b14","src":"/Users/ibrahim/Downloads/files_%2f414%2FcivilFile%2F3d14cc2a-d00d-468a-b922-347fc9b654e5.docx"},{"key":"data","value":"{\n \"email\": \"i.sahin.tammim.1003@gmail.com\",\n \"password\": \"Qw123456\",\n \"phoneNumber\": \"966511232323\",\n \"firstName\": \"ibrahim\",\n \"lastName\": \"sahin\",\n \"invoiceType\": \"company\",\n \"VATNumber\": \"312391230912390\",\n \"CRNumber\": \"5646546545\",\n \"unifiedNumber\": \"7321231231\",\n \"nationalId\": null,\n \"bankId\": 40,\n \"BankIban\": \"SA2312312123132132312123123\",\n \"BankHolderName\": \"bank holfe\",\n \"address\": {\n \"addressText\": \"Riyadh Front Exhibition & Conference Center, Riyadh\",\n \"city\": \"Riyadh\",\n \"stateName\": \"Riyadh Province\",\n \"districtName\": \"King Khalid International Airport\",\n \"neighbourhoodName\": \"King Khalid International Airport\",\n \"street\": \"RPPH+7PH\",\n \"buildingName\": null,\n \"zipCode\": \"13413\",\n \"lat\": 24.8356823,\n \"lng\": 46.729356,\n \"shortAddressCode\": null,\n \"secondary\": null\n }\n}","type":"text","uuid":"272d4132-dac1-4d86-bcfa-b09478420efc"}]},"url":"https://dashboard.tammim.app/api/v1/register"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"userType\": \"seller\",\r\n\t\"idToken\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjFjMzIxOT...\",\r\n\t\"refreshToken\": \"AMf-vBzD2f3NV_1FVzLLEwrsQtAtSegjE...\",\r\n\t\"email\": \"company@example.com\",\r\n\t\"expiresIn\": \"3600\",\r\n\t\"userID\": \"234\"\r\n \"sessionCreate\": true,\r\n \"forceLogoutDays\": 3,\r\n\t\"success\": true\r\n}\r\n"},{"id":"a77b2fae-f38c-4aee-8eaf-1054091f5db4","name":"200-Register Freelance","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Cookie","value":"session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjE2MiwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjM5MSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTUyNTIwNSwidXNlcl9pZCI6Ikdza3B6WDJGc1hTOE1NbFcyeVZpYVhkTnJKNzMiLCJzdWIiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwiaWF0IjoxNzY5NTI1MjA2LCJleHAiOjE3Njk3ODQ0MDYsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTI0QGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJpLnNhaGluLnRhbW1pbS4xMjRAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoiY3VzdG9tIn19.TR9gfSJrK47K4NAXKVoqbz9E9hHmgUBIQwoWAuhzodmpfScuUPDMNz_JxieIn7M2niLwnNCkEqjO7LQJdDAz677IbCG5mg_rJpTjbjH4i3Hbsco8avCFr2_8BGCgwLFIc7QUn30uJhL4fsyUw4-FVV3srhWVBX3WKqIg5moPITfwd9cBpenY9n0oeSQqWX4zCFChOgDtQtrAc7DgYQpSfpppz0es2hI16XnBtRAU29JycTdpLxQg6RZd80yez0wghtJM7vI45KelvLSA0Y6tsXWjz8ZsKzo7IWo58_gfJQ8AD4dqnljOpvINI1VN1ozBbvzTTZrzxJaa35JsYzMgsA; session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjE2MiwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjM5MSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTUyNTIwNSwidXNlcl9pZCI6Ikdza3B6WDJGc1hTOE1NbFcyeVZpYVhkTnJKNzMiLCJzdWIiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwiaWF0IjoxNzY5NTI1MjA2LCJleHAiOjE3Njk3ODQ0MDYsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTI0QGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJpLnNhaGluLnRhbW1pbS4xMjRAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoiY3VzdG9tIn19.TR9gfSJrK47K4NAXKVoqbz9E9hHmgUBIQwoWAuhzodmpfScuUPDMNz_JxieIn7M2niLwnNCkEqjO7LQJdDAz677IbCG5mg_rJpTjbjH4i3Hbsco8avCFr2_8BGCgwLFIc7QUn30uJhL4fsyUw4-FVV3srhWVBX3WKqIg5moPITfwd9cBpenY9n0oeSQqWX4zCFChOgDtQtrAc7DgYQpSfpppz0es2hI16XnBtRAU29JycTdpLxQg6RZd80yez0wghtJM7vI45KelvLSA0Y6tsXWjz8ZsKzo7IWo58_gfJQ8AD4dqnljOpvINI1VN1ozBbvzTTZrzxJaa35JsYzMgsA","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"civilFile","type":"file","uuid":"e59bfe0b-69f3-421a-ae29-18603fac90bf","src":"/Users/ibrahim/Downloads/files_%2F414%2FcivilFile%2F0fb36ca9-39b5-4927-8e21-98ca40f2babe.docx"},{"key":"companyFile","type":"file","uuid":"a10a69aa-446e-4559-88e8-977e7e085250","src":"/Users/ibrahim/Downloads/files_%2F414%2FcivilFile%2F33125566-4572-4893-b72e-9e7ae18504a3.docx"},{"key":"data","value":"{\n \"email\": \"i.sahin.tammim.1006@gmail.com\",\n \"password\": \"Qw123456\",\n \"phoneNumber\": \"966511234623\",\n \"firstName\": \"ibrahim\",\n \"lastName\": \"sahin\",\n \"invoiceType\": \"freelancer\",\n \"freelancerNumber\": null,\n \"nationalId\": null,\n \"unifiedNumber\": null,\n \"bankId\": 40,\n \"BankIban\": \"SA0380049800608010167519\",\n \"BankHolderName\": \"ibrahim sahin\",\n \"address\" : {\n \"addressText\": \"Riyadh Front Exhibition & Conference Center, Riyadh\",\n \"city\": \"Riyadh\",\n \"stateName\": \"Riyadh Province\",\n \"districtName\": \"King Khalid International Airport\",\n \"neighbourhoodName\": \"King Khalid International Airport\",\n \"street\": \"RPPH+7PH\",\n \"buildingName\": null,\n \"zipCode\": \"13413\",\n \"lat\": 24.8356823,\n \"lng\": 46.729356,\n \"shortAddressCode\": null,\n \"secondary\": null\n }\n}","type":"text","uuid":"a8abece7-f403-4da9-a76a-8c12200fd54b"}]},"url":"https://dashboard.tammim.app/api/v1/register"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"userType\": \"seller\",\r\n\t\"idToken\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjFjMzIxOT...\",\r\n\t\"refreshToken\": \"AMf-vBzD2f3NV_1FVzLLEwrsQtAtSegjE...\",\r\n\t\"email\": \"freeelancery@example.com\",\r\n\t\"expiresIn\": \"3600\",\r\n\t\"userID\": \"234\"\r\n \"sessionCreate\": true,\r\n \"forceLogoutDays\": 3,\r\n\t\"success\": true\r\n}\r\n"},{"id":"afb0142c-f5e6-44d4-8fbe-a9a7f44259e9","name":"400-Missing Email","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Cookie","value":"session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjE2MiwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjM5MSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTUyNTIwNSwidXNlcl9pZCI6Ikdza3B6WDJGc1hTOE1NbFcyeVZpYVhkTnJKNzMiLCJzdWIiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwiaWF0IjoxNzY5NTI1MjA2LCJleHAiOjE3Njk3ODQ0MDYsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTI0QGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJpLnNhaGluLnRhbW1pbS4xMjRAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoiY3VzdG9tIn19.TR9gfSJrK47K4NAXKVoqbz9E9hHmgUBIQwoWAuhzodmpfScuUPDMNz_JxieIn7M2niLwnNCkEqjO7LQJdDAz677IbCG5mg_rJpTjbjH4i3Hbsco8avCFr2_8BGCgwLFIc7QUn30uJhL4fsyUw4-FVV3srhWVBX3WKqIg5moPITfwd9cBpenY9n0oeSQqWX4zCFChOgDtQtrAc7DgYQpSfpppz0es2hI16XnBtRAU29JycTdpLxQg6RZd80yez0wghtJM7vI45KelvLSA0Y6tsXWjz8ZsKzo7IWo58_gfJQ8AD4dqnljOpvINI1VN1ozBbvzTTZrzxJaa35JsYzMgsA; session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjE2MiwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjM5MSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTUyNTIwNSwidXNlcl9pZCI6Ikdza3B6WDJGc1hTOE1NbFcyeVZpYVhkTnJKNzMiLCJzdWIiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwiaWF0IjoxNzY5NTI1MjA2LCJleHAiOjE3Njk3ODQ0MDYsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTI0QGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJpLnNhaGluLnRhbW1pbS4xMjRAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoiY3VzdG9tIn19.TR9gfSJrK47K4NAXKVoqbz9E9hHmgUBIQwoWAuhzodmpfScuUPDMNz_JxieIn7M2niLwnNCkEqjO7LQJdDAz677IbCG5mg_rJpTjbjH4i3Hbsco8avCFr2_8BGCgwLFIc7QUn30uJhL4fsyUw4-FVV3srhWVBX3WKqIg5moPITfwd9cBpenY9n0oeSQqWX4zCFChOgDtQtrAc7DgYQpSfpppz0es2hI16XnBtRAU29JycTdpLxQg6RZd80yez0wghtJM7vI45KelvLSA0Y6tsXWjz8ZsKzo7IWo58_gfJQ8AD4dqnljOpvINI1VN1ozBbvzTTZrzxJaa35JsYzMgsA; session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjE2MiwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjM5MSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTUyNTIwNSwidXNlcl9pZCI6Ikdza3B6WDJGc1hTOE1NbFcyeVZpYVhkTnJKNzMiLCJzdWIiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwiaWF0IjoxNzY5NTI1MjA2LCJleHAiOjE3Njk3ODQ0MDYsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTI0QGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJpLnNhaGluLnRhbW1pbS4xMjRAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoiY3VzdG9tIn19.TR9gfSJrK47K4NAXKVoqbz9E9hHmgUBIQwoWAuhzodmpfScuUPDMNz_JxieIn7M2niLwnNCkEqjO7LQJdDAz677IbCG5mg_rJpTjbjH4i3Hbsco8avCFr2_8BGCgwLFIc7QUn30uJhL4fsyUw4-FVV3srhWVBX3WKqIg5moPITfwd9cBpenY9n0oeSQqWX4zCFChOgDtQtrAc7DgYQpSfpppz0es2hI16XnBtRAU29JycTdpLxQg6RZd80yez0wghtJM7vI45KelvLSA0Y6tsXWjz8ZsKzo7IWo58_gfJQ8AD4dqnljOpvINI1VN1ozBbvzTTZrzxJaa35JsYzMgsA","disabled":true},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"civilFile","type":"file","uuid":"5f55df87-5764-4d06-a574-da49608940c1","src":"/Users/ibrahim/Downloads/files_%2F414%2FcivilFile%2F33125566-4572-4893-b72e-9e7ae18504a3.docx"},{"key":"companyFile","type":"file","uuid":"27a3f8b2-73c8-4a18-93bb-aa59e5bb9b14","src":"/Users/ibrahim/Downloads/files_%2f414%2FcivilFile%2F3d14cc2a-d00d-468a-b922-347fc9b654e5.docx"},{"key":"data","value":"{\n \"password\": \"Qw123456\",\n \"phoneNumber\": \"966511232323\",\n \"firstName\": \"ibrahim\",\n \"lastName\": \"sahin\",\n \"invoiceType\": \"company\",\n \"VATNumber\": \"312391230912390\",\n \"CRNumber\": \"5646546545\",\n \"unifiedNumber\": \"7321231231\",\n \"nationalId\": null,\n \"bankId\": 40,\n \"BankIban\": \"SA2312312123132132312123123\",\n \"BankHolderName\": \"bank holfe\",\n \"address\": {\n \"addressText\": \"Riyadh Front Exhibition & Conference Center, Riyadh\",\n \"city\": \"Riyadh\",\n \"stateName\": \"Riyadh Province\",\n \"districtName\": \"King Khalid International Airport\",\n \"neighbourhoodName\": \"King Khalid International Airport\",\n \"street\": \"RPPH+7PH\",\n \"buildingName\": null,\n \"zipCode\": \"13413\",\n \"lat\": 24.8356823,\n \"lng\": 46.729356,\n \"shortAddressCode\": null,\n \"secondary\": null\n }\n}","type":"text","uuid":"272d4132-dac1-4d86-bcfa-b09478420efc"}]},"url":"https://dashboard.tammim.app/api/v1/register"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n\t\"error\": \"Missing required field: email\"\r\n}"},{"id":"6d5f265d-75f1-4a17-a8c0-d7d823996806","name":"400-Invalid Invoice Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Cookie","value":"session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjE2MiwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjM5MSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTUyNTIwNSwidXNlcl9pZCI6Ikdza3B6WDJGc1hTOE1NbFcyeVZpYVhkTnJKNzMiLCJzdWIiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwiaWF0IjoxNzY5NTI1MjA2LCJleHAiOjE3Njk3ODQ0MDYsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTI0QGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJpLnNhaGluLnRhbW1pbS4xMjRAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoiY3VzdG9tIn19.TR9gfSJrK47K4NAXKVoqbz9E9hHmgUBIQwoWAuhzodmpfScuUPDMNz_JxieIn7M2niLwnNCkEqjO7LQJdDAz677IbCG5mg_rJpTjbjH4i3Hbsco8avCFr2_8BGCgwLFIc7QUn30uJhL4fsyUw4-FVV3srhWVBX3WKqIg5moPITfwd9cBpenY9n0oeSQqWX4zCFChOgDtQtrAc7DgYQpSfpppz0es2hI16XnBtRAU29JycTdpLxQg6RZd80yez0wghtJM7vI45KelvLSA0Y6tsXWjz8ZsKzo7IWo58_gfJQ8AD4dqnljOpvINI1VN1ozBbvzTTZrzxJaa35JsYzMgsA; session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjE2MiwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjM5MSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTUyNTIwNSwidXNlcl9pZCI6Ikdza3B6WDJGc1hTOE1NbFcyeVZpYVhkTnJKNzMiLCJzdWIiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwiaWF0IjoxNzY5NTI1MjA2LCJleHAiOjE3Njk3ODQ0MDYsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTI0QGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJpLnNhaGluLnRhbW1pbS4xMjRAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoiY3VzdG9tIn19.TR9gfSJrK47K4NAXKVoqbz9E9hHmgUBIQwoWAuhzodmpfScuUPDMNz_JxieIn7M2niLwnNCkEqjO7LQJdDAz677IbCG5mg_rJpTjbjH4i3Hbsco8avCFr2_8BGCgwLFIc7QUn30uJhL4fsyUw4-FVV3srhWVBX3WKqIg5moPITfwd9cBpenY9n0oeSQqWX4zCFChOgDtQtrAc7DgYQpSfpppz0es2hI16XnBtRAU29JycTdpLxQg6RZd80yez0wghtJM7vI45KelvLSA0Y6tsXWjz8ZsKzo7IWo58_gfJQ8AD4dqnljOpvINI1VN1ozBbvzTTZrzxJaa35JsYzMgsA; session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjE2MiwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjM5MSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTUyNTIwNSwidXNlcl9pZCI6Ikdza3B6WDJGc1hTOE1NbFcyeVZpYVhkTnJKNzMiLCJzdWIiOiJHc2twelgyRnNYUzhNTWxXMnlWaWFYZE5ySjczIiwiaWF0IjoxNzY5NTI1MjA2LCJleHAiOjE3Njk3ODQ0MDYsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTI0QGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJpLnNhaGluLnRhbW1pbS4xMjRAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoiY3VzdG9tIn19.TR9gfSJrK47K4NAXKVoqbz9E9hHmgUBIQwoWAuhzodmpfScuUPDMNz_JxieIn7M2niLwnNCkEqjO7LQJdDAz677IbCG5mg_rJpTjbjH4i3Hbsco8avCFr2_8BGCgwLFIc7QUn30uJhL4fsyUw4-FVV3srhWVBX3WKqIg5moPITfwd9cBpenY9n0oeSQqWX4zCFChOgDtQtrAc7DgYQpSfpppz0es2hI16XnBtRAU29JycTdpLxQg6RZd80yez0wghtJM7vI45KelvLSA0Y6tsXWjz8ZsKzo7IWo58_gfJQ8AD4dqnljOpvINI1VN1ozBbvzTTZrzxJaa35JsYzMgsA","disabled":true},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"civilFile","type":"file","uuid":"5f55df87-5764-4d06-a574-da49608940c1","src":"/Users/ibrahim/Downloads/files_%2F414%2FcivilFile%2F33125566-4572-4893-b72e-9e7ae18504a3.docx"},{"key":"companyFile","type":"file","uuid":"27a3f8b2-73c8-4a18-93bb-aa59e5bb9b14","src":"/Users/ibrahim/Downloads/files_%2f414%2FcivilFile%2F3d14cc2a-d00d-468a-b922-347fc9b654e5.docx"},{"key":"data","value":"{\n \"email\": \"i.sahin.tammim.1003@gmail.com\",\n \"password\": \"Qw123456\",\n \"phoneNumber\": \"966511232323\",\n \"firstName\": \"ibrahim\",\n \"lastName\": \"sahin\",\n \"invoiceType\": \"null\",\n \"VATNumber\": \"312391230912390\",\n \"CRNumber\": \"5646546545\",\n \"unifiedNumber\": \"7321231231\",\n \"nationalId\": null,\n \"bankId\": 40,\n \"BankIban\": \"SA2312312123132132312123123\",\n \"BankHolderName\": \"bank holfe\",\n \"address\": {\n \"addressText\": \"Riyadh Front Exhibition & Conference Center, Riyadh\",\n \"city\": \"Riyadh\",\n \"stateName\": \"Riyadh Province\",\n \"districtName\": \"King Khalid International Airport\",\n \"neighbourhoodName\": \"King Khalid International Airport\",\n \"street\": \"RPPH+7PH\",\n \"buildingName\": null,\n \"zipCode\": \"13413\",\n \"lat\": 24.8356823,\n \"lng\": 46.729356,\n \"shortAddressCode\": null,\n \"secondary\": null\n }\n}","type":"text","uuid":"272d4132-dac1-4d86-bcfa-b09478420efc"}]},"url":"https://dashboard.tammim.app/api/v1/register"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"error\": \"Invalid or missing invoiceType\"\r\n}"}],"_postman_id":"bf332566-963f-4e5f-ad00-74ae94e1f931"}],"id":"4bc864d2-eec6-4f90-b940-2c9efa115070","description":"This endpoint allows freelancers and companies to create a seller profile by submitting required personal or business information, bank details, address data, and supporting documents.
\n","_postman_id":"4bc864d2-eec6-4f90-b940-2c9efa115070"},{"name":"Sign In","item":[{"name":"Sign In","id":"ef85189b-9e38-4c68-b483-39e4e3f0cef3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\" : \"i.sahin.tammim.1006@gmail.com\",\n \"password\" : \"Qw123456\"\n}","options":{"raw":{"language":"json"}}},"url":"{{tammim-url}}/api/v1/signIn","urlObject":{"path":["api","v1","signIn"],"host":["{{tammim-url}}"],"query":[],"variable":[]}},"response":[{"id":"627e0194-97db-4a5d-8e0a-fbbb41d1b883","name":"200- Sign In","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\" : \"i.sahin.tammim.1006@gmail.com\",\n \"password\" : \"Qw123456\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.tammim.app/api/v1/signIn"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"kind\": \"identitytoolkit#SignupNewUserResponse\",\n \"idToken\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjFjMzIxOTgzNGRhNTBlMjBmYWVhZWE3Yzg2Y2U3YjU1MzhmMTdiZTEiLCJ0eXAiOiJKV1QifQ...\",\n \"email\": \"user@example.com\",\n \"refreshToken\": \"AMf-vByw8M9jYyzL-czaerLQCBZsfS8lqKpOO2dkJgdQgRBPDT6wnUjoA6i6S29KzBGB3UsCRtRQMJw7oeADRjbLQh09MZp1B4aLgC3nZ8smVaZNtR5dm8...\",\n \"expiresIn\": \"3600\",\n \"localId\": \"pOKhVzbIgGZTPoGlkvyM1NdDlWI3\"\n}"},{"id":"8ae3f901-5135-4ea5-9cd3-51b471f19007","name":"400- Sign In","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\" : \"i.sahin.tammim.1006@gmail.com\",\n \"password\" : \"Qw1234564444\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.tammim.app/api/v1/signIn"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n\t\"error\": \"Signup failed: INVALID_PASSWORD\"\r\n}"}],"_postman_id":"ef85189b-9e38-4c68-b483-39e4e3f0cef3"}],"id":"93e1cf96-a638-4f2c-b856-dec628667870","description":"This API endpoint authenticates a user using email and password credentials. Returns authentication tokens that can be used to access protected API endpoints.
\nAuthentication
\nNo authentication required - This is a public endpoint
\nRequest Headers
\nContent-Type: application/json
\nRequest Body
\nResponse Fields
\n","_postman_id":"93e1cf96-a638-4f2c-b856-dec628667870"},{"name":"Authorization","item":[{"name":"Refresh Token","id":"2a6150bc-c39c-421e-a32f-bf0bd47d0cb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"refresh_token\" : \"AMf-vByZj9SLsU06ql1_fRCeAXeUVJTNtT4eCDsqLSt8bJ2ypG23G33F30PVDQfDrKa2ol5ysNJczAQ8mOhcv7ay54f0DG_keicbOcaC3BYFxqrfkcas5yyNtmuAijWdsZgPNedzVZL54E9fvZKA0oXs5HfHKt8zONB-DwHcF5iOmWUYS-JnsZ0\",\n \"grand_type\" : \"refresh_token\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.tammim.app/api/v1/refreshToken","description":"This API endpoint covers the authentication endpoints for the Tammim API. After registering an account, users receive authentication tokens that must be included in subsequent API requests. This document explains how to sign in to your account and refresh expired tokens.
\nRegister a new account using /register endpoint
\nReceive idToken and refreshToken in the registration response
\nUse idToken (also called access_token) in Authorization header for API requests
\nWhen idToken expires (after 3600 seconds), use refreshToken to get a new idToken
\nIf refreshToken expires, sign in again using email and password
\nAll authenticated API endpoints require the access token (idToken) to be included in the request headers:
\n*Authorization: Bearer {access_token}
Cookie: session={access_token}
*
This API endpoint exchanges a valid refresh token for a new access token (idToken). Use this endpoint when your access token expires (after 3600 seconds) to obtain a new one without requiring the user to sign in again.
\nAuthentication
\nNo authentication required - Uses refresh token for validation
\nRequest Headers
\nContent-Type: application/json
\nRequest Body
\nResponse Fields
\n· Store tokens securely (use secure storage mechanisms)
\n· Never store tokens in plain text or in client-side code
\n· Use httpOnly cookies for web applications when possible
\n· Clear tokens on logout
\n· Refresh tokens proactively before expiration (e.g., 1 minute before)
\n· Implement automatic retry logic for 401 errors
\n· Handle refresh token expiration gracefully
\n· Redirect to login page if refresh fails
\n· Always use HTTPS for authentication requests
\n· Never log or expose tokens in error messages
\n· Implement rate limiting for sign in attempts
\n· Use strong password requirements
\n· Monitor for suspicious authentication activity
\n· Implement proper error handling for authentication failures
\n· Provide clear error messages to users
\n· Log authentication errors for security monitoring
\n· Handle network errors and timeouts gracefully
\n1. Registration/Sign In: Receive idToken and refreshToken
\n2. Active Use: Use idToken for API requests (valid for 3600 seconds)
\n3. Near Expiry: Refresh token proactively before expiration
\n4. Token Refresh: Exchange refreshToken for new idToken
\n5. Continued Use: Use new idToken for API requests
\n6. Logout/Session End: Clear all stored tokens
\n","_postman_id":"b6ebefa7-4ce1-40f5-bab6-af16ca9a31ea"},{"name":"Checkout","item":[{"name":"Checkout","id":"a9c171b7-47ac-48a8-98cb-2c768a4dd755","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"merchant_id\": \"196\",\n \"reference_id\": \"order-67890-122\",\n \"currency\": \"SAR\",\n \"returnUrl\": \"https://merchant.com/success\",\n \"cancelUrl\": \"https://merchant.com/cancel\",\n \"customer\": {\n \"code\": \"CUST001\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"+966500000000\"\n },\n \"customer_address\": {\n \"city\": \"Riyadh\",\n \"district\": \"Al Olaya\",\n \"street\": \"King Fahd Road\",\n \"fullAddress\": \"123 King Fahd Road, Riyadh, Saudi Arabia\",\n \"shortCode\": \"KFR123\",\n \"country\": \"SA\",\n \"zipCode\": \"11564\",\n \"building\": \"Building 10\"\n },\n \"cart\": [\n {\n \"sku\": \"PROD001\",\n \"name\": \"Product 1\",\n \"quantity\": 2,\n \"unit_price\": 50.75,\n \"image\": \"https://merchant.com/images/prod001.jpg\"\n },\n {\n \"sku\": \"PROD002\",\n \"name\": \"Product 2\",\n \"quantity\": 1,\n \"unit_price\": 100.00,\n \"image\": \"https://merchant.com/images/prod002.jpg\"\n }\n ],\n \"totals\": {\n \"subtotal\": 201.50,\n \"discounts\": 10.00,\n \"tax\": 15.00,\n \"grand_total\": 206.50\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dashboard.tammim.app/api/v1/checkout/initiate","urlObject":{"protocol":"https","path":["api","v1","checkout","initiate"],"host":["dashboard","tammim","app"],"query":[],"variable":[]}},"response":[{"id":"5ead0b70-3948-444f-8894-c7d2ae2a4d5d","name":"200-Checkout","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImY3NThlNTYzYzBiNjRhNzVmN2UzZGFlNDk0ZDM5NTk1YzE0MGVmOTMiLCJ0eXAiOiJKV1QifQ.eyJmaXJlYmFzZVVJRCI6IjBQU01sUU8wZFBkME5reHZGbUxlZHdJRG1HNTIiLCJwaG9uZU51bWJlciI6Ijk2NjUxMTIzNDYyMyIsInRhbW1pbUNvbXBhbnlJRCI6MjA0LCJ1c2VyVHlwZSI6InNlbGxlciIsInVzZXJJRCI6NDM1LCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3Njk3NzEyODMsInVzZXJfaWQiOiIwUFNNbFFPMGRQZDBOa3h2Rm1MZWR3SURtRzUyIiwic3ViIjoiMFBTTWxRTzBkUGQwTmt4dkZtTGVkd0lEbUc1MiIsImlhdCI6MTc2OTc3MTI4MywiZXhwIjoxNzY5Nzc0ODgzLCJlbWFpbCI6Imkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbImkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.IrNfeReXzvHXAT_kUrqSq0hWmArHNCpz2HfQFVC6x4VDztj0yJgptUr2JfbzOWj_2Zk2jANNvG8O3CMFpog5GJa63dOh4fvalZHDtN1YAdwfMv5tnta8goq2CI_l_T6kwD-Lpmz3SHA9ynhgTxV91YaQQBxzggRunmSSBrrMDfGQZ8NJRnTPOenXgZEdlxQGrWRVIsAPOKKUoSqwUWwgIBMGefy9kbFgpODD6WmfoxwG9cRSU0VtGSqAnAOC51lMiqi4gksT-jSHys94ugWIHFTAz4brZ4Yy0dTtCBbG3jnlZ-TdQ_2ss_Y2KUrD4cg-6lexAq0M9KXBDJG11KD8Qw","disabled":true},{"key":"Content-Type","value":"application/json"},{"key":"Cookie","value":"session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiIwUFNNbFFPMGRQZDBOa3h2Rm1MZWR3SURtRzUyIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjIwNCwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjQzNSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTc3MTIxNCwidXNlcl9pZCI6IjBQU01sUU8wZFBkME5reHZGbUxlZHdJRG1HNTIiLCJzdWIiOiIwUFNNbFFPMGRQZDBOa3h2Rm1MZWR3SURtRzUyIiwiaWF0IjoxNzY5NzcxMjE0LCJleHAiOjE3NzAwMzA0MTQsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTAwNkBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsiaS5zYWhpbi50YW1taW0uMTAwNkBnbWFpbC5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJjdXN0b20ifX0.opl8wQ46Y-kRLIKGD1waBJ94WIM4u-q3cYRpebufCU_iEiKmtlt1OM4DtWhArA6Jej1vlDf8Ut2COrxg0axEHEeJhogl02idB2siZY4SSRLmRpWj_SmcCrwq-GUvFaR72UXqxUTOETYI35ll7I3aN-Y16l-RGHTwMZFGPRlyYMm6cOG7MHpYmVkvxoesz17N1nH9m1jekWyxHF4oqI5xx_NGoK2e6kNQE6wRA6MAF6Z1sy1-znCZpzf7L6EYDs-4mZRCmK4p3wXdU-CCT6HqVZCQ6r4tOuSH_1sR1Y1GLRRG7fTwmTnotPgghMY1Npk5yj0o-ID8Toedt38VjdsnOA","disabled":true}],"body":{"mode":"raw","raw":"{\n \"merchant_id\": \"196\",\n \"reference_id\": \"order-67890-122\",\n \"currency\": \"SAR\",\n \"returnUrl\": \"https://merchant.com/success\",\n \"cancelUrl\": \"https://merchant.com/cancel\",\n \"customer\": {\n \"code\": \"CUST001\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"+966500000000\"\n },\n \"customer_address\": {\n \"city\": \"Riyadh\",\n \"district\": \"Al Olaya\",\n \"street\": \"King Fahd Road\",\n \"fullAddress\": \"123 King Fahd Road, Riyadh, Saudi Arabia\",\n \"shortCode\": \"KFR123\",\n \"country\": \"SA\",\n \"zipCode\": \"11564\",\n \"building\": \"Building 10\"\n },\n \"cart\": [\n {\n \"sku\": \"PROD001\",\n \"name\": \"Product 1\",\n \"quantity\": 2,\n \"unit_price\": 50.75,\n \"image\": \"https://merchant.com/images/prod001.jpg\"\n },\n {\n \"sku\": \"PROD002\",\n \"name\": \"Product 2\",\n \"quantity\": 1,\n \"unit_price\": 100.00,\n \"image\": \"https://merchant.com/images/prod002.jpg\"\n }\n ],\n \"totals\": {\n \"subtotal\": 201.50,\n \"discounts\": 10.00,\n \"tax\": 15.00,\n \"grand_total\": 206.50\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://oto-tammim-web-api-924792569625.europe-west1.run.app/api/v1/checkout/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"checkout_url\": \"https://domain.com/checkout?key=abc123xyz\",\n \"tammim_session_id\": \"abc123xyz\"\n}"},{"id":"21451721-d5ec-4093-a4ea-709c3bc2bbd9","name":"400-Checkout","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImY3NThlNTYzYzBiNjRhNzVmN2UzZGFlNDk0ZDM5NTk1YzE0MGVmOTMiLCJ0eXAiOiJKV1QifQ.eyJmaXJlYmFzZVVJRCI6IjBQU01sUU8wZFBkME5reHZGbUxlZHdJRG1HNTIiLCJwaG9uZU51bWJlciI6Ijk2NjUxMTIzNDYyMyIsInRhbW1pbUNvbXBhbnlJRCI6MjA0LCJ1c2VyVHlwZSI6InNlbGxlciIsInVzZXJJRCI6NDM1LCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3Njk3NzEyODMsInVzZXJfaWQiOiIwUFNNbFFPMGRQZDBOa3h2Rm1MZWR3SURtRzUyIiwic3ViIjoiMFBTTWxRTzBkUGQwTmt4dkZtTGVkd0lEbUc1MiIsImlhdCI6MTc2OTc3MTI4MywiZXhwIjoxNzY5Nzc0ODgzLCJlbWFpbCI6Imkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbImkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.IrNfeReXzvHXAT_kUrqSq0hWmArHNCpz2HfQFVC6x4VDztj0yJgptUr2JfbzOWj_2Zk2jANNvG8O3CMFpog5GJa63dOh4fvalZHDtN1YAdwfMv5tnta8goq2CI_l_T6kwD-Lpmz3SHA9ynhgTxV91YaQQBxzggRunmSSBrrMDfGQZ8NJRnTPOenXgZEdlxQGrWRVIsAPOKKUoSqwUWwgIBMGefy9kbFgpODD6WmfoxwG9cRSU0VtGSqAnAOC51lMiqi4gksT-jSHys94ugWIHFTAz4brZ4Yy0dTtCBbG3jnlZ-TdQ_2ss_Y2KUrD4cg-6lexAq0M9KXBDJG11KD8Qw","disabled":true},{"key":"Content-Type","value":"application/json"},{"key":"Cookie","value":"session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiIwUFNNbFFPMGRQZDBOa3h2Rm1MZWR3SURtRzUyIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjIwNCwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjQzNSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTc3MTIxNCwidXNlcl9pZCI6IjBQU01sUU8wZFBkME5reHZGbUxlZHdJRG1HNTIiLCJzdWIiOiIwUFNNbFFPMGRQZDBOa3h2Rm1MZWR3SURtRzUyIiwiaWF0IjoxNzY5NzcxMjE0LCJleHAiOjE3NzAwMzA0MTQsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTAwNkBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsiaS5zYWhpbi50YW1taW0uMTAwNkBnbWFpbC5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJjdXN0b20ifX0.opl8wQ46Y-kRLIKGD1waBJ94WIM4u-q3cYRpebufCU_iEiKmtlt1OM4DtWhArA6Jej1vlDf8Ut2COrxg0axEHEeJhogl02idB2siZY4SSRLmRpWj_SmcCrwq-GUvFaR72UXqxUTOETYI35ll7I3aN-Y16l-RGHTwMZFGPRlyYMm6cOG7MHpYmVkvxoesz17N1nH9m1jekWyxHF4oqI5xx_NGoK2e6kNQE6wRA6MAF6Z1sy1-znCZpzf7L6EYDs-4mZRCmK4p3wXdU-CCT6HqVZCQ6r4tOuSH_1sR1Y1GLRRG7fTwmTnotPgghMY1Npk5yj0o-ID8Toedt38VjdsnOA","disabled":true}],"body":{"mode":"raw","raw":"{\n \"merchant_id\": \"196aaaa\",\n \"reference_id\": \"order-67890-122\",\n \"currency\": \"SAR\",\n \"returnUrl\": \"https://merchant.com/success\",\n \"cancelUrl\": \"https://merchant.com/cancel\",\n \"customer\": {\n \"code\": \"CUST001\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"+966500000000\"\n },\n \"customer_address\": {\n \"city\": \"Riyadh\",\n \"district\": \"Al Olaya\",\n \"street\": \"King Fahd Road\",\n \"fullAddress\": \"123 King Fahd Road, Riyadh, Saudi Arabia\",\n \"shortCode\": \"KFR123\",\n \"country\": \"SA\",\n \"zipCode\": \"11564\",\n \"building\": \"Building 10\"\n },\n \"cart\": [\n {\n \"sku\": \"PROD001\",\n \"name\": \"Product 1\",\n \"quantity\": 2,\n \"unit_price\": 50.75,\n \"image\": \"https://merchant.com/images/prod001.jpg\"\n },\n {\n \"sku\": \"PROD002\",\n \"name\": \"Product 2\",\n \"quantity\": 1,\n \"unit_price\": 100.00,\n \"image\": \"https://merchant.com/images/prod002.jpg\"\n }\n ],\n \"totals\": {\n \"subtotal\": 201.50,\n \"discounts\": 10.00,\n \"tax\": 15.00,\n \"grand_total\": 206.50\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://oto-tammim-web-api-924792569625.europe-west1.run.app/api/v1/checkout/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERROR\",\n \"errorMessage\": \"Invalid merchant_id\"\n}"},{"id":"dd2e8945-b911-42ed-a00d-755f013d2579","name":"400- Already Exist","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImY3NThlNTYzYzBiNjRhNzVmN2UzZGFlNDk0ZDM5NTk1YzE0MGVmOTMiLCJ0eXAiOiJKV1QifQ.eyJmaXJlYmFzZVVJRCI6IjBQU01sUU8wZFBkME5reHZGbUxlZHdJRG1HNTIiLCJwaG9uZU51bWJlciI6Ijk2NjUxMTIzNDYyMyIsInRhbW1pbUNvbXBhbnlJRCI6MjA0LCJ1c2VyVHlwZSI6InNlbGxlciIsInVzZXJJRCI6NDM1LCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3Njk3NzEyODMsInVzZXJfaWQiOiIwUFNNbFFPMGRQZDBOa3h2Rm1MZWR3SURtRzUyIiwic3ViIjoiMFBTTWxRTzBkUGQwTmt4dkZtTGVkd0lEbUc1MiIsImlhdCI6MTc2OTc3MTI4MywiZXhwIjoxNzY5Nzc0ODgzLCJlbWFpbCI6Imkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbImkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.IrNfeReXzvHXAT_kUrqSq0hWmArHNCpz2HfQFVC6x4VDztj0yJgptUr2JfbzOWj_2Zk2jANNvG8O3CMFpog5GJa63dOh4fvalZHDtN1YAdwfMv5tnta8goq2CI_l_T6kwD-Lpmz3SHA9ynhgTxV91YaQQBxzggRunmSSBrrMDfGQZ8NJRnTPOenXgZEdlxQGrWRVIsAPOKKUoSqwUWwgIBMGefy9kbFgpODD6WmfoxwG9cRSU0VtGSqAnAOC51lMiqi4gksT-jSHys94ugWIHFTAz4brZ4Yy0dTtCBbG3jnlZ-TdQ_2ss_Y2KUrD4cg-6lexAq0M9KXBDJG11KD8Qw","disabled":true},{"key":"Content-Type","value":"application/json"},{"key":"Cookie","value":"session=eyJhbGciOiJSUzI1NiIsImtpZCI6IjB1a2x0QSJ9.eyJpc3MiOiJodHRwczovL3Nlc3Npb24uZmlyZWJhc2UuZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiZmlyZWJhc2VVSUQiOiIwUFNNbFFPMGRQZDBOa3h2Rm1MZWR3SURtRzUyIiwicGhvbmVOdW1iZXIiOiI5NjY1MTEyMzQ2MjMiLCJ0YW1taW1Db21wYW55SUQiOjIwNCwidXNlclR5cGUiOiJzZWxsZXIiLCJ1c2VySUQiOjQzNSwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTc2OTc3MTIxNCwidXNlcl9pZCI6IjBQU01sUU8wZFBkME5reHZGbUxlZHdJRG1HNTIiLCJzdWIiOiIwUFNNbFFPMGRQZDBOa3h2Rm1MZWR3SURtRzUyIiwiaWF0IjoxNzY5NzcxMjE0LCJleHAiOjE3NzAwMzA0MTQsImVtYWlsIjoiaS5zYWhpbi50YW1taW0uMTAwNkBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsiaS5zYWhpbi50YW1taW0uMTAwNkBnbWFpbC5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJjdXN0b20ifX0.opl8wQ46Y-kRLIKGD1waBJ94WIM4u-q3cYRpebufCU_iEiKmtlt1OM4DtWhArA6Jej1vlDf8Ut2COrxg0axEHEeJhogl02idB2siZY4SSRLmRpWj_SmcCrwq-GUvFaR72UXqxUTOETYI35ll7I3aN-Y16l-RGHTwMZFGPRlyYMm6cOG7MHpYmVkvxoesz17N1nH9m1jekWyxHF4oqI5xx_NGoK2e6kNQE6wRA6MAF6Z1sy1-znCZpzf7L6EYDs-4mZRCmK4p3wXdU-CCT6HqVZCQ6r4tOuSH_1sR1Y1GLRRG7fTwmTnotPgghMY1Npk5yj0o-ID8Toedt38VjdsnOA","disabled":true}],"body":{"mode":"raw","raw":"{\n \"merchant_id\": \"196\",\n \"reference_id\": \"order-67890-122\",\n \"currency\": \"SAR\",\n \"returnUrl\": \"https://merchant.com/success\",\n \"cancelUrl\": \"https://merchant.com/cancel\",\n \"customer\": {\n \"code\": \"CUST001\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"+966500000000\"\n },\n \"customer_address\": {\n \"city\": \"Riyadh\",\n \"district\": \"Al Olaya\",\n \"street\": \"King Fahd Road\",\n \"fullAddress\": \"123 King Fahd Road, Riyadh, Saudi Arabia\",\n \"shortCode\": \"KFR123\",\n \"country\": \"SA\",\n \"zipCode\": \"11564\",\n \"building\": \"Building 10\"\n },\n \"cart\": [\n {\n \"sku\": \"PROD001\",\n \"name\": \"Product 1\",\n \"quantity\": 2,\n \"unit_price\": 50.75,\n \"image\": \"https://merchant.com/images/prod001.jpg\"\n },\n {\n \"sku\": \"PROD002\",\n \"name\": \"Product 2\",\n \"quantity\": 1,\n \"unit_price\": 100.00,\n \"image\": \"https://merchant.com/images/prod002.jpg\"\n }\n ],\n \"totals\": {\n \"subtotal\": 201.50,\n \"discounts\": 10.00,\n \"tax\": 15.00,\n \"grand_total\": 206.50\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://oto-tammim-web-api-924792569625.europe-west1.run.app/api/v1/checkout/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERROR\",\n \"errorMessage\": \"Order with this reference_id already exists\"\n}"}],"_postman_id":"a9c171b7-47ac-48a8-98cb-2c768a4dd755"}],"id":"61f4348d-6d69-4163-a4da-c7e74d3b47cc","description":"This API endpoint initiates a new checkout session and generates a secure payment page URL for the customer. It also creates and stores the associated order, customer, and address records in the system to ensure a complete and traceable transaction flow.
\nAuthentication
\n· Bearer Token is required
\n· USER_ID and TAMMIM_COMPANY_ID must be present in request attributes
\nRequest Headers
\nContent-Type: application/json
\nAuthorization: Bearer {token}
\nRequired Fields
\nOptional Fields
\nCustomer Object
\nCustomer Address Object
\nCart Item Object
\nTotals Object
\nResponse Fields
\n· The system checks for an existing customer using the phone number
\n· If the customer does not exist, new customer, buyer, and address records are created
\n· If the customer exists, the existing ID is used
\n1. Order record is created (status: \"pendingPayment\")
\n2. Product records are created for each cart item
\n3. Order items are created
\n4. Unique link key (linkKey) is generated
\n5. Checkout URL is returned
\nDefault payment method: Credit Card (CC)
\n","_postman_id":"61f4348d-6d69-4163-a4da-c7e74d3b47cc"},{"name":"Webhook","item":[{"name":"Webhook Payload","item":[],"id":"e54ff0fa-2f4d-494f-a74e-b48ce3b03be4","description":"When you register a webhook with the type \"checkoutInitiate\", Tammim will send HTTP POST requests to your configured webhook URL whenever a checkout session is created or updated (including when the payment process is completed). This document provides a detailed description of the payload structure and the data fields included in these webhook notifications.
\nPayload Structure
\nThe webhook payload is sent as JSON in the request body with the following structure.
\nComplete Payload Example
\n{\n \"timestamp\": \"2026-01-27T10:30:45.123+00:00\",\n \"tammim_transaction_id\": 12345,\n \"merchant_ref_id\": \"ORDER-2026-0001\",\n \"status\": \"completed\",\n \"final_total\": 480.00,\n \"customer_details\": {\n \"customer_name\": \"John Doe\",\n \"customer_phone\": \"+905551234567\",\n \"customer_email\": \"john.doe@example.com\",\n \"customer_code\": \"CUST001\"\n },\n \"shipping_details\": {\n \"shipping_fullAddress\": \"Bagdat Avenue No:123 Kadikoy/Istanbul\",\n \"shipping_city\": \"Istanbul\",\n \"shipping_district\": \"Kadikoy\",\n \"shipping_street\": \"Bagdat Avenue\",\n \"shipping_shortCode\": \"KDK123\",\n \"shipping_Building\": \"Block A\",\n \"shipping_zipCode\": \"34710\",\n \"shipping_country\": \"TR\",\n \"selected_carrier\": \"express_shipping\"\n },\n \"payment_details\": {\n \"payment_method\": \"CC\",\n \"payment_transactionID\": 67890,\n \"payment_transaction_status\": \"success\",\n \"payment_transactionTime\": \"2026-01-27T10:30:45.000+00:00\",\n \"payment_failReason\": null\n }\n}\n\n\nRoot Level Fields
\ncustomer_details Object
\nContains information about the customer who initiated the checkout.
\nshipping_details Object
\nContains shipping and delivery address information.
\npayment_details Object
\nContains payment transaction information.
\n","_postman_id":"e54ff0fa-2f4d-494f-a74e-b48ce3b03be4"},{"name":"List Webhook","id":"c98982bb-247c-4f7b-a35e-b919a2169316","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{tammim-url}}/api/v1/webhook/list","description":"This API endpoint allows you retrieves all webhook configurations for the authenticated company.
\nRequest Headers
\nAuthorization: Bearer {token}
\nRequest Parameters
\nNo request parameters required
\n","urlObject":{"path":["api","v1","webhook","list"],"host":["{{tammim-url}}"],"query":[],"variable":[]}},"response":[{"id":"688ee149-975d-4103-8a8c-203b01465fb3","name":"200-List Webhook","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImY3NThlNTYzYzBiNjRhNzVmN2UzZGFlNDk0ZDM5NTk1YzE0MGVmOTMiLCJ0eXAiOiJKV1QifQ.eyJmaXJlYmFzZVVJRCI6IjBQU01sUU8wZFBkME5reHZGbUxlZHdJRG1HNTIiLCJwaG9uZU51bWJlciI6Ijk2NjUxMTIzNDYyMyIsInRhbW1pbUNvbXBhbnlJRCI6MjA0LCJ1c2VyVHlwZSI6InNlbGxlciIsInVzZXJJRCI6NDM1LCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3Njk3NzMxNjgsInVzZXJfaWQiOiIwUFNNbFFPMGRQZDBOa3h2Rm1MZWR3SURtRzUyIiwic3ViIjoiMFBTTWxRTzBkUGQwTmt4dkZtTGVkd0lEbUc1MiIsImlhdCI6MTc2OTc3MzE2OCwiZXhwIjoxNzY5Nzc2NzY4LCJlbWFpbCI6Imkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbImkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.iezgkRiMd1LDhIsUtGveE0tTt396zI5XO9yGS6POLF7E69YytIiUdsPw2ISHiISNS2aVgze5SafSm1sX6RM4N4RXZPLj4j4BBn2Npw9LrKxnBVxYioCoaOxgMIH9xh77F1HyXRVPai2KRJRLjvtk48mKsew2rpRfxWJ-mdY86JJaOEBfadXaY62d6fTiOe-Q8FrPMOS0CujSKYyfp2ZVpPSmUzJtD0r6-K7VC9Qx8ry-cBPiGpuSsJAZ4MWJlO9YIpKXZMnntKrtDxIikS27wpdnWKTzNCi33RbeF5Cx_GKmxSnrcWmG-hVdJGZ525xQxBN8n3hLCTpqeXtkyoA9Vg","type":"text"}],"url":"{{tammim-url}}/api/v1/webhook/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"id\": 1,\n \"webhookurl\": \"https://example.com/webhook/checkout\",\n \"webhookType\": \"checkoutInitiate\"\n },\n {\n \"id\": 2,\n \"webhookurl\": \"https://example.com/webhook/payment\",\n \"webhookType\": \"paymentComplete\"\n }\n ]\n}"},{"id":"d0b32991-5674-4129-b44a-80b9179911f2","name":"400-Invalid Company","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImY3NThlNTYzYzBiNjRhNzVmN2UzZGFlNDk0ZDM5NTk1YzE0MGVmOTMiLCJ0eXAiOiJKV1QifQ.eyJmaXJlYmFzZVVJRCI6IjBQU01sUU8wZFBkME5reHZGbUxlZHdJRG1HNTIiLCJwaG9uZU51bWJlciI6Ijk2NjUxMTIzNDYyMyIsInRhbW1pbUNvbXBhbnlJRCI6MjA0LCJ1c2VyVHlwZSI6InNlbGxlciIsInVzZXJJRCI6NDM1LCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3Njk3NzMxNjgsInVzZXJfaWQiOiIwUFNNbFFPMGRQZDBOa3h2Rm1MZWR3SURtRzUyIiwic3ViIjoiMFBTTWxRTzBkUGQwTmt4dkZtTGVkd0lEbUc1MiIsImlhdCI6MTc2OTc3MzE2OCwiZXhwIjoxNzY5Nzc2NzY4LCJlbWFpbCI6Imkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbImkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.iezgkRiMd1LDhIsUtGveE0tTt396zI5XO9yGS6POLF7E69YytIiUdsPw2ISHiISNS2aVgze5SafSm1sX6RM4N4RXZPLj4j4BBn2Npw9LrKxnBVxYioCoaOxgMIH9xh77F1HyXRVPai2KRJRLjvtk48mKsew2rpRfxWJ-mdY86JJaOEBfadXaY62d6fTiOe-Q8FrPMOS0CujSKYyfp2ZVpPSmUzJtD0r6-K7VC9Qx8ry-cBPiGpuSsJAZ4MWJlO9YIpKXZMnntKrtDxIikS27wpdnWKTzNCi33RbeF5Cx_GKmxSnrcWmG-hVdJGZ525xQxBN8n3hLCTpqeXtkyoA9Vg","type":"text"}],"url":"{{tammim-url}}/api/v1/webhook/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERROR\",\n \"errorMessage\": \"Invalid company\"\n}"}],"_postman_id":"c98982bb-247c-4f7b-a35e-b919a2169316"},{"name":"Add Webhook","id":"0f6b3658-cad6-403f-a831-040f1b723e3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"webhookurl\" : \"webhook.site/236124\",\n \"authorizationKey\" : \"key23234\",\n \"secretKey\" : \"sfddsf2\"\n}","options":{"raw":{"language":"json"}}},"url":"{{tammim-url}}/api/v1/webhook/add","description":"This API endpoint creates a new webhook configuration to receive real-time event notifications.
\nThis endpoint allows clients to register a callback URL, define the events they want to subscribe to, and securely receive automated updates whenever those events occur in the system.
\nRequest Headers
\nAuthorization: Bearer {token}
\nContent-Type: application/json
\nRequest Body
\nRequired Fields
\nOptional Fields
\nResponse Fields
\n","urlObject":{"path":["api","v1","webhook","add"],"host":["{{tammim-url}}"],"query":[],"variable":[]}},"response":[{"id":"e51aaf64-91e6-47db-98f9-e0132b5dc722","name":"200- Add Webhook","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{tammim-token}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"webhookurl\" : \"webhook.site/236124\",\n \"authorizationKey\" : \"key23234\",\n \"secretKey\" : \"sfddsf2\"\n}","options":{"raw":{"language":"json"}}},"url":"{{tammim-url}}/api/v1/webhook/add"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"id\": 123,\n \"webhook\": \"https://example.com/webhook/checkout\"\n}"},{"id":"a0298b36-3982-4b25-b315-af84f324d3dd","name":"400-Webhook URL Required","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{tammim-token}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"authorizationKey\" : \"key23234\",\n \"secretKey\" : \"sfddsf2\"\n}","options":{"raw":{"language":"json"}}},"url":"{{tammim-url}}/api/v1/webhook/add"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERROR\",\n \"error\": \"webhookurl is required!\"\n}"},{"id":"fea82c4c-1a9a-4e48-b421-90c2b9c2e44a","name":"400-Invalid Company","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{tammim-token}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"webhookurl\" : \"webhook.site/236124\",\n \"authorizationKey\" : \"key23234\",\n \"secretKey\" : \"sfddsf2\"\n}","options":{"raw":{"language":"json"}}},"url":"{{tammim-url}}/api/v1/webhook/add"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERROR\",\n \"errorMessage\": \"Invalid company\"\n}"}],"_postman_id":"0f6b3658-cad6-403f-a831-040f1b723e3a"},{"name":"Update Webhook","id":"b2da85e6-626f-4f02-b92b-52a2728c7bc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\" : \"6\",\n \"webhookurl\" : \"updateurl.webhook.site\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oto-tammim-web-api-924792569625.europe-west1.run.app/api/v1/webhook/update","description":"This API endpoint allows clients to modify webhook settings such as the callback URL, subscribed events, authentication details, or activation status.
\nRequest Headers
\nAuthorization: Bearer {token}
\nContent-Type: application/json
\nRequired Fields
\nOptional Fields
\n","urlObject":{"protocol":"https","path":["api","v1","webhook","update"],"host":["oto-tammim-web-api-924792569625","europe-west1","run","app"],"query":[],"variable":[]}},"response":[{"id":"e09e158b-26e1-478a-8d5c-5e735bb6ed64","name":"200-Update Webhook","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImY3NThlNTYzYzBiNjRhNzVmN2UzZGFlNDk0ZDM5NTk1YzE0MGVmOTMiLCJ0eXAiOiJKV1QifQ.eyJmaXJlYmFzZVVJRCI6IjBQU01sUU8wZFBkME5reHZGbUxlZHdJRG1HNTIiLCJwaG9uZU51bWJlciI6Ijk2NjUxMTIzNDYyMyIsInRhbW1pbUNvbXBhbnlJRCI6MjA0LCJ1c2VyVHlwZSI6InNlbGxlciIsInVzZXJJRCI6NDM1LCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3Njk3NzMxNjgsInVzZXJfaWQiOiIwUFNNbFFPMGRQZDBOa3h2Rm1MZWR3SURtRzUyIiwic3ViIjoiMFBTTWxRTzBkUGQwTmt4dkZtTGVkd0lEbUc1MiIsImlhdCI6MTc2OTc3MzE2OCwiZXhwIjoxNzY5Nzc2NzY4LCJlbWFpbCI6Imkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbImkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.iezgkRiMd1LDhIsUtGveE0tTt396zI5XO9yGS6POLF7E69YytIiUdsPw2ISHiISNS2aVgze5SafSm1sX6RM4N4RXZPLj4j4BBn2Npw9LrKxnBVxYioCoaOxgMIH9xh77F1HyXRVPai2KRJRLjvtk48mKsew2rpRfxWJ-mdY86JJaOEBfadXaY62d6fTiOe-Q8FrPMOS0CujSKYyfp2ZVpPSmUzJtD0r6-K7VC9Qx8ry-cBPiGpuSsJAZ4MWJlO9YIpKXZMnntKrtDxIikS27wpdnWKTzNCi33RbeF5Cx_GKmxSnrcWmG-hVdJGZ525xQxBN8n3hLCTpqeXtkyoA9Vg","disabled":true},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\" : \"6\",\n \"webhookurl\" : \"updateurl.webhook.site\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oto-tammim-web-api-924792569625.europe-west1.run.app/api/v1/webhook/update"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b2da85e6-626f-4f02-b92b-52a2728c7bc7"},{"name":"Delete Webhook","id":"541729ea-9919-42bc-91a5-18eb8db292e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\" : \"5\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oto-tammim-web-api-924792569625.europe-west1.run.app/api/v1/webhook/delete","description":"This API endpoint deletes an existing webhook configuration.
\nOnce removed, the webhook will stop receiving all event notifications, effectively unsubscribing the client from any previously registered events.
\nAuthorization: Bearer {token}
\nContent-Type: application/json
\nResponse - Success (200 OK)
\nNo response body is returned. HTTP 200 status indicates successful deletion.
\n","urlObject":{"protocol":"https","path":["api","v1","webhook","delete"],"host":["oto-tammim-web-api-924792569625","europe-west1","run","app"],"query":[],"variable":[]}},"response":[{"id":"295fb043-9aee-458d-8cf2-3e7100aee3bd","name":"200-Delete Webhook","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImY3NThlNTYzYzBiNjRhNzVmN2UzZGFlNDk0ZDM5NTk1YzE0MGVmOTMiLCJ0eXAiOiJKV1QifQ.eyJmaXJlYmFzZVVJRCI6IjBQU01sUU8wZFBkME5reHZGbUxlZHdJRG1HNTIiLCJwaG9uZU51bWJlciI6Ijk2NjUxMTIzNDYyMyIsInRhbW1pbUNvbXBhbnlJRCI6MjA0LCJ1c2VyVHlwZSI6InNlbGxlciIsInVzZXJJRCI6NDM1LCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3Njk3NzMxNjgsInVzZXJfaWQiOiIwUFNNbFFPMGRQZDBOa3h2Rm1MZWR3SURtRzUyIiwic3ViIjoiMFBTTWxRTzBkUGQwTmt4dkZtTGVkd0lEbUc1MiIsImlhdCI6MTc2OTc3MzE2OCwiZXhwIjoxNzY5Nzc2NzY4LCJlbWFpbCI6Imkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbImkuc2FoaW4udGFtbWltLjEwMDZAZ21haWwuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.iezgkRiMd1LDhIsUtGveE0tTt396zI5XO9yGS6POLF7E69YytIiUdsPw2ISHiISNS2aVgze5SafSm1sX6RM4N4RXZPLj4j4BBn2Npw9LrKxnBVxYioCoaOxgMIH9xh77F1HyXRVPai2KRJRLjvtk48mKsew2rpRfxWJ-mdY86JJaOEBfadXaY62d6fTiOe-Q8FrPMOS0CujSKYyfp2ZVpPSmUzJtD0r6-K7VC9Qx8ry-cBPiGpuSsJAZ4MWJlO9YIpKXZMnntKrtDxIikS27wpdnWKTzNCi33RbeF5Cx_GKmxSnrcWmG-hVdJGZ525xQxBN8n3hLCTpqeXtkyoA9Vg","disabled":true},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\" : \"5\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oto-tammim-web-api-924792569625.europe-west1.run.app/api/v1/webhook/delete"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"541729ea-9919-42bc-91a5-18eb8db292e2"}],"id":"3603840c-95c8-44e4-881c-879946a3c7f1","description":"This API endpoint allows sellers to configure and manage webhook endpoints for receiving real-time notifications about checkout events. Webhooks enable automated integration between Tammim and your systems by sending HTTP POST requests to your specified URL when events occur.
\nAuthentication
\n· All webhook management endpoints require authentication:
\n· Bearer Token must be included in the Authorization header
\nResponse Fields
\n","_postman_id":"3603840c-95c8-44e4-881c-879946a3c7f1"},{"name":"Error Messages","item":[],"id":"5bbdc95c-a3eb-411c-b16a-82dd1d622e88","description":"Common Errors & Solutions
\nCommon Errors & Solutions
\n