{"info":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","description":"

Payiano business API is a REST API designed to streamline the development of a payment solution for any platform – online, mobile, or in-person – by setting up a Payiano account. Access all necessary resources for testing and launching your project. It offers a range of modules that cover essential functionalities, ensuring developers can quickly prototype their projects with ease.

Getting Started

Create an individual account from the portal.
Create a new business account.
Create a new application to get your access_token.
Fork this postman collection.
Copy your application token and update the collection access_token variable.

The API encompasses a lot of modules like:

Payment Links:\nProvides a centralized hub where business owners can manage and track payment links, making the collection of payments seamless and efficient. View and organize all your active and expired links in one place.
Customer Management:\nOffers methods for retrieving customer information and managing customer-related operations.
Discounts:\nProviding businesses with crucial insights into their promotional landscape.
Taxes:\nIt helps you manage taxes efficiently. You can set up various taxes and use them for subscriptions, and one-time payments through Checkout.
Transactions:\nMonitor your business financial activities seamlessly. This powerful feature offers a comprehensive view of all transactions made through Payiano, including payments received, refunds issued, and charges applied.

Additionally, the API incorporates advanced features such as filtering and pagination within tall resources allowing developers to efficiently manage data.

To aid developers in utilizing the API effectively, we provide a comprehensive Postman collection that describes the API endpoints and their functionalities.

With the Payiano API, developers can save valuable time and effort by integrating realistic payment solution into their applications swiftly. By offering an intuitive interface and simplified integration, the API empowers developers to focus on delivering exceptional user experiences without compromising on the quality and authenticity of the payment gateway environment.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"}],"owner":"25728032","collectionId":"83ea0f4a-7d43-4a44-879d-194df727a81e","publishedId":"2sB3BBprRi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"1d6dee"},"publishDate":"2025-08-05T09:12:57.000Z"},"item":[{"name":"App","item":[{"name":"Whoami","id":"272c0214-c78d-48eb-a243-731f869f2f06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/app/whoami","description":"

When using Payiano's APIs, it's essential to authenticate each request with a set of unique API credentials that are linked to your Payiano account. This process begins with registering an App on your Payiano dashboard, which is a necessary step to obtain these credentials. Once your App is registered, it acts as a bridge between you and the Payiano API, allowing you to perform a variety of functions relevant to your business needs. For instance, your App can send Payment Links, list Tax information, access account Balances, modify product details, add shipping methods, or manage Customers data. The versatility of the app is further enhanced by its customizable settings, which include setting up the webhook URL, success redirect URL, failed redirect URL, and defining the scope of permissions it has. This level of customization ensures that you can tailor the app to suit a wide range of tasks, enabling efficient and effective interaction with your Payiano account through the API, thereby streamlining various aspects of your business operations.

A list of additional app relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"app.permissions,app.permissions_count"}],"variable":[]}},"response":[{"id":"6c235ef4-fb28-47df-af55-5a2dd8bdf7bb","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/app/whoami","host":["https://api.payiano.dev"],"path":["v1","app","whoami"],"query":[{"value":"app.permissions,app.permissions_count","key":"includes","description":"A list of additional app relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"When using [Payiano](https://payiano.com)'s APIs, it's essential to authenticate each request with a set of unique API credentials that are linked to your [Payiano](https://payiano.com) account. This process begins with registering an App on your [Payiano](https://payiano.com) dashboard, which is a necessary step to obtain these credentials. Once your App is registered, it acts as a bridge between you and the [Payiano](https://payiano.com) API, allowing you to perform a variety of functions relevant to your business needs. For instance, your App can send [Payment Links](https://docs.payiano.com/api/rest/v1/company/online-payments/payment-links/list), list [Tax](https://docs.payiano.com/api/rest/v1/company/taxes/list) information, access account [Balances](https://docs.payiano.com/api/rest/v1/company/online-payments/balances/list), modify product details, add shipping methods, or manage [Customers](https://docs.payiano.com/api/rest/v1/company/customers/list) data. The versatility of the app is further enhanced by its customizable settings, which include setting up the webhook URL, success redirect URL, failed redirect URL, and defining the scope of permissions it has. This level of customization ensures that you can tailor the app to suit a wide range of tasks, enabling efficient and effective interaction with your [Payiano](https://payiano.com) account through the API, thereby streamlining various aspects of your business operations."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"app\": {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"name\": \"Graply integration APP\",\n \"key\": \"303168716b613033636e63686679736168777674336e636464335f3031687\",\n \"token\": \"eyJpdiI6IjRJL291L2YyeGVxc2NhRzE5bVd6RlE9PSIsInZhbHVlIjoiMVpmdTJmNmUxQndXWlVacm1WZ2dBQ1dyeSttZFJXWGJkMDVrci85Nm\",\n \"platform\": \"Shopify\",\n \"is_active\": true,\n \"error_redirect_url\": \"https://graply.com/payments/error\",\n \"success_redirect_url\": \"https://graply.com/payments/success\",\n \"webhook_urls\": [\n \"https://api.graply.com/wbhook/payments\",\n \"https://api.graply.dev/wbhook/payments\"\n ],\n \"description\": \"This is the Shopify app.\",\n \"permissions_count\": 1,\n \"permissions\": [\n {\n \"name\": \"company_update\",\n \"is_app\": true\n }\n ],\n \"created_at\": \"2024-01-07 19:40:05\",\n \"updated_at\": \"2024-01-07 19:40:05\"\n }\n}"}],"_postman_id":"272c0214-c78d-48eb-a243-731f869f2f06"}],"id":"d787b905-03e6-433b-9809-227f637363f1","_postman_id":"d787b905-03e6-433b-9809-227f637363f1","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}},{"name":"Customers","item":[{"name":"Customers","item":[{"name":"Customer Addresses","item":[{"name":"List Addresses","id":"dcb63e72-9890-4ce5-9063-195a83b00cb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customers/:customer_id/addresses","description":"

The list customer addresses feature in Payiano acts as an online address book tailored for businesses. It gathers all the addresses of a business's customers in a single spot, making it incredibly convenient. This feature is a game-changer for sending products to the right addresses, designing special promotions for customers based on their location, and ensuring that every customer feels valued with personalized deals and updates relevant to their area.

Easy access to this organized list allows businesses to deliver products efficiently, foster a closer relationship with their customers by tailoring their offerings, and increase customer satisfaction by showing a deep understanding of their preferences and requirements. It's all about making business operations smoother and keeping customers engaged and content by making sure they're getting exactly what they need, when they need it, where they live.

The page number to be retrieved, for the list of customer address. So, a combination of page=1 and per_page=25 returns the first 25 customer address. A combination of page=2 and per_page=25 returns the next 25 customer address.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of customer address to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of customer address, you can specify a particular column as a reference point for organizing the items in a specific order.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

This refers to the way by which you would like to sort or order the results. When retrieving a list of customer address, you can specify a particular way for organizing the items in a specific order, such as ascending or descending.

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

An easy and effective free search text to search customer address. Please provide a minimum of 3 characters for each search item. This ensures that your search query is specific enough to yield relevant results.

\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"

A list of additional customer address relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"customer_address.country"}],"variable":[{"type":"any","key":"customer_id"}]}},"response":[{"id":"78820e43-394f-42b2-89ed-9e63eedc1aff","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customers/:customer_id/addresses","host":["https://api.payiano.dev"],"path":["v1","customers",":customer_id","addresses"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of customer address. So, a combination of `page=1` and `per_page=25` returns the first 25 customer address. A combination of `page=2` and `per_page=25` returns the next 25 customer address.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of customer address to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of customer address, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of customer address, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search customer address. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true},{"value":"customer_address.country","key":"includes","description":"A list of additional customer address relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"customer_id"}]},"description":"The list customer addresses feature in [Payiano](https://payiano.com) acts as an online address book tailored for businesses. It gathers all the addresses of a business's customers in a single spot, making it incredibly convenient. This feature is a game-changer for sending products to the right addresses, designing special promotions for customers based on their location, and ensuring that every customer feels valued with personalized deals and updates relevant to their area. \n\nEasy access to this organized list allows businesses to deliver products efficiently, foster a closer relationship with their customers by tailoring their offerings, and increase customer satisfaction by showing a deep understanding of their preferences and requirements. It's all about making business operations smoother and keeping customers engaged and content by making sure they're getting exactly what they need, when they need it, where they live."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"BILLING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n }\n ]\n}"}],"_postman_id":"dcb63e72-9890-4ce5-9063-195a83b00cb2"},{"name":"Create Address","id":"ca1a3f1d-e247-4539-90d7-7efe291cf6c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customers/:customer_id/addresses","description":"

The create customer address endpoint is like starting a new page in our digital address book specifically designed for businesses using Payiano. When a business meets a new customer or a current customer needs to add a different address, this endpoint makes it easy to add that new information into the system. It's like when you meet someone new and save their address in your phone.

For businesses, this means they can quickly update their records with a new shipping or billing address whenever a customer moves or wants their order sent somewhere new. This keeps everything up-to-date, ensuring that orders, promotions, and any important notices are sent to the right place right from the start. It’s a key tool for growing their customer base and making sure the first step in the customer journey is smooth and welcoming, laying the groundwork for a strong relationship with each customer by recognizing and recording their individual needs right away.

\n","type":"text/plain"},"key":"includes","value":"customer_address.country"}],"variable":[{"type":"any","key":"customer_id"}]}},"response":[{"id":"cb43cf63-d749-4f3c-8577-d64318f32cd1","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customers/:customer_id/addresses","host":["https://api.payiano.dev"],"path":["v1","customers",":customer_id","addresses"],"query":[{"value":"customer_address.country","key":"includes","description":"A list of additional customer address relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"customer_id"}]},"description":"The create customer address endpoint is like starting a new page in our digital address book specifically designed for businesses using [Payiano](https://payiano.com). When a business meets a new customer or a current customer needs to add a different address, this endpoint makes it easy to add that new information into the system. It's like when you meet someone new and save their address in your phone. \n\nFor businesses, this means they can quickly update their records with a new shipping or billing address whenever a customer moves or wants their order sent somewhere new. This keeps everything up-to-date, ensuring that orders, promotions, and any important notices are sent to the right place right from the start. It’s a key tool for growing their customer base and making sure the first step in the customer journey is smooth and welcoming, laying the groundwork for a strong relationship with each customer by recognizing and recording their individual needs right away."},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customer_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"BILLING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"ca1a3f1d-e247-4539-90d7-7efe291cf6c7"}],"id":"444cbc35-62cf-4dbb-8894-6af6c61b1058","_postman_id":"444cbc35-62cf-4dbb-8894-6af6c61b1058","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}},{"name":"List Customers","id":"855949c1-d1a3-4fbc-af2a-2b95b208d1d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customers?includes=customer.metadata,customer.tags,customer.tags.metadata,customer.billing_address,customer.billing_address.country,customer.shipping_address,customer.shipping_address.country","description":"

The Customers resource in our API represents a crucial component of our service, primarily designed to manage customer information effectively. This resource is essential for businesses seeking to build a robust and user-friendly platform. By offering a comprehensive overview of customer data, it enables seamless integration of customer management into your application. Payiano helps you manage customers efficiently. You can set up various customers and attach them for Payment Links, subscriptions, and one-time payments through Checkout.

Importance of Handling Customer Data

Personalized Experience: Understanding customer preferences and history allows for tailored experiences, increasing customer satisfaction and loyalty.
Efficiency and Accuracy: Accurate customer data ensures smooth transactions, reduces errors, and enhances the efficiency of operations, from billing to customer support.
Data Analysis: Well-organized customer data can be a goldmine for insights, helping in strategic decision-making and targeted marketing.
Multiple Addresses: One of the key features of the Customers resource is the ability to associate multiple shipping and billing addresses with a single customer profile. This flexibility is particularly beneficial for customers who require different addresses for various purposes, such as separate billing and shipping addresses, or for those who frequently change their shipping locations.

The page number to be retrieved, for the list of customers. So, a combination of page=1 and per_page=25 returns the first 25 customers. A combination of page=2 and per_page=25 returns the next 25 customers.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of customers to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of customers, you can specify a particular column as a reference point for organizing the items in a specific order.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

This refers to the way by which you would like to sort or order the results. When retrieving a list of customers, you can specify a particular way for organizing the items in a specific order, such as ascending or descending.

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

An easy and effective free search text to search customers. Please provide a minimum of 3 characters for each search item. This ensures that your search query is specific enough to yield relevant results.

\n","type":"text/plain"},"key":"q","value":""},{"description":{"content":"

A list of additional customer relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"customer.metadata,customer.tags,customer.tags.metadata,customer.billing_address,customer.billing_address.country,customer.shipping_address,customer.shipping_address.country"}],"variable":[]}},"response":[{"id":"1657fcd5-3ad3-4e23-81a8-a5d463c44b83","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customers","host":["https://api.payiano.dev"],"path":["v1","customers"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of customers. So, a combination of `page=1` and `per_page=25` returns the first 25 customers. A combination of `page=2` and `per_page=25` returns the next 25 customers.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of customers to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of customers, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of customers, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search customers. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true},{"value":"customer.metadata,customer.tags,customer.tags.metadata,customer.billing_address,customer.billing_address.country,customer.shipping_address,customer.shipping_address.country","key":"includes","description":"A list of additional customer relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"The Customers resource in our API represents a crucial component of our service, primarily designed to manage customer information effectively. This resource is essential for businesses seeking to build a robust and user-friendly platform. By offering a comprehensive overview of customer data, it enables seamless integration of customer management into your application. [Payiano](https://payiano.com) helps you manage customers efficiently. You can set up various customers and attach them for [Payment Links](https://docs.payiano.com/api/rest/v1/company/online-payments/payment-links/list), subscriptions, and one-time payments through Checkout. \n\n### Importance of Handling Customer Data\n- **Personalized Experience**: Understanding customer preferences and history allows for tailored experiences, increasing customer satisfaction and loyalty. \n- **Efficiency and Accuracy**: Accurate customer data ensures smooth transactions, reduces errors, and enhances the efficiency of operations, from billing to customer support. \n- **Data Analysis**: Well-organized customer data can be a goldmine for insights, helping in strategic decision-making and targeted marketing. \n- **Multiple Addresses**: One of the key features of the Customers resource is the ability to associate multiple shipping and billing addresses with a single customer profile. This flexibility is particularly beneficial for customers who require different addresses for various purposes, such as separate billing and shipping addresses, or for those who frequently change their shipping locations."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"name\": \"Mohsen Ali\",\n \"email\": \"mohsen@gawaab.com\",\n \"billing_emails\": [\n \"shady.abbas@gawaab.com\",\n \"diab.maged@gawaab.com\"\n ],\n \"cc_emails\": [\n \"ramy.tarek@gawaab.com\",\n \"dina.mourad@gawaab.com\"\n ],\n \"shipping_address_as_billing_address\": true,\n \"billing_email_as_customer_email\": true,\n \"phone_number\": \"+201000333000\",\n \"type\": \"INDIVIDUAL\",\n \"gender\": \"MALE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"is_active\": true,\n \"description\": \"Business development head at Gawaab\",\n \"tags\": [\n {\n \"id\": \"01hqjp31wcww3jhnagehc16r04\",\n \"name\": \"Frequent Buyers\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"description\": \"Customers who make purchases more than twice a month.\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"is_deleted\": false,\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n ],\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"billing_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"BILLING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"shipping_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"SHIPPING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\"\n }\n ]\n}"}],"_postman_id":"855949c1-d1a3-4fbc-af2a-2b95b208d1d7"},{"name":"Create Customer","id":"b79d2798-4600-492c-9890-ae7941c7f133","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Mohsen Allam\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.payiano.dev/v1/customers?includes=customer.metadata,customer.tags,customer.tags.metadata,customer.billing_address,customer.billing_address.country,customer.shipping_address,customer.shipping_address.country","description":"

The create customer feature supports various aspects of customer data management. With Payiano, you can effectively organize and maintain information about your customers. This functionality not only helps in keeping your data structured but also improves the overall efficiency of your application by allowing quick and easy updates to customer profiles whenever necessary.

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customers/:id","description":"

When you access a customer's profile using Payiano, you're not just retrieving basic contact information; you're delving into a comprehensive set of details crucial for effective business operations. This includes the customer's name, email address, phone number, and the country where they are located, among other vital data. Such rich and accurate information plays a pivotal role in enhancing various facets of your business.

This accurate customer data is instrumental in ensuring smooth financial transactions. It helps in reducing the likelihood of errors that can occur due to incorrect or outdated information, thereby maintaining the integrity of your financial operations. Furthermore, it significantly enhances the efficiency of your customer service team. With immediate access to detailed customer information, support staff can provide more personalized, informed, and efficient assistance. This leads to improved customer satisfaction and loyalty.

\n","type":"text/plain"},"key":"includes","value":"customer.metadata,customer.tags,customer.tags.metadata,customer.billing_address,customer.billing_address.country,customer.shipping_address,customer.shipping_address.country"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"c34810de-6047-4718-941c-e3ba6d04d7c9","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customers/:id","host":["https://api.payiano.dev"],"path":["v1","customers",":id"],"query":[{"value":"customer.metadata,customer.tags,customer.tags.metadata,customer.billing_address,customer.billing_address.country,customer.shipping_address,customer.shipping_address.country","key":"includes","description":"A list of additional customer relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"When you access a customer's profile using [Payiano](https://payiano.com), you're not just retrieving basic contact information; you're delving into a comprehensive set of details crucial for effective business operations. This includes the customer's name, email address, phone number, and the country where they are located, among other vital data. Such rich and accurate information plays a pivotal role in enhancing various facets of your business. \n\nThis accurate customer data is instrumental in ensuring smooth financial transactions. It helps in reducing the likelihood of errors that can occur due to incorrect or outdated information, thereby maintaining the integrity of your financial operations. Furthermore, it significantly enhances the efficiency of your customer service team. With immediate access to detailed customer information, support staff can provide more personalized, informed, and efficient assistance. This leads to improved customer satisfaction and loyalty."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customer\": {\n \"id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"name\": \"Mohsen Ali\",\n \"email\": \"mohsen@gawaab.com\",\n \"billing_emails\": [\n \"shady.abbas@gawaab.com\",\n \"diab.maged@gawaab.com\"\n ],\n \"cc_emails\": [\n \"ramy.tarek@gawaab.com\",\n \"dina.mourad@gawaab.com\"\n ],\n \"shipping_address_as_billing_address\": true,\n \"billing_email_as_customer_email\": true,\n \"phone_number\": \"+201000333000\",\n \"type\": \"INDIVIDUAL\",\n \"gender\": \"MALE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"is_active\": true,\n \"description\": \"Business development head at Gawaab\",\n \"tags\": [\n {\n \"id\": \"01hqjp31wcww3jhnagehc16r04\",\n \"name\": \"Frequent Buyers\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"description\": \"Customers who make purchases more than twice a month.\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"is_deleted\": false,\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n ],\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"billing_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"BILLING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"shipping_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"SHIPPING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\"\n }\n}"}],"_postman_id":"894301ec-7eee-4b3c-916c-afd83e874ac7"},{"name":"Update Customer","id":"5d6157cd-01c4-4946-9b93-a6aef7715561","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customers/:id","description":"

With Payiano Update Customer endpoint you can edit and update the details of an existing customer in your database. You can modify various attributes of a customer's profile, such as their name, email address, phone number, or any other information you have on file. This capability is particularly important for keeping customer data current and accurate.

This ensures that all customer records are up-to-date, which is essential for effective communication, smooth transactions, and accurate record-keeping. The endpoint is also user-friendly, allowing quick and easy changes without the need to create a new customer profile from scratch. It's an essential tool for businesses that aim to maintain high-quality, reliable customer data management.

\n","type":"text/plain"},"key":"includes","value":"customer.metadata,customer.tags,customer.tags.metadata,customer.billing_address,customer.billing_address.country,customer.shipping_address,customer.shipping_address.country"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"34cba9ae-98ed-454f-a46f-2125217e1602","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customers/:id","host":["https://api.payiano.dev"],"path":["v1","customers",":id"],"query":[{"value":"customer.metadata,customer.tags,customer.tags.metadata,customer.billing_address,customer.billing_address.country,customer.shipping_address,customer.shipping_address.country","key":"includes","description":"A list of additional customer relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"With [Payiano](https://payiano.com) Update Customer endpoint you can edit and update the details of an existing customer in your database. You can modify various attributes of a customer's profile, such as their name, email address, phone number, or any other information you have on file. This capability is particularly important for keeping customer data current and accurate. \n\nThis ensures that all customer records are up-to-date, which is essential for effective communication, smooth transactions, and accurate record-keeping. The endpoint is also user-friendly, allowing quick and easy changes without the need to create a new customer profile from scratch. It's an essential tool for businesses that aim to maintain high-quality, reliable customer data management."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customer\": {\n \"id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"name\": \"Mohsen Ali\",\n \"email\": \"mohsen@gawaab.com\",\n \"billing_emails\": [\n \"shady.abbas@gawaab.com\",\n \"diab.maged@gawaab.com\"\n ],\n \"cc_emails\": [\n \"ramy.tarek@gawaab.com\",\n \"dina.mourad@gawaab.com\"\n ],\n \"shipping_address_as_billing_address\": true,\n \"billing_email_as_customer_email\": true,\n \"phone_number\": \"+201000333000\",\n \"type\": \"INDIVIDUAL\",\n \"gender\": \"MALE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"is_active\": true,\n \"description\": \"Business development head at Gawaab\",\n \"tags\": [\n {\n \"id\": \"01hqjp31wcww3jhnagehc16r04\",\n \"name\": \"Frequent Buyers\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"description\": \"Customers who make purchases more than twice a month.\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"is_deleted\": false,\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n ],\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"billing_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"BILLING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"shipping_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"SHIPPING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\"\n }\n}"}],"_postman_id":"5d6157cd-01c4-4946-9b93-a6aef7715561"}],"id":"afb3c574-7557-499a-aed8-2ea7116a506e","_postman_id":"afb3c574-7557-499a-aed8-2ea7116a506e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}},{"name":"Addresses","item":[{"name":"List Addresses","id":"06e918a1-5dd4-4b84-bf01-b3677d164ae1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customer_addresses","description":"

The Payiano list customers addresses endpoint is like a digital address book for businesses. It helps them see all their customers' addresses in one place. This is super helpful for sending out products, creating special offers that target people in certain areas, and making sure customers feel taken care of by offering them deals and news that match where they live. By having easy access to this list, businesses can make sure products reach the right place, create a connection by personalizing their services, and keep customers happy by understanding their needs better.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of customer address to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"includes","value":"customer_address.country"}],"variable":[]}},"response":[{"id":"847a14f4-a55e-4f3a-9c52-77ef0aa94a11","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customer_addresses","host":["https://api.payiano.dev"],"path":["v1","customer_addresses"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of customer address. So, a combination of `page=1` and `per_page=25` returns the first 25 customer address. A combination of `page=2` and `per_page=25` returns the next 25 customer address.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of customer address to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of customer address, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of customer address, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search customer address. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true},{"value":"customer_address.country","key":"includes","description":"A list of additional customer address relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"The [Payiano](https://payiano.com) list customers addresses endpoint is like a digital address book for businesses. It helps them see all their customers' addresses in one place. This is super helpful for sending out products, creating special offers that target people in certain areas, and making sure customers feel taken care of by offering them deals and news that match where they live. By having easy access to this list, businesses can make sure products reach the right place, create a connection by personalizing their services, and keep customers happy by understanding their needs better."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"BILLING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n }\n ]\n}"}],"_postman_id":"06e918a1-5dd4-4b84-bf01-b3677d164ae1"},{"name":"Retrieve Address","id":"1fa8e90f-14a2-4d2d-a49b-717061fe1045","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customer_addresses/:id","description":"

The Payiano retrieve customer address endpoint is really important for businesses because it helps them quickly get the right address details when they need to send something or solve a problem for a customer. It's like having a quick shortcut to find where to send a product without having to go through a huge list. This makes sure that everything runs smoothly, from sending out orders to making sure a customer's issue is resolved fast, which makes customers trust and feel good about the business.

\n","type":"text/plain"},"key":"includes","value":"customer_address.country"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"1f526a88-9838-4322-a70c-e6686fd13d66","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customer_addresses/:id","host":["https://api.payiano.dev"],"path":["v1","customer_addresses",":id"],"query":[{"value":"customer_address.country","key":"includes","description":"A list of additional customer address relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The [Payiano](https://payiano.com) retrieve customer address endpoint is really important for businesses because it helps them quickly get the right address details when they need to send something or solve a problem for a customer. It's like having a quick shortcut to find where to send a product without having to go through a huge list. This makes sure that everything runs smoothly, from sending out orders to making sure a customer's issue is resolved fast, which makes customers trust and feel good about the business."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customer_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"BILLING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"1fa8e90f-14a2-4d2d-a49b-717061fe1045"},{"name":"Update Address","id":"4b9db377-72b3-4acb-8dcd-335d5ab0de54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customer_addresses/:id","description":"

The update customer address endpoint in Payiano is all about keeping things current. Whenever a customer's address changes, this endpoint makes sure the business can change it in their system too. This keeps everything running smoothly, making sure that orders, bills, and any communications go to the right place. It helps businesses stay flexible and responsive, which means fewer mistakes, less wasted time and money, and happier customers because they see that the business is paying attention and cares about getting things right.

In the Payiano system, it's important to note a key operational rule regarding record updates. If a customer address record has been soft deleted, without being permanently removed from the database, any updates to this record are forbidden. This restriction ensures data integrity and consistency, as modifying a soft-deleted record could lead to confusion or inaccuracies in the system management.

To update a soft-deleted customer address, the record must first be restored. Restoration reverts the record's deleted status, making it once again eligible for updates and modifications. This policy is crucial for maintaining a clear and accurate representation of the customer address record, while still retaining the flexibility to recover and revise previously soft-deleted customer address as needed. By enforcing this rule, the Payiano system ensures a streamlined and coherent management process, balancing flexibility with control.

\n","type":"text/plain"},"key":"includes","value":"customer_address.country"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"a2da9a59-cdd8-4e69-b999-093ef6168a1b","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customer_addresses/:id","host":["https://api.payiano.dev"],"path":["v1","customer_addresses",":id"],"query":[{"value":"customer_address.country","key":"includes","description":"A list of additional customer address relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The update customer address endpoint in [Payiano](https://payiano.com) is all about keeping things current. Whenever a customer's address changes, this endpoint makes sure the business can change it in their system too. This keeps everything running smoothly, making sure that orders, bills, and any communications go to the right place. It helps businesses stay flexible and responsive, which means fewer mistakes, less wasted time and money, and happier customers because they see that the business is paying attention and cares about getting things right. \n\nIn the [Payiano](https://payiano.com) system, it's important to note a key operational rule regarding record updates. If a customer address record has been soft deleted, without being permanently removed from the database, any updates to this record are **forbidden**. This restriction ensures data integrity and consistency, as modifying a soft-deleted record could lead to confusion or inaccuracies in the system management. \n\nTo update a soft-deleted customer address, the record must first be [restored](https://docs.payiano.com/api/rest/v1/company/customers/addresses/restore). Restoration reverts the record's deleted status, making it once again eligible for updates and modifications. This policy is crucial for maintaining a clear and accurate representation of the customer address record, while still retaining the flexibility to recover and revise previously soft-deleted customer address as needed. By enforcing this rule, the [Payiano](https://payiano.com) system ensures a streamlined and coherent management process, balancing flexibility with control."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customer_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"BILLING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"4b9db377-72b3-4acb-8dcd-335d5ab0de54"},{"name":"Delete Address","id":"4da77070-c105-4409-bdb9-356b290def59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customer_addresses/:id","description":"

The Payiano's delete customer address endpoint is for cleaning up. Just like how you might clean up your contact list by removing old numbers, businesses use this to remove outdated or wrong addresses. This helps keep their records clean and accurate, which means they're not sending stuff to places where customers don't live anymore, cutting down on confusion and wasted effort. Plus, it's important for following laws that protect people's privacy, showing customers that the business respects their information and wants to keep things tidy and secure.

This attribute determines the deletion method to be applied to the customer address delete in the database. When the value is set to true, it indicates that the customer address should be permanently and irreversibly removed from the database, commonly known as a Hard Delete. If the value is set to false, it implies a Soft Delete approach, where the customer address is not physically removed from the database. With Soft Delete it's still possible to restore the customer address record.

\n","type":"text/plain"},"key":"force_delete","value":"false"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"b3c944f4-26b1-410e-9e92-f0dcf5ff1145","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customer_addresses/:id","host":["https://api.payiano.dev"],"path":["v1","customer_addresses",":id"],"query":[{"value":"false","key":"force_delete","description":"This attribute determines the deletion method to be applied to the customer address delete in the database. When the value is set to `true`, it indicates that the customer address should be permanently and irreversibly removed from the database, commonly known as a **Hard Delete**. If the value is set to `false`, it implies a **Soft Delete** approach, where the customer address is not physically removed from the database. With **Soft Delete** it's still possible to restore the customer address record.","disabled":true}],"variable":[{"key":"id"}]},"description":"The [Payiano](https://payiano.com)'s delete customer address endpoint is for cleaning up. Just like how you might clean up your contact list by removing old numbers, businesses use this to remove outdated or wrong addresses. This helps keep their records clean and accurate, which means they're not sending stuff to places where customers don't live anymore, cutting down on confusion and wasted effort. Plus, it's important for following laws that protect people's privacy, showing customers that the business respects their information and wants to keep things tidy and secure."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": true\n}"}],"_postman_id":"4da77070-c105-4409-bdb9-356b290def59"},{"name":"Restore Address","id":"27fc0608-2c58-478c-8d83-ef973c2aba2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customer_addresses/:id/restore","description":"

The Payiano restore endpoint is like a safety net for businesses. Sometimes, information gets deleted by mistake, but this endpoint allows businesses to get that lost information back. This is especially helpful for looking back at old addresses. Having this option means businesses won't lose important information forever and can keep a full history of their interactions with customers, which helps them make smarter decisions and maintain good relationships with customers.

\n","type":"text/plain"},"key":"includes","value":"customer_address.country"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"b1fa6dca-d25f-46f1-bb70-ea2e14f5ff44","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customer_addresses/:id/restore","host":["https://api.payiano.dev"],"path":["v1","customer_addresses",":id","restore"],"query":[{"value":"customer_address.country","key":"includes","description":"A list of additional customer address relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The [Payiano](https://payiano.com) restore endpoint is like a safety net for businesses. Sometimes, information gets deleted by mistake, but this endpoint allows businesses to get that lost information back. This is especially helpful for looking back at old addresses. Having this option means businesses won't lose important information forever and can keep a full history of their interactions with customers, which helps them make smarter decisions and maintain good relationships with customers."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customer_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"BILLING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"27fc0608-2c58-478c-8d83-ef973c2aba2f"}],"id":"a785d624-af70-4ab3-bbab-c4571c36abcf","_postman_id":"a785d624-af70-4ab3-bbab-c4571c36abcf","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}},{"name":"Tags","item":[{"name":"List Tags","id":"bfb134dd-fd87-4ae5-98ae-f142c7714ed7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customer_tags","description":"

The List Customer Tags feature in Payiano is a handy tool that lets you see all the tags you've created to group your customers. This is like having a quick reference guide to all your customer groups. With this feature, you can easily keep track of different groups, whether they're categorized by preferences, location, or any other criteria you've set. It's really useful for getting an overview of how your customers are organized, helping you tailor your services and communication more effectively.

The page number to be retrieved, for the list of customer tags. So, a combination of page=1 and per_page=25 returns the first 25 customer tags. A combination of page=2 and per_page=25 returns the next 25 customer tags.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of customer tags to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of customer tags, you can specify a particular column as a reference point for organizing the items in a specific order.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

This refers to the way by which you would like to sort or order the results. When retrieving a list of customer tags, you can specify a particular way for organizing the items in a specific order, such as ascending or descending.

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

An easy and effective free search text to search customer tags. Please provide a minimum of 3 characters for each search item. This ensures that your search query is specific enough to yield relevant results.

\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"

A list of additional customer tag relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"customer_tag.metadata"}],"variable":[]}},"response":[{"id":"4d31c11c-09d0-4f8a-b86d-ffe7b1d4da21","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customer_tags","host":["https://api.payiano.dev"],"path":["v1","customer_tags"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of customer tags. So, a combination of `page=1` and `per_page=25` returns the first 25 customer tags. A combination of `page=2` and `per_page=25` returns the next 25 customer tags.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of customer tags to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of customer tags, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of customer tags, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search customer tags. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true},{"value":"customer_tag.metadata","key":"includes","description":"A list of additional customer tag relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"The List Customer Tags feature in [Payiano](https://payiano.com) is a handy tool that lets you see all the tags you've created to group your customers. This is like having a quick reference guide to all your customer groups. With this feature, you can easily keep track of different groups, whether they're categorized by preferences, location, or any other criteria you've set. It's really useful for getting an overview of how your customers are organized, helping you tailor your services and communication more effectively."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"id\": \"01hqjp31wcww3jhnagehc16r04\",\n \"name\": \"Frequent Buyers\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"description\": \"Customers who make purchases more than twice a month.\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"is_deleted\": false,\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n ]\n}"}],"_postman_id":"bfb134dd-fd87-4ae5-98ae-f142c7714ed7"},{"name":"Create Tag","id":"b8981219-d906-4757-9e96-4ad4b39ab7f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customer_tags","description":"

With the Create Customer Tag function in Payiano, you can start grouping your customers into different categories. This is like putting labels on your customer profiles, making it easier to manage them based on shared characteristics or needs. For example, you might create a tag for customers who prefer a certain type of product or service. This feature simplifies how you handle customer information and lets you customize your approach to meet different group needs, enhancing your business's efficiency and customer satisfaction.

\n","type":"text/plain"},"key":"includes","value":"customer_tag.metadata"}],"variable":[]}},"response":[{"id":"7e7681bc-6415-480a-a98a-b7d41efc8e01","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customer_tags","host":["https://api.payiano.dev"],"path":["v1","customer_tags"],"query":[{"value":"customer_tag.metadata","key":"includes","description":"A list of additional customer tag relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"With the Create Customer Tag function in [Payiano](https://payiano.com), you can start grouping your customers into different categories. This is like putting labels on your customer profiles, making it easier to manage them based on shared characteristics or needs. For example, you might create a tag for customers who prefer a certain type of product or service. This feature simplifies how you handle customer information and lets you customize your approach to meet different group needs, enhancing your business's efficiency and customer satisfaction."},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customer_tag\": {\n \"id\": \"01hqjp31wcww3jhnagehc16r04\",\n \"name\": \"Frequent Buyers\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"description\": \"Customers who make purchases more than twice a month.\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"is_deleted\": false,\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"b8981219-d906-4757-9e96-4ad4b39ab7f1"},{"name":"Retrieve Tag","id":"454a77b8-3adc-4f7a-9365-82fd1ecd0e54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customer_tags/:id","description":"

The Retrieve Customer Tag feature in Payiano is all about focusing on a specific customer group. Imagine you have a tag for 'frequent buyers' and you want to see who's in this group. This feature lets you do just that. It provides detailed information about the specific tag, like which customers are included under it. This is really useful for when you need to understand or communicate with a particular customer segment, helping you make more informed decisions and offer more personalized services.

\n","type":"text/plain"},"key":"includes","value":"customer_tag.metadata"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"45cac94d-c1f6-4585-82b0-697809bc9741","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customer_tags/:id","host":["https://api.payiano.dev"],"path":["v1","customer_tags",":id"],"query":[{"value":"customer_tag.metadata","key":"includes","description":"A list of additional customer tag relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The Retrieve Customer Tag feature in [Payiano](https://payiano.com) is all about focusing on a specific customer group. Imagine you have a tag for 'frequent buyers' and you want to see who's in this group. This feature lets you do just that. It provides detailed information about the specific tag, like which customers are included under it. This is really useful for when you need to understand or communicate with a particular customer segment, helping you make more informed decisions and offer more personalized services."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customer_tag\": {\n \"id\": \"01hqjp31wcww3jhnagehc16r04\",\n \"name\": \"Frequent Buyers\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"description\": \"Customers who make purchases more than twice a month.\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"is_deleted\": false,\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"454a77b8-3adc-4f7a-9365-82fd1ecd0e54"},{"name":"Update Tag","id":"5bbeaa5f-7098-434c-912b-8c97fb4c4038","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customer_tags/:id","description":"

The Update Customer Tag endpoint in Payiano is a feature designed for modifying existing customer tags. This function allows you to make changes to your already established customer tags. For example, if you want to change a tag name from 'Regular Customers' to 'Loyal Customers' or update the description to better fit the group's current characteristics, this feature makes it possible. It's ideal for keeping your customer groupings relevant and accurate over time. Whether it's a minor tweak in the tag name for clarity, or a significant change in the description due to evolving customer behaviors, this endpoint ensures your customer tags remain effective and up-to-date for your business needs.

In the Payiano system, it's important to note a key operational rule regarding record updates. If a customer tag record has been soft deleted, without being permanently removed from the database, any updates to this record are forbidden. This restriction ensures data integrity and consistency, as modifying a soft-deleted record could lead to confusion or inaccuracies in the system management.

To update a soft-deleted customer tag, the record must first be restored. Restoration reverts the record's deleted status, making it once again eligible for updates and modifications. This policy is crucial for maintaining a clear and accurate representation of the customer tag record, while still retaining the flexibility to recover and revise previously soft-deleted customer tag as needed. By enforcing this rule, the Payiano system ensures a streamlined and coherent management process, balancing flexibility with control.

\n","type":"text/plain"},"key":"includes","value":"customer_tag.metadata"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"438e85e9-0865-4a3a-a40a-4be5b9df7110","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customer_tags/:id","host":["https://api.payiano.dev"],"path":["v1","customer_tags",":id"],"query":[{"value":"customer_tag.metadata","key":"includes","description":"A list of additional customer tag relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The Update Customer Tag endpoint in [Payiano](https://payiano.com) is a feature designed for modifying existing customer tags. This function allows you to make changes to your already established customer tags. For example, if you want to change a tag name from 'Regular Customers' to 'Loyal Customers' or update the description to better fit the group's current characteristics, this feature makes it possible. It's ideal for keeping your customer groupings relevant and accurate over time. Whether it's a minor tweak in the tag name for clarity, or a significant change in the description due to evolving customer behaviors, this endpoint ensures your customer tags remain effective and up-to-date for your business needs. \n\nIn the [Payiano](https://payiano.com) system, it's important to note a key operational rule regarding record updates. If a customer tag record has been soft deleted, without being permanently removed from the database, any updates to this record are **forbidden**. This restriction ensures data integrity and consistency, as modifying a soft-deleted record could lead to confusion or inaccuracies in the system management. \n\nTo update a soft-deleted customer tag, the record must first be [restored](https://docs.payiano.com/api/rest/v1/company/customers/tags/restore). Restoration reverts the record's deleted status, making it once again eligible for updates and modifications. This policy is crucial for maintaining a clear and accurate representation of the customer tag record, while still retaining the flexibility to recover and revise previously soft-deleted customer tag as needed. By enforcing this rule, the [Payiano](https://payiano.com) system ensures a streamlined and coherent management process, balancing flexibility with control."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customer_tag\": {\n \"id\": \"01hqjp31wcww3jhnagehc16r04\",\n \"name\": \"Frequent Buyers\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"description\": \"Customers who make purchases more than twice a month.\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"is_deleted\": false,\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"5bbeaa5f-7098-434c-912b-8c97fb4c4038"},{"name":"Delete Tag","id":"f5742ed8-689b-408c-aec8-c471163f1acc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customer_tags/:id","description":"

Payiano's Delete Customer Tag function is useful when you need to remove a certain customer group tag from your system. Maybe a tag is no longer relevant or needs updating. This feature allows you to keep your customer groups current and meaningful. By deleting outdated or unnecessary tags, you ensure that your customer organization stays efficient and reflective of your current business strategy.

This attribute determines the deletion method to be applied to the customer tag delete in the database. When the value is set to true, it indicates that the customer tag should be permanently and irreversibly removed from the database, commonly known as a Hard Delete. If the value is set to false, it implies a Soft Delete approach, where the customer tag is not physically removed from the database. With Soft Delete it's still possible to restore the customer tag record.

\n","type":"text/plain"},"key":"force_delete","value":"false"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"162b677e-be8d-4784-8f2d-598203cb3679","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customer_tags/:id","host":["https://api.payiano.dev"],"path":["v1","customer_tags",":id"],"query":[{"value":"false","key":"force_delete","description":"This attribute determines the deletion method to be applied to the customer tag delete in the database. When the value is set to `true`, it indicates that the customer tag should be permanently and irreversibly removed from the database, commonly known as a **Hard Delete**. If the value is set to `false`, it implies a **Soft Delete** approach, where the customer tag is not physically removed from the database. With **Soft Delete** it's still possible to restore the customer tag record.","disabled":true}],"variable":[{"key":"id"}]},"description":"[Payiano](https://payiano.com)'s Delete Customer Tag function is useful when you need to remove a certain customer group tag from your system. Maybe a tag is no longer relevant or needs updating. This feature allows you to keep your customer groups current and meaningful. By deleting outdated or unnecessary tags, you ensure that your customer organization stays efficient and reflective of your current business strategy."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": true\n}"}],"_postman_id":"f5742ed8-689b-408c-aec8-c471163f1acc"},{"name":"Restore Tag","id":"998ef5a8-68ff-44cd-9bf7-8731bff5336b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/customer_tags/:id/restore","description":"

The Restore Customer Tag feature in Payiano offers a vital functionality for reinstating previously deleted customer tags. This is particularly useful in scenarios where a tag was removed accidentally or if there’s a change in business strategy that makes an old tag relevant again. With this endpoint, you can easily bring back a customer group tag without having to recreate it from scratch.

This ensures continuity and consistency in your customer categorization efforts. Restoring a tag can help in re-aligning with past marketing strategies or customer engagement plans, aiding in seamless integration of historical customer data with current operational needs. By enabling the recovery of former tags, Payiano enhances your ability to adapt to evolving business requirements while maintaining a comprehensive and organized customer database.

\n","type":"text/plain"},"key":"includes","value":"customer_tag.metadata"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"ea100b79-54c4-4f4d-af3b-084c244a4c91","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/customer_tags/:id/restore","host":["https://api.payiano.dev"],"path":["v1","customer_tags",":id","restore"],"query":[{"value":"customer_tag.metadata","key":"includes","description":"A list of additional customer tag relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The Restore Customer Tag feature in [Payiano](https://payiano.com) offers a vital functionality for reinstating previously deleted customer tags. This is particularly useful in scenarios where a tag was removed accidentally or if there’s a change in business strategy that makes an old tag relevant again. With this endpoint, you can easily bring back a customer group tag without having to recreate it from scratch. \n\nThis ensures continuity and consistency in your customer categorization efforts. Restoring a tag can help in re-aligning with past marketing strategies or customer engagement plans, aiding in seamless integration of historical customer data with current operational needs. By enabling the recovery of former tags, [Payiano](https://payiano.com) enhances your ability to adapt to evolving business requirements while maintaining a comprehensive and organized customer database."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"customer_tag\": {\n \"id\": \"01hqjp31wcww3jhnagehc16r04\",\n \"name\": \"Frequent Buyers\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"description\": \"Customers who make purchases more than twice a month.\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"is_deleted\": false,\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"998ef5a8-68ff-44cd-9bf7-8731bff5336b"}],"id":"3ccb5bff-c371-471c-bc4e-c4e3a3d46413","_postman_id":"3ccb5bff-c371-471c-bc4e-c4e3a3d46413","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}}],"id":"51ac5fc8-f5b4-4733-9f11-e7448cf3c7e2","_postman_id":"51ac5fc8-f5b4-4733-9f11-e7448cf3c7e2","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}},{"name":"Discounts","item":[{"name":"List Discounts","id":"ff9395bd-8268-47d2-927a-921092b007a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/discounts","description":"

The Payiano list discounts endpoint offers a comprehensive view of all historical discounts, providing businesses with crucial insights into their promotional landscape. This endpoint allows for efficient management and assessment of discount campaigns, giving companies the ability to track the performance and impact of each discount over time. By aggregating all discount data, this endpoint facilitates strategic decision-making, enabling businesses to refine their promotional strategies based on past successes and areas for improvement.

The page number to be retrieved, for the list of discounts. So, a combination of page=1 and per_page=25 returns the first 25 discounts. A combination of page=2 and per_page=25 returns the next 25 discounts.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of discounts to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of discounts, you can specify a particular column as a reference point for organizing the items in a specific order.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

This refers to the way by which you would like to sort or order the results. When retrieving a list of discounts, you can specify a particular way for organizing the items in a specific order, such as ascending or descending.

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

An easy and effective free search text to search discounts. Please provide a minimum of 3 characters for each search item. This ensures that your search query is specific enough to yield relevant results.

\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"

A list of additional discount relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"discount.metadata"}],"variable":[]}},"response":[{"id":"e65338cf-2d94-4e29-a804-fd63162f986a","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/discounts","host":["https://api.payiano.dev"],"path":["v1","discounts"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of discounts. So, a combination of `page=1` and `per_page=25` returns the first 25 discounts. A combination of `page=2` and `per_page=25` returns the next 25 discounts.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of discounts to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of discounts, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of discounts, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search discounts. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true},{"value":"discount.metadata","key":"includes","description":"A list of additional discount relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"The [Payiano](https://payiano.com) list discounts endpoint offers a comprehensive view of all historical discounts, providing businesses with crucial insights into their promotional landscape. This endpoint allows for efficient management and assessment of discount campaigns, giving companies the ability to track the performance and impact of each discount over time. By aggregating all discount data, this endpoint facilitates strategic decision-making, enabling businesses to refine their promotional strategies based on past successes and areas for improvement."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"id\": \"01hsyngn0bxgmx5yg8jq3vda4y\",\n \"name\": \"Black Friday discount\",\n \"value\": 50,\n \"value_type\": \"FLAT\",\n \"is_active\": true,\n \"reference_id\": \"dfa01948-b4f2-3055-8847-2a2fbae0c514\",\n \"starts_at\": \"2024-11-29 00:00:00\",\n \"expires_at\": \"2024-11-29 23:59:59\",\n \"description\": \"The black Friday discount\",\n \"is_expired\": false,\n \"is_started\": false,\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2024-03-27 00:38:44\",\n \"updated_at\": \"2024-03-27 00:38:44\"\n }\n ]\n}"}],"_postman_id":"ff9395bd-8268-47d2-927a-921092b007a0"},{"name":"Create Discount","id":"d91f2c90-5b80-4cdb-a8bb-576787c2cf07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/discounts","description":"

The Payiano create discount endpoint serves as the foundation for businesses to introduce new promotions, allowing for the strategic launch of discounts aimed at driving sales and engaging customers. This endpoint is the starting point for crafting targeted promotional campaigns, enabling businesses to swiftly respond to market trends, seasonal demands, or competitive pressures. By facilitating the initiation of discount offers, the \"Create\" endpoint empowers companies to attract new customers, retain existing ones, and stimulate overall sales activity, laying the groundwork for a dynamic and adaptable marketing strategy.

This endpoint supports the customization of discounts to fit various business goals, from clearing inventory to promoting new product launches. It allows businesses to quickly deploy tailored promotions, ensuring that they can capitalize on opportunities as they arise. This level of agility is crucial in maintaining a competitive edge, enabling companies to react in real-time to changing market dynamics and customer preferences, thereby enhancing their ability to meet sales targets and improve customer satisfaction.

\n
Note that once set, you can't change the value and value_type attributes. To update these, you'll need to create a new discount and archive the old one.
\n

\n","type":"text/plain"},"key":"includes","value":"discount.metadata"}],"variable":[]}},"response":[{"id":"97b8c036-335e-4403-b1dc-796289c99831","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/discounts","host":["https://api.payiano.dev"],"path":["v1","discounts"],"query":[{"value":"discount.metadata","key":"includes","description":"A list of additional discount relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"The [Payiano](https://payiano.com) create discount endpoint serves as the foundation for businesses to introduce new promotions, allowing for the strategic launch of discounts aimed at driving sales and engaging customers. This endpoint is the starting point for crafting targeted promotional campaigns, enabling businesses to swiftly respond to market trends, seasonal demands, or competitive pressures. By facilitating the initiation of discount offers, the \"Create\" endpoint empowers companies to attract new customers, retain existing ones, and stimulate overall sales activity, laying the groundwork for a dynamic and adaptable marketing strategy. \n\nThis endpoint supports the customization of discounts to fit various business goals, from clearing inventory to promoting new product launches. It allows businesses to quickly deploy tailored promotions, ensuring that they can capitalize on opportunities as they arise. This level of agility is crucial in maintaining a competitive edge, enabling companies to react in real-time to changing market dynamics and customer preferences, thereby enhancing their ability to meet sales targets and improve customer satisfaction. \n\n> Note that once set, you can't change the `value` and `value_type` attributes. To update these, you'll need to create a new discount and archive the old one."},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"discount\": {\n \"id\": \"01hsyngn0bxgmx5yg8jq3vda4y\",\n \"name\": \"Black Friday discount\",\n \"value\": 50,\n \"value_type\": \"FLAT\",\n \"is_active\": true,\n \"reference_id\": \"dfa01948-b4f2-3055-8847-2a2fbae0c514\",\n \"starts_at\": \"2024-11-29 00:00:00\",\n \"expires_at\": \"2024-11-29 23:59:59\",\n \"description\": \"The black Friday discount\",\n \"is_expired\": false,\n \"is_started\": false,\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2024-03-27 00:38:44\",\n \"updated_at\": \"2024-03-27 00:38:44\"\n }\n}"}],"_postman_id":"d91f2c90-5b80-4cdb-a8bb-576787c2cf07"},{"name":"Retrieve Discount","id":"aef3eeac-cb98-4110-b6fd-d87ed4f8dc82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/discounts/:id","description":"

With the Payiano retrieve discount endpoint is designed to retrieve specific details about individual discounts, allowing businesses to drill down into the particulars of a single promotion. This focused access is essential for analyzing the nuances of each discount's performance, understanding its appeal to customers, and identifying potential areas for optimization. By providing detailed information on demand, this endpoint supports a granular approach to promotional analysis, enabling businesses to fine-tune their marketing strategies for enhanced effectiveness.

\n","type":"text/plain"},"key":"includes","value":"discount.metadata"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"709b2efb-e30c-4849-974f-58998341fe8d","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/discounts/:id","host":["https://api.payiano.dev"],"path":["v1","discounts",":id"],"query":[{"value":"discount.metadata","key":"includes","description":"A list of additional discount relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"With the [Payiano](https://payiano.com) retrieve discount endpoint is designed to retrieve specific details about individual discounts, allowing businesses to drill down into the particulars of a single promotion. This focused access is essential for analyzing the nuances of each discount's performance, understanding its appeal to customers, and identifying potential areas for optimization. By providing detailed information on demand, this endpoint supports a granular approach to promotional analysis, enabling businesses to fine-tune their marketing strategies for enhanced effectiveness."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"discount\": {\n \"id\": \"01hsyngn0bxgmx5yg8jq3vda4y\",\n \"name\": \"Black Friday discount\",\n \"value\": 50,\n \"value_type\": \"FLAT\",\n \"is_active\": true,\n \"reference_id\": \"dfa01948-b4f2-3055-8847-2a2fbae0c514\",\n \"starts_at\": \"2024-11-29 00:00:00\",\n \"expires_at\": \"2024-11-29 23:59:59\",\n \"description\": \"The black Friday discount\",\n \"is_expired\": false,\n \"is_started\": false,\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2024-03-27 00:38:44\",\n \"updated_at\": \"2024-03-27 00:38:44\"\n }\n}"}],"_postman_id":"aef3eeac-cb98-4110-b6fd-d87ed4f8dc82"},{"name":"Update Discount","id":"43c9835e-7ed2-4c99-a84b-c1d58194ba8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/discounts/:id","description":"

The Payiano update discount endpoint is vital for maintaining the relevance and effectiveness of discounts over time. It allows businesses to modify existing promotions in response to evolving market conditions, consumer behavior, or strategic shifts. Whether it’s extending the offer period, or changing the terms, this endpoint ensures that businesses can keep their promotions fresh and aligned with current objectives. This adaptability is key to sustaining customer interest and achieving long-term promotional success.

This endpoint supports continuous improvement and optimization of discount strategies. By analyzing performance data and customer feedback, businesses can identify opportunities to enhance the appeal of their offers. The ability to update discounts accordingly enables companies to refine their promotions dynamically, ensuring that they remain attractive to customers and effective in driving sales. This ongoing optimization process is essential for keeping pace with a fast-moving market and maintaining a compelling value proposition for customers.

\n","type":"text/plain"},"key":"includes","value":"discount.metadata"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"7f2417c1-aefd-4be1-b4c3-13fcccb66bd3","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/discounts/:id","host":["https://api.payiano.dev"],"path":["v1","discounts",":id"],"query":[{"value":"discount.metadata","key":"includes","description":"A list of additional discount relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The [Payiano](https://payiano.com) update discount endpoint is vital for maintaining the relevance and effectiveness of discounts over time. It allows businesses to modify existing promotions in response to evolving market conditions, consumer behavior, or strategic shifts. Whether it’s extending the offer period, or changing the terms, this endpoint ensures that businesses can keep their promotions fresh and aligned with current objectives. This adaptability is key to sustaining customer interest and achieving long-term promotional success. \n\nThis endpoint supports continuous improvement and optimization of discount strategies. By analyzing performance data and customer feedback, businesses can identify opportunities to enhance the appeal of their offers. The ability to update discounts accordingly enables companies to refine their promotions dynamically, ensuring that they remain attractive to customers and effective in driving sales. This ongoing optimization process is essential for keeping pace with a fast-moving market and maintaining a compelling value proposition for customers."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"discount\": {\n \"id\": \"01hsyngn0bxgmx5yg8jq3vda4y\",\n \"name\": \"Black Friday discount\",\n \"value\": 50,\n \"value_type\": \"FLAT\",\n \"is_active\": true,\n \"reference_id\": \"dfa01948-b4f2-3055-8847-2a2fbae0c514\",\n \"starts_at\": \"2024-11-29 00:00:00\",\n \"expires_at\": \"2024-11-29 23:59:59\",\n \"description\": \"The black Friday discount\",\n \"is_expired\": false,\n \"is_started\": false,\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2024-03-27 00:38:44\",\n \"updated_at\": \"2024-03-27 00:38:44\"\n }\n}"}],"_postman_id":"43c9835e-7ed2-4c99-a84b-c1d58194ba8b"}],"id":"a39f4e7e-023a-4fb9-8482-d490e517e63f","_postman_id":"a39f4e7e-023a-4fb9-8482-d490e517e63f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}},{"name":"Online Payments","item":[{"name":"Balances","item":[{"name":"List Balances","id":"4becdcca-c22e-4feb-b75a-55aba24823ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/balances","description":"

The balances or available funds refer to the amount of money that is ready for transfer, withdrawn or payout through Payiano's automated processes or explicitly through the Transfers API, Utilities API or Payouts API. These funds are immediately accessible for various financial transactions.

Real-Time Fund Availability

To provide a breakdown of the available balance, Payiano organizes it by currency. This means that you can see how much money is available for each specific currency. This information is crucial for businesses and organizations to manage their finances effectively, as it allows them to track and access funds that are ready for use or disbursement, facilitating seamless financial operations.

Instant Access: Funds reflected in the balances are immediately accessible for transfers, withdrawals, or payouts.
Real-Time Updates: The balance information is updated in real time, ensuring accuracy and immediacy.
Currency Categorization: Balances are organized by currency, facilitating easy management of multi-currency funds.

The page number to be retrieved, for the list of balances. So, a combination of page=1 and per_page=25 returns the first 25 balances. A combination of page=2 and per_page=25 returns the next 25 balances.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of balances to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of balances, you can specify a particular column as a reference point for organizing the items in a specific order.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

This refers to the way by which you would like to sort or order the results. When retrieving a list of balances, you can specify a particular way for organizing the items in a specific order, such as ascending or descending.

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

An easy and effective free search text to search balances. Please provide a minimum of 3 characters for each search item. This ensures that your search query is specific enough to yield relevant results.

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"8f6ff2c9-28d6-4a78-8145-cfc5a776cb22","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/balances","host":["https://api.payiano.dev"],"path":["v1","balances"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of balances. So, a combination of `page=1` and `per_page=25` returns the first 25 balances. A combination of `page=2` and `per_page=25` returns the next 25 balances.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of balances to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of balances, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of balances, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search balances. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true}]},"description":"The balances or available funds refer to the amount of money that is ready for transfer, withdrawn or payout through [Payiano](https://payiano.com)'s automated processes or explicitly through the Transfers API, Utilities API or Payouts API. These funds are immediately accessible for various financial transactions. \n\n## Real-Time Fund Availability \nTo provide a breakdown of the available balance, [Payiano](https://payiano.com) organizes it by currency. This means that you can see how much money is available for each specific currency. This information is crucial for businesses and organizations to manage their finances effectively, as it allows them to track and access funds that are ready for use or disbursement, facilitating seamless financial operations. \n\n- **Instant Access**: Funds reflected in the balances are immediately accessible for transfers, withdrawals, or payouts. \n- **Real-Time Updates**: The balance information is updated in real time, ensuring accuracy and immediacy. \n- **Currency Categorization**: Balances are organized by currency, facilitating easy management of multi-currency funds."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"currency_code\": \"USD\",\n \"available_amount\": 1000,\n \"pending_amount\": 550\n }\n ]\n}"}],"_postman_id":"4becdcca-c22e-4feb-b75a-55aba24823ee"},{"name":"Retrieve Balance","id":"dd6982a4-1f4b-4ac5-ad43-3ebd178a0380","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/balances/:id","description":"

When you retrieve a balance from Payiano, you are essentially obtaining information about the amount of money that is currently available and can be utilized for various financial transactions. These funds are ready and accessible for a range of financial operations and can be used as needed. The funds in your balance are ready for immediate use. You don't need to wait or go through additional steps to access these funds. They are readily available for your financial needs.

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/checkouts","description":"

With Payiano you can retrieve list of Checkouts. This API endpoint play a pivotal role in the success and operational efficiency of your business. These endpoint facilitate seamless integration of payment and checkout processes into business applications, making it easier to handle transactions, track payments, and manage financial data. They are essential for businesses aiming to provide a smooth and secure online payment experience for their customers. By leveraging these endpoint, businesses can streamline their operations, reduce manual errors, and enhance the overall customer experience, ultimately contributing to increased sales and customer satisfaction.

Access to such detailed checkout information is like having a powerful tool that ensures your financial reports are accurate and trustworthy. This makes your financial activities more reliable and trustworthy. Checkouts are applied to various Payiano resources like Payment Links, Invoices, Orders and Subscriptions.

The page number to be retrieved, for the list of checkouts. So, a combination of page=1 and per_page=25 returns the first 25 checkouts. A combination of page=2 and per_page=25 returns the next 25 checkouts.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of checkouts to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of checkouts, you can specify a particular column as a reference point for organizing the items in a specific order.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

This refers to the way by which you would like to sort or order the results. When retrieving a list of checkouts, you can specify a particular way for organizing the items in a specific order, such as ascending or descending.

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

An easy and effective free search text to search checkouts. Please provide a minimum of 3 characters for each search item. This ensures that your search query is specific enough to yield relevant results.

\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"

A list of additional checkout relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"checkout.payer,checkout.payer.billing_address,checkout.payer.billing_address.country,checkout.payer.shipping_address,checkout.payer.shipping_address.country"}],"variable":[]}},"response":[{"id":"c0e39f91-e8bf-4cc5-9658-c8824ab5144d","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/checkouts","host":["https://api.payiano.dev"],"path":["v1","checkouts"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of checkouts. So, a combination of `page=1` and `per_page=25` returns the first 25 checkouts. A combination of `page=2` and `per_page=25` returns the next 25 checkouts.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of checkouts to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of checkouts, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of checkouts, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search checkouts. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true},{"value":"checkout.payer,checkout.payer.billing_address,checkout.payer.billing_address.country,checkout.payer.shipping_address,checkout.payer.shipping_address.country","key":"includes","description":"A list of additional checkout relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"With [Payiano](https://payiano.com) you can retrieve list of Checkouts. This API endpoint play a pivotal role in the success and operational efficiency of your business. These endpoint facilitate seamless integration of payment and checkout processes into business applications, making it easier to handle transactions, track payments, and manage financial data. They are essential for businesses aiming to provide a smooth and secure online payment experience for their customers. By leveraging these endpoint, businesses can streamline their operations, reduce manual errors, and enhance the overall customer experience, ultimately contributing to increased sales and customer satisfaction. \n\nAccess to such detailed checkout information is like having a powerful tool that ensures your financial reports are accurate and trustworthy. This makes your financial activities more reliable and trustworthy. Checkouts are applied to various [Payiano](https://payiano.com) resources like [Payment Links](https://docs.payiano.com/api/rest/v1/company/online-payments/payment-links/list), Invoices, Orders and Subscriptions."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"payable_id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"payable_type\": \"PAYMENT_LINK\",\n \"currency_code\": \"EGP\",\n \"paid_amount\": 0,\n \"total_amount\": 1140,\n \"remaining_amount\": 1140,\n \"is_completed\": false,\n \"is_coupon_allowed\": true,\n \"has_billing_address\": true,\n \"has_shipping_address\": false,\n \"status\": \"UNPAID\",\n \"error_redirect_url\": \"https://graply.com/payments/error\",\n \"success_redirect_url\": \"https://graply.com/payments/success\",\n \"pay_action\": \"PAY\",\n \"fees_strategy\": \"DEFAULT\",\n \"urls\": {\n \"url\": \"http://pay.payiano.com/checkouts/01hqh45s7826hfwdze8dp1z21f\",\n \"short_url\": \"https://grap.ly/7HlD4c1\",\n \"short_url_id\": \"7HlD4c1\",\n \"qr_code_url\": \"http://api-pay.payiano.com/v1/checkouts/01hqh45s7826hfwdze8dp1z21f/qrcode\"\n },\n \"paid_at\": null,\n \"payer\": {\n \"name\": \"Mohsen Ali\",\n \"email\": \"mohsen@gawaab.com\",\n \"phone_number\": \"+201000333000\",\n \"shipping_address_as_billing_address\": true,\n \"billing_address\": {\n \"country_code\": \"EG\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"note\": null,\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n }\n },\n \"shipping_address\": {\n \"country_code\": \"EG\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"note\": null,\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n }\n }\n },\n \"created_at\": \"2024-02-04 14:47:55\",\n \"updated_at\": \"2024-02-04 14:47:55\"\n }\n ]\n}"}],"_postman_id":"78e2a88b-7b66-40ee-9270-81289b231763"},{"name":"Retrieve Checkout","id":"b4a7d42c-026b-4924-8e7e-03c002331ac9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/checkouts/:id","description":"

Payiano offers a feature where you can get a Checkout details. This service is really important for how well your business does. It helps by making it easier to mix payment and checkout steps into your business apps. This means you can handle money matters, keep an eye on payments, and organize your financial info better. It's really handy for any business that wants to give its customers a smooth and safe way to pay online. Using this feature, businesses can make their day-to-day operations more efficient, cut down on mistakes that happen when things are done by hand, and improve the experience for customers. All this can lead to more sales and happier customers.

\n","type":"text/plain"},"key":"includes","value":"checkout.payer,checkout.payer.billing_address,checkout.payer.billing_address.country,checkout.payer.shipping_address,checkout.payer.shipping_address.country"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"3601d398-9fcf-48a4-9fdf-790a24297046","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/checkouts/:id","host":["https://api.payiano.dev"],"path":["v1","checkouts",":id"],"query":[{"value":"checkout.payer,checkout.payer.billing_address,checkout.payer.billing_address.country,checkout.payer.shipping_address,checkout.payer.shipping_address.country","key":"includes","description":"A list of additional checkout relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"[Payiano](https://payiano.com) offers a feature where you can get a Checkout details. This service is really important for how well your business does. It helps by making it easier to mix payment and checkout steps into your business apps. This means you can handle money matters, keep an eye on payments, and organize your financial info better. It's really handy for any business that wants to give its customers a smooth and safe way to pay online. Using this feature, businesses can make their day-to-day operations more efficient, cut down on mistakes that happen when things are done by hand, and improve the experience for customers. All this can lead to more sales and happier customers."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"checkout\": {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"payable_id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"payable_type\": \"PAYMENT_LINK\",\n \"currency_code\": \"EGP\",\n \"paid_amount\": 0,\n \"total_amount\": 1140,\n \"remaining_amount\": 1140,\n \"is_completed\": false,\n \"is_coupon_allowed\": true,\n \"has_billing_address\": true,\n \"has_shipping_address\": false,\n \"status\": \"UNPAID\",\n \"error_redirect_url\": \"https://graply.com/payments/error\",\n \"success_redirect_url\": \"https://graply.com/payments/success\",\n \"pay_action\": \"PAY\",\n \"fees_strategy\": \"DEFAULT\",\n \"urls\": {\n \"url\": \"http://pay.payiano.com/checkouts/01hqh45s7826hfwdze8dp1z21f\",\n \"short_url\": \"https://grap.ly/7HlD4c1\",\n \"short_url_id\": \"7HlD4c1\",\n \"qr_code_url\": \"http://api-pay.payiano.com/v1/checkouts/01hqh45s7826hfwdze8dp1z21f/qrcode\"\n },\n \"paid_at\": null,\n \"payer\": {\n \"name\": \"Mohsen Ali\",\n \"email\": \"mohsen@gawaab.com\",\n \"phone_number\": \"+201000333000\",\n \"shipping_address_as_billing_address\": true,\n \"billing_address\": {\n \"country_code\": \"EG\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"note\": null,\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n }\n },\n \"shipping_address\": {\n \"country_code\": \"EG\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"note\": null,\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n }\n }\n },\n \"created_at\": \"2024-02-04 14:47:55\",\n \"updated_at\": \"2024-02-04 14:47:55\"\n }\n}"}],"_postman_id":"b4a7d42c-026b-4924-8e7e-03c002331ac9"}],"id":"d066c14d-9b56-45c0-b2c4-45a2cbdae58b","_postman_id":"d066c14d-9b56-45c0-b2c4-45a2cbdae58b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}},{"name":"Payment Links","item":[{"name":"List Payment Links","id":"35e089d8-9949-448f-b2b3-c04188cb1cce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/payment_links","description":"

The Payment Links Module is much more than a basic feature – it's a solution to the usual hassles of handling payments. It gets rid of the need for complicated billing setups and makes it easier for businesses to get paid quickly and without trouble. With its easy-to-use design and ability to track payments as they happen, it helps businesses take control of their money matters more efficiently. This allows them to focus more on growing their business instead of worrying about payment issues.

Create Payment Links: Generate unique payment links for different services or products with just a few clicks. Customize these links with description, amount, tax, due and expiration dates.
Manage Links: View and organize all your active and expired links in one place. Edit or deactivate links as needed.
Real-Time Tracking: Monitor the status of each payment link, including views, payments received, and pending transactions.
Ease of Use: Simplifies the payment process - no technical expertise needed to create or manage links.

The page number to be retrieved, for the list of payment links. So, a combination of page=1 and per_page=25 returns the first 25 payment links. A combination of page=2 and per_page=25 returns the next 25 payment links.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of payment links to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of payment links, you can specify a particular column as a reference point for organizing the items in a specific order.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

This refers to the way by which you would like to sort or order the results. When retrieving a list of payment links, you can specify a particular way for organizing the items in a specific order, such as ascending or descending.

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

An easy and effective free search text to search payment links. Please provide a minimum of 3 characters for each search item. This ensures that your search query is specific enough to yield relevant results.

\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"

A list of additional payment link relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"payment_link.metadata,payment_link.payment_details,payment_link.payment_details.taxes,payment_link.payment_details.taxes.metadata,payment_link.customer,payment_link.customer.metadata,payment_link.customer.tags,payment_link.customer.tags.metadata,payment_link.customer.billing_address,payment_link.customer.billing_address.country,payment_link.customer.shipping_address,payment_link.customer.shipping_address.country"}],"variable":[]}},"response":[{"id":"5c8b1aad-a28f-477d-b179-656f8ba07861","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/payment_links","host":["https://api.payiano.dev"],"path":["v1","payment_links"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of payment links. So, a combination of `page=1` and `per_page=25` returns the first 25 payment links. A combination of `page=2` and `per_page=25` returns the next 25 payment links.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of payment links to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of payment links, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of payment links, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search payment links. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true},{"value":"payment_link.metadata,payment_link.payment_details,payment_link.payment_details.taxes,payment_link.payment_details.taxes.metadata,payment_link.customer,payment_link.customer.metadata,payment_link.customer.tags,payment_link.customer.tags.metadata,payment_link.customer.billing_address,payment_link.customer.billing_address.country,payment_link.customer.shipping_address,payment_link.customer.shipping_address.country","key":"includes","description":"A list of additional payment link relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"The Payment Links Module is much more than a basic feature – it's a solution to the usual hassles of handling payments. It gets rid of the need for complicated billing setups and makes it easier for businesses to get paid quickly and without trouble. With its easy-to-use design and ability to track payments as they happen, it helps businesses take control of their money matters more efficiently. This allows them to focus more on growing their business instead of worrying about payment issues. \n\n- **Create Payment Links**: Generate unique payment links for different services or products with just a few clicks. Customize these links with description, amount, tax, due and expiration dates. \n- **Manage Links**: View and organize all your active and expired links in one place. Edit or deactivate links as needed. \n- **Real-Time Tracking**: Monitor the status of each payment link, including views, payments received, and pending transactions. \n- **Ease of Use**: Simplifies the payment process - no technical expertise needed to create or manage links."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"id\": \"01hqjmrh1hjg315bhnytk0k7ne\",\n \"title\": \"Office accessories for Gawaab corporate\",\n \"payment_details\": {\n \"currency_code\": \"EGP\",\n \"amount\": 1000,\n \"taxes\": [\n {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"name\": \"Value added tax\",\n \"value\": 14,\n \"value_type\": \"PERCENTAGE\",\n \"type\": \"VAT\",\n \"strategy\": \"EXCLUSIVE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"b438800f-9e32-36a1-aee8-725aca982cc7\",\n \"is_active\": true,\n \"description\": \"The value added tax\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-24 18:02:40\",\n \"updated_at\": \"2023-12-24 18:02:40\"\n },\n {\n \"id\": \"01ht1mz21w0b63gffe17fhzvk2\",\n \"name\": \"Sales tax\",\n \"value\": 100,\n \"value_type\": \"FLAT\",\n \"type\": \"SALES_TAX\",\n \"strategy\": \"INCLUSIVE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"62824653-0d70-3580-8beb-6144971cc93b\",\n \"is_active\": true,\n \"description\": \"The value added tax\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-24 18:02:40\",\n \"updated_at\": \"2023-12-24 18:02:40\"\n }\n ],\n \"tax_strategy\": null,\n \"exclusive_tax_amount\": 140,\n \"inclusive_tax_amount\": 100,\n \"total_tax_amount\": 240,\n \"amount_after_tax\": 1140,\n \"total_amount\": 1140,\n \"paid_amount\": 0,\n \"remaining_amount\": 1140,\n \"status\": \"UNPAID\",\n \"is_completed\": false,\n \"paid_at\": null\n },\n \"reference_id\": \"e07ac088-4cb3-3797-bfae-bc4ddca71648\",\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"customer\": {\n \"id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"name\": \"Mohsen Ali\",\n \"email\": \"mohsen@gawaab.com\",\n \"billing_emails\": [\n \"shady.abbas@gawaab.com\",\n \"diab.maged@gawaab.com\"\n ],\n \"cc_emails\": [\n \"ramy.tarek@gawaab.com\",\n \"dina.mourad@gawaab.com\"\n ],\n \"shipping_address_as_billing_address\": true,\n \"billing_email_as_customer_email\": true,\n \"phone_number\": \"+201000333000\",\n \"type\": \"INDIVIDUAL\",\n \"gender\": \"MALE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"is_active\": true,\n \"description\": \"Business development head at Gawaab\",\n \"tags\": [\n {\n \"id\": \"01hqjp31wcww3jhnagehc16r04\",\n \"name\": \"Frequent Buyers\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"description\": \"Customers who make purchases more than twice a month.\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"is_deleted\": false,\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n ],\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"billing_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"BILLING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"shipping_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"SHIPPING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\"\n },\n \"description\": \"Stylish, comfortable sofas, modern furniture, whiteboards and desks.\",\n \"due_date\": \"2024-05-20\",\n \"expires_at\": \"2024-05-24 13:50:00\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-11 21:45:05\",\n \"updated_at\": \"2023-12-11 21:45:05\"\n }\n ]\n}"}],"_postman_id":"35e089d8-9949-448f-b2b3-c04188cb1cce"},{"name":"Create Payment Link","id":"03a5634a-0d0f-4e8e-baf7-3bfb08f1da04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/payment_links","description":"

The Payment Link feature in our financial platform, designed to streamline the payment process for businesses of all sizes. This page serves as a centralized hub where business owners can manage and track payment links, making the collection of payments seamless and efficient. View and organize all your active and expired links in one place. Monitor the status of each payment link, including payments received, and pending transactions. Reduces the time and effort required to invoice and collect payments. Simplifies the payment process - no technical expertise needed to create or manage links.

Why It's Important

The Payment Link is more than just a feature; it's a solution to the common pain points in payment processing. It eliminates the need for complex billing systems and allows businesses to get paid quickly and painlessly. By offering a user-friendly interface and real-time tracking, it empowers businesses to manage their finances more effectively and focus on growth.

\n","type":"text/plain"},"key":"includes","value":"payment_link.metadata,payment_link.payment_details,payment_link.payment_details.taxes,payment_link.payment_details.taxes.metadata,payment_link.customer,payment_link.customer.metadata,payment_link.customer.tags,payment_link.customer.tags.metadata,payment_link.customer.billing_address,payment_link.customer.billing_address.country,payment_link.customer.shipping_address,payment_link.customer.shipping_address.country,checkout.payer,checkout.payer.billing_address,checkout.payer.billing_address.country,checkout.payer.shipping_address,checkout.payer.shipping_address.country"}],"variable":[]}},"response":[{"id":"907af532-2c3b-4702-b6bd-912880ea7fd0","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/payment_links","host":["https://api.payiano.dev"],"path":["v1","payment_links"],"query":[{"value":"payment_link.metadata,payment_link.payment_details,payment_link.payment_details.taxes,payment_link.payment_details.taxes.metadata,payment_link.customer,payment_link.customer.metadata,payment_link.customer.tags,payment_link.customer.tags.metadata,payment_link.customer.billing_address,payment_link.customer.billing_address.country,payment_link.customer.shipping_address,payment_link.customer.shipping_address.country,checkout.payer,checkout.payer.billing_address,checkout.payer.billing_address.country,checkout.payer.shipping_address,checkout.payer.shipping_address.country","key":"includes","description":"A list of additional payment link relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"The Payment Link feature in our financial platform, designed to streamline the payment process for businesses of all sizes. This page serves as a centralized hub where business owners can manage and track payment links, making the collection of payments seamless and efficient. View and organize all your active and expired links in one place. Monitor the status of each payment link, including payments received, and pending transactions. Reduces the time and effort required to invoice and collect payments. Simplifies the payment process - no technical expertise needed to create or manage links. \n\n## Why It's Important\nThe Payment Link is more than just a feature; it's a solution to the common pain points in payment processing. It eliminates the need for complex billing systems and allows businesses to get paid quickly and painlessly. By offering a user-friendly interface and real-time tracking, it empowers businesses to manage their finances more effectively and focus on growth."},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"payment_link\": {\n \"id\": \"01hqjmrh1hjg315bhnytk0k7ne\",\n \"title\": \"Office accessories for Gawaab corporate\",\n \"payment_details\": {\n \"currency_code\": \"EGP\",\n \"amount\": 1000,\n \"taxes\": [\n {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"name\": \"Value added tax\",\n \"value\": 14,\n \"value_type\": \"PERCENTAGE\",\n \"type\": \"VAT\",\n \"strategy\": \"EXCLUSIVE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"b438800f-9e32-36a1-aee8-725aca982cc7\",\n \"is_active\": true,\n \"description\": \"The value added tax\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-24 18:02:40\",\n \"updated_at\": \"2023-12-24 18:02:40\"\n },\n {\n \"id\": \"01ht1mz21w0b63gffe17fhzvk2\",\n \"name\": \"Sales tax\",\n \"value\": 100,\n \"value_type\": \"FLAT\",\n \"type\": \"SALES_TAX\",\n \"strategy\": \"INCLUSIVE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"62824653-0d70-3580-8beb-6144971cc93b\",\n \"is_active\": true,\n \"description\": \"The value added tax\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-24 18:02:40\",\n \"updated_at\": \"2023-12-24 18:02:40\"\n }\n ],\n \"tax_strategy\": null,\n \"exclusive_tax_amount\": 140,\n \"inclusive_tax_amount\": 100,\n \"total_tax_amount\": 240,\n \"amount_after_tax\": 1140,\n \"total_amount\": 1140,\n \"paid_amount\": 0,\n \"remaining_amount\": 1140,\n \"status\": \"UNPAID\",\n \"is_completed\": false,\n \"paid_at\": null\n },\n \"reference_id\": \"e07ac088-4cb3-3797-bfae-bc4ddca71648\",\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"customer\": {\n \"id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"name\": \"Mohsen Ali\",\n \"email\": \"mohsen@gawaab.com\",\n \"billing_emails\": [\n \"shady.abbas@gawaab.com\",\n \"diab.maged@gawaab.com\"\n ],\n \"cc_emails\": [\n \"ramy.tarek@gawaab.com\",\n \"dina.mourad@gawaab.com\"\n ],\n \"shipping_address_as_billing_address\": true,\n \"billing_email_as_customer_email\": true,\n \"phone_number\": \"+201000333000\",\n \"type\": \"INDIVIDUAL\",\n \"gender\": \"MALE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"is_active\": true,\n \"description\": \"Business development head at Gawaab\",\n \"tags\": [\n {\n \"id\": \"01hqjp31wcww3jhnagehc16r04\",\n \"name\": \"Frequent Buyers\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"description\": \"Customers who make purchases more than twice a month.\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"is_deleted\": false,\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n ],\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"billing_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"BILLING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"shipping_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"SHIPPING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\"\n },\n \"description\": \"Stylish, comfortable sofas, modern furniture, whiteboards and desks.\",\n \"due_date\": \"2024-05-20\",\n \"expires_at\": \"2024-05-24 13:50:00\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-11 21:45:05\",\n \"updated_at\": \"2023-12-11 21:45:05\"\n },\n \"checkout\": {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"payable_id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"payable_type\": \"PAYMENT_LINK\",\n \"currency_code\": \"EGP\",\n \"paid_amount\": 0,\n \"total_amount\": 1140,\n \"remaining_amount\": 1140,\n \"is_completed\": false,\n \"is_coupon_allowed\": true,\n \"has_billing_address\": true,\n \"has_shipping_address\": false,\n \"status\": \"UNPAID\",\n \"error_redirect_url\": \"https://graply.com/payments/error\",\n \"success_redirect_url\": \"https://graply.com/payments/success\",\n \"pay_action\": \"PAY\",\n \"fees_strategy\": \"DEFAULT\",\n \"urls\": {\n \"url\": \"http://pay.payiano.com/checkouts/01hqh45s7826hfwdze8dp1z21f\",\n \"short_url\": \"https://grap.ly/7HlD4c1\",\n \"short_url_id\": \"7HlD4c1\",\n \"qr_code_url\": \"http://api-pay.payiano.com/v1/checkouts/01hqh45s7826hfwdze8dp1z21f/qrcode\"\n },\n \"paid_at\": null,\n \"payer\": {\n \"name\": \"Mohsen Ali\",\n \"email\": \"mohsen@gawaab.com\",\n \"phone_number\": \"+201000333000\",\n \"shipping_address_as_billing_address\": true,\n \"billing_address\": {\n \"country_code\": \"EG\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"note\": null,\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n }\n },\n \"shipping_address\": {\n \"country_code\": \"EG\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"note\": null,\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n }\n }\n },\n \"created_at\": \"2024-02-04 14:47:55\",\n \"updated_at\": \"2024-02-04 14:47:55\"\n }\n}"}],"_postman_id":"03a5634a-0d0f-4e8e-baf7-3bfb08f1da04"},{"name":"Retrieve Payment Link","id":"320490cf-287f-421c-9460-274e28e3c687","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/payment_links/:id","description":"

With Payiano you can retrieve a Payment Link. This created link has details like how much money needs to be paid. You can send this link to the person who needs to pay, like a customer, through email, text message, or even on social media. The customer clicks on this link, which takes them to a secure website where they can choose how to pay, like using a credit card or a bank transfer. This method is really handy because it's quick, safe, and lets people pay in different ways. It's great for online shopping, freelancers who need to bill their clients and charities collecting donations. Payment links are becoming more popular because they make online payments easy and work well for everyone, whether they're buying something, getting paid, or donating to a cause.

\n","type":"text/plain"},"key":"includes","value":"payment_link.metadata,payment_link.payment_details,payment_link.payment_details.taxes,payment_link.payment_details.taxes.metadata,payment_link.customer,payment_link.customer.metadata,payment_link.customer.tags,payment_link.customer.tags.metadata,payment_link.customer.billing_address,payment_link.customer.billing_address.country,payment_link.customer.shipping_address,payment_link.customer.shipping_address.country"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"479aa35b-02ef-439d-b62c-2b55262f87cf","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/payment_links/:id","host":["https://api.payiano.dev"],"path":["v1","payment_links",":id"],"query":[{"value":"payment_link.metadata,payment_link.payment_details,payment_link.payment_details.taxes,payment_link.payment_details.taxes.metadata,payment_link.customer,payment_link.customer.metadata,payment_link.customer.tags,payment_link.customer.tags.metadata,payment_link.customer.billing_address,payment_link.customer.billing_address.country,payment_link.customer.shipping_address,payment_link.customer.shipping_address.country","key":"includes","description":"A list of additional payment link relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"With [Payiano](https://payiano.com) you can retrieve a Payment Link. This [created](https://docs.payiano.com/api/rest/v1/company/online-payments/payment-links/create) link has details like how much money needs to be paid. You can send this link to the person who needs to pay, like a customer, through email, text message, or even on social media. The customer clicks on this link, which takes them to a secure website where they can choose how to pay, like using a credit card or a bank transfer. This method is really handy because it's quick, safe, and lets people pay in different ways. It's great for online shopping, freelancers who need to bill their clients and charities collecting donations. Payment links are becoming more popular because they make online payments easy and work well for everyone, whether they're buying something, getting paid, or donating to a cause."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"payment_link\": {\n \"id\": \"01hqjmrh1hjg315bhnytk0k7ne\",\n \"title\": \"Office accessories for Gawaab corporate\",\n \"payment_details\": {\n \"currency_code\": \"EGP\",\n \"amount\": 1000,\n \"taxes\": [\n {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"name\": \"Value added tax\",\n \"value\": 14,\n \"value_type\": \"PERCENTAGE\",\n \"type\": \"VAT\",\n \"strategy\": \"EXCLUSIVE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"b438800f-9e32-36a1-aee8-725aca982cc7\",\n \"is_active\": true,\n \"description\": \"The value added tax\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-24 18:02:40\",\n \"updated_at\": \"2023-12-24 18:02:40\"\n },\n {\n \"id\": \"01ht1mz21w0b63gffe17fhzvk2\",\n \"name\": \"Sales tax\",\n \"value\": 100,\n \"value_type\": \"FLAT\",\n \"type\": \"SALES_TAX\",\n \"strategy\": \"INCLUSIVE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"62824653-0d70-3580-8beb-6144971cc93b\",\n \"is_active\": true,\n \"description\": \"The value added tax\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-24 18:02:40\",\n \"updated_at\": \"2023-12-24 18:02:40\"\n }\n ],\n \"tax_strategy\": null,\n \"exclusive_tax_amount\": 140,\n \"inclusive_tax_amount\": 100,\n \"total_tax_amount\": 240,\n \"amount_after_tax\": 1140,\n \"total_amount\": 1140,\n \"paid_amount\": 0,\n \"remaining_amount\": 1140,\n \"status\": \"UNPAID\",\n \"is_completed\": false,\n \"paid_at\": null\n },\n \"reference_id\": \"e07ac088-4cb3-3797-bfae-bc4ddca71648\",\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"customer\": {\n \"id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"name\": \"Mohsen Ali\",\n \"email\": \"mohsen@gawaab.com\",\n \"billing_emails\": [\n \"shady.abbas@gawaab.com\",\n \"diab.maged@gawaab.com\"\n ],\n \"cc_emails\": [\n \"ramy.tarek@gawaab.com\",\n \"dina.mourad@gawaab.com\"\n ],\n \"shipping_address_as_billing_address\": true,\n \"billing_email_as_customer_email\": true,\n \"phone_number\": \"+201000333000\",\n \"type\": \"INDIVIDUAL\",\n \"gender\": \"MALE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"is_active\": true,\n \"description\": \"Business development head at Gawaab\",\n \"tags\": [\n {\n \"id\": \"01hqjp31wcww3jhnagehc16r04\",\n \"name\": \"Frequent Buyers\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"description\": \"Customers who make purchases more than twice a month.\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"is_deleted\": false,\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n ],\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"billing_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"BILLING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"shipping_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"SHIPPING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\"\n },\n \"description\": \"Stylish, comfortable sofas, modern furniture, whiteboards and desks.\",\n \"due_date\": \"2024-05-20\",\n \"expires_at\": \"2024-05-24 13:50:00\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-11 21:45:05\",\n \"updated_at\": \"2023-12-11 21:45:05\"\n }\n}"}],"_postman_id":"320490cf-287f-421c-9460-274e28e3c687"},{"name":"Update Payment Link","id":"9e9f3428-0045-420f-8515-e6a1b7f0f417","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/payment_links/:id","description":"

With Payiano you can update Payment Links seamlessly. You can make adjustments to certain parts of your existing Payment Links. This means you can keep your Payment Links up-to-date without having to start from scratch each time. Just remember, only specific attributes of the Payment Links can be changed. This restriction is in place because once a Payment Link is created and an invoice is sent to the customer, changing certain details like the payment amount could lead to confusion or compromise the integrity of the data. Keeping some attributes fixed ensures that the payment process remains clear and reliable for both you and your customers. If you need to change the amount on a Payment Link, the best approach is to create a new one. This ensures clarity and accuracy in your transactions.

\n","type":"text/plain"},"key":"includes","value":"payment_link.metadata,payment_link.payment_details,payment_link.payment_details.taxes,payment_link.payment_details.taxes.metadata,payment_link.customer,payment_link.customer.metadata,payment_link.customer.tags,payment_link.customer.tags.metadata,payment_link.customer.billing_address,payment_link.customer.billing_address.country,payment_link.customer.shipping_address,payment_link.customer.shipping_address.country"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"00ffeb78-1a6f-4b40-87f6-1bee2ca6f625","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/payment_links/:id","host":["https://api.payiano.dev"],"path":["v1","payment_links",":id"],"query":[{"value":"payment_link.metadata,payment_link.payment_details,payment_link.payment_details.taxes,payment_link.payment_details.taxes.metadata,payment_link.customer,payment_link.customer.metadata,payment_link.customer.tags,payment_link.customer.tags.metadata,payment_link.customer.billing_address,payment_link.customer.billing_address.country,payment_link.customer.shipping_address,payment_link.customer.shipping_address.country","key":"includes","description":"A list of additional payment link relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"With [Payiano](https://payiano.com) you can update Payment Links seamlessly. You can make adjustments to certain parts of your existing Payment Links. This means you can keep your Payment Links up-to-date without having to start from scratch each time. Just remember, **only specific attributes** of the Payment Links can be changed. This restriction is in place because once a Payment Link is created and an invoice is sent to the customer, changing certain details like the payment amount could lead to confusion or compromise the integrity of the data. Keeping some attributes fixed ensures that the payment process remains clear and reliable for both you and your customers. If you need to change the amount on a Payment Link, the best approach is to [create](https://docs.payiano.com/api/rest/v1/company/online-payments/payment-links/create) a new one. This ensures clarity and accuracy in your transactions."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"payment_link\": {\n \"id\": \"01hqjmrh1hjg315bhnytk0k7ne\",\n \"title\": \"Office accessories for Gawaab corporate\",\n \"payment_details\": {\n \"currency_code\": \"EGP\",\n \"amount\": 1000,\n \"taxes\": [\n {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"name\": \"Value added tax\",\n \"value\": 14,\n \"value_type\": \"PERCENTAGE\",\n \"type\": \"VAT\",\n \"strategy\": \"EXCLUSIVE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"b438800f-9e32-36a1-aee8-725aca982cc7\",\n \"is_active\": true,\n \"description\": \"The value added tax\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-24 18:02:40\",\n \"updated_at\": \"2023-12-24 18:02:40\"\n },\n {\n \"id\": \"01ht1mz21w0b63gffe17fhzvk2\",\n \"name\": \"Sales tax\",\n \"value\": 100,\n \"value_type\": \"FLAT\",\n \"type\": \"SALES_TAX\",\n \"strategy\": \"INCLUSIVE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"62824653-0d70-3580-8beb-6144971cc93b\",\n \"is_active\": true,\n \"description\": \"The value added tax\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-24 18:02:40\",\n \"updated_at\": \"2023-12-24 18:02:40\"\n }\n ],\n \"tax_strategy\": null,\n \"exclusive_tax_amount\": 140,\n \"inclusive_tax_amount\": 100,\n \"total_tax_amount\": 240,\n \"amount_after_tax\": 1140,\n \"total_amount\": 1140,\n \"paid_amount\": 0,\n \"remaining_amount\": 1140,\n \"status\": \"UNPAID\",\n \"is_completed\": false,\n \"paid_at\": null\n },\n \"reference_id\": \"e07ac088-4cb3-3797-bfae-bc4ddca71648\",\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"customer\": {\n \"id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"name\": \"Mohsen Ali\",\n \"email\": \"mohsen@gawaab.com\",\n \"billing_emails\": [\n \"shady.abbas@gawaab.com\",\n \"diab.maged@gawaab.com\"\n ],\n \"cc_emails\": [\n \"ramy.tarek@gawaab.com\",\n \"dina.mourad@gawaab.com\"\n ],\n \"shipping_address_as_billing_address\": true,\n \"billing_email_as_customer_email\": true,\n \"phone_number\": \"+201000333000\",\n \"type\": \"INDIVIDUAL\",\n \"gender\": \"MALE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"is_active\": true,\n \"description\": \"Business development head at Gawaab\",\n \"tags\": [\n {\n \"id\": \"01hqjp31wcww3jhnagehc16r04\",\n \"name\": \"Frequent Buyers\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"description\": \"Customers who make purchases more than twice a month.\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"is_deleted\": false,\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n ],\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"billing_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"BILLING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"shipping_address\": {\n \"id\": \"01ht3tph1szfa5b02qsay22hk1\",\n \"country_code\": \"EG\",\n \"type\": \"SHIPPING_ADDRESS\",\n \"is_default\": true,\n \"reference_id\": \"96bf2bca-61c0-3eba-bc85-bfae3bcfd85f\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"is_deleted\": false,\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"note\": null,\n \"customer_id\": \"01hqjp3f48879znt9v4dysrk2r\",\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n },\n \"created_at\": \"2024-03-29 00:45:32\",\n \"updated_at\": \"2024-03-29 00:45:32\",\n \"deleted_at\": null\n },\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\"\n },\n \"description\": \"Stylish, comfortable sofas, modern furniture, whiteboards and desks.\",\n \"due_date\": \"2024-05-20\",\n \"expires_at\": \"2024-05-24 13:50:00\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-11 21:45:05\",\n \"updated_at\": \"2023-12-11 21:45:05\"\n }\n}"}],"_postman_id":"9e9f3428-0045-420f-8515-e6a1b7f0f417"},{"name":"Cancel Payment Link","id":"faa42ce0-d988-49bf-a95c-c2560a730d39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/payment_links/:id/cancel","description":"

The Cancel Payment Link feature integrated into Payiano represents a vital functionality for both businesses and individuals engaged in digital transactions, ensuring they maintain control and flexibility over their payment processes. This feature is especially critical when a transaction becomes redundant or if there's an error in the originally sent payment details. By allowing instant invalidation of a payment link, it prevents any potential or unintended financial exchanges.

Additionally, this feature is really helpful for fixing mistakes. For example, if you send a Payment Link with the wrong details, canceling it stops any wrong payments from happening. This tool gives businesses full control over their Payment Links, making sure that only the right transactions go through. It also tells everyone automatically when a Payment Link is canceled. This keeps things clear and helps avoid any mix-ups.

Enhancing the security aspect, this feature is pivotal for withdrawing links that might have been compromised or erroneously shared, thereby safeguarding the transactional integrity. Designed with user-friendliness at its core, the process to cancel a payment link is straightforward and accessible, requiring just a few clicks, making it manageable for users irrespective of their technical expertise. However, it's important to note that the cancellation of a payment link is irreversible; thus, if a subsequent transaction is necessary, a new link must be created. This design principle underscores the commitment to maintaining transactional clarity and integrity, a cornerstone for smooth and secure business operations in the digital age.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}},"urlObject":{"path":["v1","payment_links",":id","cancel"],"host":["https://api.payiano.dev"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"c8fbea94-d9d6-4392-a74c-3229522fbb12","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/payment_links/:id/cancel","host":["https://api.payiano.dev"],"path":["v1","payment_links",":id","cancel"],"variable":[{"key":"id"}]},"description":"The Cancel Payment Link feature integrated into [Payiano](https://payiano.com) represents a vital functionality for both businesses and individuals engaged in digital transactions, ensuring they maintain control and flexibility over their payment processes. This feature is especially critical when a transaction becomes redundant or if there's an error in the originally sent payment details. By allowing instant invalidation of a payment link, it prevents any potential or unintended financial exchanges. \n\nAdditionally, this feature is really helpful for fixing mistakes. For example, if you send a Payment Link with the wrong details, canceling it stops any wrong payments from happening. This tool gives businesses full control over their [Payment Links](https://docs.payiano.com/api/rest/v1/company/online-payments/payment-links/list), making sure that only the right transactions go through. It also tells everyone automatically when a Payment Link is canceled. This keeps things clear and helps avoid any mix-ups. \n\nEnhancing the security aspect, this feature is pivotal for withdrawing links that might have been compromised or erroneously shared, thereby safeguarding the transactional integrity. Designed with user-friendliness at its core, the process to cancel a payment link is straightforward and accessible, requiring just a few clicks, making it manageable for users irrespective of their technical expertise. However, it's important to note that the cancellation of a payment link is irreversible; thus, if a subsequent transaction is necessary, a new link must be [created](https://docs.payiano.com/api/rest/v1/company/online-payments/payment-links/create). This design principle underscores the commitment to maintaining transactional clarity and integrity, a cornerstone for smooth and secure business operations in the digital age."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": true\n}"}],"_postman_id":"faa42ce0-d988-49bf-a95c-c2560a730d39"},{"name":"Payment Link Checkout","id":"e96d03e0-7698-44b9-a744-96b40cb180ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/payment_links/:id/checkout","description":"

In Payiano Retrieve Checkout feature bridges the gap between creating a Payment Link and the final Checkout process, offering a seamless and integrated experience for customers. This feature allows businesses to retrieve the associated Checkout information tied to each Payment Link. This Checkout information is crucial as it encompasses the customer's journey from clicking the Payment Link to selecting their preferred payment method, be it via credit card, bank transfer, or other means, on a secure payment platform.

This dual functionality is particularly beneficial for a wide range of users – from online retailers and freelancers invoicing clients, to charities collecting donations – as it simplifies the online payment process, ensuring a smooth and secure transaction. By integrating the retrieval of both Payment Link and Checkout details, Payiano enhances the efficiency of financial transactions. It allows businesses to monitor and manage payments effectively, ensuring a streamlined payment process that reduces manual errors, increases operational efficiency, and ultimately leads to greater customer satisfaction.

This integration is a testament to Payiano's commitment to providing comprehensive, user-friendly solutions that cater to the dynamic needs of modern businesses, making it an invaluable tool for anyone looking to optimize their online payment systems.

\n","type":"text/plain"},"key":"includes","value":"checkout.payer,checkout.payer.billing_address,checkout.payer.billing_address.country,checkout.payer.shipping_address,checkout.payer.shipping_address.country"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"f4e7d0e5-43de-443b-81f7-c60940abbd43","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/payment_links/:id/checkout","host":["https://api.payiano.dev"],"path":["v1","payment_links",":id","checkout"],"query":[{"value":"checkout.payer,checkout.payer.billing_address,checkout.payer.billing_address.country,checkout.payer.shipping_address,checkout.payer.shipping_address.country","key":"includes","description":"A list of additional checkout relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"In [Payiano](https://payiano.com) Retrieve Checkout feature bridges the gap between [creating](https://docs.payiano.com/api/rest/v1/company/online-payments/payment-links/create) a Payment Link and the final Checkout process, offering a seamless and integrated experience for customers. This feature allows businesses to retrieve the associated Checkout information tied to each Payment Link. This Checkout information is crucial as it encompasses the customer's journey from clicking the Payment Link to selecting their preferred payment method, be it via credit card, bank transfer, or other means, on a secure payment platform. \n\nThis dual functionality is particularly beneficial for a wide range of users – from online retailers and freelancers invoicing clients, to charities collecting donations – as it simplifies the online payment process, ensuring a smooth and secure transaction. By integrating the retrieval of both Payment Link and Checkout details, Payiano enhances the efficiency of financial transactions. It allows businesses to monitor and manage payments effectively, ensuring a streamlined payment process that reduces manual errors, increases operational efficiency, and ultimately leads to greater customer satisfaction. \n\nThis integration is a testament to [Payiano](https://payiano.com)'s commitment to providing comprehensive, user-friendly solutions that cater to the dynamic needs of modern businesses, making it an invaluable tool for anyone looking to optimize their online payment systems."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"checkout\": {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"payable_id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"payable_type\": \"PAYMENT_LINK\",\n \"currency_code\": \"EGP\",\n \"paid_amount\": 0,\n \"total_amount\": 1140,\n \"remaining_amount\": 1140,\n \"is_completed\": false,\n \"is_coupon_allowed\": true,\n \"has_billing_address\": true,\n \"has_shipping_address\": false,\n \"status\": \"UNPAID\",\n \"error_redirect_url\": \"https://graply.com/payments/error\",\n \"success_redirect_url\": \"https://graply.com/payments/success\",\n \"pay_action\": \"PAY\",\n \"fees_strategy\": \"DEFAULT\",\n \"urls\": {\n \"url\": \"http://pay.payiano.com/checkouts/01hqh45s7826hfwdze8dp1z21f\",\n \"short_url\": \"https://grap.ly/7HlD4c1\",\n \"short_url_id\": \"7HlD4c1\",\n \"qr_code_url\": \"http://api-pay.payiano.com/v1/checkouts/01hqh45s7826hfwdze8dp1z21f/qrcode\"\n },\n \"paid_at\": null,\n \"payer\": {\n \"name\": \"Mohsen Ali\",\n \"email\": \"mohsen@gawaab.com\",\n \"phone_number\": \"+201000333000\",\n \"shipping_address_as_billing_address\": true,\n \"billing_address\": {\n \"country_code\": \"EG\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"note\": null,\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n }\n },\n \"shipping_address\": {\n \"country_code\": \"EG\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"note\": null,\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n }\n }\n },\n \"created_at\": \"2024-02-04 14:47:55\",\n \"updated_at\": \"2024-02-04 14:47:55\"\n }\n}"}],"_postman_id":"e96d03e0-7698-44b9-a744-96b40cb180ff"}],"id":"97ac9c10-8c80-420b-a17b-b4a40955d8d8","_postman_id":"97ac9c10-8c80-420b-a17b-b4a40955d8d8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}},{"name":"Payment Methods","item":[{"name":"List Payment Methods","id":"ce3a455b-a8df-4815-821e-c65649c28c91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/payment_methods","description":"

This endpoint provides a comprehensive list of all payment methods integrated into your Payiano account. It's like a directory that shows you every payment option set up for your business, from digital wallets like PayPal to various card payment systems. The endpoint is crucial for managing your payment options because it gives you a quick and complete overview. You can see which methods are available to your customers, allowing you to adjust your offerings based on their preferences or your business needs. This overview is especially important for ensuring you're providing a diverse range of payment options, catering to the varied preferences of your customers.

The page number to be retrieved, for the list of payment methods. So, a combination of page=1 and per_page=25 returns the first 25 payment methods. A combination of page=2 and per_page=25 returns the next 25 payment methods.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of payment methods to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of payment methods, you can specify a particular column as a reference point for organizing the items in a specific order.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

This refers to the way by which you would like to sort or order the results. When retrieving a list of payment methods, you can specify a particular way for organizing the items in a specific order, such as ascending or descending.

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

An easy and effective free search text to search payment methods. Please provide a minimum of 3 characters for each search item. This ensures that your search query is specific enough to yield relevant results.

\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"

A list of additional payment method relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"payment_method.provider"}],"variable":[]}},"response":[{"id":"38c9e134-7cbf-4d4a-ab20-0bfc50186c02","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/payment_methods","host":["https://api.payiano.dev"],"path":["v1","payment_methods"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of payment methods. So, a combination of `page=1` and `per_page=25` returns the first 25 payment methods. A combination of `page=2` and `per_page=25` returns the next 25 payment methods.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of payment methods to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of payment methods, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of payment methods, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search payment methods. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true},{"value":"payment_method.provider","key":"includes","description":"A list of additional payment method relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"This endpoint provides a comprehensive list of all payment methods integrated into your [Payiano](https://payiano.com) account. It's like a directory that shows you every payment option set up for your business, from digital wallets like PayPal to various card payment systems. The endpoint is crucial for managing your payment options because it gives you a quick and complete overview. You can see which methods are available to your customers, allowing you to adjust your offerings based on their preferences or your business needs. This overview is especially important for ensuring you're providing a diverse range of payment options, catering to the varied preferences of your customers."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"name\": \"PAYPAL\",\n \"is_enabled\": true,\n \"apply_fees_on_payer\": false,\n \"is_active\": true,\n \"provider\": {\n \"name\": \"PAYPAL\"\n }\n }\n ]\n}"}],"_postman_id":"ce3a455b-a8df-4815-821e-c65649c28c91"},{"name":"Retrieve Payment Method","id":"99899817-27ec-4916-a1bb-26d243a8d38d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/payment_methods/:name","description":"

This endpoint is important when you want to check the settings or operational status of a Payment Method. For instance, if you want to ensure that the PayPal option is correctly configured, this endpoint allows you to verify its status, including whether it's active and if it's applying additional fees to the customer. This detailed information is vital for troubleshooting, auditing, and ensuring each payment method aligns with your current business strategies and customer needs.

\n","type":"text/plain"},"key":"includes","value":"payment_method.provider"}],"variable":[{"type":"any","key":"name"}]}},"response":[{"id":"2f6cc3b3-a15f-4e28-95f6-45b29999f8de","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/payment_methods/:name","host":["https://api.payiano.dev"],"path":["v1","payment_methods",":name"],"query":[{"value":"payment_method.provider","key":"includes","description":"A list of additional payment method relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"name"}]},"description":"This endpoint is important when you want to check the settings or operational status of a Payment Method. For instance, if you want to ensure that the PayPal option is correctly configured, this endpoint allows you to verify its status, including whether it's active and if it's applying additional fees to the customer. This detailed information is vital for troubleshooting, auditing, and ensuring each payment method aligns with your current business strategies and customer needs."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"payment_method\": {\n \"name\": \"PAYPAL\",\n \"is_enabled\": true,\n \"apply_fees_on_payer\": false,\n \"is_active\": true,\n \"provider\": {\n \"name\": \"PAYPAL\"\n }\n },\n \"fees\": [\n {\n \"currency_code\": \"EGP\",\n \"type\": \"PROCESSING_FEE\",\n \"flat_amount\": 2.5,\n \"percentage\": 2,\n \"min_amount\": null,\n \"max_amount\": null\n }\n ]\n}"}],"_postman_id":"99899817-27ec-4916-a1bb-26d243a8d38d"},{"name":"Update Payment Method","id":"894d4ca3-3fce-4271-afad-98422eeeb3b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/payment_methods/:name","description":"

This endpoint is all about flexibility and control. It lets you modify the settings of your existing Payment Methods. Say you want to temporarily deactivate a Payment Method, adjust commission fees, or reactivate a previously disabled option; this is where you do it. The ability to update these details is essential for dynamic business operations, allowing you to respond to changes in the market, customer preferences, or internal policies.

\n","type":"text/plain"},"key":"includes","value":"payment_method.provider"}],"variable":[{"type":"any","key":"name"}]}},"response":[{"id":"ca3080f5-0266-40c4-a314-5a8fa0b11537","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/payment_methods/:name","host":["https://api.payiano.dev"],"path":["v1","payment_methods",":name"],"query":[{"value":"payment_method.provider","key":"includes","description":"A list of additional payment method relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"name"}]},"description":"This endpoint is all about flexibility and control. It lets you modify the settings of your existing Payment Methods. Say you want to temporarily deactivate a Payment Method, adjust commission fees, or reactivate a previously disabled option; this is where you do it. The ability to update these details is essential for dynamic business operations, allowing you to respond to changes in the market, customer preferences, or internal policies."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"payment_method\": {\n \"name\": \"PAYPAL\",\n \"is_enabled\": true,\n \"apply_fees_on_payer\": false,\n \"is_active\": true,\n \"provider\": {\n \"name\": \"PAYPAL\"\n }\n }\n}"}],"_postman_id":"894d4ca3-3fce-4271-afad-98422eeeb3b9"},{"name":"List Currencies","id":"3192d757-d476-48db-846c-2a15be0d3568","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/payment_methods_currencies","description":"

This endpoint provides a comprehensive list of all payment methods currencies supported within the system and available into your Payiano business account. This information is crucial for applications and services that handle transactions in multiple currencies, enabling them to display the appropriate payment currency code options. The three-character ISO-4217 Currency Code that identifies the currency for the payment. Your business should be eligible to use the selected currency code.

\n
This endpoint is designed to show you the unique and distinct currency codes that are available for the payment methods enabled both in our system and specifically in your account. If a payment method isn't currently active, and it's the only one that supports a certain currency, then you won't see that currency listed. For example, ( e.g If PayPal is the only payment method that supports Euros (EUR), but PayPal isn't active in your account. In that case, you won't get EUR wihtin the currency list ). Essentially, this helps to ensure that you only get the currencies you can actually use with the payment methods available to your account.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}},"urlObject":{"path":["v1","payment_methods_currencies"],"host":["https://api.payiano.dev"],"query":[],"variable":[]}},"response":[{"id":"bd14d76d-eafb-42b5-8921-70c58f2c0ca3","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":"https://api.payiano.dev/v1/payment_methods_currencies","description":"This endpoint provides a comprehensive list of all payment methods currencies supported within the system and available into your [Payiano](https://payiano.com) business account. This information is crucial for applications and services that handle transactions in multiple currencies, enabling them to display the appropriate payment currency code options. The three-character [ISO-4217 Currency Code](https://docs.payiano.com/api/rest/reference/currency-codes) that identifies the currency for the payment. Your business should be eligible to use the selected currency code. \n\n> This endpoint is designed to show you the unique and distinct currency codes that are available for the payment methods enabled both in our system and specifically in your account. If a payment method isn't currently active, and it's the only one that supports a certain currency, then you won't see that currency listed. For example, ( e.g If PayPal is the only payment method that supports Euros (EUR), but PayPal isn't active in your account. In that case, you won't get EUR wihtin the currency list ). Essentially, this helps to ensure that you only get the currencies you can actually use with the payment methods available to your account."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"currencies\": [\n \"EGP\",\n \"USD\"\n ]\n}"}],"_postman_id":"3192d757-d476-48db-846c-2a15be0d3568"}],"id":"7f32c668-b3dc-44b7-835e-cd39e74cc538","_postman_id":"7f32c668-b3dc-44b7-835e-cd39e74cc538","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}},{"name":"Transactions","item":[{"name":"List Transactions","id":"d8e14f47-39f9-430d-8bec-d2678ea91dea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/transactions","description":"

The Payiano's list transactions endpoint serves as the backbone for businesses to monitor their financial activities seamlessly. This powerful feature offers a comprehensive view of all transactions made through Payiano, including payments received, refunds issued, and charges applied. It's designed to simplify the financial management process by providing detailed insights into each transaction, enabling businesses to:

View Historical Data: Access a complete record of all past and present transactions, ensuring no detail is overlooked.
Export Reports: For further analysis or record-keeping, transactions can be exported in various formats, making it easy to share information with accountants or integrate into other financial tools. \nThis endpoint is invaluable for businesses of all sizes, offering a clear and organized view of their financial transactions, aiding in reconciliation, and helping to make informed decisions about their financial health.

The page number to be retrieved, for the list of transactions. So, a combination of page=1 and per_page=25 returns the first 25 transactions. A combination of page=2 and per_page=25 returns the next 25 transactions.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of transactions to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of transactions, you can specify a particular column as a reference point for organizing the items in a specific order.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

This refers to the way by which you would like to sort or order the results. When retrieving a list of transactions, you can specify a particular way for organizing the items in a specific order, such as ascending or descending.

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

An easy and effective free search text to search transactions. Please provide a minimum of 3 characters for each search item. This ensures that your search query is specific enough to yield relevant results.

\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"

A list of additional transaction relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"transaction.payment_method,transaction.payment_method.provider,transaction.payer,transaction.payer.billing_address,transaction.payer.billing_address.country,transaction.payer.shipping_address,transaction.payer.shipping_address.country"}],"variable":[]}},"response":[{"id":"4e635159-cd1f-498b-9cde-3fb3999cf32b","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/transactions","host":["https://api.payiano.dev"],"path":["v1","transactions"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of transactions. So, a combination of `page=1` and `per_page=25` returns the first 25 transactions. A combination of `page=2` and `per_page=25` returns the next 25 transactions.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of transactions to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of transactions, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of transactions, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search transactions. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true},{"value":"transaction.payment_method,transaction.payment_method.provider,transaction.payer,transaction.payer.billing_address,transaction.payer.billing_address.country,transaction.payer.shipping_address,transaction.payer.shipping_address.country","key":"includes","description":"A list of additional transaction relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"The [Payiano](https://payiano.com)'s list transactions endpoint serves as the backbone for businesses to monitor their financial activities seamlessly. This powerful feature offers a comprehensive view of all transactions made through [Payiano](https://payiano.com), including payments received, refunds issued, and charges applied. It's designed to simplify the financial management process by providing detailed insights into each transaction, enabling businesses to: \n\n- **View Historical Data**: Access a complete record of all past and present transactions, ensuring no detail is overlooked. \n- **Export Reports**: For further analysis or record-keeping, transactions can be exported in various formats, making it easy to share information with accountants or integrate into other financial tools. \nThis endpoint is invaluable for businesses of all sizes, offering a clear and organized view of their financial transactions, aiding in reconciliation, and helping to make informed decisions about their financial health."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"id\": \"01hsgngrhmjmcdr560hwzvv8e2\",\n \"currency_code\": \"EGP\",\n \"amount\": 1140,\n \"target_amount\": 1140,\n \"target_currency_code\": \"EGP\",\n \"conversion_rate\": 1,\n \"status\": \"UNPAID\",\n \"payment_method_name\": \"BASATA_CASH_COLLECTION\",\n \"payment_method\": {\n \"name\": \"BASATA_CASH_COLLECTION\",\n \"is_active\": null,\n \"payment_type\": \"CASH_COLLECTION\",\n \"provider\": {\n \"name\": \"BASATA\"\n }\n },\n \"payment_type\": \"CASH_COLLECTION\",\n \"payment_identifier\": \"11\",\n \"expires_at\": \"2024-03-01 19:57:50\",\n \"paid_at\": null,\n \"payer\": {\n \"name\": \"Mohsen Ali\",\n \"email\": \"mohsen@gawaab.com\",\n \"phone_number\": \"+201000333000\",\n \"shipping_address_as_billing_address\": true,\n \"billing_address\": {\n \"country_code\": \"EG\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"note\": null,\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n }\n },\n \"shipping_address\": {\n \"country_code\": \"EG\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"note\": null,\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n }\n }\n },\n \"created_at\": \"2024-02-28 19:57:50\",\n \"updated_at\": \"2024-02-28 19:57:50\"\n }\n ]\n}"}],"_postman_id":"d8e14f47-39f9-430d-8bec-d2678ea91dea"},{"name":"Retrieve Transaction","id":"a13e0494-9692-4cf0-8c77-27288a4df265","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/transactions/:id","description":"

The Payiano retrieve transaction endpoint offers a detailed look into individual transactions processed through Payiano. This feature is crucial for businesses that need to drill down into the specifics of each payment or refund. With this endpoint, you can:

Access Detailed Information: Get comprehensive details about a specific transaction, including the payer's information, payment method, date, amount, and any associated fees or refunds.
Verify Payment Status: Quickly confirm the status of a transaction, such as completed, pending, or failed, which is essential for managing customer inquiries and ensuring accurate record-keeping.
Understand Transaction Context: Gain insights into the context of each transaction, such as the related payment link, any messages or notes attached to the payment, and the transaction's impact on your balance. \nThis detailed view not only helps in addressing specific queries but also plays a critical role in financial auditing, customer service, and managing refunds or disputes. The retrieve transaction endpoint is a key tool for maintaining transparency and trust in financial dealings, ensuring every transaction can be reviewed and understood in full detail.

\n","type":"text/plain"},"key":"includes","value":"transaction.payment_method,transaction.payment_method.provider,transaction.payer,transaction.payer.billing_address,transaction.payer.billing_address.country,transaction.payer.shipping_address,transaction.payer.shipping_address.country"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"ff9f3b3f-ff2a-4307-9312-c9c1c2f88efd","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/transactions/:id","host":["https://api.payiano.dev"],"path":["v1","transactions",":id"],"query":[{"value":"transaction.payment_method,transaction.payment_method.provider,transaction.payer,transaction.payer.billing_address,transaction.payer.billing_address.country,transaction.payer.shipping_address,transaction.payer.shipping_address.country","key":"includes","description":"A list of additional transaction relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The [Payiano](https://payiano.com) retrieve transaction endpoint offers a detailed look into individual transactions processed through [Payiano](https://payiano.com). This feature is crucial for businesses that need to drill down into the specifics of each payment or refund. With this endpoint, you can: \n\n- **Access Detailed Information**: Get comprehensive details about a specific transaction, including the payer's information, payment method, date, amount, and any associated fees or refunds. \n- **Verify Payment Status**: Quickly confirm the status of a transaction, such as completed, pending, or failed, which is essential for managing customer inquiries and ensuring accurate record-keeping. \n- **Understand Transaction Context**: Gain insights into the context of each transaction, such as the related payment link, any messages or notes attached to the payment, and the transaction's impact on your balance. \nThis detailed view not only helps in addressing specific queries but also plays a critical role in financial auditing, customer service, and managing refunds or disputes. The retrieve transaction endpoint is a key tool for maintaining transparency and trust in financial dealings, ensuring every transaction can be reviewed and understood in full detail."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"transaction\": {\n \"id\": \"01hsgngrhmjmcdr560hwzvv8e2\",\n \"currency_code\": \"EGP\",\n \"amount\": 1140,\n \"target_amount\": 1140,\n \"target_currency_code\": \"EGP\",\n \"conversion_rate\": 1,\n \"status\": \"UNPAID\",\n \"payment_method_name\": \"BASATA_CASH_COLLECTION\",\n \"payment_method\": {\n \"name\": \"BASATA_CASH_COLLECTION\",\n \"is_active\": null,\n \"payment_type\": \"CASH_COLLECTION\",\n \"provider\": {\n \"name\": \"BASATA\"\n }\n },\n \"payment_type\": \"CASH_COLLECTION\",\n \"payment_identifier\": \"11\",\n \"expires_at\": \"2024-03-01 19:57:50\",\n \"paid_at\": null,\n \"payer\": {\n \"name\": \"Mohsen Ali\",\n \"email\": \"mohsen@gawaab.com\",\n \"phone_number\": \"+201000333000\",\n \"shipping_address_as_billing_address\": true,\n \"billing_address\": {\n \"country_code\": \"EG\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"note\": null,\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n }\n },\n \"shipping_address\": {\n \"country_code\": \"EG\",\n \"line_one\": \"7th Makram Ebid, Nasr City\",\n \"line_two\": \"Building 174, apartment 12\",\n \"city\": \"Cairo\",\n \"state\": \"Nasr City\",\n \"zip_code\": \"11321\",\n \"phone_number\": \"+201004545850\",\n \"landline_number\": \"6546543213216\",\n \"fax_number\": \"5456464646\",\n \"note\": null,\n \"first_name\": \"Mohsen\",\n \"last_name\": \"Osama\",\n \"location\": {\n \"lat\": 21.32,\n \"lng\": 12.63\n },\n \"country\": {\n \"code\": \"EG\",\n \"dial_code\": \"+20\",\n \"currency_code\": \"EGP\",\n \"name\": \"Egypt\",\n \"name_ar\": \"مصر\",\n \"lang\": \"AR\",\n \"flag\": \"🇪🇬\"\n }\n }\n },\n \"created_at\": \"2024-02-28 19:57:50\",\n \"updated_at\": \"2024-02-28 19:57:50\"\n }\n}"}],"_postman_id":"a13e0494-9692-4cf0-8c77-27288a4df265"}],"id":"a99c78bc-7965-4f85-98ab-51b67ccfdff3","_postman_id":"a99c78bc-7965-4f85-98ab-51b67ccfdff3","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}}],"id":"d1f7b30f-5d78-4166-88e4-5fe748ced7a6","_postman_id":"d1f7b30f-5d78-4166-88e4-5fe748ced7a6","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}},{"name":"Store","item":[{"name":"Product Categories","item":[{"name":"List Categories","id":"9928c095-3749-4de1-a69f-7a19011d0659","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/product_categories","description":"

Payiano categories are delving a key feature of your product management system. This isn't just about listing names; Without a catalog, finding a product would be a daunting task. It's the starting point for understanding your inventory. It answers questions like, \"What kinds of products do we offer?\" and \"How are our products organized?\" This clarity is crucial not only for your team but also for customers navigating your product offerings.

Categories like having a directory of all the different types of products you sell. For example, if you sell clothes, this list might show categories like 'Men’s Clothing', 'Women’s Clothing', and 'Children’s Clothing'. It helps you see all the categories at once, making it easy to get an overview of what you offer. This is really helpful for keeping things organized and making sure you know all the different areas your products fit into.

You can sort categories based on various factors - which ones are most popular, which are new, or even which ones are seasonal. Such sorting makes this tool not just informative but also strategic. This endpoint could also integrate analytics, showing which categories are performing well, guiding your marketing and stocking decisions.

The page number to be retrieved, for the list of product categories. So, a combination of page=1 and per_page=25 returns the first 25 product categories. A combination of page=2 and per_page=25 returns the next 25 product categories.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of product categories to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of product categories, you can specify a particular column as a reference point for organizing the items in a specific order.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

This refers to the way by which you would like to sort or order the results. When retrieving a list of product categories, you can specify a particular way for organizing the items in a specific order, such as ascending or descending.

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

An easy and effective free search text to search product categories. Please provide a minimum of 3 characters for each search item. This ensures that your search query is specific enough to yield relevant results.

\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"

A list of additional product category relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"product_category.metadata,product_category.products_count,product_category.categories_count,product_category.parent_category,product_category.parent_category.metadata,product_category.parent_category.products_count,product_category.parent_category.categories_count"}],"variable":[]}},"response":[{"id":"0c045993-0bdb-4bb6-b013-2e61541e03be","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/product_categories","host":["https://api.payiano.dev"],"path":["v1","product_categories"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of product categories. So, a combination of `page=1` and `per_page=25` returns the first 25 product categories. A combination of `page=2` and `per_page=25` returns the next 25 product categories.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of product categories to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of product categories, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of product categories, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search product categories. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true},{"value":"product_category.metadata,product_category.products_count,product_category.categories_count,product_category.parent_category,product_category.parent_category.metadata,product_category.parent_category.products_count,product_category.parent_category.categories_count","key":"includes","description":"A list of additional product category relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"[Payiano](https://payiano.com) categories are delving a key feature of your product management system. This isn't just about listing names; Without a catalog, finding a product would be a daunting task. It's the starting point for understanding your inventory. It answers questions like, \"What kinds of products do we offer?\" and \"How are our products organized?\" This clarity is crucial not only for your team but also for customers navigating your product offerings. \n\nCategories like having a directory of all the different types of products you sell. For example, if you sell clothes, this list might show categories like 'Men’s Clothing', 'Women’s Clothing', and 'Children’s Clothing'. It helps you see all the categories at once, making it easy to get an overview of what you offer. This is really helpful for keeping things organized and making sure you know all the different areas your products fit into. \n\nYou can sort categories based on various factors - which ones are most popular, which are new, or even which ones are seasonal. Such sorting makes this tool not just informative but also strategic. This endpoint could also integrate analytics, showing which categories are performing well, guiding your marketing and stocking decisions."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"id\": \"01hqjp622m9rykncnmtsyey5d8\",\n \"name\": \"Sports Shoes\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"slug\": \"sports-shoes\",\n \"parent_category_id\": null,\n \"description\": \"Featuring top brands and the latest technology for comfort and performance.\",\n \"is_deleted\": false,\n \"products_count\": 0,\n \"categories_count\": 0,\n \"parent_category\": {\n \"id\": \"01hqjp6ftspfxgk2ews9y7wfc2\",\n \"name\": \"Footwear\",\n \"is_active\": true,\n \"reference_id\": \"f58bc0b0-7d1a-395b-88c5-a17a380b3885\",\n \"slug\": \"footwear\",\n \"parent_category_id\": null,\n \"description\": \"A wide range of athletic footwear suitable for various sports activities.\",\n \"is_deleted\": false,\n \"products_count\": 0,\n \"categories_count\": 1,\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n },\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n ]\n}"}],"_postman_id":"9928c095-3749-4de1-a69f-7a19011d0659"},{"name":"Create Category","id":"a05e3787-4cdd-4854-b2a0-2a190f9722ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/product_categories","description":"

With Payiano Create Product Category, you can make a new category for your products. Imagine you start selling accessories like hats and scarves, but you don’t have a category for them. You can use this endpoint to create a new category called 'Accessories'. This helps keep your new items organized and makes it easier for you and your customers to find them.

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/product_categories/:id","description":"

With Payiano Retrieve Product Category is for when you want to look closely at one specific category. Say you pick 'Men’s Clothing' from your list. This endpoint will give you more details about just this category. It's like taking a book off the shelf to read its summary – you learn what kinds of men's clothes you have, how many items are there, and maybe some information about what customers think of these products. This is useful when you need to know more about a certain type of product.

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/product_categories/:id","description":"

The Payiano Update Product Category lets you make changes to an existing category. For instance, if you want to change the 'Accessories' category to 'Hats and Scarves' because you're not selling other accessories, this endpoint helps you do that. It's like renaming a folder on your computer to make sure it accurately describes what's inside. This keeps everything up-to-date and clear.

In the Payiano system, it's important to note a key operational rule regarding record updates. If a product category record has been soft deleted, without being permanently removed from the database, any updates to this record are forbidden. This restriction ensures data integrity and consistency, as modifying a soft-deleted record could lead to confusion or inaccuracies in the system management.

To update a soft-deleted product category, the record must first be restored. Restoration reverts the record's deleted status, making it once again eligible for updates and modifications. This policy is crucial for maintaining a clear and accurate representation of the product category record, while still retaining the flexibility to recover and revise previously soft-deleted product category as needed. By enforcing this rule, the Payiano system ensures a streamlined and coherent management process, balancing flexibility with control.

\n","type":"text/plain"},"key":"includes","value":"product_category.metadata,product_category.products_count,product_category.categories_count,product_category.parent_category,product_category.parent_category.metadata,product_category.parent_category.products_count,product_category.parent_category.categories_count"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"ae2b2546-0379-408a-8768-196a13f710a1","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/product_categories/:id","host":["https://api.payiano.dev"],"path":["v1","product_categories",":id"],"query":[{"value":"product_category.metadata,product_category.products_count,product_category.categories_count,product_category.parent_category,product_category.parent_category.metadata,product_category.parent_category.products_count,product_category.parent_category.categories_count","key":"includes","description":"A list of additional product category relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The [Payiano](https://payiano.com) Update Product Category lets you make changes to an existing category. For instance, if you want to change the 'Accessories' category to 'Hats and Scarves' because you're not selling other accessories, this endpoint helps you do that. It's like renaming a folder on your computer to make sure it accurately describes what's inside. This keeps everything up-to-date and clear. \n\nIn the [Payiano](https://payiano.com) system, it's important to note a key operational rule regarding record updates. If a product category record has been soft deleted, without being permanently removed from the database, any updates to this record are **forbidden**. This restriction ensures data integrity and consistency, as modifying a soft-deleted record could lead to confusion or inaccuracies in the system management. \n\nTo update a soft-deleted product category, the record must first be [restored](https://docs.payiano.com/api/rest/v1/company/store/categories/restore). Restoration reverts the record's deleted status, making it once again eligible for updates and modifications. This policy is crucial for maintaining a clear and accurate representation of the product category record, while still retaining the flexibility to recover and revise previously soft-deleted product category as needed. By enforcing this rule, the [Payiano](https://payiano.com) system ensures a streamlined and coherent management process, balancing flexibility with control."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"product_category\": {\n \"id\": \"01hqjp622m9rykncnmtsyey5d8\",\n \"name\": \"Sports Shoes\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"slug\": \"sports-shoes\",\n \"parent_category_id\": null,\n \"description\": \"Featuring top brands and the latest technology for comfort and performance.\",\n \"is_deleted\": false,\n \"products_count\": 0,\n \"categories_count\": 0,\n \"parent_category\": {\n \"id\": \"01hqjp6ftspfxgk2ews9y7wfc2\",\n \"name\": \"Footwear\",\n \"is_active\": true,\n \"reference_id\": \"f58bc0b0-7d1a-395b-88c5-a17a380b3885\",\n \"slug\": \"footwear\",\n \"parent_category_id\": null,\n \"description\": \"A wide range of athletic footwear suitable for various sports activities.\",\n \"is_deleted\": false,\n \"products_count\": 0,\n \"categories_count\": 1,\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n },\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"52f6fb45-7e7f-4d97-b692-7b7d75d26db9"},{"name":"Delete Category","id":"196cc133-b63f-47d6-90d1-2f279f480ebc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/product_categories/:id","description":"

The Payiano Delete Product Category endpoint is used when you no longer need a category. For example, if you stop selling children’s clothing, you can use this endpoint to remove the 'Children’s Clothing' category. It’s like removing a shelf in your store that you don’t need anymore. This helps keep your product categories tidy and relevant to what you’re selling now.

This attribute determines the deletion method to be applied to the product category delete in the database. When the value is set to true, it indicates that the product category should be permanently and irreversibly removed from the database, commonly known as a Hard Delete. If the value is set to false, it implies a Soft Delete approach, where the product category is not physically removed from the database. With Soft Delete it's still possible to restore the product category record.

\n","type":"text/plain"},"key":"force_delete","value":"false"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"2d2d4553-5c2f-413f-914c-2256aec9cf81","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/product_categories/:id","host":["https://api.payiano.dev"],"path":["v1","product_categories",":id"],"query":[{"value":"false","key":"force_delete","description":"This attribute determines the deletion method to be applied to the product category delete in the database. When the value is set to `true`, it indicates that the product category should be permanently and irreversibly removed from the database, commonly known as a **Hard Delete**. If the value is set to `false`, it implies a **Soft Delete** approach, where the product category is not physically removed from the database. With **Soft Delete** it's still possible to restore the product category record.","disabled":true}],"variable":[{"key":"id"}]},"description":"The [Payiano](https://payiano.com) Delete Product Category endpoint is used when you no longer need a category. For example, if you stop selling children’s clothing, you can use this endpoint to remove the 'Children’s Clothing' category. It’s like removing a shelf in your store that you don’t need anymore. This helps keep your product categories tidy and relevant to what you’re selling now."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": true\n}"}],"_postman_id":"196cc133-b63f-47d6-90d1-2f279f480ebc"},{"name":"Restore Category","id":"dd03ad75-80e9-4d1f-88ed-65ceb32dde54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/product_categories/:id/restore","description":"

The Payiano Restore Product Category is used to bring back a category you had deleted. Suppose you decide to sell children’s clothing again after some time. Instead of creating a new category, you can use this endpoint to bring back the 'Children’s Clothing' category you had before. It’s like putting a shelf back in your store because you need it again. This is helpful when you want to go back to selling something you used to sell.

\n","type":"text/plain"},"key":"includes","value":"product_category.metadata,product_category.products_count,product_category.categories_count,product_category.parent_category,product_category.parent_category.metadata,product_category.parent_category.products_count,product_category.parent_category.categories_count"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"37d50495-1601-48c7-9cc5-0d76a0dae38f","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/product_categories/:id/restore","host":["https://api.payiano.dev"],"path":["v1","product_categories",":id","restore"],"query":[{"value":"product_category.metadata,product_category.products_count,product_category.categories_count,product_category.parent_category,product_category.parent_category.metadata,product_category.parent_category.products_count,product_category.parent_category.categories_count","key":"includes","description":"A list of additional product category relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The [Payiano](https://payiano.com) Restore Product Category is used to bring back a category you had deleted. Suppose you decide to sell children’s clothing again after some time. Instead of creating a new category, you can use this endpoint to bring back the 'Children’s Clothing' category you had before. It’s like putting a shelf back in your store because you need it again. This is helpful when you want to go back to selling something you used to sell."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"product_category\": {\n \"id\": \"01hqjp622m9rykncnmtsyey5d8\",\n \"name\": \"Sports Shoes\",\n \"is_active\": true,\n \"reference_id\": \"7193edd2-7574-3b76-9103-e0e37580129b\",\n \"slug\": \"sports-shoes\",\n \"parent_category_id\": null,\n \"description\": \"Featuring top brands and the latest technology for comfort and performance.\",\n \"is_deleted\": false,\n \"products_count\": 0,\n \"categories_count\": 0,\n \"parent_category\": {\n \"id\": \"01hqjp6ftspfxgk2ews9y7wfc2\",\n \"name\": \"Footwear\",\n \"is_active\": true,\n \"reference_id\": \"f58bc0b0-7d1a-395b-88c5-a17a380b3885\",\n \"slug\": \"footwear\",\n \"parent_category_id\": null,\n \"description\": \"A wide range of athletic footwear suitable for various sports activities.\",\n \"is_deleted\": false,\n \"products_count\": 0,\n \"categories_count\": 1,\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n },\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-04 06:15:41\",\n \"updated_at\": \"2023-12-04 06:15:41\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"dd03ad75-80e9-4d1f-88ed-65ceb32dde54"}],"id":"4f29eca5-fedb-4b5e-821f-3a367d79a81b","_postman_id":"4f29eca5-fedb-4b5e-821f-3a367d79a81b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}},{"name":"Product Brands","item":[{"name":"List Brands","id":"36448c27-bbf6-4636-a79b-f1431a35ce48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/product_brands","description":"

The Payiano list product brands endpoint offers a comprehensive overview of all the brands within a business's store, serving as an essential tool for inventory management and marketing strategy. It enables businesses to evaluate their brand diversity, identify potential gaps in their product offerings, and strategize future expansions. By having a clear and organized listing of brands, companies can ensure that their product range is well-balanced and meets the varied needs and preferences of their customer base, thereby enhancing customer satisfaction and loyalty.

This endpoint aids in streamlining operations and facilitating smoother integration across various business functions. From supply chain management to marketing and sales, having ready access to a detailed list of brands allows for more coordinated efforts and efficiency. For instance, marketing teams can use this information to design brand-specific promotions, while sales teams can leverage it to inform customers about the breadth of available products, ultimately leading to more effective cross-selling and up-selling strategies.

The page number to be retrieved, for the list of product brands. So, a combination of page=1 and per_page=25 returns the first 25 product brands. A combination of page=2 and per_page=25 returns the next 25 product brands.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of product brands to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of product brands, you can specify a particular column as a reference point for organizing the items in a specific order.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

This refers to the way by which you would like to sort or order the results. When retrieving a list of product brands, you can specify a particular way for organizing the items in a specific order, such as ascending or descending.

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

An easy and effective free search text to search product brands. Please provide a minimum of 3 characters for each search item. This ensures that your search query is specific enough to yield relevant results.

\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"

A list of additional product brand relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"product_brand.metadata,product_brand.products_count"}],"variable":[]}},"response":[{"id":"94db7232-ecab-4625-b1ad-07c5b3b6758e","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/product_brands","host":["https://api.payiano.dev"],"path":["v1","product_brands"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of product brands. So, a combination of `page=1` and `per_page=25` returns the first 25 product brands. A combination of `page=2` and `per_page=25` returns the next 25 product brands.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of product brands to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of product brands, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of product brands, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search product brands. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true},{"value":"product_brand.metadata,product_brand.products_count","key":"includes","description":"A list of additional product brand relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"The [Payiano](https://payiano.com) list product brands endpoint offers a comprehensive overview of all the brands within a business's store, serving as an essential tool for inventory management and marketing strategy. It enables businesses to evaluate their brand diversity, identify potential gaps in their product offerings, and strategize future expansions. By having a clear and organized listing of brands, companies can ensure that their product range is well-balanced and meets the varied needs and preferences of their customer base, thereby enhancing customer satisfaction and loyalty. \n\nThis endpoint aids in streamlining operations and facilitating smoother integration across various business functions. From supply chain management to marketing and sales, having ready access to a detailed list of brands allows for more coordinated efforts and efficiency. For instance, marketing teams can use this information to design brand-specific promotions, while sales teams can leverage it to inform customers about the breadth of available products, ultimately leading to more effective cross-selling and up-selling strategies."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"id\": \"01htcy6rwpcjn56ys9p1f37ans\",\n \"name\": \"Asfour Crystal\",\n \"slug\": \"asfour-crystal\",\n \"description\": \"Utilizing the latest in technology to introduce its unlimited possibilities to transform dreams into impressive.\",\n \"reference_id\": \"3e88d728-b647-3b34-bebc-88807f8a2d0b\",\n \"is_active\": true,\n \"is_deleted\": false,\n \"products_count\": 0,\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2024-04-01 13:40:00\",\n \"updated_at\": \"2024-04-01 13:40:00\",\n \"deleted_at\": null\n }\n ]\n}"}],"_postman_id":"36448c27-bbf6-4636-a79b-f1431a35ce48"},{"name":"Create Brand","id":"20f60b23-60d5-4c97-aa6b-f5164e2b6d00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/product_brands","description":"

The Payiano create product brand endpoint empowers businesses to expand their portfolio by adding new brands. This feature is instrumental in keeping the product offerings fresh and aligned with market trends or consumer demands. When a business identifies an opportunity to introduce a new brand—whether to tap into emerging market segments or to diversify its product lineup—this endpoint facilitates a seamless addition to the system. This capability not only enhances the catalog's variety but also enables companies to quickly adapt to changes in consumer preferences, ensuring the product range remains competitive and appealing to a broad audience.

By allowing for the introduction of new brands, businesses can effectively segment their market, target distinct consumer demographics, and craft specialized marketing campaigns. This endpoint provides the foundation for building a diverse and robust brand portfolio, enabling companies to differentiate themselves in a crowded marketplace and to cultivate a distinctive brand identity that resonates with their target customers.

\n","type":"text/plain"},"key":"includes","value":"product_brand.metadata,product_brand.products_count"}],"variable":[]}},"response":[{"id":"702ffef8-7da4-409d-9450-371d9832c736","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/product_brands","host":["https://api.payiano.dev"],"path":["v1","product_brands"],"query":[{"value":"product_brand.metadata,product_brand.products_count","key":"includes","description":"A list of additional product brand relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"The [Payiano](https://payiano.com) create product brand endpoint empowers businesses to expand their portfolio by adding new brands. This feature is instrumental in keeping the product offerings fresh and aligned with market trends or consumer demands. When a business identifies an opportunity to introduce a new brand—whether to tap into emerging market segments or to diversify its product lineup—this endpoint facilitates a seamless addition to the system. This capability not only enhances the catalog's variety but also enables companies to quickly adapt to changes in consumer preferences, ensuring the product range remains competitive and appealing to a broad audience. \n\nBy allowing for the introduction of new brands, businesses can effectively segment their market, target distinct consumer demographics, and craft specialized marketing campaigns. This endpoint provides the foundation for building a diverse and robust brand portfolio, enabling companies to differentiate themselves in a crowded marketplace and to cultivate a distinctive brand identity that resonates with their target customers."},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"product_brand\": {\n \"id\": \"01htcy6rwpcjn56ys9p1f37ans\",\n \"name\": \"Asfour Crystal\",\n \"slug\": \"asfour-crystal\",\n \"description\": \"Utilizing the latest in technology to introduce its unlimited possibilities to transform dreams into impressive.\",\n \"reference_id\": \"3e88d728-b647-3b34-bebc-88807f8a2d0b\",\n \"is_active\": true,\n \"is_deleted\": false,\n \"products_count\": 0,\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2024-04-01 13:40:00\",\n \"updated_at\": \"2024-04-01 13:40:00\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"20f60b23-60d5-4c97-aa6b-f5164e2b6d00"},{"name":"Retrieve Brand","id":"04d99d69-bb10-4f93-ae91-2139841d971a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/product_brands/:id","description":"

The Payiano retrieve product brand endpoint is designed to fetch detailed information about a specific brand, enabling businesses to drill down into the characteristics and offerings of a particular brand in their portfolio. By having access to in-depth information about a brand, businesses can tailor their marketing strategies to highlight the unique selling points of each brand, thereby enhancing the effectiveness of their advertising and promotional efforts.

It supports operational excellence by enabling quick responses to customer inquiries and efficient product management. Whether it's providing customers with detailed information about a brand or assessing the brand's performance, this endpoint ensures that businesses have the necessary data at their fingertips. This facilitates informed decision-making, improves customer service, and helps maintain a competitive edge in the marketplace.

\n","type":"text/plain"},"key":"includes","value":"product_brand.metadata,product_brand.products_count"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"eae40dde-98a6-4fc6-8913-1eecd6cb6ca0","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/product_brands/:id","host":["https://api.payiano.dev"],"path":["v1","product_brands",":id"],"query":[{"value":"product_brand.metadata,product_brand.products_count","key":"includes","description":"A list of additional product brand relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The [Payiano](https://payiano.com) retrieve product brand endpoint is designed to fetch detailed information about a specific brand, enabling businesses to drill down into the characteristics and offerings of a particular brand in their portfolio. By having access to in-depth information about a brand, businesses can tailor their marketing strategies to highlight the unique selling points of each brand, thereby enhancing the effectiveness of their advertising and promotional efforts. \n\nIt supports operational excellence by enabling quick responses to customer inquiries and efficient product management. Whether it's providing customers with detailed information about a brand or assessing the brand's performance, this endpoint ensures that businesses have the necessary data at their fingertips. This facilitates informed decision-making, improves customer service, and helps maintain a competitive edge in the marketplace."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"product_brand\": {\n \"id\": \"01htcy6rwpcjn56ys9p1f37ans\",\n \"name\": \"Asfour Crystal\",\n \"slug\": \"asfour-crystal\",\n \"description\": \"Utilizing the latest in technology to introduce its unlimited possibilities to transform dreams into impressive.\",\n \"reference_id\": \"3e88d728-b647-3b34-bebc-88807f8a2d0b\",\n \"is_active\": true,\n \"is_deleted\": false,\n \"products_count\": 0,\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2024-04-01 13:40:00\",\n \"updated_at\": \"2024-04-01 13:40:00\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"04d99d69-bb10-4f93-ae91-2139841d971a"},{"name":"Update Brand","id":"73b89de5-49ec-468e-8995-c3d0712414b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/product_brands/:id","description":"

The Payiano update product brand endpoint is essential for maintaining the accuracy and relevancy of brand information within a business's catalog. As brands evolve—whether through changes in their product lines, target demographics, or brand positioning—this endpoint ensures that businesses can reflect these changes in their systems promptly. Updating brand information is key to ensuring consistency across marketing, sales, and customer service channels, enabling businesses to present a cohesive and current brand image to their customers.

This endpoint also plays a pivotal role in strategic brand management. By allowing businesses to modify brand details, it supports the repositioning of brands, alignment with new market trends, and refinement of target consumer segments. Such adaptability is indispensable for keeping pace with the dynamic nature of the marketplace, ensuring that businesses can effectively communicate the value and uniqueness of their brands to their target audience.

In the Payiano system, it's important to note a key operational rule regarding record updates. If a product brand record has been soft deleted, without being permanently removed from the database, any updates to this record are forbidden. This restriction ensures data integrity and consistency, as modifying a soft-deleted record could lead to confusion or inaccuracies in the system management.

To update a soft-deleted product brand, the record must first be restored. Restoration reverts the record's deleted status, making it once again eligible for updates and modifications. This policy is crucial for maintaining a clear and accurate representation of the product brand record, while still retaining the flexibility to recover and revise previously soft-deleted product brand as needed. By enforcing this rule, the Payiano system ensures a streamlined and coherent management process, balancing flexibility with control.

\n","type":"text/plain"},"key":"includes","value":"product_brand.metadata,product_brand.products_count"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"2ff2717f-796c-4066-8725-8efb366e720f","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/product_brands/:id","host":["https://api.payiano.dev"],"path":["v1","product_brands",":id"],"query":[{"value":"product_brand.metadata,product_brand.products_count","key":"includes","description":"A list of additional product brand relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The [Payiano](https://payiano.com) update product brand endpoint is essential for maintaining the accuracy and relevancy of brand information within a business's catalog. As brands evolve—whether through changes in their product lines, target demographics, or brand positioning—this endpoint ensures that businesses can reflect these changes in their systems promptly. Updating brand information is key to ensuring consistency across marketing, sales, and customer service channels, enabling businesses to present a cohesive and current brand image to their customers. \n\nThis endpoint also plays a pivotal role in strategic brand management. By allowing businesses to modify brand details, it supports the repositioning of brands, alignment with new market trends, and refinement of target consumer segments. Such adaptability is indispensable for keeping pace with the dynamic nature of the marketplace, ensuring that businesses can effectively communicate the value and uniqueness of their brands to their target audience. \n\nIn the [Payiano](https://payiano.com) system, it's important to note a key operational rule regarding record updates. If a product brand record has been soft deleted, without being permanently removed from the database, any updates to this record are **forbidden**. This restriction ensures data integrity and consistency, as modifying a soft-deleted record could lead to confusion or inaccuracies in the system management. \n\nTo update a soft-deleted product brand, the record must first be [restored](https://docs.payiano.com/api/rest/v1/company/store/brands/restore). Restoration reverts the record's deleted status, making it once again eligible for updates and modifications. This policy is crucial for maintaining a clear and accurate representation of the product brand record, while still retaining the flexibility to recover and revise previously soft-deleted product brand as needed. By enforcing this rule, the [Payiano](https://payiano.com) system ensures a streamlined and coherent management process, balancing flexibility with control."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"product_brand\": {\n \"id\": \"01htcy6rwpcjn56ys9p1f37ans\",\n \"name\": \"Asfour Crystal\",\n \"slug\": \"asfour-crystal\",\n \"description\": \"Utilizing the latest in technology to introduce its unlimited possibilities to transform dreams into impressive.\",\n \"reference_id\": \"3e88d728-b647-3b34-bebc-88807f8a2d0b\",\n \"is_active\": true,\n \"is_deleted\": false,\n \"products_count\": 0,\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2024-04-01 13:40:00\",\n \"updated_at\": \"2024-04-01 13:40:00\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"73b89de5-49ec-468e-8995-c3d0712414b9"},{"name":"Delete Brand","id":"31cfb7b6-5d7b-4aad-8a0d-83c961cd98f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/product_brands/:id","description":"

The Payiano delete product brand endpoint facilitates the removal of brands that no longer align with a business's strategic direction, product portfolio, or market presence. This capability is important for keeping the brand portfolio relevant and focused, ensuring that only those brands that contribute to the business's goals and meet customer needs are maintained. By allowing for the tidying of the brand catalog, businesses can avoid diluting their brand equity and can concentrate resources on nurturing and growing brands with the greatest potential for success.

This attribute determines the deletion method to be applied to the product brand delete in the database. When the value is set to true, it indicates that the product brand should be permanently and irreversibly removed from the database, commonly known as a Hard Delete. If the value is set to false, it implies a Soft Delete approach, where the product brand is not physically removed from the database. With Soft Delete it's still possible to restore the product brand record.

\n","type":"text/plain"},"key":"force_delete","value":"false"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"de4cba4d-5ece-4be6-a34e-4423239ccd86","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/product_brands/:id","host":["https://api.payiano.dev"],"path":["v1","product_brands",":id"],"query":[{"value":"false","key":"force_delete","description":"This attribute determines the deletion method to be applied to the product brand delete in the database. When the value is set to `true`, it indicates that the product brand should be permanently and irreversibly removed from the database, commonly known as a **Hard Delete**. If the value is set to `false`, it implies a **Soft Delete** approach, where the product brand is not physically removed from the database. With **Soft Delete** it's still possible to restore the product brand record.","disabled":true}],"variable":[{"key":"id"}]},"description":"The [Payiano](https://payiano.com) delete product brand endpoint facilitates the removal of brands that no longer align with a business's strategic direction, product portfolio, or market presence. This capability is important for keeping the brand portfolio relevant and focused, ensuring that only those brands that contribute to the business's goals and meet customer needs are maintained. By allowing for the tidying of the brand catalog, businesses can avoid diluting their brand equity and can concentrate resources on nurturing and growing brands with the greatest potential for success."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": true\n}"}],"_postman_id":"31cfb7b6-5d7b-4aad-8a0d-83c961cd98f8"},{"name":"Restore Brand","id":"9a406528-84b3-41c0-a174-6799aa47cb7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/product_brands/:id/restore","description":"

The Payiano restore product brand endpoint allows businesses to reinstate brands that were previously removed or archived, offering a strategic advantage in responding to changing market trends or consumer demands. This functionality is especially beneficial for quickly capitalizing on resurgence in popularity or re-introducing legacy brands to capture nostalgia-driven market segments. By enabling the restoration of brands, businesses can agilely adapt their product offerings without the need for starting from scratch, saving time and resources in the process.

This endpoint underscores a business's ability to manage its brand portfolio dynamically. It ensures that decisions to phase out brands are not final, providing a safety net that allows for strategic reversals. This flexibility is key in a fluctuating market, allowing companies to swiftly pivot their strategies and offerings in response to new opportunities or shifts in consumer preferences, thereby maintaining relevance and competitiveness.

\n","type":"text/plain"},"key":"includes","value":"product_brand.metadata,product_brand.products_count"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"0d8b4cd7-a53b-4064-82d9-ceb8fe8d907a","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/product_brands/:id/restore","host":["https://api.payiano.dev"],"path":["v1","product_brands",":id","restore"],"query":[{"value":"product_brand.metadata,product_brand.products_count","key":"includes","description":"A list of additional product brand relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The [Payiano](https://payiano.com) restore product brand endpoint allows businesses to reinstate brands that were previously removed or archived, offering a strategic advantage in responding to changing market trends or consumer demands. This functionality is especially beneficial for quickly capitalizing on resurgence in popularity or re-introducing legacy brands to capture nostalgia-driven market segments. By enabling the restoration of brands, businesses can agilely adapt their product offerings without the need for starting from scratch, saving time and resources in the process. \n\nThis endpoint underscores a business's ability to manage its brand portfolio dynamically. It ensures that decisions to phase out brands are not final, providing a safety net that allows for strategic reversals. This flexibility is key in a fluctuating market, allowing companies to swiftly pivot their strategies and offerings in response to new opportunities or shifts in consumer preferences, thereby maintaining relevance and competitiveness."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"product_brand\": {\n \"id\": \"01htcy6rwpcjn56ys9p1f37ans\",\n \"name\": \"Asfour Crystal\",\n \"slug\": \"asfour-crystal\",\n \"description\": \"Utilizing the latest in technology to introduce its unlimited possibilities to transform dreams into impressive.\",\n \"reference_id\": \"3e88d728-b647-3b34-bebc-88807f8a2d0b\",\n \"is_active\": true,\n \"is_deleted\": false,\n \"products_count\": 0,\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2024-04-01 13:40:00\",\n \"updated_at\": \"2024-04-01 13:40:00\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"9a406528-84b3-41c0-a174-6799aa47cb7a"}],"id":"158ff748-78cc-49f2-92de-ffe64835420a","_postman_id":"158ff748-78cc-49f2-92de-ffe64835420a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}}],"id":"2845bd6f-253a-4bc6-aa10-9643b9769a00","_postman_id":"2845bd6f-253a-4bc6-aa10-9643b9769a00","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}},{"name":"Request Logs","item":[{"name":"List Request Logs","id":"3f1c6185-6ead-4876-a172-0eb2599a35f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/request_logs","description":"

The Payiano's Request Log is an invaluable resource for businesses, serving as a window into the interactions between clients and the API. It offers a detailed account of how the API is used, including insights into user behaviors, request patterns, and system performance. This endpoint is instrumental in identifying trends, pinpointing areas for improvement, and ensuring optimal functionality of the API.

Overall, the Request Log is a critical tool for maintaining the health and efficiency of the API. It empowers businesses to make data-driven decisions, improve integration capabilities, and ultimately contributes significantly to the success and growth of the organization.

By analyzing the data collected through this endpoint, businesses can gain a deeper understanding of their user base, including how and when the API is accessed most frequently. This information is key to optimizing the user experience, enhancing system performance, and ensuring the API's stability and scalability. Furthermore, the log plays a crucial role in security and compliance, offering the ability to track and analyze access patterns, detect anomalies, and respond promptly to potential threats or breaches.

The page number to be retrieved, for the list of request logs. So, a combination of page=1 and per_page=25 returns the first 25 request logs. A combination of page=2 and per_page=25 returns the next 25 request logs.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of request logs to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of request logs, you can specify a particular column as a reference point for organizing the items in a specific order.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

This refers to the way by which you would like to sort or order the results. When retrieving a list of request logs, you can specify a particular way for organizing the items in a specific order, such as ascending or descending.

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

An easy and effective free search text to search request logs. Please provide a minimum of 3 characters for each search item. This ensures that your search query is specific enough to yield relevant results.

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"94529800-95b9-41bc-9556-972bca769d7e","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/request_logs","host":["https://api.payiano.dev"],"path":["v1","request_logs"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of request logs. So, a combination of `page=1` and `per_page=25` returns the first 25 request logs. A combination of `page=2` and `per_page=25` returns the next 25 request logs.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of request logs to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of request logs, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of request logs, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search request logs. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true}]},"description":"The [Payiano](https://payiano.com)'s Request Log is an invaluable resource for businesses, serving as a window into the interactions between clients and the API. It offers a detailed account of how the API is used, including insights into user behaviors, request patterns, and system performance. This endpoint is instrumental in identifying trends, pinpointing areas for improvement, and ensuring optimal functionality of the API. \n\nOverall, the Request Log is a critical tool for maintaining the health and efficiency of the API. It empowers businesses to make data-driven decisions, improve integration capabilities, and ultimately contributes significantly to the success and growth of the organization. \n\nBy analyzing the data collected through this endpoint, businesses can gain a deeper understanding of their user base, including how and when the API is accessed most frequently. This information is key to optimizing the user experience, enhancing system performance, and ensuring the API's stability and scalability. Furthermore, the log plays a crucial role in security and compliance, offering the ability to track and analyze access patterns, detect anomalies, and respond promptly to potential threats or breaches."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"path\": \"v1/customers\",\n \"method\": \"POST\",\n \"origin\": \"my.payiano.com\",\n \"response_time\": 1,\n \"client_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36\",\n \"client_ip\": \"199.36.158.100\",\n \"request_query\": {\n \"includes\": [\n \"customer.billding_address\"\n ]\n },\n \"request_body\": {\n \"name\": \"Yara Kamal\",\n \"email\": \"yara@graply.com\",\n \"reference_id\": \"db64355a-8e8d-31e8-a782-2dce8057fe61\"\n },\n \"request_headers\": {\n \"host\": [\n \"api.payiano.com\"\n ],\n \"accept\": [\n \"application/json\"\n ],\n \"authorization\": \"Bearer eyJpdiI***********ZRcGQUG4\",\n \"user-agent\": [\n \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36\"\n ]\n },\n \"response_code\": 422,\n \"response_body\": {\n \"message\": \"The reference id has already been taken.\",\n \"errors\": {\n \"reference_id\": [\n \"The reference id has already been taken.\"\n ]\n }\n },\n \"response_headers\": {\n \"cache-control\": [\n \"no-cache, private\"\n ],\n \"date\": [\n \"Mon, 29 Jan 2024 07:22:21 GMT\"\n ],\n \"content-type\": [\n \"application/json\"\n ]\n },\n \"requested_at\": \"2024-01-07 19:40:05\",\n \"created_at\": \"2024-01-07 19:40:05\",\n \"updated_at\": \"2024-01-07 19:40:05\"\n }\n ]\n}"}],"_postman_id":"3f1c6185-6ead-4876-a172-0eb2599a35f1"},{"name":"Retrieve Request Log","id":"334cf005-a9f4-46e8-b53a-f733b4b2fb8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/request_logs/:id","description":"

If you're a developer working on integrating with Payiano's, the Request Log endpoint can be a really handy tool. Whether you're setting up a new integration or updating an existing one, this endpoint lets you check out all the details of the requests your application is sending to Payiano's. It's great for confirming the data you're sending in your POST or PUT requests and for looking over the query parameters in your GET requests. Plus, once your integration is up and running, the Request Log is there to help you keep an eye on things. You can easily search for any errors (like those with Response Codes of 400 or higher) or hunt down specific requests to make sure Payiano's got them.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}},"urlObject":{"path":["v1","request_logs",":id"],"host":["https://api.payiano.dev"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"01e4299c-e8d0-485b-970c-81972743c745","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/request_logs/:id","host":["https://api.payiano.dev"],"path":["v1","request_logs",":id"],"variable":[{"key":"id"}]},"description":"If you're a developer working on integrating with [Payiano](https://payiano.com)'s, the Request Log endpoint can be a really handy tool. Whether you're setting up a new integration or updating an existing one, this endpoint lets you check out all the details of the requests your application is sending to [Payiano](https://payiano.com)'s. It's great for confirming the data you're sending in your `POST` or `PUT` requests and for looking over the query parameters in your `GET` requests. Plus, once your integration is up and running, the Request Log is there to help you keep an eye on things. You can easily search for any errors (like those with Response Codes of `400` or higher) or hunt down specific requests to make sure [Payiano](https://payiano.com)'s got them."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"request_log\": {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"path\": \"v1/customers\",\n \"method\": \"POST\",\n \"origin\": \"my.payiano.com\",\n \"response_time\": 1,\n \"client_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36\",\n \"client_ip\": \"199.36.158.100\",\n \"request_query\": {\n \"includes\": [\n \"customer.billding_address\"\n ]\n },\n \"request_body\": {\n \"name\": \"Yara Kamal\",\n \"email\": \"yara@graply.com\",\n \"reference_id\": \"db64355a-8e8d-31e8-a782-2dce8057fe61\"\n },\n \"request_headers\": {\n \"host\": [\n \"api.payiano.com\"\n ],\n \"accept\": [\n \"application/json\"\n ],\n \"authorization\": \"Bearer eyJpdiI***********ZRcGQUG4\",\n \"user-agent\": [\n \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36\"\n ]\n },\n \"response_code\": 422,\n \"response_body\": {\n \"message\": \"The reference id has already been taken.\",\n \"errors\": {\n \"reference_id\": [\n \"The reference id has already been taken.\"\n ]\n }\n },\n \"response_headers\": {\n \"cache-control\": [\n \"no-cache, private\"\n ],\n \"date\": [\n \"Mon, 29 Jan 2024 07:22:21 GMT\"\n ],\n \"content-type\": [\n \"application/json\"\n ]\n },\n \"requested_at\": \"2024-01-07 19:40:05\",\n \"created_at\": \"2024-01-07 19:40:05\",\n \"updated_at\": \"2024-01-07 19:40:05\"\n }\n}"}],"_postman_id":"334cf005-a9f4-46e8-b53a-f733b4b2fb8e"}],"id":"c7c3344a-7f8b-4987-a485-c9b3b2c864e8","_postman_id":"c7c3344a-7f8b-4987-a485-c9b3b2c864e8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}},{"name":"Taxes","item":[{"name":"List Taxes","id":"b710145f-f536-4955-af3f-8cb019d498fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/taxes","description":"

Payiano helps you manage taxes efficiently. You can set up various taxes and use them for subscriptions, and one-time payments through Checkout. But remember, Payiano won't automatically create these taxes for you. When you use taxes, Payiano calculates the total tax for each rate and provides a summary table. This can be exported for tax reports. It's important to create a catalog of taxes that comply with the tax laws of the country where your business operates.

Understanding these nuances in tax management is crucial for accurate financial planning and compliance with tax laws in different countries. Payiano's flexibility in handling both manual and automated Tax Calculations, along with its Dashboard and API capabilities, makes it a versatile tool for businesses navigating complex tax environments.

The page number to be retrieved, for the list of taxes. So, a combination of page=1 and per_page=25 returns the first 25 taxes. A combination of page=2 and per_page=25 returns the next 25 taxes.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The maximum number of taxes to return in the response.

\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"

This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of taxes, you can specify a particular column as a reference point for organizing the items in a specific order.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

This refers to the way by which you would like to sort or order the results. When retrieving a list of taxes, you can specify a particular way for organizing the items in a specific order, such as ascending or descending.

\n","type":"text/plain"},"key":"order","value":"ASC,DESC"},{"disabled":true,"description":{"content":"

An easy and effective free search text to search taxes. Please provide a minimum of 3 characters for each search item. This ensures that your search query is specific enough to yield relevant results.

\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"

A list of additional tax relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"tax.metadata"}],"variable":[]}},"response":[{"id":"66e61d93-f764-430b-9ac3-6ae91fbbf022","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/taxes","host":["https://api.payiano.dev"],"path":["v1","taxes"],"query":[{"value":"1","key":"page","description":"The page number to be retrieved, for the list of taxes. So, a combination of `page=1` and `per_page=25` returns the first 25 taxes. A combination of `page=2` and `per_page=25` returns the next 25 taxes.","disabled":true},{"value":"25","key":"per_page","description":"The maximum number of taxes to return in the response.","disabled":true},{"value":"","key":"order_by","description":"This refers to the column or attribute by which you would like to sort or order the results. When retrieving a list of taxes, you can specify a particular column as a reference point for organizing the items in a specific order.","disabled":true},{"value":"ASC,DESC","key":"order","description":"This refers to the way by which you would like to sort or order the results. When retrieving a list of taxes, you can specify a particular way for organizing the items in a specific order, such as `ascending` or `descending`.","disabled":true},{"value":"","key":"q","description":"An easy and effective free search text to search taxes. Please provide a minimum of `3` characters for each search item. This ensures that your search query is specific enough to yield relevant results.","disabled":true},{"value":"tax.metadata","key":"includes","description":"A list of additional tax relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"[Payiano](https://payiano.com) helps you manage taxes efficiently. You can set up various taxes and use them for subscriptions, and one-time payments through Checkout. But remember, [Payiano](https://payiano.com) won't automatically create these taxes for you. When you use taxes, [Payiano](https://payiano.com) calculates the total tax for each rate and provides a summary table. This can be exported for tax reports. It's important to create a catalog of taxes that comply with the tax laws of the country where your business operates. \n\nUnderstanding these nuances in tax management is crucial for accurate financial planning and compliance with tax laws in different countries. [Payiano](https://payiano.com)'s flexibility in handling both manual and automated [Tax Calculations](https://docs.payiano.com/api/rest/company/tax-calculations), along with its Dashboard and API capabilities, makes it a versatile tool for businesses navigating complex tax environments."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_items\": 1,\n \"current_page\": 1,\n \"items\": [\n {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"name\": \"Value added tax\",\n \"value\": 14,\n \"value_type\": \"PERCENTAGE\",\n \"type\": \"VAT\",\n \"strategy\": \"EXCLUSIVE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"b438800f-9e32-36a1-aee8-725aca982cc7\",\n \"is_active\": true,\n \"description\": \"The value added tax\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-24 18:02:40\",\n \"updated_at\": \"2023-12-24 18:02:40\"\n }\n ]\n}"}],"_postman_id":"b710145f-f536-4955-af3f-8cb019d498fb"},{"name":"Create Tax","id":"31caef9f-0e14-4f42-87a2-c1802f82152c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/taxes","description":"

If you have a few taxes, it's easy to create and manage them in the Payiano Dashboard or thorugh the API. These Taxes can then be applied to various transactions in Payiano Payment Links, Invoices and Orders. Here, you can create and apply these taxes to your business transactions. It's important to create a catalog of taxes that comply with the tax laws of the country where your business operates.

\n
Note that once set, you can't change the value, value_type, type, strategy, or country_code properties. To update these, you'll need to create a new tax and archive the old one.
\n

A list of additional tax relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"tax.metadata"}],"variable":[]}},"response":[{"id":"99b14966-1ff6-43b4-b74c-8d6263d95683","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/taxes","host":["https://api.payiano.dev"],"path":["v1","taxes"],"query":[{"value":"tax.metadata","key":"includes","description":"A list of additional tax relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}]},"description":"If you have a few taxes, it's easy to create and manage them in the [Payiano](https://payiano.com) Dashboard or thorugh the API. These Taxes can then be applied to various transactions in [Payiano](https://payiano.com) Payment Links, Invoices and Orders. Here, you can create and apply these taxes to your business transactions. It's important to create a catalog of taxes that comply with the tax laws of the country where your business operates. \n\n> Note that once set, you can't change the `value`, `value_type`, `type`, `strategy`, or `country_code` properties. To update these, you'll need to create a new tax and archive the old one."},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"tax\": {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"name\": \"Value added tax\",\n \"value\": 14,\n \"value_type\": \"PERCENTAGE\",\n \"type\": \"VAT\",\n \"strategy\": \"EXCLUSIVE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"b438800f-9e32-36a1-aee8-725aca982cc7\",\n \"is_active\": true,\n \"description\": \"The value added tax\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-24 18:02:40\",\n \"updated_at\": \"2023-12-24 18:02:40\"\n }\n}"}],"_postman_id":"31caef9f-0e14-4f42-87a2-c1802f82152c"},{"name":"Retrieve Tax","id":"e9303c15-1c6a-4f66-9574-2d960e2f220d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/taxes/:id","description":"

When you use Payiano to look at the details of a tax, you're getting a lot more than just basic facts. You're diving into a wealth of important information that's really helpful for running your business well. This includes the name of the tax, what type it is, how it's used, a detailed description, and which country it applies to, along with other essential details. Having this complete and precise information is crucial because it improves many parts of your business.

This detailed tax information along with the Tax Calculations are keys to making sure your financial tax reports are smooth and accurate. It helps avoid mistakes that can happen if you use wrong or old tax data, keeping your financial processes reliable and trustworthy. Plus, it makes the job of your tax service team a lot easier. They can quickly get all the detailed tax information they need, which makes their work more efficient.

A list of additional tax relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"tax.metadata"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"bd4fddea-99b2-495f-ad9d-6bb85d605463","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/taxes/:id","host":["https://api.payiano.dev"],"path":["v1","taxes",":id"],"query":[{"value":"tax.metadata","key":"includes","description":"A list of additional tax relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"When you use [Payiano](https://payiano.com) to look at the details of a tax, you're getting a lot more than just basic facts. You're diving into a wealth of important information that's really helpful for running your business well. This includes the name of the tax, what type it is, how it's used, a detailed description, and which country it applies to, along with other essential details. Having this complete and precise information is crucial because it improves many parts of your business. \n\nThis detailed tax information along with the [Tax Calculations](https://docs.payiano.com/api/rest/company/tax-calculations) are keys to making sure your financial tax reports are smooth and accurate. It helps avoid mistakes that can happen if you use wrong or old tax data, keeping your financial processes reliable and trustworthy. Plus, it makes the job of your tax service team a lot easier. They can quickly get all the detailed tax information they need, which makes their work more efficient."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"tax\": {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"name\": \"Value added tax\",\n \"value\": 14,\n \"value_type\": \"PERCENTAGE\",\n \"type\": \"VAT\",\n \"strategy\": \"EXCLUSIVE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"b438800f-9e32-36a1-aee8-725aca982cc7\",\n \"is_active\": true,\n \"description\": \"The value added tax\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-24 18:02:40\",\n \"updated_at\": \"2023-12-24 18:02:40\"\n }\n}"}],"_postman_id":"e9303c15-1c6a-4f66-9574-2d960e2f220d"},{"name":"Update Tax","id":"1fafd03d-ad10-4cdb-aa03-f5693bce64f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"

The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support application/json.

\n"}],"url":"https://api.payiano.dev/v1/taxes/:id","description":"

The Payiano update tax endpoint is a critical tool for maintaining the integrity and relevance of tax data within our system. It enables businesses to make precise adjustments to tax records, ensuring that the information remains current and reflective of any changes in tax legislation, company policies, or operational needs. This functionality is essential for businesses that need to adapt quickly to changing tax environments, whether due to regulatory updates, shifts in business strategy, or modifications to tax applicability and rates.

The ability to update tax information seamlessly helps in preventing discrepancies, reducing the risk of compliance issues, and fostering trust and clarity in financial transactions with customers. This endpoint not only facilitates the operational flexibility required for efficient tax management but also supports the accuracy and reliability of the financial data, which are paramount for businesses operating in multiple jurisdictions with varying tax requirements.

A list of additional tax relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

\n","type":"text/plain"},"key":"includes","value":"tax.metadata"}],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"f8dc724b-d53a-41da-9797-1b734926048a","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text","description":"The Content-Type header field is used to specify the nature of the data in the body. Payiano REST APIs support `application/json`."}],"url":{"raw":"https://api.payiano.dev/v1/taxes/:id","host":["https://api.payiano.dev"],"path":["v1","taxes",":id"],"query":[{"value":"tax.metadata","key":"includes","description":"A list of additional tax relations to return, if available. Feel free to send the relations you would like to return with every item. See [Including Resources](https://docs.payiano.com/api/rest/including-resources) to better understand how this is working.","disabled":true}],"variable":[{"key":"id"}]},"description":"The [Payiano](https://payiano.com) update tax endpoint is a critical tool for maintaining the integrity and relevance of tax data within our system. It enables businesses to make precise adjustments to tax records, ensuring that the information remains current and reflective of any changes in tax legislation, company policies, or operational needs. This functionality is essential for businesses that need to adapt quickly to changing tax environments, whether due to regulatory updates, shifts in business strategy, or modifications to tax applicability and rates. \n\nThe ability to update tax information seamlessly helps in preventing discrepancies, reducing the risk of compliance issues, and fostering trust and clarity in financial transactions with customers. This endpoint not only facilitates the operational flexibility required for efficient tax management but also supports the accuracy and reliability of the financial data, which are paramount for businesses operating in multiple jurisdictions with varying tax requirements."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"tax\": {\n \"id\": \"01hqh45s7826hfwdze8dp1z21f\",\n \"name\": \"Value added tax\",\n \"value\": 14,\n \"value_type\": \"PERCENTAGE\",\n \"type\": \"VAT\",\n \"strategy\": \"EXCLUSIVE\",\n \"country_code\": \"EG\",\n \"reference_id\": \"b438800f-9e32-36a1-aee8-725aca982cc7\",\n \"is_active\": true,\n \"description\": \"The value added tax\",\n \"metadata\": {\n \"info\": [\n {\n \"key\": \"Company name\",\n \"value\": \"Graply\"\n }\n ],\n \"list\": [\n \"Cairo, Nasr City, 7th District, Building 12 floor 5\"\n ]\n },\n \"created_at\": \"2023-12-24 18:02:40\",\n \"updated_at\": \"2023-12-24 18:02:40\"\n }\n}"}],"_postman_id":"1fafd03d-ad10-4cdb-aa03-f5693bce64f5"}],"id":"2719330e-be56-4753-a7c9-33b1702a5590","_postman_id":"2719330e-be56-4753-a7c9-33b1702a5590","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"83ea0f4a-7d43-4a44-879d-194df727a81e","id":"83ea0f4a-7d43-4a44-879d-194df727a81e","name":"Payiano Business APIs","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"fb63b469-b7ec-4b65-ba45-b2e3274bc8c1","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"654c3cae-de5c-44b9-b653-8b10a5d97adc","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"base_url","value":"https://api.payiano.dev"},{"key":"access_token","value":""}]}