diff --git a/SumUpAPICollection.json b/SumUpAPICollection.json index 5249a17..23a7851 100644 --- a/SumUpAPICollection.json +++ b/SumUpAPICollection.json @@ -5,12 +5,12 @@ "description": "Checkouts represent online payment sessions that you create before attempting to charge a payer. A checkout captures the payment intent, such as the amount, currency, merchant, and optional customer or redirect settings, and then moves through its lifecycle as you process it.\n\nUse this tag to:\n- create a checkout before collecting or confirming payment details\n- process the checkout with a card, saved card, wallet, or supported alternative payment method\n- retrieve or list checkouts to inspect their current state and associated payment attempts\n- deactivate a checkout that should no longer be used\n\nTypical workflow:\n- create a checkout with the order amount, currency, and merchant information\n- process the checkout through SumUp client tools such as the [Payment Widget and Swift Checkout SDK](https://developer.sumup.com/online-payments/checkouts)\n- retrieve the checkout or use the Transactions endpoints to inspect the resulting payment record\n\nCheckouts are used to initiate and orchestrate online payments. Transactions remain the authoritative record of the resulting payment outcome.", "item": [ { - "id": "5715b2e7-b79d-46bb-9010-d15145fb2b2c", + "id": "9bd0aff4-5281-4493-b638-d4586d4602ab", "name": "Get available payment methods", "request": { "name": "Get available payment methods", "description": { - "content": "Get payment methods available for the given merchant to use with a checkout.", + "content": "Lists the payment methods available to the merchant for checkout payments. Use the optional amount and currency filters to check eligibility for a particular payment before presenting payment options to the payer.", "type": "text/plain" }, "url": { @@ -27,7 +27,7 @@ { "disabled": false, "description": { - "content": "The amount for which the payment methods should be eligible, in major units.", + "content": "Payment amount in major units, for example `9.99` for EUR 9.99. When filtering by `amount`, also provide `currency`.", "type": "text/plain" }, "key": "amount", @@ -36,7 +36,7 @@ { "disabled": false, "description": { - "content": "The currency for which the payment methods should be eligible.", + "content": "Three-letter ISO 4217 currency code for which the payment methods should be eligible, for example `EUR`.", "type": "text/plain" }, "key": "currency", @@ -76,7 +76,7 @@ }, "response": [ { - "id": "21ca2ca5-b33c-42fb-9f7f-e5c9ca767470", + "id": "6c6b1f3a-7a85-41ed-a304-bdf2f0ba924a", "name": "Available payment methods", "originalRequest": { "url": { @@ -93,7 +93,7 @@ { "disabled": false, "description": { - "content": "The amount for which the payment methods should be eligible, in major units.", + "content": "Payment amount in major units, for example `9.99` for EUR 9.99. When filtering by `amount`, also provide `currency`.", "type": "text/plain" }, "key": "amount", @@ -102,7 +102,7 @@ { "disabled": false, "description": { - "content": "The currency for which the payment methods should be eligible.", + "content": "Three-letter ISO 4217 currency code for which the payment methods should be eligible, for example `EUR`.", "type": "text/plain" }, "key": "currency", @@ -144,7 +144,7 @@ "_postman_previewlanguage": "json" }, { - "id": "503ac9fe-ab17-4546-93af-bc32121befa2", + "id": "5012ce38-b025-41df-ab20-6bab482d5021", "name": "The request is invalid for the submitted query parameters.", "originalRequest": { "url": { @@ -161,7 +161,7 @@ { "disabled": false, "description": { - "content": "The amount for which the payment methods should be eligible, in major units.", + "content": "Payment amount in major units, for example `9.99` for EUR 9.99. When filtering by `amount`, also provide `currency`.", "type": "text/plain" }, "key": "amount", @@ -170,7 +170,7 @@ { "disabled": false, "description": { - "content": "The currency for which the payment methods should be eligible.", + "content": "Three-letter ISO 4217 currency code for which the payment methods should be eligible, for example `EUR`.", "type": "text/plain" }, "key": "currency", @@ -218,7 +218,7 @@ } }, { - "id": "c97ea330-5acb-4ac3-910e-943878d310f2", + "id": "720ddda0-32a9-408a-ae70-8a78fdaf1f8d", "name": "Create a checkout", "request": { "name": "Create a checkout", @@ -250,7 +250,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"customer_id\": \"\",\n \"purpose\": \"CHECKOUT\",\n \"valid_until\": \"\",\n \"redirect_url\": \"\",\n \"hosted_checkout\": {\n \"enabled\": \"\"\n }\n}", + "raw": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"NOK\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"customer_id\": \"\",\n \"purpose\": \"CHECKOUT\",\n \"valid_until\": \"\",\n \"redirect_url\": \"\",\n \"hosted_checkout\": {\n \"enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -270,7 +270,7 @@ }, "response": [ { - "id": "1218e5a3-6b65-4689-ac9f-1e80e53e3522", + "id": "7975aee1-db5d-423b-a27f-c6327f12e531", "name": "Returns the created checkout resource.", "originalRequest": { "url": { @@ -297,7 +297,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"customer_id\": \"\",\n \"purpose\": \"CHECKOUT\",\n \"valid_until\": \"\",\n \"redirect_url\": \"\",\n \"hosted_checkout\": {\n \"enabled\": \"\"\n }\n}", + "raw": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"NOK\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"customer_id\": \"\",\n \"purpose\": \"CHECKOUT\",\n \"valid_until\": \"\",\n \"redirect_url\": \"\",\n \"hosted_checkout\": {\n \"enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -314,12 +314,12 @@ "value": "application/json" } ], - "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"PENDING\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"CZK\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"CASH\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"MANUAL_ENTRY\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"CZK\",\n \"timestamp\": \"\",\n \"status\": \"CANCELLED\",\n \"payment_type\": \"BOLETO\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"MANUAL_ENTRY\",\n \"auth_code\": \"\"\n }\n ]\n}", + "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"CHF\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"PENDING\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"HRK\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"UNKNOWN\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"CONTACTLESS\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"RON\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"UNKNOWN\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"MANUAL_ENTRY\",\n \"auth_code\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3d8e85b3-238a-4d31-bbea-c97bcbbefa54", + "id": "ef6d7245-4b55-44f5-ab1e-daeb2538b8c9", "name": "The request body is invalid.", "originalRequest": { "url": { @@ -346,7 +346,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"customer_id\": \"\",\n \"purpose\": \"CHECKOUT\",\n \"valid_until\": \"\",\n \"redirect_url\": \"\",\n \"hosted_checkout\": {\n \"enabled\": \"\"\n }\n}", + "raw": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"NOK\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"customer_id\": \"\",\n \"purpose\": \"CHECKOUT\",\n \"valid_until\": \"\",\n \"redirect_url\": \"\",\n \"hosted_checkout\": {\n \"enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -368,7 +368,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e1348f14-4b01-4445-b02a-11ed3d792104", + "id": "24282baa-62fc-45f1-be92-1d840cd537a4", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -395,7 +395,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"customer_id\": \"\",\n \"purpose\": \"CHECKOUT\",\n \"valid_until\": \"\",\n \"redirect_url\": \"\",\n \"hosted_checkout\": {\n \"enabled\": \"\"\n }\n}", + "raw": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"NOK\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"customer_id\": \"\",\n \"purpose\": \"CHECKOUT\",\n \"valid_until\": \"\",\n \"redirect_url\": \"\",\n \"hosted_checkout\": {\n \"enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -417,7 +417,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6b96e69d-d595-43db-b97d-68f4ee74086a", + "id": "675a0b3f-f59a-421e-abf2-e4312777b48c", "name": "The request isn't sufficiently authorized to create a checkout.", "originalRequest": { "url": { @@ -444,7 +444,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"customer_id\": \"\",\n \"purpose\": \"CHECKOUT\",\n \"valid_until\": \"\",\n \"redirect_url\": \"\",\n \"hosted_checkout\": {\n \"enabled\": \"\"\n }\n}", + "raw": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"NOK\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"customer_id\": \"\",\n \"purpose\": \"CHECKOUT\",\n \"valid_until\": \"\",\n \"redirect_url\": \"\",\n \"hosted_checkout\": {\n \"enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -466,7 +466,7 @@ "_postman_previewlanguage": "json" }, { - "id": "821a7b0c-110d-4e60-9913-28e6069effd1", + "id": "60495034-3286-499f-bfc2-47ced1b79818", "name": "A checkout already exists for the provided unique parameters.", "originalRequest": { "url": { @@ -493,7 +493,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"customer_id\": \"\",\n \"purpose\": \"CHECKOUT\",\n \"valid_until\": \"\",\n \"redirect_url\": \"\",\n \"hosted_checkout\": {\n \"enabled\": \"\"\n }\n}", + "raw": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"NOK\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"customer_id\": \"\",\n \"purpose\": \"CHECKOUT\",\n \"valid_until\": \"\",\n \"redirect_url\": \"\",\n \"hosted_checkout\": {\n \"enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -521,7 +521,7 @@ } }, { - "id": "e625ccae-8c29-4fb0-a413-b0a81b188e0c", + "id": "83c8b407-ca57-44bb-95a1-ea8d55831462", "name": "List checkouts", "request": { "name": "List checkouts", @@ -541,7 +541,7 @@ { "disabled": false, "description": { - "content": "Filters the list of checkout resources by the unique reference of the checkout.", + "content": "Filters checkouts by the merchant-defined `checkout_reference` supplied when creating the checkout. This is separate from the SumUp-generated checkout `id`.", "type": "text/plain" }, "key": "checkout_reference", @@ -570,7 +570,7 @@ }, "response": [ { - "id": "c74d0467-af1a-43af-adaf-3650c5f20137", + "id": "35fbebf3-d1d0-477e-85f0-2bf29e1892ce", "name": "Returns a list of checkout resources.", "originalRequest": { "url": { @@ -585,7 +585,7 @@ { "disabled": false, "description": { - "content": "Filters the list of checkout resources by the unique reference of the checkout.", + "content": "Filters checkouts by the merchant-defined `checkout_reference` supplied when creating the checkout. This is separate from the SumUp-generated checkout `id`.", "type": "text/plain" }, "key": "checkout_reference", @@ -611,12 +611,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"CHF\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"PENDING\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"NOK\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"MOTO\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"BANCONTACT\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"PLN\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"POS\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"CUSTOMER_ENTRY\",\n \"auth_code\": \"\"\n }\n ],\n \"transaction_code\": \"\",\n \"transaction_id\": \"\",\n \"merchant_name\": \"\",\n \"redirect_url\": \"\",\n \"payment_instrument\": {\n \"token\": \"\"\n }\n },\n {\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"GBP\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"PENDING\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"inactive\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"EUR\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"MOTO\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"BANCONTACT\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"RON\",\n \"timestamp\": \"\",\n \"status\": \"CANCELLED\",\n \"payment_type\": \"BOLETO\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"N/A\",\n \"auth_code\": \"\"\n }\n ],\n \"transaction_code\": \"\",\n \"transaction_id\": \"\",\n \"merchant_name\": \"\",\n \"redirect_url\": \"\",\n \"payment_instrument\": {\n \"token\": \"\"\n }\n }\n]", + "body": "[\n {\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"PLN\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"PAID\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"BRL\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"UNKNOWN\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"CONTACTLESS_MAGSTRIPE\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"PLN\",\n \"timestamp\": \"\",\n \"status\": \"CANCELLED\",\n \"payment_type\": \"APM\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"CUSTOMER_ENTRY\",\n \"auth_code\": \"\"\n }\n ],\n \"transaction_code\": \"\",\n \"transaction_id\": \"\",\n \"merchant_name\": \"\",\n \"redirect_url\": \"\",\n \"payment_instrument\": {\n \"token\": \"\"\n }\n },\n {\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"BRL\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"FAILED\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"HUF\",\n \"timestamp\": \"\",\n \"status\": \"SUCCESSFUL\",\n \"payment_type\": \"MOTO\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"EPS\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"CZK\",\n \"timestamp\": \"\",\n \"status\": \"SUCCESSFUL\",\n \"payment_type\": \"MOTO\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"IDEAL\",\n \"auth_code\": \"\"\n }\n ],\n \"transaction_code\": \"\",\n \"transaction_id\": \"\",\n \"merchant_name\": \"\",\n \"redirect_url\": \"\",\n \"payment_instrument\": {\n \"token\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0d36a673-116a-47e3-adc6-38579a4f96c6", + "id": "492fe551-862a-4f01-b1c4-b26a31949b58", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -631,7 +631,7 @@ { "disabled": false, "description": { - "content": "Filters the list of checkout resources by the unique reference of the checkout.", + "content": "Filters checkouts by the merchant-defined `checkout_reference` supplied when creating the checkout. This is separate from the SumUp-generated checkout `id`.", "type": "text/plain" }, "key": "checkout_reference", @@ -668,12 +668,12 @@ } }, { - "id": "72861399-96c9-47e9-8704-565e9bd1b7e1", + "id": "3991dc76-8d1f-4168-8b37-e972f5a5e769", "name": "Retrieve a checkout", "request": { "name": "Retrieve a checkout", "description": { - "content": "Retrieves an identified checkout resource. Use this request after processing a checkout to confirm its status and inform the end user respectively.", + "content": "Retrieves a checkout by its SumUp `checkout_id`. After processing a payment, returning from a redirect, or receiving a checkout notification, retrieve the checkout to confirm its current `status` before updating your order or displaying the payment outcome to the payer.", "type": "text/plain" }, "url": { @@ -693,7 +693,7 @@ "key": "checkout_id", "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" } } @@ -719,7 +719,7 @@ }, "response": [ { - "id": "9759e884-687c-4a53-9e1f-112d7968201c", + "id": "6b89a3d6-b810-42b6-a892-4b87eeeb0e69", "name": "Returns the requested checkout resource.", "originalRequest": { "url": { @@ -736,7 +736,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -762,12 +762,12 @@ "value": "application/json" } ], - "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"CLP\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"FAILED\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"BRL\",\n \"timestamp\": \"\",\n \"status\": \"CANCELLED\",\n \"payment_type\": \"ECOM\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"QR_CODE_PIX\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"HUF\",\n \"timestamp\": \"\",\n \"status\": \"CANCELLED\",\n \"payment_type\": \"POS\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"NONE\",\n \"auth_code\": \"\"\n }\n ],\n \"transaction_code\": \"\",\n \"transaction_id\": \"\",\n \"merchant_name\": \"\",\n \"redirect_url\": \"\",\n \"payment_instrument\": {\n \"token\": \"\"\n }\n}", + "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"NOK\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"PENDING\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"APM\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"N/A\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"HRK\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"BALANCE\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"TWINT\",\n \"auth_code\": \"\"\n }\n ],\n \"transaction_code\": \"\",\n \"transaction_id\": \"\",\n \"merchant_name\": \"\",\n \"redirect_url\": \"\",\n \"payment_instrument\": {\n \"token\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "846e7bcc-d44c-451d-9b4a-eb509a1a2da6", + "id": "dc438a20-2405-4a4b-9a0a-433c7d65f9f8", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -784,7 +784,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -815,7 +815,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4361850f-c313-4dbb-b52f-a66d0e02da81", + "id": "2133a86a-caea-49b3-bf09-1bc8aa205fb8", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -832,7 +832,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -869,7 +869,7 @@ } }, { - "id": "04c1b2d8-011e-49ab-971e-e5b3a63a35da", + "id": "fa4cb965-6482-499a-8d65-8f6500a07af1", "name": "Update a checkout", "request": { "name": "Update a checkout", @@ -894,7 +894,7 @@ "key": "checkout_id", "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" } } @@ -913,7 +913,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"currency\": \"SEK\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", + "raw": "{\n \"amount\": \"\",\n \"currency\": \"BRL\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -933,7 +933,7 @@ }, "response": [ { - "id": "19a73032-eaf3-422b-a82c-e45ce189672d", + "id": "13577d77-2131-4014-b763-beb665e26618", "name": "Returns the updated checkout resource.", "originalRequest": { "url": { @@ -950,7 +950,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -972,7 +972,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"currency\": \"SEK\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", + "raw": "{\n \"amount\": \"\",\n \"currency\": \"BRL\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -989,12 +989,12 @@ "value": "application/json" } ], - "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"PENDING\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"CZK\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"CASH\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"MANUAL_ENTRY\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"CZK\",\n \"timestamp\": \"\",\n \"status\": \"CANCELLED\",\n \"payment_type\": \"BOLETO\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"MANUAL_ENTRY\",\n \"auth_code\": \"\"\n }\n ]\n}", + "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"CHF\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"PENDING\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"HRK\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"UNKNOWN\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"CONTACTLESS\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"RON\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"UNKNOWN\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"MANUAL_ENTRY\",\n \"auth_code\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d7e69af0-4d8a-40f3-a6df-27fccbe72677", + "id": "9a5c9b6a-c0fc-476a-b8d6-07facf6ec3f5", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -1011,7 +1011,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1033,7 +1033,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"currency\": \"SEK\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", + "raw": "{\n \"amount\": \"\",\n \"currency\": \"BRL\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -1055,7 +1055,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fa95c5f3-99bb-4b30-95e5-6d9ed1b8bc6e", + "id": "98718e83-959b-41f9-af61-86bb70a2db9c", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -1072,7 +1072,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1094,7 +1094,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"currency\": \"SEK\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", + "raw": "{\n \"amount\": \"\",\n \"currency\": \"BRL\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -1122,12 +1122,12 @@ } }, { - "id": "2f31a1b7-0662-4eb3-bf6e-288e2046f3ee", + "id": "ccdab805-bf42-4a71-ba1a-d2c909e7f6e7", "name": "Process a checkout", "request": { "name": "Process a checkout", "description": { - "content": ":::caution[PCI DSS compliance required]\nWhen you submit raw card details directly to the Checkout API, your systems store, process, or transmit cardholder data and are therefore subject to applicable [PCI DSS requirements](https://www.pcisecuritystandards.org/document_library/). You should only use this integration if your environment is appropriately PCI DSS compliant.\n:::\n\nProcessing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resource initiated in the `Create a checkout` endpoint.\n\nFollow this request with `Retrieve a checkout` to confirm its status.", + "content": ":::caution[PCI DSS compliance required]\nWhen you submit raw card details directly to the Checkout API, your systems store, process, or transmit cardholder data and are therefore subject to applicable [PCI DSS requirements](https://www.pcisecuritystandards.org/document_library/). You should only use this integration if your environment is appropriately PCI DSS compliant.\n:::\n\nProcessing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resource initiated in the `Create a checkout` endpoint.\n\nA processing response can require an additional payer action, such as a 3DS challenge or a payment-provider redirect. If `next_step` is returned, follow its instructions to continue the payment flow.\n\nRetrieve the checkout afterwards to confirm its payment status. Acceptance of the processing request does not by itself mean the checkout is paid.", "type": "text/plain" }, "url": { @@ -1147,7 +1147,7 @@ "key": "checkout_id", "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" } } @@ -1166,7 +1166,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"bancontact\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"05\",\n \"cvv\": \"\",\n \"type\": \"PLUXEE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", + "raw": "{\n \"payment_type\": \"apple_pay\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"10\",\n \"expiry_year\": \"26\",\n \"cvv\": \"\",\n \"type\": \"SWILE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1186,7 +1186,7 @@ }, "response": [ { - "id": "caf69fb7-7607-44e8-b14a-d926f1896bb1", + "id": "e62dd298-5b13-478f-818c-3520bee94649", "name": "Returns the checkout resource after a processing attempt.", "originalRequest": { "url": { @@ -1203,7 +1203,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1225,7 +1225,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"bancontact\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"05\",\n \"cvv\": \"\",\n \"type\": \"PLUXEE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", + "raw": "{\n \"payment_type\": \"apple_pay\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"10\",\n \"expiry_year\": \"26\",\n \"cvv\": \"\",\n \"type\": \"SWILE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1242,12 +1242,12 @@ "value": "application/json" } ], - "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"CLP\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"FAILED\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"BRL\",\n \"timestamp\": \"\",\n \"status\": \"CANCELLED\",\n \"payment_type\": \"ECOM\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"QR_CODE_PIX\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"HUF\",\n \"timestamp\": \"\",\n \"status\": \"CANCELLED\",\n \"payment_type\": \"POS\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"NONE\",\n \"auth_code\": \"\"\n }\n ],\n \"transaction_code\": \"\",\n \"transaction_id\": \"\",\n \"merchant_name\": \"\",\n \"redirect_url\": \"\",\n \"payment_instrument\": {\n \"token\": \"\"\n }\n}", + "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"NOK\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"PENDING\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"APM\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"N/A\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"HRK\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"BALANCE\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"TWINT\",\n \"auth_code\": \"\"\n }\n ],\n \"transaction_code\": \"\",\n \"transaction_id\": \"\",\n \"merchant_name\": \"\",\n \"redirect_url\": \"\",\n \"payment_instrument\": {\n \"token\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "213ee66b-5939-4540-8f48-fa151b893b7a", + "id": "992812b4-3f03-4d3f-a500-4595587953e1", "name": "Returns the next required action for asynchronous checkout processing.", "originalRequest": { "url": { @@ -1264,7 +1264,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1286,7 +1286,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"bancontact\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"05\",\n \"cvv\": \"\",\n \"type\": \"PLUXEE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", + "raw": "{\n \"payment_type\": \"apple_pay\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"10\",\n \"expiry_year\": \"26\",\n \"cvv\": \"\",\n \"type\": \"SWILE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1303,12 +1303,12 @@ "value": "application/json" } ], - "body": "{\n \"next_step\": {\n \"url\": \"\",\n \"method\": \"\",\n \"redirect_url\": \"\",\n \"mechanism\": [\n \"browser\",\n \"iframe\"\n ],\n \"payload\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n}", + "body": "{\n \"next_step\": {\n \"url\": \"\",\n \"method\": \"\",\n \"redirect_url\": \"\",\n \"mechanism\": [\n \"iframe\",\n \"browser\"\n ],\n \"payload\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "68f39ed4-6b71-4cbc-8d83-32aa63012be5", + "id": "d23bdd75-25dc-4602-a99b-e7874d2ee196", "name": "The request body is invalid for processing the checkout.", "originalRequest": { "url": { @@ -1325,7 +1325,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1347,7 +1347,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"bancontact\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"05\",\n \"cvv\": \"\",\n \"type\": \"PLUXEE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", + "raw": "{\n \"payment_type\": \"apple_pay\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"10\",\n \"expiry_year\": \"26\",\n \"cvv\": \"\",\n \"type\": \"SWILE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1369,7 +1369,7 @@ "_postman_previewlanguage": "json" }, { - "id": "51d60139-0f14-4c76-a7ac-5d27cc11b4d7", + "id": "14830221-52c5-4ef4-9f20-29be3ae405a3", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -1386,7 +1386,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1408,7 +1408,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"bancontact\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"05\",\n \"cvv\": \"\",\n \"type\": \"PLUXEE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", + "raw": "{\n \"payment_type\": \"apple_pay\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"10\",\n \"expiry_year\": \"26\",\n \"cvv\": \"\",\n \"type\": \"SWILE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1430,7 +1430,7 @@ "_postman_previewlanguage": "json" }, { - "id": "da965745-0c40-4edb-89cf-7e3eb53a4396", + "id": "a8bbf58c-7849-4265-b5ec-31e4b40629f8", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -1447,7 +1447,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1469,7 +1469,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"bancontact\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"05\",\n \"cvv\": \"\",\n \"type\": \"PLUXEE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", + "raw": "{\n \"payment_type\": \"apple_pay\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"10\",\n \"expiry_year\": \"26\",\n \"cvv\": \"\",\n \"type\": \"SWILE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1491,7 +1491,7 @@ "_postman_previewlanguage": "json" }, { - "id": "938feab4-7620-4f77-a79c-1076489ba71d", + "id": "f673b100-542d-467c-82fc-0cdf55763bc4", "name": "The request conflicts with the current state of the resource.", "originalRequest": { "url": { @@ -1508,7 +1508,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1530,7 +1530,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"bancontact\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"05\",\n \"cvv\": \"\",\n \"type\": \"PLUXEE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", + "raw": "{\n \"payment_type\": \"apple_pay\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"10\",\n \"expiry_year\": \"26\",\n \"cvv\": \"\",\n \"type\": \"SWILE\",\n \"zip_code\": \"\"\n },\n \"google_pay\": {},\n \"apple_pay\": {},\n \"token\": \"\",\n \"customer_id\": \"\",\n \"personal_details\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"tax_id\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"postal_code\": \"\",\n \"state\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1558,7 +1558,7 @@ } }, { - "id": "01bd1147-904f-4d28-8eea-563163c1edfb", + "id": "9694b7ba-eff3-4d75-992b-1f909167d27c", "name": "Deactivate a checkout", "request": { "name": "Deactivate a checkout", @@ -1583,7 +1583,7 @@ "key": "checkout_id", "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" } } @@ -1609,7 +1609,7 @@ }, "response": [ { - "id": "11da2da5-9a7a-4864-8228-8b0f309f1d06", + "id": "65075578-d683-4ab3-a6d3-c13354ff442a", "name": "Returns the checkout object after successful deactivation.", "originalRequest": { "url": { @@ -1626,7 +1626,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1652,12 +1652,12 @@ "value": "application/json" } ], - "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"PENDING\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"CZK\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"CASH\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"MANUAL_ENTRY\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"CZK\",\n \"timestamp\": \"\",\n \"status\": \"CANCELLED\",\n \"payment_type\": \"BOLETO\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"MANUAL_ENTRY\",\n \"auth_code\": \"\"\n }\n ]\n}", + "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"CHF\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"PENDING\",\n \"date\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\",\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"HRK\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"UNKNOWN\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"CONTACTLESS\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"RON\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"UNKNOWN\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"MANUAL_ENTRY\",\n \"auth_code\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c4e92b2f-c643-4c98-b04a-6a5ed8e215a7", + "id": "8742f079-8ca4-41c0-83a9-08f1fdc5d5a3", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -1674,7 +1674,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1705,7 +1705,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3148e923-3845-4bc8-a07c-a84049bfcf86", + "id": "f0d9a4ce-3eb7-4974-a8ef-aafed42bbe7b", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -1722,7 +1722,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1753,7 +1753,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e57ccd13-e1fe-4994-bc8a-0536cf3a3dd4", + "id": "68651837-d795-49e9-b3db-c937b56b0c9d", "name": "The request conflicts with the current state of the resource.", "originalRequest": { "url": { @@ -1770,7 +1770,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1807,7 +1807,7 @@ } }, { - "id": "886c3190-3b3a-4724-888c-0ce2251e4c08", + "id": "0ce0f62f-fdfd-4d0a-9075-a4124904dd84", "name": "Create an Apple Pay session", "request": { "name": "Create an Apple Pay session", @@ -1833,7 +1833,7 @@ "key": "checkout_id", "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" } } @@ -1872,7 +1872,7 @@ }, "response": [ { - "id": "850130f1-e4b3-483b-a315-ade47d8156f2", + "id": "bca82122-9f0c-476c-98a9-a1536a0077ed", "name": "Successful request. Returns the Apple Pay merchant session object\nthat should be forwarded to the Apple Pay JS SDK to complete merchant\nvalidation and continue the payment flow.", "originalRequest": { "url": { @@ -1890,7 +1890,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1934,7 +1934,7 @@ "_postman_previewlanguage": "json" }, { - "id": "857e0981-6057-4026-a46b-babd339fcefc", + "id": "c84bfc74-4b4d-4d93-8198-3ed29e488a5c", "name": "Bad Request", "originalRequest": { "url": { @@ -1952,7 +1952,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -1996,7 +1996,7 @@ "_postman_previewlanguage": "json" }, { - "id": "68baae97-c063-46e9-8388-76fe77039fa9", + "id": "42470213-8ea9-448a-b786-3f9fb5851d9c", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -2014,7 +2014,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the checkout resource.", + "content": "(Required) SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "type": "text/plain" }, "type": "any", @@ -2067,15 +2067,15 @@ }, { "name": "Customers", - "description": "Allow your regular customers to save their information with the Customers model.\n\nThis will prevent re-entering payment instrument information for recurring payments on your platform.\n\nDepending on the needs you can allow, creating, listing or deactivating payment instruments & creating, retrieving and updating customers.", + "description": "Customers represent payers in your integration. Create a customer with your own `customer_id` to associate their personal details and saved payment instruments with your business records.\n\nTo save a card, create a checkout for that customer with `purpose = SETUP_RECURRING_PAYMENT`, then process it with the payer's consent and mandate details. See the [tokenization guide](https://developer.sumup.com/online-payments/guides/tokenization-with-payment-sdk/).\n\nUse the Customers endpoints to create, retrieve, or update customer details and to list or deactivate saved payment instruments. For subsequent payments, process a new checkout with the saved instrument's `token` and its associated `customer_id`.", "item": [ { - "id": "62e29f6e-cbe9-4f47-a84d-bf8815b30744", + "id": "41da5993-f03b-4f7a-a959-b555e79f4333", "name": "Create a customer", "request": { "name": "Create a customer", "description": { - "content": "Creates a new saved customer resource which you can later manipulate and save payment instruments to.", + "content": "Creates a customer using the `customer_id` you supply. Choose an identifier that maps to the payer in your own system and reuse it when retrieving the customer or associating checkouts and saved payment instruments with them.", "type": "text/plain" }, "url": { @@ -2122,7 +2122,7 @@ }, "response": [ { - "id": "5186fc62-3f00-42b4-a6f0-03f00acd456b", + "id": "4f123ddd-9d6b-41a7-ab3f-2eb44fcfa454", "name": "Returns the customer resource.", "originalRequest": { "url": { @@ -2171,7 +2171,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e6e38595-bf58-48f3-af30-0e636426af89", + "id": "038205f3-adc6-48a3-92a7-e2d7e5caafa0", "name": "The request body is invalid.", "originalRequest": { "url": { @@ -2220,7 +2220,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1eae6768-f73f-4e9a-b14a-e6e61199c1c4", + "id": "ba6ca2cc-3ea8-407e-8fce-7f9adf5fd402", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -2269,7 +2269,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5c240116-0ad5-4c07-9234-dbc2a15beb38", + "id": "9e35ed9f-248c-41f4-8353-c8d8971407f2", "name": "The request is authenticated but not permitted for this operation.", "originalRequest": { "url": { @@ -2318,7 +2318,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9205726d-b26d-4403-873c-b24007d0824c", + "id": "feb6a1db-eee3-48ee-b1ee-d8cf6f044a64", "name": "A customer with the provided identifier already exists.", "originalRequest": { "url": { @@ -2373,12 +2373,12 @@ } }, { - "id": "975fd854-00a4-4cd2-914e-b40c609138fe", + "id": "fbb95242-bcf4-408f-b676-6abb4622aff5", "name": "Retrieve a customer", "request": { "name": "Retrieve a customer", "description": { - "content": "Retrieves an identified saved customer resource through the unique `customer_id` parameter, generated upon customer creation.", + "content": "Retrieves a saved customer using the `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "url": { @@ -2398,7 +2398,7 @@ "key": "customer_id", "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" } } @@ -2424,7 +2424,7 @@ }, "response": [ { - "id": "c9c120bf-f5b0-41cf-b791-ea05d99602ef", + "id": "263e85bc-ee49-4675-ba04-58805ba407cf", "name": "Returns the customer resource.", "originalRequest": { "url": { @@ -2441,7 +2441,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -2472,7 +2472,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fec19c22-9d19-4458-9ffa-3c713a223d2f", + "id": "7478ffb4-7f5c-42ac-9242-9aa4c9e867f3", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -2489,7 +2489,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -2520,7 +2520,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d21af290-a637-4c80-9b32-b05c36d40be7", + "id": "2b5ba8fa-e7ad-43cf-b8b2-455a83ac161b", "name": "The request is authenticated but not permitted for this operation.", "originalRequest": { "url": { @@ -2537,7 +2537,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -2568,7 +2568,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d23de362-a97c-402a-be53-af4cd538f620", + "id": "4775464a-0a58-4662-a10a-38c3a778d4f1", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -2585,7 +2585,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -2622,7 +2622,7 @@ } }, { - "id": "73dabafe-e975-4ade-bebe-63e00246aae1", + "id": "85c2e0d3-5972-4286-b366-a70f404eb7f0", "name": "Update a customer", "request": { "name": "Update a customer", @@ -2647,7 +2647,7 @@ "key": "customer_id", "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" } } @@ -2686,7 +2686,7 @@ }, "response": [ { - "id": "614ef66e-7f90-4514-823f-cecc2b7d5043", + "id": "384aaefe-c8b4-4d6d-a638-fb0dea92710b", "name": "Returns the customer resource.", "originalRequest": { "url": { @@ -2703,7 +2703,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -2747,7 +2747,7 @@ "_postman_previewlanguage": "json" }, { - "id": "be09a081-6b93-4432-a222-9a44eae239e8", + "id": "87f226fb-6856-4387-bda4-eb549b7d6cad", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -2764,7 +2764,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -2808,7 +2808,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f0fb9b51-35e7-4d3e-b6dc-576c5295e145", + "id": "52b0816c-7e91-4790-97aa-ebd53bbfea5b", "name": "The request is authenticated but not permitted for this operation.", "originalRequest": { "url": { @@ -2825,7 +2825,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -2869,7 +2869,7 @@ "_postman_previewlanguage": "json" }, { - "id": "838e1898-9f9c-4cac-a271-2fa48a76f6cb", + "id": "70b947c6-96ca-4a0a-98ab-bddc2339d5d8", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -2886,7 +2886,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -2936,7 +2936,7 @@ } }, { - "id": "bc192bc5-7e75-4c8f-bf73-be59a3dca204", + "id": "c87bcdff-11fb-4cb0-bf87-a78687ff44f3", "name": "List payment instruments", "request": { "name": "List payment instruments", @@ -2962,7 +2962,7 @@ "key": "customer_id", "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" } } @@ -2988,7 +2988,7 @@ }, "response": [ { - "id": "9e4ecd2f-7ac4-4b97-a015-4df2f1c41e8b", + "id": "4150a8cb-c633-4386-b214-ddb4ec04d620", "name": "Returns the list of saved payment instruments for the customer.", "originalRequest": { "url": { @@ -3006,7 +3006,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -3032,12 +3032,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"token\": \"\",\n \"active\": true,\n \"type\": \"card\",\n \"card\": {\n \"last_4_digits\": \"\",\n \"type\": \"VR\"\n },\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"inactive\",\n \"merchant_code\": \"\"\n },\n \"created_at\": \"\"\n },\n {\n \"token\": \"\",\n \"active\": true,\n \"type\": \"card\",\n \"card\": {\n \"last_4_digits\": \"\",\n \"type\": \"PLUXEE\"\n },\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"inactive\",\n \"merchant_code\": \"\"\n },\n \"created_at\": \"\"\n }\n]", + "body": "[\n {\n \"token\": \"\",\n \"active\": true,\n \"type\": \"card\",\n \"card\": {\n \"last_4_digits\": \"\",\n \"type\": \"VISA_VPAY\"\n },\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"inactive\",\n \"merchant_code\": \"\"\n },\n \"created_at\": \"\"\n },\n {\n \"token\": \"\",\n \"active\": true,\n \"type\": \"card\",\n \"card\": {\n \"last_4_digits\": \"\",\n \"type\": \"VPAY\"\n },\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"inactive\",\n \"merchant_code\": \"\"\n },\n \"created_at\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "dcffb83e-5ada-4d33-a2f3-517bb8e2e3ce", + "id": "df79dbac-fb6a-4278-b50e-f0acca38e701", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -3055,7 +3055,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -3086,7 +3086,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6bafdc27-f0a0-419d-9dab-cba9a2ef01a7", + "id": "e33c76fd-fcc2-4927-a364-980b24d3e2f7", "name": "The request is authenticated but not permitted for this operation.", "originalRequest": { "url": { @@ -3104,7 +3104,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -3135,7 +3135,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cb9a8747-033a-4247-9f61-1f375df0086d", + "id": "8391f120-2126-4564-bf2c-3c134e054191", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -3153,7 +3153,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -3190,7 +3190,7 @@ } }, { - "id": "4dfed1e4-8334-4117-880c-d8a61957d02f", + "id": "469cabb1-930b-4fbc-b4f8-be704d8052ea", "name": "Deactivate a payment instrument", "request": { "name": "Deactivate a payment instrument", @@ -3217,7 +3217,7 @@ "key": "customer_id", "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" } }, @@ -3253,7 +3253,7 @@ }, "response": [ { - "id": "a080bf0a-5c1c-419c-8004-01cfaae8fb1b", + "id": "ead8e7c0-2385-4567-88c0-6a5d72f7447c", "name": "Returns an empty response body when the operation succeeds.", "originalRequest": { "url": { @@ -3272,7 +3272,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -3301,7 +3301,7 @@ "_postman_previewlanguage": "text" }, { - "id": "7d153d1e-561d-4920-a652-7c6527d30e3f", + "id": "9f5244f4-a6a1-4afa-9c5b-917b94b98904", "name": "The request is invalid.", "originalRequest": { "url": { @@ -3320,7 +3320,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -3361,7 +3361,7 @@ "_postman_previewlanguage": "json" }, { - "id": "77c47a0e-c416-40fd-bfbc-d5bd47873efe", + "id": "27acc052-09b4-4b1e-bbab-a3f526a7a233", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -3380,7 +3380,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -3421,7 +3421,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8bb10175-a193-4333-a727-6eb653512a5f", + "id": "2d8dca00-fc57-4daa-91d9-18d730e679f5", "name": "The request is authenticated but not permitted for this operation.", "originalRequest": { "url": { @@ -3440,7 +3440,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -3481,7 +3481,7 @@ "_postman_previewlanguage": "json" }, { - "id": "872f089f-a5fd-4910-8868-4e2661618ecb", + "id": "c9441e1c-085d-4892-be23-67cf04e24b11", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -3500,7 +3500,7 @@ { "disabled": false, "description": { - "content": "(Required) Unique identifier of the saved customer resource.", + "content": "(Required) The `customer_id` you supplied when creating the customer.", "type": "text/plain" }, "type": "any", @@ -3553,12 +3553,12 @@ "description": "Transactions represent completed or attempted payment operations processed for a merchant account. A transaction contains the core payment result, such as the amount, currency, payment method, creation time, and current high-level status.\n\nIn addition to the main payment outcome, a transaction can contain related events that describe what happened after the original payment attempt. These events provide visibility into the financial lifecycle of the transaction, for example:\n- `PAYOUT`: the payment being prepared for payout or included in a payout to the merchant\n- `REFUND`: money returned to the payer\n- `CHARGE_BACK`: money reversed after the original payment\n- `PAYOUT_DEDUCTION`: an amount deducted from a payout to cover a refund or chargeback\n\nFrom an integrator's perspective, transactions are the authoritative record of payment outcomes. Use this tag to:\n- list transactions for reporting, reconciliation, and customer support workflows\n- retrieve a single transaction when you need the latest payment details\n- inspect `simple_status` for the current merchant-facing outcome of the payment\n- inspect `events` or `transaction_events` when you need refund, payout, or chargeback history\n\nTypical workflow:\n- create and process payments through the Checkouts endpoints\n- use the Transactions endpoints to read the resulting payment records\n- use the returned statuses and events to update your own order, accounting, or support systems", "item": [ { - "id": "fd30b770-4b0d-4402-aabd-e2f6df7f8cab", + "id": "88f5a7eb-995c-4f0d-bd21-08ad8c8f41d8", "name": "Refund a transaction", "request": { "name": "Refund a transaction", "description": { - "content": "Refunds an identified transaction either in full or partially.", + "content": "Refunds a transaction identified by its SumUp transaction ID. Omit the request body to request a full refund, or provide `amount` for a partial refund in the transaction's currency.\n\nRetrieve the transaction afterwards to inspect its refunded amount and refund events. The transaction must be eligible for a refund; see the error responses for invalid amounts, permissions, and processing failures.", "type": "text/plain" }, "url": { @@ -3630,7 +3630,7 @@ }, "response": [ { - "id": "fa555f10-1699-4f05-b204-fccb6b8f13e8", + "id": "67065191-ad1d-4f22-9d6f-0c8140d9bdd6", "name": "The transaction was refunded in full or partially based on the request.", "originalRequest": { "url": { @@ -3704,7 +3704,7 @@ "_postman_previewlanguage": "json" }, { - "id": "463e355b-6927-4d70-9021-53baa1dc6546", + "id": "9123af9c-feec-4d85-b91e-e98ba609cf1b", "name": "The refund request is invalid.", "originalRequest": { "url": { @@ -3778,7 +3778,7 @@ "_postman_previewlanguage": "json" }, { - "id": "57b22d4e-a284-4400-8134-f1bb85873552", + "id": "03c17bfa-d77b-40e4-875b-2f253d5705cf", "name": "The request is authenticated but not permitted for this operation.", "originalRequest": { "url": { @@ -3852,7 +3852,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9f870944-e1c9-490e-a5b2-f900fe84015d", + "id": "d3499390-3d99-4012-ab5e-1b6e340a35d7", "name": "The requested transaction does not exist or does not belong to the merchant.", "originalRequest": { "url": { @@ -3926,7 +3926,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6844e373-3c03-409f-a969-52dc24c5b099", + "id": "7a338901-a0be-4358-92f5-cd34644d5c0b", "name": "The transaction cannot be refunded due to business constraints.", "originalRequest": { "url": { @@ -4000,7 +4000,7 @@ "_postman_previewlanguage": "json" }, { - "id": "48959a09-2cb5-4b89-b72a-3637952a590a", + "id": "1e615741-8254-429d-bc15-a21589bf7352", "name": "The refund could not be processed by the payment processor.", "originalRequest": { "url": { @@ -4080,7 +4080,7 @@ } }, { - "id": "038243ca-c96e-4a69-a622-9c87feeba85d", + "id": "bc2d3ada-aa28-4eaa-8645-8daa8a2cf69f", "name": "Retrieve a transaction", "request": { "name": "Retrieve a transaction", @@ -4169,7 +4169,7 @@ }, "response": [ { - "id": "120d6def-1d52-46ea-b675-46f18e115e6c", + "id": "21b70301-bf02-4d75-be49-4af18c15e2a4", "name": "Returns the requested transaction resource.", "originalRequest": { "url": { @@ -4250,12 +4250,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"DKK\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"RECURRING\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"PAYPAL\",\n \"auth_code\": \"\",\n \"product_summary\": \"\",\n \"payouts_total\": \"\",\n \"payouts_received\": \"\",\n \"payout_plan\": \"TRUE_INSTALLMENT\",\n \"foreign_transaction_id\": \"\",\n \"client_transaction_id\": \"\",\n \"username\": \"\",\n \"fee_amount\": \"\",\n \"lat\": \"\",\n \"lon\": \"\",\n \"horizontal_accuracy\": \"\",\n \"merchant_id\": \"\",\n \"device_info\": {\n \"name\": \"\",\n \"system_name\": \"\",\n \"model\": \"\",\n \"system_version\": \"\",\n \"uuid\": \"\"\n },\n \"simple_payment_type\": \"RECURRING\",\n \"verification_method\": \"online PIN\",\n \"card\": {\n \"last_4_digits\": \"\",\n \"type\": \"DISCOVER\",\n \"payment_account_reference\": \"\"\n },\n \"elv_account\": {\n \"sort_code\": \"\",\n \"last_4_digits\": \"\",\n \"sequence_no\": \"\",\n \"iban\": \"\"\n },\n \"local_time\": \"\",\n \"payout_date\": \"\",\n \"payout_type\": \"PREPAID_CARD\",\n \"process_as\": \"DEBIT\",\n \"products\": [\n {\n \"name\": \"\",\n \"price_label\": \"\",\n \"price\": \"\",\n \"vat_rate\": \"\",\n \"single_vat_amount\": \"\",\n \"price_with_vat\": \"\",\n \"vat_amount\": \"\",\n \"quantity\": \"\",\n \"total_price\": \"\",\n \"total_with_vat\": \"\"\n },\n {\n \"name\": \"\",\n \"price_label\": \"\",\n \"price\": \"\",\n \"vat_rate\": \"\",\n \"single_vat_amount\": \"\",\n \"price_with_vat\": \"\",\n \"vat_amount\": \"\",\n \"quantity\": \"\",\n \"total_price\": \"\",\n \"total_with_vat\": \"\"\n }\n ],\n \"vat_rates\": [\n {\n \"rate\": \"\",\n \"net\": \"\",\n \"vat\": \"\",\n \"gross\": \"\"\n },\n {\n \"rate\": \"\",\n \"net\": \"\",\n \"vat\": \"\",\n \"gross\": \"\"\n }\n ],\n \"transaction_events\": [\n {\n \"id\": \"\",\n \"event_type\": \"PAYOUT_DEDUCTION\",\n \"status\": \"RECONCILED\",\n \"amount\": \"\",\n \"due_date\": \"\",\n \"date\": \"\",\n \"installment_number\": \"\",\n \"timestamp\": \"\"\n },\n {\n \"id\": \"\",\n \"event_type\": \"PAYOUT_DEDUCTION\",\n \"status\": \"PAID_OUT\",\n \"amount\": \"\",\n \"due_date\": \"\",\n \"date\": \"\",\n \"installment_number\": \"\",\n \"timestamp\": \"\"\n }\n ],\n \"simple_status\": \"REFUND_FAILED\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"type\": \"\",\n \"min_amount\": \"\",\n \"max_amount\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"type\": \"\",\n \"min_amount\": \"\",\n \"max_amount\": \"\"\n }\n ],\n \"events\": [\n {\n \"id\": \"\",\n \"transaction_id\": \"\",\n \"type\": \"REFUND\",\n \"status\": \"SCHEDULED\",\n \"amount\": \"\",\n \"timestamp\": \"\",\n \"fee_amount\": \"\",\n \"installment_number\": \"\",\n \"deducted_amount\": \"\",\n \"deducted_fee_amount\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_id\": \"\",\n \"type\": \"CHARGE_BACK\",\n \"status\": \"SCHEDULED\",\n \"amount\": \"\",\n \"timestamp\": \"\",\n \"fee_amount\": \"\",\n \"installment_number\": \"\",\n \"deducted_amount\": \"\",\n \"deducted_fee_amount\": \"\"\n }\n ],\n \"location\": {\n \"lat\": \"\",\n \"lon\": \"\",\n \"horizontal_accuracy\": \"\"\n },\n \"tax_enabled\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"PLN\",\n \"timestamp\": \"\",\n \"status\": \"CANCELLED\",\n \"payment_type\": \"BALANCE\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"P24\",\n \"auth_code\": \"\",\n \"product_summary\": \"\",\n \"payouts_total\": \"\",\n \"payouts_received\": \"\",\n \"payout_plan\": \"SINGLE_PAYMENT\",\n \"foreign_transaction_id\": \"\",\n \"client_transaction_id\": \"\",\n \"username\": \"\",\n \"fee_amount\": \"\",\n \"lat\": \"\",\n \"lon\": \"\",\n \"horizontal_accuracy\": \"\",\n \"merchant_id\": \"\",\n \"device_info\": {\n \"name\": \"\",\n \"system_name\": \"\",\n \"model\": \"\",\n \"system_version\": \"\",\n \"uuid\": \"\"\n },\n \"simple_payment_type\": \"CARD\",\n \"verification_method\": \"signature\",\n \"card\": {\n \"last_4_digits\": \"\",\n \"type\": \"VISA\",\n \"payment_account_reference\": \"\"\n },\n \"elv_account\": {\n \"sort_code\": \"\",\n \"last_4_digits\": \"\",\n \"sequence_no\": \"\",\n \"iban\": \"\"\n },\n \"local_time\": \"\",\n \"payout_date\": \"\",\n \"payout_type\": \"PREPAID_CARD\",\n \"process_as\": \"CREDIT\",\n \"products\": [\n {\n \"name\": \"\",\n \"price_label\": \"\",\n \"price\": \"\",\n \"vat_rate\": \"\",\n \"single_vat_amount\": \"\",\n \"price_with_vat\": \"\",\n \"vat_amount\": \"\",\n \"quantity\": \"\",\n \"total_price\": \"\",\n \"total_with_vat\": \"\"\n },\n {\n \"name\": \"\",\n \"price_label\": \"\",\n \"price\": \"\",\n \"vat_rate\": \"\",\n \"single_vat_amount\": \"\",\n \"price_with_vat\": \"\",\n \"vat_amount\": \"\",\n \"quantity\": \"\",\n \"total_price\": \"\",\n \"total_with_vat\": \"\"\n }\n ],\n \"vat_rates\": [\n {\n \"rate\": \"\",\n \"net\": \"\",\n \"vat\": \"\",\n \"gross\": \"\"\n },\n {\n \"rate\": \"\",\n \"net\": \"\",\n \"vat\": \"\",\n \"gross\": \"\"\n }\n ],\n \"transaction_events\": [\n {\n \"id\": \"\",\n \"event_type\": \"PAYOUT\",\n \"status\": \"SUCCESSFUL\",\n \"amount\": \"\",\n \"due_date\": \"\",\n \"date\": \"\",\n \"installment_number\": \"\",\n \"timestamp\": \"\"\n },\n {\n \"id\": \"\",\n \"event_type\": \"REFUND\",\n \"status\": \"RECONCILED\",\n \"amount\": \"\",\n \"due_date\": \"\",\n \"date\": \"\",\n \"installment_number\": \"\",\n \"timestamp\": \"\"\n }\n ],\n \"simple_status\": \"REFUNDED\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"type\": \"\",\n \"min_amount\": \"\",\n \"max_amount\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\",\n \"type\": \"\",\n \"min_amount\": \"\",\n \"max_amount\": \"\"\n }\n ],\n \"events\": [\n {\n \"id\": \"\",\n \"transaction_id\": \"\",\n \"type\": \"REFUND\",\n \"status\": \"RECONCILED\",\n \"amount\": \"\",\n \"timestamp\": \"\",\n \"fee_amount\": \"\",\n \"installment_number\": \"\",\n \"deducted_amount\": \"\",\n \"deducted_fee_amount\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_id\": \"\",\n \"type\": \"PAYOUT_DEDUCTION\",\n \"status\": \"SUCCESSFUL\",\n \"amount\": \"\",\n \"timestamp\": \"\",\n \"fee_amount\": \"\",\n \"installment_number\": \"\",\n \"deducted_amount\": \"\",\n \"deducted_fee_amount\": \"\"\n }\n ],\n \"location\": {\n \"lat\": \"\",\n \"lon\": \"\",\n \"horizontal_accuracy\": \"\"\n },\n \"tax_enabled\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "42d6bebf-fa5a-4049-a88b-6cfdb11947cf", + "id": "1f999653-8d51-4501-b7d5-20a56f5af3aa", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -4341,7 +4341,7 @@ "_postman_previewlanguage": "json" }, { - "id": "be9f56f3-537f-4c5d-8bbd-8352c58b898c", + "id": "2fccd879-a53e-48a0-af57-052ae9d4602b", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -4433,12 +4433,12 @@ } }, { - "id": "7d7ce596-ba7a-41a3-b8e8-7f9882348a90", + "id": "b053f453-1927-4460-9f19-daf8bf220f95", "name": "List transactions", "request": { "name": "List transactions", "description": { - "content": "Lists detailed history of all transactions associated with the merchant profile.", + "content": "Lists transaction history for the merchant, with optional filters for payment type, status, and date range. The response contains the current page in `items` and pagination query strings in `links`.\n\nTo request another page, use the query string from the relevant link's `href` with this history endpoint. Use `changes_since` when retrieving transactions modified since a previous synchronization, including transactions created earlier whose status has changed.", "type": "text/plain" }, "url": { @@ -4465,7 +4465,7 @@ { "disabled": false, "description": { - "content": "Specifies the order in which the returned results are displayed. (This can only be one of ascending,descending)", + "content": "Sort direction for the transaction history. Use `ascending` or `descending`; the default is `ascending`. (This can only be one of ascending,descending)", "type": "text/plain" }, "key": "order", @@ -4474,7 +4474,7 @@ { "disabled": false, "description": { - "content": "Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will return 10 results.", + "content": "Maximum number of transactions per page. Must be a positive integer. Defaults to `10` when omitted; a page can contain fewer results.", "type": "text/plain" }, "key": "limit", @@ -4483,7 +4483,7 @@ { "disabled": false, "description": { - "content": "Filters the returned results by user email.", + "content": "Filters transactions by user email. For multiple values, repeat the query parameter, for example `users[]=first@example.com&users[]=second@example.com`.", "type": "text/plain" }, "key": "users[]", @@ -4492,7 +4492,7 @@ { "disabled": false, "description": { - "content": "Filters the returned results by user email.", + "content": "Filters transactions by user email. For multiple values, repeat the query parameter, for example `users[]=first@example.com&users[]=second@example.com`.", "type": "text/plain" }, "key": "users[]", @@ -4501,20 +4501,20 @@ { "disabled": false, "description": { - "content": "Filters the returned results by the specified list of final statuses of the transactions.", + "content": "Filters transactions by the listed final statuses. For multiple values, repeat the query parameter, for example `statuses[]=SUCCESSFUL&statuses[]=REFUNDED`.", "type": "text/plain" }, "key": "statuses[]", - "value": "CANCELLED" + "value": "FAILED" }, { "disabled": false, "description": { - "content": "Filters the returned results by the specified list of final statuses of the transactions.", + "content": "Filters transactions by the listed final statuses. For multiple values, repeat the query parameter, for example `statuses[]=SUCCESSFUL&statuses[]=REFUNDED`.", "type": "text/plain" }, "key": "statuses[]", - "value": "SUCCESSFUL" + "value": "FAILED" }, { "disabled": false, @@ -4523,7 +4523,7 @@ "type": "text/plain" }, "key": "payment_types[]", - "value": "CASH" + "value": "BALANCE" }, { "disabled": false, @@ -4532,7 +4532,7 @@ "type": "text/plain" }, "key": "payment_types[]", - "value": "CASH" + "value": "DIRECT_DEBIT" }, { "disabled": false, @@ -4541,7 +4541,7 @@ "type": "text/plain" }, "key": "entry_modes[]", - "value": "PIX" + "value": "MYBANK" }, { "disabled": false, @@ -4550,7 +4550,7 @@ "type": "text/plain" }, "key": "entry_modes[]", - "value": "BOLETO" + "value": "BANCONTACT" }, { "disabled": false, @@ -4568,7 +4568,7 @@ "type": "text/plain" }, "key": "types[]", - "value": "REFUND" + "value": "CHARGE_BACK" }, { "disabled": false, @@ -4591,7 +4591,7 @@ { "disabled": false, "description": { - "content": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *smaller* than the specified value. This parameters supersedes the `newest_time` parameter (if both are provided in the request).", + "content": "Pagination reference that returns results before the specified reference. Use the value from a returned pagination link rather than constructing it yourself. This parameter takes precedence over `newest_time` when both are provided.", "type": "text/plain" }, "key": "newest_ref", @@ -4609,7 +4609,7 @@ { "disabled": false, "description": { - "content": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *greater* than the specified value. This parameters supersedes the `oldest_time` parameter (if both are provided in the request).", + "content": "Pagination reference that returns results after the specified reference. Use the value from a returned pagination link rather than constructing it yourself. This parameter takes precedence over `oldest_time` when both are provided.", "type": "text/plain" }, "key": "oldest_ref", @@ -4649,7 +4649,7 @@ }, "response": [ { - "id": "7ac63ac1-f6e3-4be7-8aa2-ce3bb00e0b56", + "id": "d28984aa-b89b-4aa6-bd0d-0d4fb068ec4d", "name": "Returns a page of transaction history items.", "originalRequest": { "url": { @@ -4676,7 +4676,7 @@ { "disabled": false, "description": { - "content": "Specifies the order in which the returned results are displayed. (This can only be one of ascending,descending)", + "content": "Sort direction for the transaction history. Use `ascending` or `descending`; the default is `ascending`. (This can only be one of ascending,descending)", "type": "text/plain" }, "key": "order", @@ -4685,7 +4685,7 @@ { "disabled": false, "description": { - "content": "Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will return 10 results.", + "content": "Maximum number of transactions per page. Must be a positive integer. Defaults to `10` when omitted; a page can contain fewer results.", "type": "text/plain" }, "key": "limit", @@ -4694,7 +4694,7 @@ { "disabled": false, "description": { - "content": "Filters the returned results by user email.", + "content": "Filters transactions by user email. For multiple values, repeat the query parameter, for example `users[]=first@example.com&users[]=second@example.com`.", "type": "text/plain" }, "key": "users[]", @@ -4703,11 +4703,11 @@ { "disabled": false, "description": { - "content": "Filters the returned results by the specified list of final statuses of the transactions.", + "content": "Filters transactions by the listed final statuses. For multiple values, repeat the query parameter, for example `statuses[]=SUCCESSFUL&statuses[]=REFUNDED`.", "type": "text/plain" }, "key": "statuses[]", - "value": "SUCCESSFUL" + "value": "FAILED" }, { "disabled": false, @@ -4716,7 +4716,7 @@ "type": "text/plain" }, "key": "payment_types[]", - "value": "CASH" + "value": "DIRECT_DEBIT" }, { "disabled": false, @@ -4725,7 +4725,7 @@ "type": "text/plain" }, "key": "entry_modes[]", - "value": "BOLETO" + "value": "BANCONTACT" }, { "disabled": false, @@ -4734,7 +4734,7 @@ "type": "text/plain" }, "key": "types[]", - "value": "REFUND" + "value": "CHARGE_BACK" }, { "disabled": false, @@ -4757,7 +4757,7 @@ { "disabled": false, "description": { - "content": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *smaller* than the specified value. This parameters supersedes the `newest_time` parameter (if both are provided in the request).", + "content": "Pagination reference that returns results before the specified reference. Use the value from a returned pagination link rather than constructing it yourself. This parameter takes precedence over `newest_time` when both are provided.", "type": "text/plain" }, "key": "newest_ref", @@ -4775,7 +4775,7 @@ { "disabled": false, "description": { - "content": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *greater* than the specified value. This parameters supersedes the `oldest_time` parameter (if both are provided in the request).", + "content": "Pagination reference that returns results after the specified reference. Use the value from a returned pagination link rather than constructing it yourself. This parameter takes precedence over `oldest_time` when both are provided.", "type": "text/plain" }, "key": "oldest_ref", @@ -4812,12 +4812,12 @@ "value": "application/json" } ], - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"NOK\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"BITCOIN\",\n \"installments_count\": \"\",\n \"product_summary\": \"\",\n \"payouts_total\": \"\",\n \"payouts_received\": \"\",\n \"payout_plan\": \"TRUE_INSTALLMENT\",\n \"transaction_id\": \"\",\n \"client_transaction_id\": \"\",\n \"user\": \"\",\n \"type\": \"REFUND\",\n \"card_type\": \"VISA_ELECTRON\",\n \"payout_date\": \"\",\n \"payout_type\": \"BANK_ACCOUNT\",\n \"refunded_amount\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"DIRECT_DEBIT\",\n \"installments_count\": \"\",\n \"product_summary\": \"\",\n \"payouts_total\": \"\",\n \"payouts_received\": \"\",\n \"payout_plan\": \"SINGLE_PAYMENT\",\n \"transaction_id\": \"\",\n \"client_transaction_id\": \"\",\n \"user\": \"\",\n \"type\": \"PAYMENT\",\n \"card_type\": \"ELO\",\n \"payout_date\": \"\",\n \"payout_type\": \"PREPAID_CARD\",\n \"refunded_amount\": \"\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n}", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"SEK\",\n \"timestamp\": \"\",\n \"status\": \"SUCCESSFUL\",\n \"payment_type\": \"POS\",\n \"installments_count\": \"\",\n \"product_summary\": \"\",\n \"payouts_total\": \"\",\n \"payouts_received\": \"\",\n \"payout_plan\": \"TRUE_INSTALLMENT\",\n \"transaction_id\": \"\",\n \"client_transaction_id\": \"\",\n \"user\": \"\",\n \"type\": \"PAYMENT\",\n \"card_type\": \"UNKNOWN\",\n \"payout_date\": \"\",\n \"payout_type\": \"PREPAID_CARD\",\n \"refunded_amount\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"CLP\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"MOTO\",\n \"installments_count\": \"\",\n \"product_summary\": \"\",\n \"payouts_total\": \"\",\n \"payouts_received\": \"\",\n \"payout_plan\": \"ACCELERATED_INSTALLMENT\",\n \"transaction_id\": \"\",\n \"client_transaction_id\": \"\",\n \"user\": \"\",\n \"type\": \"PAYMENT\",\n \"card_type\": \"SWILE\",\n \"payout_date\": \"\",\n \"payout_type\": \"BANK_ACCOUNT\",\n \"refunded_amount\": \"\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "aea508ec-ffd0-49a1-b744-a791bc9d26ce", + "id": "19127308-6f3a-474a-afd6-12ff48a951a3", "name": "The request is invalid for the submitted query parameters.", "originalRequest": { "url": { @@ -4844,7 +4844,7 @@ { "disabled": false, "description": { - "content": "Specifies the order in which the returned results are displayed. (This can only be one of ascending,descending)", + "content": "Sort direction for the transaction history. Use `ascending` or `descending`; the default is `ascending`. (This can only be one of ascending,descending)", "type": "text/plain" }, "key": "order", @@ -4853,7 +4853,7 @@ { "disabled": false, "description": { - "content": "Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will return 10 results.", + "content": "Maximum number of transactions per page. Must be a positive integer. Defaults to `10` when omitted; a page can contain fewer results.", "type": "text/plain" }, "key": "limit", @@ -4862,7 +4862,7 @@ { "disabled": false, "description": { - "content": "Filters the returned results by user email.", + "content": "Filters transactions by user email. For multiple values, repeat the query parameter, for example `users[]=first@example.com&users[]=second@example.com`.", "type": "text/plain" }, "key": "users[]", @@ -4871,11 +4871,11 @@ { "disabled": false, "description": { - "content": "Filters the returned results by the specified list of final statuses of the transactions.", + "content": "Filters transactions by the listed final statuses. For multiple values, repeat the query parameter, for example `statuses[]=SUCCESSFUL&statuses[]=REFUNDED`.", "type": "text/plain" }, "key": "statuses[]", - "value": "SUCCESSFUL" + "value": "FAILED" }, { "disabled": false, @@ -4884,7 +4884,7 @@ "type": "text/plain" }, "key": "payment_types[]", - "value": "CASH" + "value": "DIRECT_DEBIT" }, { "disabled": false, @@ -4893,7 +4893,7 @@ "type": "text/plain" }, "key": "entry_modes[]", - "value": "BOLETO" + "value": "BANCONTACT" }, { "disabled": false, @@ -4902,7 +4902,7 @@ "type": "text/plain" }, "key": "types[]", - "value": "REFUND" + "value": "CHARGE_BACK" }, { "disabled": false, @@ -4925,7 +4925,7 @@ { "disabled": false, "description": { - "content": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *smaller* than the specified value. This parameters supersedes the `newest_time` parameter (if both are provided in the request).", + "content": "Pagination reference that returns results before the specified reference. Use the value from a returned pagination link rather than constructing it yourself. This parameter takes precedence over `newest_time` when both are provided.", "type": "text/plain" }, "key": "newest_ref", @@ -4943,7 +4943,7 @@ { "disabled": false, "description": { - "content": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *greater* than the specified value. This parameters supersedes the `oldest_time` parameter (if both are provided in the request).", + "content": "Pagination reference that returns results after the specified reference. Use the value from a returned pagination link rather than constructing it yourself. This parameter takes precedence over `oldest_time` when both are provided.", "type": "text/plain" }, "key": "oldest_ref", @@ -4985,7 +4985,7 @@ "_postman_previewlanguage": "json" }, { - "id": "764c2cff-4a43-4800-9032-a386c97a0af9", + "id": "de6df0ad-00db-426e-b65c-1ecb843d8c73", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -5012,7 +5012,7 @@ { "disabled": false, "description": { - "content": "Specifies the order in which the returned results are displayed. (This can only be one of ascending,descending)", + "content": "Sort direction for the transaction history. Use `ascending` or `descending`; the default is `ascending`. (This can only be one of ascending,descending)", "type": "text/plain" }, "key": "order", @@ -5021,7 +5021,7 @@ { "disabled": false, "description": { - "content": "Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will return 10 results.", + "content": "Maximum number of transactions per page. Must be a positive integer. Defaults to `10` when omitted; a page can contain fewer results.", "type": "text/plain" }, "key": "limit", @@ -5030,7 +5030,7 @@ { "disabled": false, "description": { - "content": "Filters the returned results by user email.", + "content": "Filters transactions by user email. For multiple values, repeat the query parameter, for example `users[]=first@example.com&users[]=second@example.com`.", "type": "text/plain" }, "key": "users[]", @@ -5039,11 +5039,11 @@ { "disabled": false, "description": { - "content": "Filters the returned results by the specified list of final statuses of the transactions.", + "content": "Filters transactions by the listed final statuses. For multiple values, repeat the query parameter, for example `statuses[]=SUCCESSFUL&statuses[]=REFUNDED`.", "type": "text/plain" }, "key": "statuses[]", - "value": "SUCCESSFUL" + "value": "FAILED" }, { "disabled": false, @@ -5052,7 +5052,7 @@ "type": "text/plain" }, "key": "payment_types[]", - "value": "CASH" + "value": "DIRECT_DEBIT" }, { "disabled": false, @@ -5061,7 +5061,7 @@ "type": "text/plain" }, "key": "entry_modes[]", - "value": "BOLETO" + "value": "BANCONTACT" }, { "disabled": false, @@ -5070,7 +5070,7 @@ "type": "text/plain" }, "key": "types[]", - "value": "REFUND" + "value": "CHARGE_BACK" }, { "disabled": false, @@ -5093,7 +5093,7 @@ { "disabled": false, "description": { - "content": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *smaller* than the specified value. This parameters supersedes the `newest_time` parameter (if both are provided in the request).", + "content": "Pagination reference that returns results before the specified reference. Use the value from a returned pagination link rather than constructing it yourself. This parameter takes precedence over `newest_time` when both are provided.", "type": "text/plain" }, "key": "newest_ref", @@ -5111,7 +5111,7 @@ { "disabled": false, "description": { - "content": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *greater* than the specified value. This parameters supersedes the `oldest_time` parameter (if both are provided in the request).", + "content": "Pagination reference that returns results after the specified reference. Use the value from a returned pagination link rather than constructing it yourself. This parameter takes precedence over `oldest_time` when both are provided.", "type": "text/plain" }, "key": "oldest_ref", @@ -5165,7 +5165,7 @@ "description": "The Payouts model will allow you to track funds you’ve received from SumUp.\n\nYou can receive a detailed payouts list with information like dates, fees, references and statuses, using the `List payouts` endpoint.", "item": [ { - "id": "7f2463dd-05bb-474c-aeee-f616e4b3b985", + "id": "b4dac632-97a1-4203-a096-f9603abef0bf", "name": "List payouts", "request": { "name": "List payouts", @@ -5263,7 +5263,7 @@ }, "response": [ { - "id": "e03e3c66-df22-444e-917b-f4509fa5eb3f", + "id": "6a3b2b22-2778-4627-bb05-b2dbe1482a54", "name": "Returns the list of payout and deduction records for the requested period.", "originalRequest": { "url": { @@ -5353,12 +5353,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"\",\n \"type\": \"BALANCE_DEDUCTION\",\n \"amount\": \"\",\n \"date\": \"\",\n \"currency\": \"\",\n \"fee\": \"\",\n \"status\": \"SUCCESSFUL\",\n \"reference\": \"\",\n \"transaction_code\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"REFUND_DEDUCTION\",\n \"amount\": \"\",\n \"date\": \"\",\n \"currency\": \"\",\n \"fee\": \"\",\n \"status\": \"SUCCESSFUL\",\n \"reference\": \"\",\n \"transaction_code\": \"\"\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"type\": \"PAYOUT\",\n \"amount\": \"\",\n \"date\": \"\",\n \"currency\": \"\",\n \"fee\": \"\",\n \"status\": \"SUCCESSFUL\",\n \"reference\": \"\",\n \"transaction_code\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"CHARGE_BACK_DEDUCTION\",\n \"amount\": \"\",\n \"date\": \"\",\n \"currency\": \"\",\n \"fee\": \"\",\n \"status\": \"SUCCESSFUL\",\n \"reference\": \"\",\n \"transaction_code\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2f0eb52c-19f0-4f8d-9742-ff654af9e5ac", + "id": "f4691d34-5c4d-4b4a-b14e-22777a7cb879", "name": "The request is invalid for the submitted query parameters.", "originalRequest": { "url": { @@ -5453,7 +5453,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0ab1269e-8c74-421a-932d-ca651174dc3f", + "id": "a68c0973-fc7a-4ee5-9769-3e0671114a93", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -5557,15 +5557,15 @@ }, { "name": "Receipts", - "description": "The Receipts model obtains receipt-like details for specific transactions.", + "description": "Retrieve structured receipt data for a transaction, including payment, merchant, and acquirer details. Use this data to display a receipt in your application. The response is JSON, rather than a rendered receipt document.", "item": [ { - "id": "f1b9a96a-6d47-4db7-ae0c-f403a039bf28", + "id": "d3f552c2-8ca3-4070-ac09-a279c00924ea", "name": "Retrieve receipt details", "request": { "name": "Retrieve receipt details", "description": { - "content": "Retrieves receipt specific data for a transaction.", + "content": "Retrieves structured receipt data for a transaction belonging to the merchant specified by `mid`. The path accepts either the SumUp transaction ID or transaction code. Provide `tx_event_id` to include a specific transaction event, such as a refund, on the receipt.", "type": "text/plain" }, "url": { @@ -5630,7 +5630,7 @@ }, "response": [ { - "id": "958195ce-80f9-4bd1-bee0-b86d9016d537", + "id": "2efd89ec-ac91-4e36-90eb-64c6aa6d69f9", "name": "Returns receipt details for the requested transaction.", "originalRequest": { "url": { @@ -5692,12 +5692,12 @@ "value": "application/json" } ], - "body": "{\n \"transaction_data\": {\n \"transaction_code\": \"\",\n \"transaction_id\": \"\",\n \"merchant_code\": \"\",\n \"amount\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"currency\": \"\",\n \"timestamp\": \"\",\n \"status\": \"\",\n \"payment_type\": \"\",\n \"entry_mode\": \"\",\n \"verification_method\": \"\",\n \"card_reader\": {\n \"code\": \"\",\n \"type\": \"\"\n },\n \"card\": {\n \"last_4_digits\": \"\",\n \"type\": \"\"\n },\n \"installments_count\": \"\",\n \"process_as\": \"DEBIT\",\n \"products\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"vat_rate\": \"\",\n \"single_vat_amount\": \"\",\n \"price_with_vat\": \"\",\n \"vat_amount\": \"\",\n \"quantity\": \"\",\n \"total_price\": \"\",\n \"total_with_vat\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"vat_rate\": \"\",\n \"single_vat_amount\": \"\",\n \"price_with_vat\": \"\",\n \"vat_amount\": \"\",\n \"quantity\": \"\",\n \"total_price\": \"\",\n \"total_with_vat\": \"\"\n }\n ],\n \"vat_rates\": [\n {\n \"gross\": \"\",\n \"net\": \"\",\n \"rate\": \"\",\n \"vat\": \"\"\n },\n {\n \"gross\": \"\",\n \"net\": \"\",\n \"rate\": \"\",\n \"vat\": \"\"\n }\n ],\n \"events\": [\n {\n \"id\": \"\",\n \"transaction_id\": \"\",\n \"type\": \"PAYOUT\",\n \"status\": \"SUCCESSFUL\",\n \"amount\": \"\",\n \"timestamp\": \"\",\n \"receipt_no\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_id\": \"\",\n \"type\": \"PAYOUT_DEDUCTION\",\n \"status\": \"PAID_OUT\",\n \"amount\": \"\",\n \"timestamp\": \"\",\n \"receipt_no\": \"\"\n }\n ],\n \"receipt_no\": \"\"\n },\n \"merchant_data\": {\n \"merchant_profile\": {\n \"merchant_code\": \"\",\n \"business_name\": \"\",\n \"company_registration_number\": \"\",\n \"vat_id\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"language\": \"\",\n \"address\": {\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_en_name\": \"\",\n \"country_native_name\": \"\",\n \"region_name\": \"\",\n \"post_code\": \"\",\n \"landline\": \"\"\n }\n },\n \"locale\": \"\"\n },\n \"emv_data\": {},\n \"acquirer_data\": {\n \"tid\": \"\",\n \"authorization_code\": \"\",\n \"return_code\": \"\",\n \"local_time\": \"\"\n }\n}", + "body": "{\n \"transaction_data\": {\n \"transaction_code\": \"\",\n \"transaction_id\": \"\",\n \"merchant_code\": \"\",\n \"amount\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"currency\": \"\",\n \"timestamp\": \"\",\n \"status\": \"\",\n \"payment_type\": \"\",\n \"entry_mode\": \"\",\n \"verification_method\": \"\",\n \"card_reader\": {\n \"code\": \"\",\n \"type\": \"\"\n },\n \"card\": {\n \"last_4_digits\": \"\",\n \"type\": \"\"\n },\n \"installments_count\": \"\",\n \"process_as\": \"DEBIT\",\n \"products\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"vat_rate\": \"\",\n \"single_vat_amount\": \"\",\n \"price_with_vat\": \"\",\n \"vat_amount\": \"\",\n \"quantity\": \"\",\n \"total_price\": \"\",\n \"total_with_vat\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"vat_rate\": \"\",\n \"single_vat_amount\": \"\",\n \"price_with_vat\": \"\",\n \"vat_amount\": \"\",\n \"quantity\": \"\",\n \"total_price\": \"\",\n \"total_with_vat\": \"\"\n }\n ],\n \"vat_rates\": [\n {\n \"gross\": \"\",\n \"net\": \"\",\n \"rate\": \"\",\n \"vat\": \"\"\n },\n {\n \"gross\": \"\",\n \"net\": \"\",\n \"rate\": \"\",\n \"vat\": \"\"\n }\n ],\n \"events\": [\n {\n \"id\": \"\",\n \"transaction_id\": \"\",\n \"type\": \"REFUND\",\n \"status\": \"SUCCESSFUL\",\n \"amount\": \"\",\n \"timestamp\": \"\",\n \"receipt_no\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_id\": \"\",\n \"type\": \"PAYOUT\",\n \"status\": \"PENDING\",\n \"amount\": \"\",\n \"timestamp\": \"\",\n \"receipt_no\": \"\"\n }\n ],\n \"receipt_no\": \"\"\n },\n \"merchant_data\": {\n \"merchant_profile\": {\n \"merchant_code\": \"\",\n \"business_name\": \"\",\n \"company_registration_number\": \"\",\n \"vat_id\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"language\": \"\",\n \"address\": {\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_en_name\": \"\",\n \"country_native_name\": \"\",\n \"region_name\": \"\",\n \"post_code\": \"\",\n \"landline\": \"\"\n }\n },\n \"locale\": \"\"\n },\n \"emv_data\": {},\n \"acquirer_data\": {\n \"tid\": \"\",\n \"authorization_code\": \"\",\n \"return_code\": \"\",\n \"local_time\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a8b6cafe-df38-46b8-9fc1-401607f348b1", + "id": "6b9fc5a2-9e74-4cc2-a7a1-3891101a45f9", "name": "The request is invalid for the submitted parameters.", "originalRequest": { "url": { @@ -5764,7 +5764,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b0e0a71d-a9a9-490c-b97b-609b8519bc93", + "id": "336928b7-2bc1-42d1-946c-25a8057e7d43", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -5831,7 +5831,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c0cee463-32d4-4f98-977a-ed138f0d5ef7", + "id": "4e8f8332-5a1c-4546-bac0-178cedcc52e4", "name": "The requested transaction event does not exist for the provided transaction.", "originalRequest": { "url": { @@ -5910,7 +5910,7 @@ "description": "A reader represents a device that accepts payments. You can use the SumUp Solo to accept in-person payments.", "item": [ { - "id": "b5761cf1-0e9f-4fa4-a5f5-861aa4dc7c5b", + "id": "c49811ef-6c2b-4321-b0d0-7c402dcc4a0f", "name": "Create a Go Reader Payment", "request": { "name": "Create a Go Reader Payment", @@ -5987,7 +5987,7 @@ }, "response": [ { - "id": "21a1c9c2-ce26-412a-9c9b-3540e73adecb", + "id": "d7160150-14cc-4cfe-8cfa-b1f49a59f8a8", "name": "Returns the result of the payment initiated on the reader.", "originalRequest": { "url": { @@ -6061,7 +6061,7 @@ "_postman_previewlanguage": "json" }, { - "id": "87d6322f-ffcd-43f6-94f1-4ce8601eb71b", + "id": "b4318728-e952-47cb-a293-841e2ed4a993", "name": "The request is invalid.", "originalRequest": { "url": { @@ -6135,7 +6135,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3787e206-a575-44be-9259-17c1140b93c7", + "id": "55e02727-de33-4021-bb23-e5d141bbd4fe", "name": "Authentication failed or missing required scope.", "originalRequest": { "url": { @@ -6209,7 +6209,7 @@ "_postman_previewlanguage": "json" }, { - "id": "41daa9a1-ef8c-4fc1-8af6-a08b169a486c", + "id": "1a372063-4467-4d3e-8324-7494f0c97d02", "name": "The requested Reader resource does not exist.", "originalRequest": { "url": { @@ -6283,7 +6283,7 @@ "_postman_previewlanguage": "json" }, { - "id": "afbb0bef-86ee-4cb4-8cdb-348a28c1a289", + "id": "e0defc29-7baa-425d-84bc-3b55c3e5fa21", "name": "The request could not be processed as it violates a business rule.", "originalRequest": { "url": { @@ -6363,7 +6363,7 @@ } }, { - "id": "64e4498d-ac9a-4164-9708-93cca9f9d4ed", + "id": "b10c74d6-67c8-4c87-af38-d0b52f5fe8b0", "name": "List Readers", "request": { "name": "List Readers", @@ -6415,7 +6415,7 @@ }, "response": [ { - "id": "18b2a708-bbca-4d29-8f49-4872204a4c51", + "id": "7b6c35dc-3ce5-4187-9ed9-a02575315edd", "name": "Returns a list Reader objects.", "originalRequest": { "url": { @@ -6459,12 +6459,12 @@ "value": "application/json" } ], - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"processing\",\n \"device\": {\n \"identifier\": \"\",\n \"model\": \"virtual-solo\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"metadata\": {\n \"key_0\": 7681.209115997319,\n \"key_1\": 9045,\n \"key_2\": true,\n \"key_3\": 9470.651704750808,\n \"key_4\": 9498.46445919976,\n \"key_5\": 7039,\n \"key_6\": \"string\",\n \"key_7\": \"string\",\n \"key_8\": \"string\",\n \"key_9\": 8110.158744667025,\n \"key_10\": 5152.525901853113,\n \"key_11\": 5778.218653461547,\n \"key_12\": 2290.9141685159275,\n \"key_13\": \"string\",\n \"key_14\": 4072,\n \"key_15\": false,\n \"key_16\": \"string\",\n \"key_17\": 4979.64672379208,\n \"key_18\": 7844.148899320413,\n \"key_19\": 2630,\n \"key_20\": 4443.954005636004,\n \"key_21\": 7487,\n \"key_22\": 9113.799701363572,\n \"key_23\": \"string\",\n \"key_24\": false,\n \"key_25\": 4246,\n \"key_26\": \"string\",\n \"key_27\": \"string\",\n \"key_28\": false,\n \"key_29\": 9840.216733574365,\n \"key_30\": 9544.681455781878,\n \"key_31\": \"string\",\n \"key_32\": 7512,\n \"key_33\": 3353,\n \"key_34\": \"string\",\n \"key_35\": 1576.2996920498651,\n \"key_36\": 6612\n },\n \"service_account_id\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"processing\",\n \"device\": {\n \"identifier\": \"\",\n \"model\": \"virtual-solo\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 2431.2794463826594,\n \"key_2\": 318.7793535372729,\n \"key_3\": \"string\",\n \"key_4\": true,\n \"key_5\": false,\n \"key_6\": \"string\",\n \"key_7\": true,\n \"key_8\": true,\n \"key_9\": true,\n \"key_10\": 9451,\n \"key_11\": 1155.8699747351575,\n \"key_12\": 3140.283883975652,\n \"key_13\": 3189.2968234257355,\n \"key_14\": \"string\",\n \"key_15\": \"string\",\n \"key_16\": 7380,\n \"key_17\": 6969,\n \"key_18\": 8625,\n \"key_19\": false,\n \"key_20\": true,\n \"key_21\": 2870,\n \"key_22\": false,\n \"key_23\": 7254,\n \"key_24\": true,\n \"key_25\": \"string\",\n \"key_26\": true,\n \"key_27\": true,\n \"key_28\": \"string\",\n \"key_29\": 9500,\n \"key_30\": 6740.555769437086,\n \"key_31\": true,\n \"key_32\": false,\n \"key_33\": 9273,\n \"key_34\": 8849\n },\n \"service_account_id\": \"\"\n }\n ]\n}", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"expired\",\n \"device\": {\n \"identifier\": \"\",\n \"model\": \"solo\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"metadata\": {\n \"key_0\": 3921.2511086512623,\n \"key_1\": 2830.674416144818,\n \"key_2\": false,\n \"key_3\": 2919,\n \"key_4\": 7553,\n \"key_5\": \"string\",\n \"key_6\": true,\n \"key_7\": 5979.303409992942,\n \"key_8\": 566,\n \"key_9\": 6360.144649332069,\n \"key_10\": \"string\",\n \"key_11\": 1069,\n \"key_12\": 9284.678693279391,\n \"key_13\": \"string\",\n \"key_14\": false,\n \"key_15\": 81,\n \"key_16\": 8869\n },\n \"service_account_id\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"unknown\",\n \"device\": {\n \"identifier\": \"\",\n \"model\": \"virtual-solo\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 8077.834690392554\n },\n \"service_account_id\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b65fafe3-81a7-435e-afc1-a44dfc4c5b1a", + "id": "9127eab1-0c88-4011-9fb7-c479ddf0649d", "name": "Authentication failed or missing required scope.", "originalRequest": { "url": { @@ -6519,7 +6519,7 @@ } }, { - "id": "2c071686-a43a-4a1c-87f6-7bd149009837", + "id": "5681ba3d-1eea-4f7d-b9da-7a503a28ad78", "name": "Create a Reader", "request": { "name": "Create a Reader", @@ -6564,7 +6564,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 6407,\n \"key_2\": true,\n \"key_3\": 150,\n \"key_4\": 6689.019459075854,\n \"key_5\": 6885.474888879439,\n \"key_6\": 1579,\n \"key_7\": \"string\",\n \"key_8\": 4331,\n \"key_9\": 2537,\n \"key_10\": 1764.4048366996178,\n \"key_11\": \"string\",\n \"key_12\": 2001.4646138132975,\n \"key_13\": 4876.585234693643,\n \"key_14\": 256,\n \"key_15\": false,\n \"key_16\": 1748.0123124505465,\n \"key_17\": 6810.795803875795,\n \"key_18\": 8983.176732046015,\n \"key_19\": 4315.458076304457,\n \"key_20\": 9272.402781514611,\n \"key_21\": \"string\",\n \"key_22\": 4251.9488090959885,\n \"key_23\": 3815.4798618500354,\n \"key_24\": 2002.6504878754836,\n \"key_25\": true,\n \"key_26\": 5811,\n \"key_27\": 9904,\n \"key_28\": false,\n \"key_29\": true,\n \"key_30\": \"string\",\n \"key_31\": 6064,\n \"key_32\": 891.7724656835513,\n \"key_33\": \"string\",\n \"key_34\": false,\n \"key_35\": 6903,\n \"key_36\": 2200.593899589676,\n \"key_37\": 3594.6992057302587,\n \"key_38\": 6442.658345818098,\n \"key_39\": false,\n \"key_40\": 1049,\n \"key_41\": 1158,\n \"key_42\": 9866,\n \"key_43\": false,\n \"key_44\": \"string\",\n \"key_45\": false,\n \"key_46\": 1527\n }\n}", + "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 3335,\n \"key_2\": 399,\n \"key_3\": 4996,\n \"key_4\": 2529,\n \"key_5\": \"string\",\n \"key_6\": 7890,\n \"key_7\": 5610,\n \"key_8\": \"string\",\n \"key_9\": 4262.086721363882,\n \"key_10\": true\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6584,7 +6584,7 @@ }, "response": [ { - "id": "eb193677-baa0-4c6b-b87b-7b48d19702e6", + "id": "2b28f211-aab1-43c9-826f-ccd0534096f2", "name": "Returns the Reader object if the creation succeeded.", "originalRequest": { "url": { @@ -6624,7 +6624,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 6407,\n \"key_2\": true,\n \"key_3\": 150,\n \"key_4\": 6689.019459075854,\n \"key_5\": 6885.474888879439,\n \"key_6\": 1579,\n \"key_7\": \"string\",\n \"key_8\": 4331,\n \"key_9\": 2537,\n \"key_10\": 1764.4048366996178,\n \"key_11\": \"string\",\n \"key_12\": 2001.4646138132975,\n \"key_13\": 4876.585234693643,\n \"key_14\": 256,\n \"key_15\": false,\n \"key_16\": 1748.0123124505465,\n \"key_17\": 6810.795803875795,\n \"key_18\": 8983.176732046015,\n \"key_19\": 4315.458076304457,\n \"key_20\": 9272.402781514611,\n \"key_21\": \"string\",\n \"key_22\": 4251.9488090959885,\n \"key_23\": 3815.4798618500354,\n \"key_24\": 2002.6504878754836,\n \"key_25\": true,\n \"key_26\": 5811,\n \"key_27\": 9904,\n \"key_28\": false,\n \"key_29\": true,\n \"key_30\": \"string\",\n \"key_31\": 6064,\n \"key_32\": 891.7724656835513,\n \"key_33\": \"string\",\n \"key_34\": false,\n \"key_35\": 6903,\n \"key_36\": 2200.593899589676,\n \"key_37\": 3594.6992057302587,\n \"key_38\": 6442.658345818098,\n \"key_39\": false,\n \"key_40\": 1049,\n \"key_41\": 1158,\n \"key_42\": 9866,\n \"key_43\": false,\n \"key_44\": \"string\",\n \"key_45\": false,\n \"key_46\": 1527\n }\n}", + "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 3335,\n \"key_2\": 399,\n \"key_3\": 4996,\n \"key_4\": 2529,\n \"key_5\": \"string\",\n \"key_6\": 7890,\n \"key_7\": 5610,\n \"key_8\": \"string\",\n \"key_9\": 4262.086721363882,\n \"key_10\": true\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6641,12 +6641,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"expired\",\n \"device\": {\n \"identifier\": \"\",\n \"model\": \"virtual-solo\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"metadata\": {\n \"key_0\": 445.6594211113041,\n \"key_1\": 7196.124696833716,\n \"key_2\": 7405,\n \"key_3\": true,\n \"key_4\": 9166,\n \"key_5\": 1787,\n \"key_6\": 1087,\n \"key_7\": 4145,\n \"key_8\": false,\n \"key_9\": 2559.840451745823,\n \"key_10\": 1931,\n \"key_11\": 8652.89909561378,\n \"key_12\": 1362.3917957828423,\n \"key_13\": true,\n \"key_14\": false,\n \"key_15\": \"string\",\n \"key_16\": \"string\",\n \"key_17\": 1826,\n \"key_18\": \"string\",\n \"key_19\": 4396,\n \"key_20\": 4973.933629236815,\n \"key_21\": 2515.259480561205,\n \"key_22\": false,\n \"key_23\": 3756,\n \"key_24\": \"string\",\n \"key_25\": 768,\n \"key_26\": 8532,\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": false,\n \"key_30\": 7274,\n \"key_31\": 804,\n \"key_32\": true,\n \"key_33\": true,\n \"key_34\": \"string\",\n \"key_35\": 8702.875834334065,\n \"key_36\": false,\n \"key_37\": true,\n \"key_38\": false,\n \"key_39\": 2710,\n \"key_40\": 6064,\n \"key_41\": 389.00454800179006,\n \"key_42\": 5275,\n \"key_43\": true,\n \"key_44\": \"string\",\n \"key_45\": 4516,\n \"key_46\": false,\n \"key_47\": 8575.13876639941,\n \"key_48\": \"string\",\n \"key_49\": false,\n \"key_50\": 872.2753735158162,\n \"key_51\": true,\n \"key_52\": 4903.953059138362,\n \"key_53\": false,\n \"key_54\": 1340,\n \"key_55\": 3496,\n \"key_56\": \"string\",\n \"key_57\": 4091,\n \"key_58\": 4458.188212373529,\n \"key_59\": 7902,\n \"key_60\": \"string\",\n \"key_61\": 4120.887850539297,\n \"key_62\": \"string\",\n \"key_63\": true\n },\n \"service_account_id\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"processing\",\n \"device\": {\n \"identifier\": \"\",\n \"model\": \"solo\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"metadata\": {\n \"key_0\": 269,\n \"key_1\": 8122,\n \"key_2\": true,\n \"key_3\": 5272,\n \"key_4\": 5374,\n \"key_5\": 8289,\n \"key_6\": 3452,\n \"key_7\": 1015.4036504964004,\n \"key_8\": 3096,\n \"key_9\": true,\n \"key_10\": 9371.427252151556,\n \"key_11\": 9362,\n \"key_12\": false,\n \"key_13\": 3253,\n \"key_14\": \"string\",\n \"key_15\": true,\n \"key_16\": \"string\",\n \"key_17\": false,\n \"key_18\": true,\n \"key_19\": \"string\",\n \"key_20\": 9991.910788469917,\n \"key_21\": 2618,\n \"key_22\": true,\n \"key_23\": true\n },\n \"service_account_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "30b1db3e-9a0f-4789-ad8e-bc1a594bd7ab", + "id": "82257166-a379-410c-820f-5a9bd52d8d6c", "name": "The request is invalid.", "originalRequest": { "url": { @@ -6686,7 +6686,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 6407,\n \"key_2\": true,\n \"key_3\": 150,\n \"key_4\": 6689.019459075854,\n \"key_5\": 6885.474888879439,\n \"key_6\": 1579,\n \"key_7\": \"string\",\n \"key_8\": 4331,\n \"key_9\": 2537,\n \"key_10\": 1764.4048366996178,\n \"key_11\": \"string\",\n \"key_12\": 2001.4646138132975,\n \"key_13\": 4876.585234693643,\n \"key_14\": 256,\n \"key_15\": false,\n \"key_16\": 1748.0123124505465,\n \"key_17\": 6810.795803875795,\n \"key_18\": 8983.176732046015,\n \"key_19\": 4315.458076304457,\n \"key_20\": 9272.402781514611,\n \"key_21\": \"string\",\n \"key_22\": 4251.9488090959885,\n \"key_23\": 3815.4798618500354,\n \"key_24\": 2002.6504878754836,\n \"key_25\": true,\n \"key_26\": 5811,\n \"key_27\": 9904,\n \"key_28\": false,\n \"key_29\": true,\n \"key_30\": \"string\",\n \"key_31\": 6064,\n \"key_32\": 891.7724656835513,\n \"key_33\": \"string\",\n \"key_34\": false,\n \"key_35\": 6903,\n \"key_36\": 2200.593899589676,\n \"key_37\": 3594.6992057302587,\n \"key_38\": 6442.658345818098,\n \"key_39\": false,\n \"key_40\": 1049,\n \"key_41\": 1158,\n \"key_42\": 9866,\n \"key_43\": false,\n \"key_44\": \"string\",\n \"key_45\": false,\n \"key_46\": 1527\n }\n}", + "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 3335,\n \"key_2\": 399,\n \"key_3\": 4996,\n \"key_4\": 2529,\n \"key_5\": \"string\",\n \"key_6\": 7890,\n \"key_7\": 5610,\n \"key_8\": \"string\",\n \"key_9\": 4262.086721363882,\n \"key_10\": true\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6708,7 +6708,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d55ef33f-5f2c-4fe3-a580-5459c52bac6a", + "id": "7c770a03-093b-49a2-b20d-ae30297e9031", "name": "There's no pending reader for the submitted pairing code.", "originalRequest": { "url": { @@ -6748,7 +6748,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 6407,\n \"key_2\": true,\n \"key_3\": 150,\n \"key_4\": 6689.019459075854,\n \"key_5\": 6885.474888879439,\n \"key_6\": 1579,\n \"key_7\": \"string\",\n \"key_8\": 4331,\n \"key_9\": 2537,\n \"key_10\": 1764.4048366996178,\n \"key_11\": \"string\",\n \"key_12\": 2001.4646138132975,\n \"key_13\": 4876.585234693643,\n \"key_14\": 256,\n \"key_15\": false,\n \"key_16\": 1748.0123124505465,\n \"key_17\": 6810.795803875795,\n \"key_18\": 8983.176732046015,\n \"key_19\": 4315.458076304457,\n \"key_20\": 9272.402781514611,\n \"key_21\": \"string\",\n \"key_22\": 4251.9488090959885,\n \"key_23\": 3815.4798618500354,\n \"key_24\": 2002.6504878754836,\n \"key_25\": true,\n \"key_26\": 5811,\n \"key_27\": 9904,\n \"key_28\": false,\n \"key_29\": true,\n \"key_30\": \"string\",\n \"key_31\": 6064,\n \"key_32\": 891.7724656835513,\n \"key_33\": \"string\",\n \"key_34\": false,\n \"key_35\": 6903,\n \"key_36\": 2200.593899589676,\n \"key_37\": 3594.6992057302587,\n \"key_38\": 6442.658345818098,\n \"key_39\": false,\n \"key_40\": 1049,\n \"key_41\": 1158,\n \"key_42\": 9866,\n \"key_43\": false,\n \"key_44\": \"string\",\n \"key_45\": false,\n \"key_46\": 1527\n }\n}", + "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 3335,\n \"key_2\": 399,\n \"key_3\": 4996,\n \"key_4\": 2529,\n \"key_5\": \"string\",\n \"key_6\": 7890,\n \"key_7\": 5610,\n \"key_8\": \"string\",\n \"key_9\": 4262.086721363882,\n \"key_10\": true\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6770,7 +6770,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9dfb029c-6da7-4529-bcae-18973b1acd48", + "id": "f45d5b1c-a6db-4ab7-b7e0-8477cff9fcc7", "name": "The Reader is not in a pending state.", "originalRequest": { "url": { @@ -6810,7 +6810,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 6407,\n \"key_2\": true,\n \"key_3\": 150,\n \"key_4\": 6689.019459075854,\n \"key_5\": 6885.474888879439,\n \"key_6\": 1579,\n \"key_7\": \"string\",\n \"key_8\": 4331,\n \"key_9\": 2537,\n \"key_10\": 1764.4048366996178,\n \"key_11\": \"string\",\n \"key_12\": 2001.4646138132975,\n \"key_13\": 4876.585234693643,\n \"key_14\": 256,\n \"key_15\": false,\n \"key_16\": 1748.0123124505465,\n \"key_17\": 6810.795803875795,\n \"key_18\": 8983.176732046015,\n \"key_19\": 4315.458076304457,\n \"key_20\": 9272.402781514611,\n \"key_21\": \"string\",\n \"key_22\": 4251.9488090959885,\n \"key_23\": 3815.4798618500354,\n \"key_24\": 2002.6504878754836,\n \"key_25\": true,\n \"key_26\": 5811,\n \"key_27\": 9904,\n \"key_28\": false,\n \"key_29\": true,\n \"key_30\": \"string\",\n \"key_31\": 6064,\n \"key_32\": 891.7724656835513,\n \"key_33\": \"string\",\n \"key_34\": false,\n \"key_35\": 6903,\n \"key_36\": 2200.593899589676,\n \"key_37\": 3594.6992057302587,\n \"key_38\": 6442.658345818098,\n \"key_39\": false,\n \"key_40\": 1049,\n \"key_41\": 1158,\n \"key_42\": 9866,\n \"key_43\": false,\n \"key_44\": \"string\",\n \"key_45\": false,\n \"key_46\": 1527\n }\n}", + "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 3335,\n \"key_2\": 399,\n \"key_3\": 4996,\n \"key_4\": 2529,\n \"key_5\": \"string\",\n \"key_6\": 7890,\n \"key_7\": 5610,\n \"key_8\": \"string\",\n \"key_9\": 4262.086721363882,\n \"key_10\": true\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6838,7 +6838,7 @@ } }, { - "id": "92001d86-58b4-4c64-a212-8493d412fa98", + "id": "e09a5426-5c23-4829-85c2-02b12e71a4e1", "name": "Retrieve a Reader", "request": { "name": "Retrieve a Reader", @@ -6910,7 +6910,7 @@ }, "response": [ { - "id": "c9587d29-2e92-4936-bfd8-d93c0dbf5cce", + "id": "33945680-eac3-45b3-9bb1-095a63b6c27c", "name": "Returns a Reader object for a valid identifier.", "originalRequest": { "url": { @@ -6974,12 +6974,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"expired\",\n \"device\": {\n \"identifier\": \"\",\n \"model\": \"virtual-solo\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"metadata\": {\n \"key_0\": 445.6594211113041,\n \"key_1\": 7196.124696833716,\n \"key_2\": 7405,\n \"key_3\": true,\n \"key_4\": 9166,\n \"key_5\": 1787,\n \"key_6\": 1087,\n \"key_7\": 4145,\n \"key_8\": false,\n \"key_9\": 2559.840451745823,\n \"key_10\": 1931,\n \"key_11\": 8652.89909561378,\n \"key_12\": 1362.3917957828423,\n \"key_13\": true,\n \"key_14\": false,\n \"key_15\": \"string\",\n \"key_16\": \"string\",\n \"key_17\": 1826,\n \"key_18\": \"string\",\n \"key_19\": 4396,\n \"key_20\": 4973.933629236815,\n \"key_21\": 2515.259480561205,\n \"key_22\": false,\n \"key_23\": 3756,\n \"key_24\": \"string\",\n \"key_25\": 768,\n \"key_26\": 8532,\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": false,\n \"key_30\": 7274,\n \"key_31\": 804,\n \"key_32\": true,\n \"key_33\": true,\n \"key_34\": \"string\",\n \"key_35\": 8702.875834334065,\n \"key_36\": false,\n \"key_37\": true,\n \"key_38\": false,\n \"key_39\": 2710,\n \"key_40\": 6064,\n \"key_41\": 389.00454800179006,\n \"key_42\": 5275,\n \"key_43\": true,\n \"key_44\": \"string\",\n \"key_45\": 4516,\n \"key_46\": false,\n \"key_47\": 8575.13876639941,\n \"key_48\": \"string\",\n \"key_49\": false,\n \"key_50\": 872.2753735158162,\n \"key_51\": true,\n \"key_52\": 4903.953059138362,\n \"key_53\": false,\n \"key_54\": 1340,\n \"key_55\": 3496,\n \"key_56\": \"string\",\n \"key_57\": 4091,\n \"key_58\": 4458.188212373529,\n \"key_59\": 7902,\n \"key_60\": \"string\",\n \"key_61\": 4120.887850539297,\n \"key_62\": \"string\",\n \"key_63\": true\n },\n \"service_account_id\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"processing\",\n \"device\": {\n \"identifier\": \"\",\n \"model\": \"solo\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"metadata\": {\n \"key_0\": 269,\n \"key_1\": 8122,\n \"key_2\": true,\n \"key_3\": 5272,\n \"key_4\": 5374,\n \"key_5\": 8289,\n \"key_6\": 3452,\n \"key_7\": 1015.4036504964004,\n \"key_8\": 3096,\n \"key_9\": true,\n \"key_10\": 9371.427252151556,\n \"key_11\": 9362,\n \"key_12\": false,\n \"key_13\": 3253,\n \"key_14\": \"string\",\n \"key_15\": true,\n \"key_16\": \"string\",\n \"key_17\": false,\n \"key_18\": true,\n \"key_19\": \"string\",\n \"key_20\": 9991.910788469917,\n \"key_21\": 2618,\n \"key_22\": true,\n \"key_23\": true\n },\n \"service_account_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "632a512b-de2c-43c9-82a7-9204278f1854", + "id": "bc6dc4fc-5600-4b5d-aed0-20aca01d297a", "name": "The requested Reader resource does not exist.", "originalRequest": { "url": { @@ -7054,7 +7054,7 @@ } }, { - "id": "368a0d6e-7bd9-49cb-9288-830c0a3385ac", + "id": "6d0ba91d-ef31-4eae-bdff-fe0e72d81422", "name": "Delete a reader", "request": { "name": "Delete a reader", @@ -7117,7 +7117,7 @@ }, "response": [ { - "id": "bb185b61-dcfe-4b28-ada9-a8d75abb4c09", + "id": "2a1f3c8a-1e28-422c-9f1e-664befa1f0fd", "name": "Returns an empty response if the deletion succeeded.", "originalRequest": { "url": { @@ -7165,7 +7165,7 @@ "_postman_previewlanguage": "text" }, { - "id": "6e6219e9-ecc2-4e95-a06e-661cd6115896", + "id": "26eafc23-fd93-459a-8ffb-a8040b140859", "name": "The requested Reader resource does not exist.", "originalRequest": { "url": { @@ -7231,7 +7231,7 @@ } }, { - "id": "206ed2d2-91c4-4595-bd3b-733a6799a857", + "id": "689b1cb2-c60d-4904-a2f5-b77a19811b34", "name": "Update a Reader", "request": { "name": "Update a Reader", @@ -7287,7 +7287,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 3333,\n \"key_1\": 6661,\n \"key_2\": 2040.61475544268,\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": true,\n \"key_6\": \"string\",\n \"key_7\": 2258,\n \"key_8\": 761.8097510814126,\n \"key_9\": 2296,\n \"key_10\": 7530.104673990257,\n \"key_11\": 3115,\n \"key_12\": 2396,\n \"key_13\": \"string\",\n \"key_14\": 3863.024783594986,\n \"key_15\": 9725.343910646516,\n \"key_16\": 7084,\n \"key_17\": 6170,\n \"key_18\": 7312,\n \"key_19\": 6809.313164737905,\n \"key_20\": 2188,\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": true,\n \"key_24\": 9658,\n \"key_25\": 1762.556809484339,\n \"key_26\": 8871.80090290655,\n \"key_27\": true,\n \"key_28\": true,\n \"key_29\": 8730,\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": \"string\",\n \"key_33\": 5438,\n \"key_34\": false,\n \"key_35\": false,\n \"key_36\": 8309.605158232542,\n \"key_37\": false,\n \"key_38\": 514.4894751200835,\n \"key_39\": 3034,\n \"key_40\": false,\n \"key_41\": \"string\",\n \"key_42\": \"string\",\n \"key_43\": true,\n \"key_44\": 7457,\n \"key_45\": 3942,\n \"key_46\": \"string\",\n \"key_47\": true\n }\n}", + "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 7250,\n \"key_2\": false,\n \"key_3\": \"string\",\n \"key_4\": 4164.834325726397,\n \"key_5\": \"string\",\n \"key_6\": \"string\",\n \"key_7\": 7309.702603202953,\n \"key_8\": \"string\",\n \"key_9\": \"string\",\n \"key_10\": 9730,\n \"key_11\": 3479.789692990789,\n \"key_12\": 5835.916853385436,\n \"key_13\": 1235,\n \"key_14\": 8528,\n \"key_15\": false,\n \"key_16\": 237.24943498555584,\n \"key_17\": 9610.3494914569,\n \"key_18\": \"string\",\n \"key_19\": false,\n \"key_20\": \"string\",\n \"key_21\": 2856.4355394590125,\n \"key_22\": true,\n \"key_23\": 4108,\n \"key_24\": 9775,\n \"key_25\": 1574,\n \"key_26\": false,\n \"key_27\": 8390,\n \"key_28\": 9598,\n \"key_29\": 8121,\n \"key_30\": \"string\",\n \"key_31\": false,\n \"key_32\": true,\n \"key_33\": \"string\",\n \"key_34\": 1573.753837901559,\n \"key_35\": \"string\",\n \"key_36\": 9511.228359281822,\n \"key_37\": 8964.7632641251,\n \"key_38\": \"string\",\n \"key_39\": \"string\",\n \"key_40\": 2076,\n \"key_41\": 9001.715027601624,\n \"key_42\": 3896,\n \"key_43\": false,\n \"key_44\": 87,\n \"key_45\": true,\n \"key_46\": false,\n \"key_47\": 4411.06591545561,\n \"key_48\": false,\n \"key_49\": true,\n \"key_50\": 4952.370932183499,\n \"key_51\": true,\n \"key_52\": false,\n \"key_53\": 622.7375432352833,\n \"key_54\": \"string\",\n \"key_55\": true,\n \"key_56\": false,\n \"key_57\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -7307,7 +7307,7 @@ }, "response": [ { - "id": "3c7d1504-02f5-4759-a3dd-1656a472fec8", + "id": "7e91684e-aa0f-4d48-811a-7f5d663011f0", "name": "Returns the updated Reader object if the update succeeded.", "originalRequest": { "url": { @@ -7358,7 +7358,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 3333,\n \"key_1\": 6661,\n \"key_2\": 2040.61475544268,\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": true,\n \"key_6\": \"string\",\n \"key_7\": 2258,\n \"key_8\": 761.8097510814126,\n \"key_9\": 2296,\n \"key_10\": 7530.104673990257,\n \"key_11\": 3115,\n \"key_12\": 2396,\n \"key_13\": \"string\",\n \"key_14\": 3863.024783594986,\n \"key_15\": 9725.343910646516,\n \"key_16\": 7084,\n \"key_17\": 6170,\n \"key_18\": 7312,\n \"key_19\": 6809.313164737905,\n \"key_20\": 2188,\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": true,\n \"key_24\": 9658,\n \"key_25\": 1762.556809484339,\n \"key_26\": 8871.80090290655,\n \"key_27\": true,\n \"key_28\": true,\n \"key_29\": 8730,\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": \"string\",\n \"key_33\": 5438,\n \"key_34\": false,\n \"key_35\": false,\n \"key_36\": 8309.605158232542,\n \"key_37\": false,\n \"key_38\": 514.4894751200835,\n \"key_39\": 3034,\n \"key_40\": false,\n \"key_41\": \"string\",\n \"key_42\": \"string\",\n \"key_43\": true,\n \"key_44\": 7457,\n \"key_45\": 3942,\n \"key_46\": \"string\",\n \"key_47\": true\n }\n}", + "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 7250,\n \"key_2\": false,\n \"key_3\": \"string\",\n \"key_4\": 4164.834325726397,\n \"key_5\": \"string\",\n \"key_6\": \"string\",\n \"key_7\": 7309.702603202953,\n \"key_8\": \"string\",\n \"key_9\": \"string\",\n \"key_10\": 9730,\n \"key_11\": 3479.789692990789,\n \"key_12\": 5835.916853385436,\n \"key_13\": 1235,\n \"key_14\": 8528,\n \"key_15\": false,\n \"key_16\": 237.24943498555584,\n \"key_17\": 9610.3494914569,\n \"key_18\": \"string\",\n \"key_19\": false,\n \"key_20\": \"string\",\n \"key_21\": 2856.4355394590125,\n \"key_22\": true,\n \"key_23\": 4108,\n \"key_24\": 9775,\n \"key_25\": 1574,\n \"key_26\": false,\n \"key_27\": 8390,\n \"key_28\": 9598,\n \"key_29\": 8121,\n \"key_30\": \"string\",\n \"key_31\": false,\n \"key_32\": true,\n \"key_33\": \"string\",\n \"key_34\": 1573.753837901559,\n \"key_35\": \"string\",\n \"key_36\": 9511.228359281822,\n \"key_37\": 8964.7632641251,\n \"key_38\": \"string\",\n \"key_39\": \"string\",\n \"key_40\": 2076,\n \"key_41\": 9001.715027601624,\n \"key_42\": 3896,\n \"key_43\": false,\n \"key_44\": 87,\n \"key_45\": true,\n \"key_46\": false,\n \"key_47\": 4411.06591545561,\n \"key_48\": false,\n \"key_49\": true,\n \"key_50\": 4952.370932183499,\n \"key_51\": true,\n \"key_52\": false,\n \"key_53\": 622.7375432352833,\n \"key_54\": \"string\",\n \"key_55\": true,\n \"key_56\": false,\n \"key_57\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -7375,12 +7375,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"expired\",\n \"device\": {\n \"identifier\": \"\",\n \"model\": \"virtual-solo\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"metadata\": {\n \"key_0\": 445.6594211113041,\n \"key_1\": 7196.124696833716,\n \"key_2\": 7405,\n \"key_3\": true,\n \"key_4\": 9166,\n \"key_5\": 1787,\n \"key_6\": 1087,\n \"key_7\": 4145,\n \"key_8\": false,\n \"key_9\": 2559.840451745823,\n \"key_10\": 1931,\n \"key_11\": 8652.89909561378,\n \"key_12\": 1362.3917957828423,\n \"key_13\": true,\n \"key_14\": false,\n \"key_15\": \"string\",\n \"key_16\": \"string\",\n \"key_17\": 1826,\n \"key_18\": \"string\",\n \"key_19\": 4396,\n \"key_20\": 4973.933629236815,\n \"key_21\": 2515.259480561205,\n \"key_22\": false,\n \"key_23\": 3756,\n \"key_24\": \"string\",\n \"key_25\": 768,\n \"key_26\": 8532,\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": false,\n \"key_30\": 7274,\n \"key_31\": 804,\n \"key_32\": true,\n \"key_33\": true,\n \"key_34\": \"string\",\n \"key_35\": 8702.875834334065,\n \"key_36\": false,\n \"key_37\": true,\n \"key_38\": false,\n \"key_39\": 2710,\n \"key_40\": 6064,\n \"key_41\": 389.00454800179006,\n \"key_42\": 5275,\n \"key_43\": true,\n \"key_44\": \"string\",\n \"key_45\": 4516,\n \"key_46\": false,\n \"key_47\": 8575.13876639941,\n \"key_48\": \"string\",\n \"key_49\": false,\n \"key_50\": 872.2753735158162,\n \"key_51\": true,\n \"key_52\": 4903.953059138362,\n \"key_53\": false,\n \"key_54\": 1340,\n \"key_55\": 3496,\n \"key_56\": \"string\",\n \"key_57\": 4091,\n \"key_58\": 4458.188212373529,\n \"key_59\": 7902,\n \"key_60\": \"string\",\n \"key_61\": 4120.887850539297,\n \"key_62\": \"string\",\n \"key_63\": true\n },\n \"service_account_id\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"processing\",\n \"device\": {\n \"identifier\": \"\",\n \"model\": \"solo\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"metadata\": {\n \"key_0\": 269,\n \"key_1\": 8122,\n \"key_2\": true,\n \"key_3\": 5272,\n \"key_4\": 5374,\n \"key_5\": 8289,\n \"key_6\": 3452,\n \"key_7\": 1015.4036504964004,\n \"key_8\": 3096,\n \"key_9\": true,\n \"key_10\": 9371.427252151556,\n \"key_11\": 9362,\n \"key_12\": false,\n \"key_13\": 3253,\n \"key_14\": \"string\",\n \"key_15\": true,\n \"key_16\": \"string\",\n \"key_17\": false,\n \"key_18\": true,\n \"key_19\": \"string\",\n \"key_20\": 9991.910788469917,\n \"key_21\": 2618,\n \"key_22\": true,\n \"key_23\": true\n },\n \"service_account_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8e056dea-5394-473f-953b-e575f56ed239", + "id": "ab1d7c56-433d-4d89-aa17-795dd3478ae9", "name": "The request isn't sufficiently authorized to modify the reader.", "originalRequest": { "url": { @@ -7431,7 +7431,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 3333,\n \"key_1\": 6661,\n \"key_2\": 2040.61475544268,\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": true,\n \"key_6\": \"string\",\n \"key_7\": 2258,\n \"key_8\": 761.8097510814126,\n \"key_9\": 2296,\n \"key_10\": 7530.104673990257,\n \"key_11\": 3115,\n \"key_12\": 2396,\n \"key_13\": \"string\",\n \"key_14\": 3863.024783594986,\n \"key_15\": 9725.343910646516,\n \"key_16\": 7084,\n \"key_17\": 6170,\n \"key_18\": 7312,\n \"key_19\": 6809.313164737905,\n \"key_20\": 2188,\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": true,\n \"key_24\": 9658,\n \"key_25\": 1762.556809484339,\n \"key_26\": 8871.80090290655,\n \"key_27\": true,\n \"key_28\": true,\n \"key_29\": 8730,\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": \"string\",\n \"key_33\": 5438,\n \"key_34\": false,\n \"key_35\": false,\n \"key_36\": 8309.605158232542,\n \"key_37\": false,\n \"key_38\": 514.4894751200835,\n \"key_39\": 3034,\n \"key_40\": false,\n \"key_41\": \"string\",\n \"key_42\": \"string\",\n \"key_43\": true,\n \"key_44\": 7457,\n \"key_45\": 3942,\n \"key_46\": \"string\",\n \"key_47\": true\n }\n}", + "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 7250,\n \"key_2\": false,\n \"key_3\": \"string\",\n \"key_4\": 4164.834325726397,\n \"key_5\": \"string\",\n \"key_6\": \"string\",\n \"key_7\": 7309.702603202953,\n \"key_8\": \"string\",\n \"key_9\": \"string\",\n \"key_10\": 9730,\n \"key_11\": 3479.789692990789,\n \"key_12\": 5835.916853385436,\n \"key_13\": 1235,\n \"key_14\": 8528,\n \"key_15\": false,\n \"key_16\": 237.24943498555584,\n \"key_17\": 9610.3494914569,\n \"key_18\": \"string\",\n \"key_19\": false,\n \"key_20\": \"string\",\n \"key_21\": 2856.4355394590125,\n \"key_22\": true,\n \"key_23\": 4108,\n \"key_24\": 9775,\n \"key_25\": 1574,\n \"key_26\": false,\n \"key_27\": 8390,\n \"key_28\": 9598,\n \"key_29\": 8121,\n \"key_30\": \"string\",\n \"key_31\": false,\n \"key_32\": true,\n \"key_33\": \"string\",\n \"key_34\": 1573.753837901559,\n \"key_35\": \"string\",\n \"key_36\": 9511.228359281822,\n \"key_37\": 8964.7632641251,\n \"key_38\": \"string\",\n \"key_39\": \"string\",\n \"key_40\": 2076,\n \"key_41\": 9001.715027601624,\n \"key_42\": 3896,\n \"key_43\": false,\n \"key_44\": 87,\n \"key_45\": true,\n \"key_46\": false,\n \"key_47\": 4411.06591545561,\n \"key_48\": false,\n \"key_49\": true,\n \"key_50\": 4952.370932183499,\n \"key_51\": true,\n \"key_52\": false,\n \"key_53\": 622.7375432352833,\n \"key_54\": \"string\",\n \"key_55\": true,\n \"key_56\": false,\n \"key_57\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -7453,7 +7453,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1d293b0b-d4f6-452c-8968-6450948cf756", + "id": "8ade96de-6acc-4e5e-9c3c-cb8f04072296", "name": "The requested Reader resource does not exist.", "originalRequest": { "url": { @@ -7504,7 +7504,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 3333,\n \"key_1\": 6661,\n \"key_2\": 2040.61475544268,\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": true,\n \"key_6\": \"string\",\n \"key_7\": 2258,\n \"key_8\": 761.8097510814126,\n \"key_9\": 2296,\n \"key_10\": 7530.104673990257,\n \"key_11\": 3115,\n \"key_12\": 2396,\n \"key_13\": \"string\",\n \"key_14\": 3863.024783594986,\n \"key_15\": 9725.343910646516,\n \"key_16\": 7084,\n \"key_17\": 6170,\n \"key_18\": 7312,\n \"key_19\": 6809.313164737905,\n \"key_20\": 2188,\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": true,\n \"key_24\": 9658,\n \"key_25\": 1762.556809484339,\n \"key_26\": 8871.80090290655,\n \"key_27\": true,\n \"key_28\": true,\n \"key_29\": 8730,\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": \"string\",\n \"key_33\": 5438,\n \"key_34\": false,\n \"key_35\": false,\n \"key_36\": 8309.605158232542,\n \"key_37\": false,\n \"key_38\": 514.4894751200835,\n \"key_39\": 3034,\n \"key_40\": false,\n \"key_41\": \"string\",\n \"key_42\": \"string\",\n \"key_43\": true,\n \"key_44\": 7457,\n \"key_45\": 3942,\n \"key_46\": \"string\",\n \"key_47\": true\n }\n}", + "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 7250,\n \"key_2\": false,\n \"key_3\": \"string\",\n \"key_4\": 4164.834325726397,\n \"key_5\": \"string\",\n \"key_6\": \"string\",\n \"key_7\": 7309.702603202953,\n \"key_8\": \"string\",\n \"key_9\": \"string\",\n \"key_10\": 9730,\n \"key_11\": 3479.789692990789,\n \"key_12\": 5835.916853385436,\n \"key_13\": 1235,\n \"key_14\": 8528,\n \"key_15\": false,\n \"key_16\": 237.24943498555584,\n \"key_17\": 9610.3494914569,\n \"key_18\": \"string\",\n \"key_19\": false,\n \"key_20\": \"string\",\n \"key_21\": 2856.4355394590125,\n \"key_22\": true,\n \"key_23\": 4108,\n \"key_24\": 9775,\n \"key_25\": 1574,\n \"key_26\": false,\n \"key_27\": 8390,\n \"key_28\": 9598,\n \"key_29\": 8121,\n \"key_30\": \"string\",\n \"key_31\": false,\n \"key_32\": true,\n \"key_33\": \"string\",\n \"key_34\": 1573.753837901559,\n \"key_35\": \"string\",\n \"key_36\": 9511.228359281822,\n \"key_37\": 8964.7632641251,\n \"key_38\": \"string\",\n \"key_39\": \"string\",\n \"key_40\": 2076,\n \"key_41\": 9001.715027601624,\n \"key_42\": 3896,\n \"key_43\": false,\n \"key_44\": 87,\n \"key_45\": true,\n \"key_46\": false,\n \"key_47\": 4411.06591545561,\n \"key_48\": false,\n \"key_49\": true,\n \"key_50\": 4952.370932183499,\n \"key_51\": true,\n \"key_52\": false,\n \"key_53\": 622.7375432352833,\n \"key_54\": \"string\",\n \"key_55\": true,\n \"key_56\": false,\n \"key_57\": false\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -7532,7 +7532,7 @@ } }, { - "id": "6bda7ad2-5d64-4167-85a7-919dff9c67f1", + "id": "44267e17-cf2a-4054-9a47-11ac0afce15d", "name": "Create a Reader Checkout", "request": { "name": "Create a Reader Checkout", @@ -7589,7 +7589,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"aade\": {\n \"provider_id\": \"\",\n \"signature\": \"\",\n \"signature_data\": \"\"\n },\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\",\n \"foreign_transaction_id\": \"\",\n \"tags\": {\n \"key_0\": 810.9224291165118,\n \"key_1\": false,\n \"key_2\": \"string\"\n }\n },\n \"card_type\": \"debit\",\n \"description\": \"\",\n \"installments\": \"\",\n \"return_url\": \"\",\n \"tip_rates\": [\n \"\",\n \"\"\n ],\n \"tip_timeout\": 30\n}", + "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"aade\": {\n \"provider_id\": \"\",\n \"signature\": \"\",\n \"signature_data\": \"\"\n },\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\",\n \"foreign_transaction_id\": \"\",\n \"tags\": {\n \"key_0\": 5131.954284307148,\n \"key_1\": 2984.613096254183,\n \"key_2\": 8985.3821617592,\n \"key_3\": 5952\n }\n },\n \"card_type\": \"debit\",\n \"description\": \"\",\n \"installments\": \"\",\n \"return_url\": \"\",\n \"tip_rates\": [\n \"\",\n \"\"\n ],\n \"tip_timeout\": 30\n}", "options": { "raw": { "headerFamily": "json", @@ -7609,7 +7609,7 @@ }, "response": [ { - "id": "5bfb5ff6-32f8-49e9-8b6f-1a4fdd1a1e7b", + "id": "4edcad1b-1fa5-481e-8f0b-69d373f8bfaa", "name": "The Checkout got successfully created for the given reader.", "originalRequest": { "url": { @@ -7661,7 +7661,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"aade\": {\n \"provider_id\": \"\",\n \"signature\": \"\",\n \"signature_data\": \"\"\n },\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\",\n \"foreign_transaction_id\": \"\",\n \"tags\": {\n \"key_0\": 810.9224291165118,\n \"key_1\": false,\n \"key_2\": \"string\"\n }\n },\n \"card_type\": \"debit\",\n \"description\": \"\",\n \"installments\": \"\",\n \"return_url\": \"\",\n \"tip_rates\": [\n \"\",\n \"\"\n ],\n \"tip_timeout\": 30\n}", + "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"aade\": {\n \"provider_id\": \"\",\n \"signature\": \"\",\n \"signature_data\": \"\"\n },\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\",\n \"foreign_transaction_id\": \"\",\n \"tags\": {\n \"key_0\": 5131.954284307148,\n \"key_1\": 2984.613096254183,\n \"key_2\": 8985.3821617592,\n \"key_3\": 5952\n }\n },\n \"card_type\": \"debit\",\n \"description\": \"\",\n \"installments\": \"\",\n \"return_url\": \"\",\n \"tip_rates\": [\n \"\",\n \"\"\n ],\n \"tip_timeout\": 30\n}", "options": { "raw": { "headerFamily": "json", @@ -7683,7 +7683,7 @@ "_postman_previewlanguage": "json" }, { - "id": "34e1b234-373b-4397-8fad-ae8c4db96b14", + "id": "197e9026-41ff-4cac-89cc-d86a2001704e", "name": "Response when given params (or one of them) are invalid", "originalRequest": { "url": { @@ -7735,7 +7735,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"aade\": {\n \"provider_id\": \"\",\n \"signature\": \"\",\n \"signature_data\": \"\"\n },\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\",\n \"foreign_transaction_id\": \"\",\n \"tags\": {\n \"key_0\": 810.9224291165118,\n \"key_1\": false,\n \"key_2\": \"string\"\n }\n },\n \"card_type\": \"debit\",\n \"description\": \"\",\n \"installments\": \"\",\n \"return_url\": \"\",\n \"tip_rates\": [\n \"\",\n \"\"\n ],\n \"tip_timeout\": 30\n}", + "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"aade\": {\n \"provider_id\": \"\",\n \"signature\": \"\",\n \"signature_data\": \"\"\n },\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\",\n \"foreign_transaction_id\": \"\",\n \"tags\": {\n \"key_0\": 5131.954284307148,\n \"key_1\": 2984.613096254183,\n \"key_2\": 8985.3821617592,\n \"key_3\": 5952\n }\n },\n \"card_type\": \"debit\",\n \"description\": \"\",\n \"installments\": \"\",\n \"return_url\": \"\",\n \"tip_rates\": [\n \"\",\n \"\"\n ],\n \"tip_timeout\": 30\n}", "options": { "raw": { "headerFamily": "json", @@ -7757,7 +7757,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f1f4740f-ef10-44b6-8f3f-0f73f0d4d983", + "id": "93452232-b852-446c-adaf-96c4f9a826df", "name": "Unauthorized", "originalRequest": { "url": { @@ -7809,7 +7809,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"aade\": {\n \"provider_id\": \"\",\n \"signature\": \"\",\n \"signature_data\": \"\"\n },\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\",\n \"foreign_transaction_id\": \"\",\n \"tags\": {\n \"key_0\": 810.9224291165118,\n \"key_1\": false,\n \"key_2\": \"string\"\n }\n },\n \"card_type\": \"debit\",\n \"description\": \"\",\n \"installments\": \"\",\n \"return_url\": \"\",\n \"tip_rates\": [\n \"\",\n \"\"\n ],\n \"tip_timeout\": 30\n}", + "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"aade\": {\n \"provider_id\": \"\",\n \"signature\": \"\",\n \"signature_data\": \"\"\n },\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\",\n \"foreign_transaction_id\": \"\",\n \"tags\": {\n \"key_0\": 5131.954284307148,\n \"key_1\": 2984.613096254183,\n \"key_2\": 8985.3821617592,\n \"key_3\": 5952\n }\n },\n \"card_type\": \"debit\",\n \"description\": \"\",\n \"installments\": \"\",\n \"return_url\": \"\",\n \"tip_rates\": [\n \"\",\n \"\"\n ],\n \"tip_timeout\": 30\n}", "options": { "raw": { "headerFamily": "json", @@ -7831,7 +7831,7 @@ "_postman_previewlanguage": "json" }, { - "id": "130a21cd-d69c-4db7-843c-75cec99576ad", + "id": "fcac4f03-388e-481c-ba28-a8582ccdedfb", "name": "Response when given reader is not found", "originalRequest": { "url": { @@ -7883,7 +7883,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"aade\": {\n \"provider_id\": \"\",\n \"signature\": \"\",\n \"signature_data\": \"\"\n },\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\",\n \"foreign_transaction_id\": \"\",\n \"tags\": {\n \"key_0\": 810.9224291165118,\n \"key_1\": false,\n \"key_2\": \"string\"\n }\n },\n \"card_type\": \"debit\",\n \"description\": \"\",\n \"installments\": \"\",\n \"return_url\": \"\",\n \"tip_rates\": [\n \"\",\n \"\"\n ],\n \"tip_timeout\": 30\n}", + "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"aade\": {\n \"provider_id\": \"\",\n \"signature\": \"\",\n \"signature_data\": \"\"\n },\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\",\n \"foreign_transaction_id\": \"\",\n \"tags\": {\n \"key_0\": 5131.954284307148,\n \"key_1\": 2984.613096254183,\n \"key_2\": 8985.3821617592,\n \"key_3\": 5952\n }\n },\n \"card_type\": \"debit\",\n \"description\": \"\",\n \"installments\": \"\",\n \"return_url\": \"\",\n \"tip_rates\": [\n \"\",\n \"\"\n ],\n \"tip_timeout\": 30\n}", "options": { "raw": { "headerFamily": "json", @@ -7905,7 +7905,7 @@ "_postman_previewlanguage": "json" }, { - "id": "70afd6f0-b394-4081-88dc-8d2b76d88e30", + "id": "61929c7e-9411-4b68-9d20-9a59782f7def", "name": "Response when given params (or one of them) are invalid", "originalRequest": { "url": { @@ -7957,7 +7957,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"aade\": {\n \"provider_id\": \"\",\n \"signature\": \"\",\n \"signature_data\": \"\"\n },\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\",\n \"foreign_transaction_id\": \"\",\n \"tags\": {\n \"key_0\": 810.9224291165118,\n \"key_1\": false,\n \"key_2\": \"string\"\n }\n },\n \"card_type\": \"debit\",\n \"description\": \"\",\n \"installments\": \"\",\n \"return_url\": \"\",\n \"tip_rates\": [\n \"\",\n \"\"\n ],\n \"tip_timeout\": 30\n}", + "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"aade\": {\n \"provider_id\": \"\",\n \"signature\": \"\",\n \"signature_data\": \"\"\n },\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\",\n \"foreign_transaction_id\": \"\",\n \"tags\": {\n \"key_0\": 5131.954284307148,\n \"key_1\": 2984.613096254183,\n \"key_2\": 8985.3821617592,\n \"key_3\": 5952\n }\n },\n \"card_type\": \"debit\",\n \"description\": \"\",\n \"installments\": \"\",\n \"return_url\": \"\",\n \"tip_rates\": [\n \"\",\n \"\"\n ],\n \"tip_timeout\": 30\n}", "options": { "raw": { "headerFamily": "json", @@ -7974,7 +7974,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": {\n \"key_0\": 6573,\n \"key_1\": 6222.277166852155\n }\n}", + "body": "{\n \"errors\": {\n \"key_0\": 1983.4497170400932,\n \"key_1\": 9431.303167428368,\n \"key_2\": \"string\",\n \"key_3\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -7985,7 +7985,7 @@ } }, { - "id": "6fa5826a-b3bd-4619-b9e3-02985096ddd1", + "id": "7a7b6dc3-0d36-4956-b1c9-003a05ee6f83", "name": "Get a Reader Status", "request": { "name": "Get a Reader Status", @@ -8049,7 +8049,7 @@ }, "response": [ { - "id": "62875695-bbfb-4819-871a-f7154af187f2", + "id": "ad7c145b-0d80-47bb-a098-09d8be880edd", "name": "Response with the device status.", "originalRequest": { "url": { @@ -8105,12 +8105,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"status\": \"OFFLINE\",\n \"battery_level\": \"\",\n \"battery_temperature\": \"\",\n \"connection_type\": \"lte\",\n \"firmware_version\": \"\",\n \"last_activity\": \"\",\n \"state\": \"WAITING_FOR_SIGNATURE\"\n }\n}", + "body": "{\n \"data\": {\n \"status\": \"ONLINE\",\n \"battery_level\": \"\",\n \"battery_temperature\": \"\",\n \"connection_type\": \"umts\",\n \"firmware_version\": \"\",\n \"last_activity\": \"\",\n \"state\": \"WAITING_FOR_CARD\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "3b6d4e42-28e2-43f5-82d5-e06ffc40e135", + "id": "e1c104d2-0d93-4768-84e3-02342416f283", "name": "Response when given params (or one of them) are invalid", "originalRequest": { "url": { @@ -8166,12 +8166,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": {\n \"type\": \"INVALID_USER_AGENT\",\n \"detail\": \"\"\n }\n}", + "body": "{\n \"errors\": {\n \"type\": \"NOT_ENOUGH_UNPAID_PAYOUTS\",\n \"detail\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ea45c2d6-437d-400b-9444-c60c627a9c39", + "id": "67ad28d7-6372-47a7-b660-1845c6eb6438", "name": "Response when given merchant's token is invalid", "originalRequest": { "url": { @@ -8232,7 +8232,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ebf6c00a-5164-45e9-b41f-06c403a899ac", + "id": "7811afbc-7c00-4cc9-a29b-3ffdb91cade3", "name": "Response when given reader is not found", "originalRequest": { "url": { @@ -8299,7 +8299,7 @@ } }, { - "id": "9da0d416-ce52-4c89-9908-93e34d8caa37", + "id": "6e3daf65-9215-4c64-9332-ce93de50c571", "name": "Terminate a Reader Checkout", "request": { "name": "Terminate a Reader Checkout", @@ -8376,7 +8376,7 @@ }, "response": [ { - "id": "42eac191-4ac7-425c-84bd-6b7596023870", + "id": "47f8f87b-7d28-4003-ad98-9ce39eb0ecc7", "name": "Response when given params (or one of them) are invalid", "originalRequest": { "url": { @@ -8450,7 +8450,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f8e88f1a-d660-44a9-8454-5ba4ca1c1c33", + "id": "cbe7120d-d517-44a4-b92b-7e820b266881", "name": "Unauthorized", "originalRequest": { "url": { @@ -8524,7 +8524,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2e6ce010-444d-4d75-814a-f134f099e7d9", + "id": "061702dc-9a8c-4bc1-a941-a3c1781a1b8f", "name": "Response when given reader is not found", "originalRequest": { "url": { @@ -8598,7 +8598,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6bd56257-5b38-4fd0-9f36-b92348e4ba25", + "id": "d3e31cc7-5c3b-4f06-bc11-f698535b9c35", "name": "Response when given params (or one of them) are invalid", "originalRequest": { "url": { @@ -8667,7 +8667,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": {\n \"key_0\": 9323\n }\n}", + "body": "{\n \"errors\": {\n \"key_0\": true,\n \"key_1\": 8486,\n \"key_2\": 1075.6506208586482,\n \"key_3\": 9447.860714352368,\n \"key_4\": 704\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -8678,7 +8678,7 @@ } }, { - "id": "70eca842-7dae-42a4-8f37-921a35874883", + "id": "26c14657-7409-4e3a-82b6-b708403a4882", "name": "Get a Reader Checkout", "request": { "name": "Get a Reader Checkout", @@ -8753,7 +8753,7 @@ }, "response": [ { - "id": "fed10a1e-014e-4281-ae89-86bc28500585", + "id": "f0ed907d-2011-4b9e-b1f5-cc20e1a48edf", "name": "The Checkout got successfully retrieved for the given reader.", "originalRequest": { "url": { @@ -8820,12 +8820,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"checkout_id\": \"\",\n \"client_transaction_id\": \"\",\n \"reader_serial_number\": \"\",\n \"payment_type\": \"pix\",\n \"card_type\": \"debit\",\n \"reader_firmware_version\": \"\",\n \"installments\": \"\",\n \"payment_status\": \"\",\n \"valid_until\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"pending\",\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"payment_failure_reason\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"checkout_id\": \"\",\n \"client_transaction_id\": \"\",\n \"reader_serial_number\": \"\",\n \"payment_type\": \"card\",\n \"card_type\": \"debit\",\n \"reader_firmware_version\": \"\",\n \"installments\": \"\",\n \"payment_status\": \"\",\n \"valid_until\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"pending\",\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"payment_failure_reason\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "130ce75c-fc48-41e1-abd2-763d625e8b61", + "id": "fe009757-9d01-447c-94a5-6e90d4d3691d", "name": "Unauthorized", "originalRequest": { "url": { @@ -8897,7 +8897,7 @@ "_postman_previewlanguage": "json" }, { - "id": "019028e0-8a04-4820-aaba-6763f2ad6269", + "id": "af37bd28-3224-42ec-94bb-47e696a58bce", "name": "Response when given reader or checkout is not found", "originalRequest": { "url": { @@ -8981,7 +8981,7 @@ "description": "Endpoints to manage account members. Members are users that have membership within merchant accounts.", "item": [ { - "id": "4e365537-2006-4f2f-b550-b9c8687930b6", + "id": "ff12eb4a-1184-4c99-b518-01b962e1a9d8", "name": "List members", "request": { "name": "List members", @@ -9052,7 +9052,7 @@ "type": "text/plain" }, "key": "status", - "value": "disabled" + "value": "expired" }, { "disabled": false, @@ -9106,7 +9106,7 @@ }, "response": [ { - "id": "092ea316-2232-4b65-a4bd-55840a57291d", + "id": "b815abb2-eaf0-4f20-afec-2340e6f4571b", "name": "Returns a list of Member objects.", "originalRequest": { "url": { @@ -9172,7 +9172,7 @@ "type": "text/plain" }, "key": "status", - "value": "disabled" + "value": "expired" }, { "disabled": false, @@ -9214,12 +9214,12 @@ "value": "application/json" } ], - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"unknown\",\n \"user\": {\n \"id\": \"\",\n \"type\": \"system_account\",\n \"email\": \"\",\n \"mfa_on_login_enabled\": \"\",\n \"virtual_user\": \"\",\n \"service_account_user\": \"\",\n \"disabled_at\": \"\",\n \"nickname\": \"\",\n \"picture\": \"\",\n \"classic\": {\n \"user_id\": \"\"\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": 7554,\n \"key_1\": 2436.195116036932,\n \"key_2\": 8337,\n \"key_3\": 8764.80848368883,\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": 6895,\n \"key_7\": false,\n \"key_8\": true,\n \"key_9\": 6959.7130822517665,\n \"key_10\": true,\n \"key_11\": 1159,\n \"key_12\": 1513.0090262233975,\n \"key_13\": 3055,\n \"key_14\": 8496.490737713975,\n \"key_15\": 4105,\n \"key_16\": \"string\",\n \"key_17\": 4867.361908744605,\n \"key_18\": \"string\",\n \"key_19\": \"string\",\n \"key_20\": \"string\",\n \"key_21\": 8081.069269094763,\n \"key_22\": \"string\",\n \"key_23\": \"string\",\n \"key_24\": 9938.32773812312,\n \"key_25\": \"string\",\n \"key_26\": 5849,\n \"key_27\": 561,\n \"key_28\": true\n },\n \"attributes\": {\n \"key_0\": 836,\n \"key_1\": 2650\n }\n },\n {\n \"id\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"unknown\",\n \"user\": {\n \"id\": \"\",\n \"type\": \"managed_user\",\n \"email\": \"\",\n \"mfa_on_login_enabled\": \"\",\n \"virtual_user\": \"\",\n \"service_account_user\": \"\",\n \"disabled_at\": \"\",\n \"nickname\": \"\",\n \"picture\": \"\",\n \"classic\": {\n \"user_id\": \"\"\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": 8236,\n \"key_1\": 3284,\n \"key_2\": \"string\",\n \"key_3\": 5580.368050192703,\n \"key_4\": \"string\",\n \"key_5\": false,\n \"key_6\": \"string\",\n \"key_7\": 6061,\n \"key_8\": 7163,\n \"key_9\": 8651.749723453346,\n \"key_10\": false,\n \"key_11\": 7240.924639237453,\n \"key_12\": false,\n \"key_13\": \"string\",\n \"key_14\": \"string\",\n \"key_15\": 9963.393102225828,\n \"key_16\": 485.4309788366673,\n \"key_17\": false,\n \"key_18\": \"string\",\n \"key_19\": 2025,\n \"key_20\": true,\n \"key_21\": 9329.59310709592,\n \"key_22\": false,\n \"key_23\": \"string\",\n \"key_24\": 3353.6912239529547,\n \"key_25\": true,\n \"key_26\": 989,\n \"key_27\": 6183,\n \"key_28\": false,\n \"key_29\": \"string\",\n \"key_30\": false,\n \"key_31\": true,\n \"key_32\": 2383.131419582947,\n \"key_33\": false,\n \"key_34\": 9144.422143370117,\n \"key_35\": 6899,\n \"key_36\": 662,\n \"key_37\": 7902,\n \"key_38\": \"string\",\n \"key_39\": 5753,\n \"key_40\": false,\n \"key_41\": false,\n \"key_42\": 3603,\n \"key_43\": \"string\",\n \"key_44\": false,\n \"key_45\": 9616,\n \"key_46\": true,\n \"key_47\": 9678.197750216626,\n \"key_48\": false,\n \"key_49\": \"string\",\n \"key_50\": true,\n \"key_51\": \"string\",\n \"key_52\": 8965,\n \"key_53\": false,\n \"key_54\": 350,\n \"key_55\": 9549.175230815998,\n \"key_56\": 7613,\n \"key_57\": \"string\"\n },\n \"attributes\": {\n \"key_0\": \"string\",\n \"key_1\": 9399.825541133227\n }\n }\n ],\n \"total_count\": \"\"\n}", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"expired\",\n \"user\": {\n \"id\": \"\",\n \"type\": \"service_account\",\n \"email\": \"\",\n \"mfa_on_login_enabled\": \"\",\n \"virtual_user\": \"\",\n \"service_account_user\": \"\",\n \"disabled_at\": \"\",\n \"nickname\": \"\",\n \"picture\": \"\",\n \"classic\": {\n \"user_id\": \"\"\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": 3863.116449965025,\n \"key_1\": 15.21073716570065,\n \"key_2\": \"string\",\n \"key_3\": true,\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": 9430.130101563676,\n \"key_7\": true,\n \"key_8\": 7177.500490158477,\n \"key_9\": 3863.1188235331006,\n \"key_10\": false,\n \"key_11\": \"string\",\n \"key_12\": 2149,\n \"key_13\": 8267,\n \"key_14\": false,\n \"key_15\": 8370,\n \"key_16\": 73.47421599007032,\n \"key_17\": \"string\",\n \"key_18\": true,\n \"key_19\": 5380.4451817329755,\n \"key_20\": false,\n \"key_21\": \"string\"\n },\n \"attributes\": {\n \"key_0\": false\n }\n },\n {\n \"id\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"pending\",\n \"user\": {\n \"id\": \"\",\n \"type\": \"managed_user\",\n \"email\": \"\",\n \"mfa_on_login_enabled\": \"\",\n \"virtual_user\": \"\",\n \"service_account_user\": \"\",\n \"disabled_at\": \"\",\n \"nickname\": \"\",\n \"picture\": \"\",\n \"classic\": {\n \"user_id\": \"\"\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": 7711,\n \"key_1\": 9171,\n \"key_2\": 298.20001409734954,\n \"key_3\": 1603.9606373754834,\n \"key_4\": \"string\",\n \"key_5\": 3576,\n \"key_6\": \"string\"\n },\n \"attributes\": {\n \"key_0\": true\n }\n }\n ],\n \"total_count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "90fe7fc8-85fe-42f4-bb46-083bd0a1de6b", + "id": "401105a1-e4e8-4953-bba4-bb49c0c2711a", "name": "Merchant not found.", "originalRequest": { "url": { @@ -9285,7 +9285,7 @@ "type": "text/plain" }, "key": "status", - "value": "disabled" + "value": "expired" }, { "disabled": false, @@ -9338,7 +9338,7 @@ } }, { - "id": "7c240ba6-cad0-4f33-85ba-16b7bf0f52c2", + "id": "2904d277-3fbd-4cfb-b7c7-4df098a59e40", "name": "Create a member", "request": { "name": "Create a member", @@ -9383,7 +9383,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 6559,\n \"key_2\": 7444.872661885446,\n \"key_3\": \"string\",\n \"key_4\": 6977.5103029719385,\n \"key_5\": 364.4020373419554,\n \"key_6\": 8057,\n \"key_7\": 9347,\n \"key_8\": \"string\",\n \"key_9\": 5036,\n \"key_10\": true,\n \"key_11\": 8347,\n \"key_12\": 2208,\n \"key_13\": 8693.978223654862,\n \"key_14\": 6285.4303626248775,\n \"key_15\": 9502,\n \"key_16\": 7961.736647259503,\n \"key_17\": 8719.406005411698,\n \"key_18\": false,\n \"key_19\": \"string\",\n \"key_20\": false,\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": 2984,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": 7077,\n \"key_27\": \"string\",\n \"key_28\": false,\n \"key_29\": 3451,\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": 378.54482847360816,\n \"key_33\": 4208,\n \"key_34\": 7856.1790900796,\n \"key_35\": false,\n \"key_36\": 8251.940528326526,\n \"key_37\": false,\n \"key_38\": true,\n \"key_39\": 7744,\n \"key_40\": \"string\",\n \"key_41\": 865.5908609249718\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": false\n }\n}", + "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": 634,\n \"key_4\": false,\n \"key_5\": 4205.645209679636,\n \"key_6\": \"string\",\n \"key_7\": false,\n \"key_8\": \"string\",\n \"key_9\": 3693,\n \"key_10\": false,\n \"key_11\": \"string\",\n \"key_12\": true,\n \"key_13\": 7665,\n \"key_14\": true,\n \"key_15\": false,\n \"key_16\": 5242.45578636602,\n \"key_17\": \"string\",\n \"key_18\": true,\n \"key_19\": \"string\",\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": 9967,\n \"key_23\": true,\n \"key_24\": true,\n \"key_25\": false,\n \"key_26\": 4624,\n \"key_27\": true,\n \"key_28\": true,\n \"key_29\": true,\n \"key_30\": 315,\n \"key_31\": 6416,\n \"key_32\": true\n },\n \"attributes\": {\n \"key_0\": 3308.4902260488657,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -9403,7 +9403,7 @@ }, "response": [ { - "id": "aa6cfcb9-85ae-421c-9eb3-b5d281987002", + "id": "330b9dc5-e73b-4d40-b4ad-fb169ec7404f", "name": "Returns the Member object if the creation succeeded.", "originalRequest": { "url": { @@ -9443,7 +9443,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 6559,\n \"key_2\": 7444.872661885446,\n \"key_3\": \"string\",\n \"key_4\": 6977.5103029719385,\n \"key_5\": 364.4020373419554,\n \"key_6\": 8057,\n \"key_7\": 9347,\n \"key_8\": \"string\",\n \"key_9\": 5036,\n \"key_10\": true,\n \"key_11\": 8347,\n \"key_12\": 2208,\n \"key_13\": 8693.978223654862,\n \"key_14\": 6285.4303626248775,\n \"key_15\": 9502,\n \"key_16\": 7961.736647259503,\n \"key_17\": 8719.406005411698,\n \"key_18\": false,\n \"key_19\": \"string\",\n \"key_20\": false,\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": 2984,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": 7077,\n \"key_27\": \"string\",\n \"key_28\": false,\n \"key_29\": 3451,\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": 378.54482847360816,\n \"key_33\": 4208,\n \"key_34\": 7856.1790900796,\n \"key_35\": false,\n \"key_36\": 8251.940528326526,\n \"key_37\": false,\n \"key_38\": true,\n \"key_39\": 7744,\n \"key_40\": \"string\",\n \"key_41\": 865.5908609249718\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": false\n }\n}", + "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": 634,\n \"key_4\": false,\n \"key_5\": 4205.645209679636,\n \"key_6\": \"string\",\n \"key_7\": false,\n \"key_8\": \"string\",\n \"key_9\": 3693,\n \"key_10\": false,\n \"key_11\": \"string\",\n \"key_12\": true,\n \"key_13\": 7665,\n \"key_14\": true,\n \"key_15\": false,\n \"key_16\": 5242.45578636602,\n \"key_17\": \"string\",\n \"key_18\": true,\n \"key_19\": \"string\",\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": 9967,\n \"key_23\": true,\n \"key_24\": true,\n \"key_25\": false,\n \"key_26\": 4624,\n \"key_27\": true,\n \"key_28\": true,\n \"key_29\": true,\n \"key_30\": 315,\n \"key_31\": 6416,\n \"key_32\": true\n },\n \"attributes\": {\n \"key_0\": 3308.4902260488657,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -9460,12 +9460,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"accepted\",\n \"user\": {\n \"id\": \"\",\n \"type\": \"system_account\",\n \"email\": \"\",\n \"mfa_on_login_enabled\": \"\",\n \"virtual_user\": \"\",\n \"service_account_user\": \"\",\n \"disabled_at\": \"\",\n \"nickname\": \"\",\n \"picture\": \"\",\n \"classic\": {\n \"user_id\": \"\"\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 2743.0012979680796,\n \"key_2\": false,\n \"key_3\": 429.7644264696099,\n \"key_4\": 8744,\n \"key_5\": \"string\",\n \"key_6\": \"string\",\n \"key_7\": false,\n \"key_8\": true,\n \"key_9\": 5813.8574165610435,\n \"key_10\": 3643,\n \"key_11\": 6290.422511024521,\n \"key_12\": \"string\",\n \"key_13\": false,\n \"key_14\": 3164,\n \"key_15\": false,\n \"key_16\": true,\n \"key_17\": 8524.505379465796,\n \"key_18\": 5319,\n \"key_19\": 198.5697964781541,\n \"key_20\": false,\n \"key_21\": true,\n \"key_22\": 8797,\n \"key_23\": 7196,\n \"key_24\": 7873,\n \"key_25\": 8842.223436117665,\n \"key_26\": 6683.667450080659,\n \"key_27\": true,\n \"key_28\": 7895,\n \"key_29\": false,\n \"key_30\": true,\n \"key_31\": true,\n \"key_32\": 3786.9862459598603,\n \"key_33\": 8979,\n \"key_34\": 6809,\n \"key_35\": true,\n \"key_36\": 246,\n \"key_37\": 3112.199520193466,\n \"key_38\": 6412,\n \"key_39\": 5802,\n \"key_40\": false,\n \"key_41\": 134.71339834498997,\n \"key_42\": 4187,\n \"key_43\": \"string\",\n \"key_44\": true,\n \"key_45\": 7855.176308866203,\n \"key_46\": \"string\",\n \"key_47\": 5465\n },\n \"attributes\": {\n \"key_0\": 435,\n \"key_1\": 1179\n }\n}", + "body": "{\n \"id\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"expired\",\n \"user\": {\n \"id\": \"\",\n \"type\": \"user\",\n \"email\": \"\",\n \"mfa_on_login_enabled\": \"\",\n \"virtual_user\": \"\",\n \"service_account_user\": \"\",\n \"disabled_at\": \"\",\n \"nickname\": \"\",\n \"picture\": \"\",\n \"classic\": {\n \"user_id\": \"\"\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 6160.179061415592,\n \"key_2\": 3315.1040749425074,\n \"key_3\": false,\n \"key_4\": 6157,\n \"key_5\": 1520.5983830742475,\n \"key_6\": true,\n \"key_7\": true,\n \"key_8\": \"string\",\n \"key_9\": \"string\",\n \"key_10\": 9804,\n \"key_11\": \"string\",\n \"key_12\": 4951.306017368184,\n \"key_13\": true,\n \"key_14\": 194,\n \"key_15\": \"string\",\n \"key_16\": 8059.958256709898,\n \"key_17\": \"string\",\n \"key_18\": 5625.582886444214,\n \"key_19\": false,\n \"key_20\": \"string\",\n \"key_21\": 6809.3056857397305,\n \"key_22\": false,\n \"key_23\": true,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": true,\n \"key_27\": true,\n \"key_28\": 2090.057101300464,\n \"key_29\": true,\n \"key_30\": 5456,\n \"key_31\": 6789,\n \"key_32\": 7756.406660719621,\n \"key_33\": 6187,\n \"key_34\": \"string\",\n \"key_35\": 8868.039483064536,\n \"key_36\": \"string\"\n },\n \"attributes\": {\n \"key_0\": true,\n \"key_1\": 8301.104135759446\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7baa5b55-4366-43ba-9988-9eafa08f53d1", + "id": "10379ae0-49bc-4a98-b7e2-abe1c14404a9", "name": "Invalid request.", "originalRequest": { "url": { @@ -9505,7 +9505,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 6559,\n \"key_2\": 7444.872661885446,\n \"key_3\": \"string\",\n \"key_4\": 6977.5103029719385,\n \"key_5\": 364.4020373419554,\n \"key_6\": 8057,\n \"key_7\": 9347,\n \"key_8\": \"string\",\n \"key_9\": 5036,\n \"key_10\": true,\n \"key_11\": 8347,\n \"key_12\": 2208,\n \"key_13\": 8693.978223654862,\n \"key_14\": 6285.4303626248775,\n \"key_15\": 9502,\n \"key_16\": 7961.736647259503,\n \"key_17\": 8719.406005411698,\n \"key_18\": false,\n \"key_19\": \"string\",\n \"key_20\": false,\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": 2984,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": 7077,\n \"key_27\": \"string\",\n \"key_28\": false,\n \"key_29\": 3451,\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": 378.54482847360816,\n \"key_33\": 4208,\n \"key_34\": 7856.1790900796,\n \"key_35\": false,\n \"key_36\": 8251.940528326526,\n \"key_37\": false,\n \"key_38\": true,\n \"key_39\": 7744,\n \"key_40\": \"string\",\n \"key_41\": 865.5908609249718\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": false\n }\n}", + "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": 634,\n \"key_4\": false,\n \"key_5\": 4205.645209679636,\n \"key_6\": \"string\",\n \"key_7\": false,\n \"key_8\": \"string\",\n \"key_9\": 3693,\n \"key_10\": false,\n \"key_11\": \"string\",\n \"key_12\": true,\n \"key_13\": 7665,\n \"key_14\": true,\n \"key_15\": false,\n \"key_16\": 5242.45578636602,\n \"key_17\": \"string\",\n \"key_18\": true,\n \"key_19\": \"string\",\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": 9967,\n \"key_23\": true,\n \"key_24\": true,\n \"key_25\": false,\n \"key_26\": 4624,\n \"key_27\": true,\n \"key_28\": true,\n \"key_29\": true,\n \"key_30\": 315,\n \"key_31\": 6416,\n \"key_32\": true\n },\n \"attributes\": {\n \"key_0\": 3308.4902260488657,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -9527,7 +9527,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3f34ef36-06d9-4a54-8372-90f5bffbff31", + "id": "7bf4794f-e03e-462e-9d34-0bc18bde5b49", "name": "Merchant not found.", "originalRequest": { "url": { @@ -9567,7 +9567,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 6559,\n \"key_2\": 7444.872661885446,\n \"key_3\": \"string\",\n \"key_4\": 6977.5103029719385,\n \"key_5\": 364.4020373419554,\n \"key_6\": 8057,\n \"key_7\": 9347,\n \"key_8\": \"string\",\n \"key_9\": 5036,\n \"key_10\": true,\n \"key_11\": 8347,\n \"key_12\": 2208,\n \"key_13\": 8693.978223654862,\n \"key_14\": 6285.4303626248775,\n \"key_15\": 9502,\n \"key_16\": 7961.736647259503,\n \"key_17\": 8719.406005411698,\n \"key_18\": false,\n \"key_19\": \"string\",\n \"key_20\": false,\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": 2984,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": 7077,\n \"key_27\": \"string\",\n \"key_28\": false,\n \"key_29\": 3451,\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": 378.54482847360816,\n \"key_33\": 4208,\n \"key_34\": 7856.1790900796,\n \"key_35\": false,\n \"key_36\": 8251.940528326526,\n \"key_37\": false,\n \"key_38\": true,\n \"key_39\": 7744,\n \"key_40\": \"string\",\n \"key_41\": 865.5908609249718\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": false\n }\n}", + "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": 634,\n \"key_4\": false,\n \"key_5\": 4205.645209679636,\n \"key_6\": \"string\",\n \"key_7\": false,\n \"key_8\": \"string\",\n \"key_9\": 3693,\n \"key_10\": false,\n \"key_11\": \"string\",\n \"key_12\": true,\n \"key_13\": 7665,\n \"key_14\": true,\n \"key_15\": false,\n \"key_16\": 5242.45578636602,\n \"key_17\": \"string\",\n \"key_18\": true,\n \"key_19\": \"string\",\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": 9967,\n \"key_23\": true,\n \"key_24\": true,\n \"key_25\": false,\n \"key_26\": 4624,\n \"key_27\": true,\n \"key_28\": true,\n \"key_29\": true,\n \"key_30\": 315,\n \"key_31\": 6416,\n \"key_32\": true\n },\n \"attributes\": {\n \"key_0\": 3308.4902260488657,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -9589,7 +9589,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ef9ee74d-c55f-424d-a9c2-634f21656ef7", + "id": "507ecf76-b7b8-42c3-999d-d25d1bbca916", "name": "Too many invitations were sent to that user and the rate limit was exceeded. The Retry-After header indicates when the client can retry.", "originalRequest": { "url": { @@ -9629,7 +9629,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 6559,\n \"key_2\": 7444.872661885446,\n \"key_3\": \"string\",\n \"key_4\": 6977.5103029719385,\n \"key_5\": 364.4020373419554,\n \"key_6\": 8057,\n \"key_7\": 9347,\n \"key_8\": \"string\",\n \"key_9\": 5036,\n \"key_10\": true,\n \"key_11\": 8347,\n \"key_12\": 2208,\n \"key_13\": 8693.978223654862,\n \"key_14\": 6285.4303626248775,\n \"key_15\": 9502,\n \"key_16\": 7961.736647259503,\n \"key_17\": 8719.406005411698,\n \"key_18\": false,\n \"key_19\": \"string\",\n \"key_20\": false,\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": 2984,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": 7077,\n \"key_27\": \"string\",\n \"key_28\": false,\n \"key_29\": 3451,\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": 378.54482847360816,\n \"key_33\": 4208,\n \"key_34\": 7856.1790900796,\n \"key_35\": false,\n \"key_36\": 8251.940528326526,\n \"key_37\": false,\n \"key_38\": true,\n \"key_39\": 7744,\n \"key_40\": \"string\",\n \"key_41\": 865.5908609249718\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": false\n }\n}", + "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": 634,\n \"key_4\": false,\n \"key_5\": 4205.645209679636,\n \"key_6\": \"string\",\n \"key_7\": false,\n \"key_8\": \"string\",\n \"key_9\": 3693,\n \"key_10\": false,\n \"key_11\": \"string\",\n \"key_12\": true,\n \"key_13\": 7665,\n \"key_14\": true,\n \"key_15\": false,\n \"key_16\": 5242.45578636602,\n \"key_17\": \"string\",\n \"key_18\": true,\n \"key_19\": \"string\",\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": 9967,\n \"key_23\": true,\n \"key_24\": true,\n \"key_25\": false,\n \"key_26\": 4624,\n \"key_27\": true,\n \"key_28\": true,\n \"key_29\": true,\n \"key_30\": 315,\n \"key_31\": 6416,\n \"key_32\": true\n },\n \"attributes\": {\n \"key_0\": 3308.4902260488657,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -9657,7 +9657,7 @@ } }, { - "id": "3bf26b91-cfb4-4c3f-be4a-15341975aeb5", + "id": "dff31c25-5a1c-41b3-a55f-aae0bc18e695", "name": "Retrieve a member", "request": { "name": "Retrieve a member", @@ -9720,7 +9720,7 @@ }, "response": [ { - "id": "117d9cea-758d-4e86-8827-58dacf239b96", + "id": "7897c907-00e4-4710-98e5-a972a356503b", "name": "Returns the Member object for a valid identifier.", "originalRequest": { "url": { @@ -9775,12 +9775,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"accepted\",\n \"user\": {\n \"id\": \"\",\n \"type\": \"system_account\",\n \"email\": \"\",\n \"mfa_on_login_enabled\": \"\",\n \"virtual_user\": \"\",\n \"service_account_user\": \"\",\n \"disabled_at\": \"\",\n \"nickname\": \"\",\n \"picture\": \"\",\n \"classic\": {\n \"user_id\": \"\"\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 2743.0012979680796,\n \"key_2\": false,\n \"key_3\": 429.7644264696099,\n \"key_4\": 8744,\n \"key_5\": \"string\",\n \"key_6\": \"string\",\n \"key_7\": false,\n \"key_8\": true,\n \"key_9\": 5813.8574165610435,\n \"key_10\": 3643,\n \"key_11\": 6290.422511024521,\n \"key_12\": \"string\",\n \"key_13\": false,\n \"key_14\": 3164,\n \"key_15\": false,\n \"key_16\": true,\n \"key_17\": 8524.505379465796,\n \"key_18\": 5319,\n \"key_19\": 198.5697964781541,\n \"key_20\": false,\n \"key_21\": true,\n \"key_22\": 8797,\n \"key_23\": 7196,\n \"key_24\": 7873,\n \"key_25\": 8842.223436117665,\n \"key_26\": 6683.667450080659,\n \"key_27\": true,\n \"key_28\": 7895,\n \"key_29\": false,\n \"key_30\": true,\n \"key_31\": true,\n \"key_32\": 3786.9862459598603,\n \"key_33\": 8979,\n \"key_34\": 6809,\n \"key_35\": true,\n \"key_36\": 246,\n \"key_37\": 3112.199520193466,\n \"key_38\": 6412,\n \"key_39\": 5802,\n \"key_40\": false,\n \"key_41\": 134.71339834498997,\n \"key_42\": 4187,\n \"key_43\": \"string\",\n \"key_44\": true,\n \"key_45\": 7855.176308866203,\n \"key_46\": \"string\",\n \"key_47\": 5465\n },\n \"attributes\": {\n \"key_0\": 435,\n \"key_1\": 1179\n }\n}", + "body": "{\n \"id\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"expired\",\n \"user\": {\n \"id\": \"\",\n \"type\": \"user\",\n \"email\": \"\",\n \"mfa_on_login_enabled\": \"\",\n \"virtual_user\": \"\",\n \"service_account_user\": \"\",\n \"disabled_at\": \"\",\n \"nickname\": \"\",\n \"picture\": \"\",\n \"classic\": {\n \"user_id\": \"\"\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 6160.179061415592,\n \"key_2\": 3315.1040749425074,\n \"key_3\": false,\n \"key_4\": 6157,\n \"key_5\": 1520.5983830742475,\n \"key_6\": true,\n \"key_7\": true,\n \"key_8\": \"string\",\n \"key_9\": \"string\",\n \"key_10\": 9804,\n \"key_11\": \"string\",\n \"key_12\": 4951.306017368184,\n \"key_13\": true,\n \"key_14\": 194,\n \"key_15\": \"string\",\n \"key_16\": 8059.958256709898,\n \"key_17\": \"string\",\n \"key_18\": 5625.582886444214,\n \"key_19\": false,\n \"key_20\": \"string\",\n \"key_21\": 6809.3056857397305,\n \"key_22\": false,\n \"key_23\": true,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": true,\n \"key_27\": true,\n \"key_28\": 2090.057101300464,\n \"key_29\": true,\n \"key_30\": 5456,\n \"key_31\": 6789,\n \"key_32\": 7756.406660719621,\n \"key_33\": 6187,\n \"key_34\": \"string\",\n \"key_35\": 8868.039483064536,\n \"key_36\": \"string\"\n },\n \"attributes\": {\n \"key_0\": true,\n \"key_1\": 8301.104135759446\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4c4db26e-7f08-4b4d-af01-00ca2dc522d9", + "id": "e4878a85-0f41-4404-aa87-063c5508997c", "name": "Merchant or member not found.", "originalRequest": { "url": { @@ -9846,7 +9846,7 @@ } }, { - "id": "8b9ce434-9e08-40a4-966b-c73fbb72a4dd", + "id": "a2c27b63-7fb6-49c8-bd74-b600e4c3e700", "name": "Update a member", "request": { "name": "Update a member", @@ -9902,7 +9902,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"roles\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 6496,\n \"key_1\": 8256,\n \"key_2\": \"string\",\n \"key_3\": true,\n \"key_4\": 3908,\n \"key_5\": false,\n \"key_6\": false,\n \"key_7\": 3105.295911602548,\n \"key_8\": 67.64027253679528\n },\n \"attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "raw": "{\n \"roles\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 3270.834118071724,\n \"key_2\": 1663.141236688568,\n \"key_3\": 5708,\n \"key_4\": 5140,\n \"key_5\": \"string\",\n \"key_6\": 8255,\n \"key_7\": 5086.938410878932,\n \"key_8\": 9454.002389876176,\n \"key_9\": \"string\",\n \"key_10\": false,\n \"key_11\": 1194.166383242936,\n \"key_12\": 1249.9830484053075,\n \"key_13\": false,\n \"key_14\": \"string\",\n \"key_15\": false,\n \"key_16\": 9587.861105025948\n },\n \"attributes\": {\n \"key_0\": 5331,\n \"key_1\": \"string\"\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -9922,7 +9922,7 @@ }, "response": [ { - "id": "a39323a2-9254-44b6-9b90-cca555099ce4", + "id": "db016212-9328-4ca2-9d6a-fd00cc333cac", "name": "Returns the updated Member object if the update succeeded.", "originalRequest": { "url": { @@ -9973,7 +9973,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"roles\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 6496,\n \"key_1\": 8256,\n \"key_2\": \"string\",\n \"key_3\": true,\n \"key_4\": 3908,\n \"key_5\": false,\n \"key_6\": false,\n \"key_7\": 3105.295911602548,\n \"key_8\": 67.64027253679528\n },\n \"attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "raw": "{\n \"roles\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 3270.834118071724,\n \"key_2\": 1663.141236688568,\n \"key_3\": 5708,\n \"key_4\": 5140,\n \"key_5\": \"string\",\n \"key_6\": 8255,\n \"key_7\": 5086.938410878932,\n \"key_8\": 9454.002389876176,\n \"key_9\": \"string\",\n \"key_10\": false,\n \"key_11\": 1194.166383242936,\n \"key_12\": 1249.9830484053075,\n \"key_13\": false,\n \"key_14\": \"string\",\n \"key_15\": false,\n \"key_16\": 9587.861105025948\n },\n \"attributes\": {\n \"key_0\": 5331,\n \"key_1\": \"string\"\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -9990,12 +9990,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"accepted\",\n \"user\": {\n \"id\": \"\",\n \"type\": \"system_account\",\n \"email\": \"\",\n \"mfa_on_login_enabled\": \"\",\n \"virtual_user\": \"\",\n \"service_account_user\": \"\",\n \"disabled_at\": \"\",\n \"nickname\": \"\",\n \"picture\": \"\",\n \"classic\": {\n \"user_id\": \"\"\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 2743.0012979680796,\n \"key_2\": false,\n \"key_3\": 429.7644264696099,\n \"key_4\": 8744,\n \"key_5\": \"string\",\n \"key_6\": \"string\",\n \"key_7\": false,\n \"key_8\": true,\n \"key_9\": 5813.8574165610435,\n \"key_10\": 3643,\n \"key_11\": 6290.422511024521,\n \"key_12\": \"string\",\n \"key_13\": false,\n \"key_14\": 3164,\n \"key_15\": false,\n \"key_16\": true,\n \"key_17\": 8524.505379465796,\n \"key_18\": 5319,\n \"key_19\": 198.5697964781541,\n \"key_20\": false,\n \"key_21\": true,\n \"key_22\": 8797,\n \"key_23\": 7196,\n \"key_24\": 7873,\n \"key_25\": 8842.223436117665,\n \"key_26\": 6683.667450080659,\n \"key_27\": true,\n \"key_28\": 7895,\n \"key_29\": false,\n \"key_30\": true,\n \"key_31\": true,\n \"key_32\": 3786.9862459598603,\n \"key_33\": 8979,\n \"key_34\": 6809,\n \"key_35\": true,\n \"key_36\": 246,\n \"key_37\": 3112.199520193466,\n \"key_38\": 6412,\n \"key_39\": 5802,\n \"key_40\": false,\n \"key_41\": 134.71339834498997,\n \"key_42\": 4187,\n \"key_43\": \"string\",\n \"key_44\": true,\n \"key_45\": 7855.176308866203,\n \"key_46\": \"string\",\n \"key_47\": 5465\n },\n \"attributes\": {\n \"key_0\": 435,\n \"key_1\": 1179\n }\n}", + "body": "{\n \"id\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"expired\",\n \"user\": {\n \"id\": \"\",\n \"type\": \"user\",\n \"email\": \"\",\n \"mfa_on_login_enabled\": \"\",\n \"virtual_user\": \"\",\n \"service_account_user\": \"\",\n \"disabled_at\": \"\",\n \"nickname\": \"\",\n \"picture\": \"\",\n \"classic\": {\n \"user_id\": \"\"\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 6160.179061415592,\n \"key_2\": 3315.1040749425074,\n \"key_3\": false,\n \"key_4\": 6157,\n \"key_5\": 1520.5983830742475,\n \"key_6\": true,\n \"key_7\": true,\n \"key_8\": \"string\",\n \"key_9\": \"string\",\n \"key_10\": 9804,\n \"key_11\": \"string\",\n \"key_12\": 4951.306017368184,\n \"key_13\": true,\n \"key_14\": 194,\n \"key_15\": \"string\",\n \"key_16\": 8059.958256709898,\n \"key_17\": \"string\",\n \"key_18\": 5625.582886444214,\n \"key_19\": false,\n \"key_20\": \"string\",\n \"key_21\": 6809.3056857397305,\n \"key_22\": false,\n \"key_23\": true,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": true,\n \"key_27\": true,\n \"key_28\": 2090.057101300464,\n \"key_29\": true,\n \"key_30\": 5456,\n \"key_31\": 6789,\n \"key_32\": 7756.406660719621,\n \"key_33\": 6187,\n \"key_34\": \"string\",\n \"key_35\": 8868.039483064536,\n \"key_36\": \"string\"\n },\n \"attributes\": {\n \"key_0\": true,\n \"key_1\": 8301.104135759446\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ce4d2ec5-ec0a-4836-b16e-96fc61da736e", + "id": "cfaea5a8-1aac-49eb-946a-eb4d9b5f5e29", "name": "Cannot set password or nickname for an invited user.", "originalRequest": { "url": { @@ -10046,7 +10046,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"roles\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 6496,\n \"key_1\": 8256,\n \"key_2\": \"string\",\n \"key_3\": true,\n \"key_4\": 3908,\n \"key_5\": false,\n \"key_6\": false,\n \"key_7\": 3105.295911602548,\n \"key_8\": 67.64027253679528\n },\n \"attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "raw": "{\n \"roles\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 3270.834118071724,\n \"key_2\": 1663.141236688568,\n \"key_3\": 5708,\n \"key_4\": 5140,\n \"key_5\": \"string\",\n \"key_6\": 8255,\n \"key_7\": 5086.938410878932,\n \"key_8\": 9454.002389876176,\n \"key_9\": \"string\",\n \"key_10\": false,\n \"key_11\": 1194.166383242936,\n \"key_12\": 1249.9830484053075,\n \"key_13\": false,\n \"key_14\": \"string\",\n \"key_15\": false,\n \"key_16\": 9587.861105025948\n },\n \"attributes\": {\n \"key_0\": 5331,\n \"key_1\": \"string\"\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10068,7 +10068,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6639f3eb-21df-4050-9d2e-a5cdd186f94b", + "id": "482febb8-3265-4abf-ac26-030bac56775e", "name": "Cannot change password for managed user. Password was already used before.", "originalRequest": { "url": { @@ -10119,7 +10119,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"roles\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 6496,\n \"key_1\": 8256,\n \"key_2\": \"string\",\n \"key_3\": true,\n \"key_4\": 3908,\n \"key_5\": false,\n \"key_6\": false,\n \"key_7\": 3105.295911602548,\n \"key_8\": 67.64027253679528\n },\n \"attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "raw": "{\n \"roles\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 3270.834118071724,\n \"key_2\": 1663.141236688568,\n \"key_3\": 5708,\n \"key_4\": 5140,\n \"key_5\": \"string\",\n \"key_6\": 8255,\n \"key_7\": 5086.938410878932,\n \"key_8\": 9454.002389876176,\n \"key_9\": \"string\",\n \"key_10\": false,\n \"key_11\": 1194.166383242936,\n \"key_12\": 1249.9830484053075,\n \"key_13\": false,\n \"key_14\": \"string\",\n \"key_15\": false,\n \"key_16\": 9587.861105025948\n },\n \"attributes\": {\n \"key_0\": 5331,\n \"key_1\": \"string\"\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10141,7 +10141,7 @@ "_postman_previewlanguage": "json" }, { - "id": "68c9619e-62d6-463a-9d1d-25d6b6eebe46", + "id": "122dfc42-728b-4a7a-8e87-756cf9f33191", "name": "Merchant or member not found.", "originalRequest": { "url": { @@ -10192,7 +10192,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"roles\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 6496,\n \"key_1\": 8256,\n \"key_2\": \"string\",\n \"key_3\": true,\n \"key_4\": 3908,\n \"key_5\": false,\n \"key_6\": false,\n \"key_7\": 3105.295911602548,\n \"key_8\": 67.64027253679528\n },\n \"attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "raw": "{\n \"roles\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 3270.834118071724,\n \"key_2\": 1663.141236688568,\n \"key_3\": 5708,\n \"key_4\": 5140,\n \"key_5\": \"string\",\n \"key_6\": 8255,\n \"key_7\": 5086.938410878932,\n \"key_8\": 9454.002389876176,\n \"key_9\": \"string\",\n \"key_10\": false,\n \"key_11\": 1194.166383242936,\n \"key_12\": 1249.9830484053075,\n \"key_13\": false,\n \"key_14\": \"string\",\n \"key_15\": false,\n \"key_16\": 9587.861105025948\n },\n \"attributes\": {\n \"key_0\": 5331,\n \"key_1\": \"string\"\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10214,7 +10214,7 @@ "_postman_previewlanguage": "json" }, { - "id": "67c24a47-8fbf-4d9c-9b98-6e6bdc0ba77b", + "id": "b9bbf32c-87b5-4996-b236-0c4c7d2ebb0b", "name": "Cannot update member as some data conflict with existing members.", "originalRequest": { "url": { @@ -10265,7 +10265,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"roles\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 6496,\n \"key_1\": 8256,\n \"key_2\": \"string\",\n \"key_3\": true,\n \"key_4\": 3908,\n \"key_5\": false,\n \"key_6\": false,\n \"key_7\": 3105.295911602548,\n \"key_8\": 67.64027253679528\n },\n \"attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "raw": "{\n \"roles\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 3270.834118071724,\n \"key_2\": 1663.141236688568,\n \"key_3\": 5708,\n \"key_4\": 5140,\n \"key_5\": \"string\",\n \"key_6\": 8255,\n \"key_7\": 5086.938410878932,\n \"key_8\": 9454.002389876176,\n \"key_9\": \"string\",\n \"key_10\": false,\n \"key_11\": 1194.166383242936,\n \"key_12\": 1249.9830484053075,\n \"key_13\": false,\n \"key_14\": \"string\",\n \"key_15\": false,\n \"key_16\": 9587.861105025948\n },\n \"attributes\": {\n \"key_0\": 5331,\n \"key_1\": \"string\"\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10293,7 +10293,7 @@ } }, { - "id": "6c174b9d-4447-49fb-ab7e-18fae5477080", + "id": "89f59a27-4ff0-4c02-a467-dca60666a1b7", "name": "Delete a member", "request": { "name": "Delete a member", @@ -10356,7 +10356,7 @@ }, "response": [ { - "id": "dc3ac0e4-2e55-4f24-a6a7-df216d1fc09b", + "id": "72f34108-2c01-45dd-b67e-7a2891b521a2", "name": "Returns an empty response if the deletion succeeded.", "originalRequest": { "url": { @@ -10404,7 +10404,7 @@ "_postman_previewlanguage": "text" }, { - "id": "245369b4-45f6-44d9-8a7d-27f28822e709", + "id": "63a5640a-346f-403c-9695-58e411d6faed", "name": "Member deletion was forbidden.", "originalRequest": { "url": { @@ -10464,7 +10464,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ab58af3a-47dc-42a9-90c6-06e41ef2bd19", + "id": "7b725151-7958-4107-8ed3-1e885b7b7d81", "name": "Merchant or member not found.", "originalRequest": { "url": { @@ -10536,7 +10536,7 @@ "description": "Endpoints to manage user's memberships. Memberships are used to connect the user to merchant accounts and to grant them access to the merchant's resources via roles.", "item": [ { - "id": "c342dbc4-476a-4f07-a26d-4ddf2eaacccf", + "id": "bed131b5-79ba-4891-9a4f-f240e5ce792e", "name": "List memberships", "request": { "name": "List memberships", @@ -10587,7 +10587,7 @@ "type": "text/plain" }, "key": "status", - "value": "disabled" + "value": "expired" }, { "disabled": false, @@ -10684,7 +10684,7 @@ }, "response": [ { - "id": "cf36498a-bbaf-4965-8a27-b8a35ea2a007", + "id": "344c3bba-e0f4-4065-85d1-7248122da204", "name": "Returns a list of Membership objects.", "originalRequest": { "url": { @@ -10730,7 +10730,7 @@ "type": "text/plain" }, "key": "status", - "value": "disabled" + "value": "expired" }, { "disabled": false, @@ -10815,12 +10815,12 @@ "value": "application/json" } ], - "body": "{\n \"total_count\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"resource_id\": \"\",\n \"type\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"disabled\",\n \"resource\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo\": \"\",\n \"attributes\": {\n \"key_0\": \"string\"\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 1848.7267830692144,\n \"key_2\": false,\n \"key_3\": false,\n \"key_4\": 6829,\n \"key_5\": false,\n \"key_6\": 4633.6136020425765,\n \"key_7\": \"string\",\n \"key_8\": 5133,\n \"key_9\": \"string\",\n \"key_10\": 843,\n \"key_11\": false,\n \"key_12\": 1399,\n \"key_13\": true,\n \"key_14\": 3503,\n \"key_15\": 5326,\n \"key_16\": 1158.6997252996011,\n \"key_17\": false,\n \"key_18\": \"string\",\n \"key_19\": true,\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": 4519,\n \"key_23\": 9158.232862556897,\n \"key_24\": 4428,\n \"key_25\": 5882,\n \"key_26\": 7054,\n \"key_27\": true,\n \"key_28\": 1308.6999953115376,\n \"key_29\": 3799,\n \"key_30\": 8069,\n \"key_31\": 2603,\n \"key_32\": true,\n \"key_33\": 7259,\n \"key_34\": 2575,\n \"key_35\": 4672.93436343982,\n \"key_36\": 7995,\n \"key_37\": true,\n \"key_38\": false,\n \"key_39\": false,\n \"key_40\": \"string\",\n \"key_41\": \"string\",\n \"key_42\": 6423,\n \"key_43\": \"string\",\n \"key_44\": 6666\n },\n \"attributes\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"id\": \"\",\n \"resource_id\": \"\",\n \"type\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"expired\",\n \"resource\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo\": \"\",\n \"attributes\": {\n \"key_0\": 2911.3805662302016\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": 2630,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": 9799.30798895646,\n \"key_5\": 1677,\n \"key_6\": 8429.257203789073,\n \"key_7\": \"string\",\n \"key_8\": 279\n },\n \"attributes\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 8129\n }\n }\n ]\n}", + "body": "{\n \"total_count\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"resource_id\": \"\",\n \"type\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"pending\",\n \"resource\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo\": \"\",\n \"attributes\": {\n \"key_0\": \"string\"\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": false,\n \"key_2\": true,\n \"key_3\": true,\n \"key_4\": 6898.50704947697,\n \"key_5\": 1442.2951643785998,\n \"key_6\": \"string\",\n \"key_7\": 3325,\n \"key_8\": \"string\",\n \"key_9\": true,\n \"key_10\": 3839,\n \"key_11\": 470,\n \"key_12\": true,\n \"key_13\": \"string\",\n \"key_14\": 7544,\n \"key_15\": false,\n \"key_16\": \"string\",\n \"key_17\": \"string\",\n \"key_18\": false,\n \"key_19\": 9992,\n \"key_20\": true,\n \"key_21\": 7613.277444752742,\n \"key_22\": 7256.156295455671,\n \"key_23\": true,\n \"key_24\": 7613\n },\n \"attributes\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"id\": \"\",\n \"resource_id\": \"\",\n \"type\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"unknown\",\n \"resource\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo\": \"\",\n \"attributes\": {\n \"key_0\": 8920,\n \"key_1\": 7599.135049649637\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": 8044.131897563327,\n \"key_1\": 2441,\n \"key_2\": true,\n \"key_3\": 2367,\n \"key_4\": 8577.897903191802,\n \"key_5\": false,\n \"key_6\": 5102\n },\n \"attributes\": {\n \"key_0\": 7790.715320006272\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ffa16a27-d5db-4008-9628-44d2f6f75687", + "id": "908767c0-b354-4431-91aa-f338d6dc52ab", "name": "Invalid query parameter combination.", "originalRequest": { "url": { @@ -10866,7 +10866,7 @@ "type": "text/plain" }, "key": "status", - "value": "disabled" + "value": "expired" }, { "disabled": false, @@ -10956,7 +10956,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ede21486-010d-4014-a034-3097e38631a2", + "id": "fad195c9-b739-4136-a579-db0cae50d728", "name": "Authentication failed or missing required scope.", "originalRequest": { "url": { @@ -11002,7 +11002,7 @@ "type": "text/plain" }, "key": "status", - "value": "disabled" + "value": "expired" }, { "disabled": false, @@ -11104,7 +11104,7 @@ "description": "Endpoints to manage custom roles. Custom roles allow you to tailor roles from individual permissions to match your needs. Once created, you can assign your custom roles to your merchant account members using the memberships.", "item": [ { - "id": "445d2eba-b47a-4156-91e5-d37b1b139624", + "id": "ad882f9a-2fb6-4c42-87e2-0b6403236ca4", "name": "List roles", "request": { "name": "List roles", @@ -11156,7 +11156,7 @@ }, "response": [ { - "id": "6fe8af76-61db-48fc-b99b-3577cc36ab4b", + "id": "d189642d-8ad3-4713-8fcb-691572cda70d", "name": "Returns a list of Role objects.", "originalRequest": { "url": { @@ -11200,12 +11200,12 @@ "value": "application/json" } ], - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"is_predefined\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": true,\n \"key_3\": false,\n \"key_4\": \"string\",\n \"key_5\": 4350,\n \"key_6\": \"string\",\n \"key_7\": \"string\",\n \"key_8\": 5969,\n \"key_9\": \"string\",\n \"key_10\": 9934.088449997887,\n \"key_11\": \"string\",\n \"key_12\": 7835.179346552672,\n \"key_13\": false,\n \"key_14\": true,\n \"key_15\": 7069,\n \"key_16\": \"string\",\n \"key_17\": 7356,\n \"key_18\": 7029,\n \"key_19\": 9042.935721198362,\n \"key_20\": 9180,\n \"key_21\": 7387.13191396033,\n \"key_22\": 1910,\n \"key_23\": true\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"is_predefined\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": true,\n \"key_4\": true,\n \"key_5\": 5147,\n \"key_6\": 9631.41890772503,\n \"key_7\": \"string\",\n \"key_8\": true,\n \"key_9\": false,\n \"key_10\": \"string\",\n \"key_11\": 5800.397072125041,\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": 1120.9941229722676,\n \"key_15\": 2681.7556714013244,\n \"key_16\": 8670.437056616516,\n \"key_17\": \"string\",\n \"key_18\": 8760,\n \"key_19\": \"string\",\n \"key_20\": 7494,\n \"key_21\": 8522,\n \"key_22\": \"string\",\n \"key_23\": true,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": \"string\",\n \"key_27\": 3410.485976554394,\n \"key_28\": false,\n \"key_29\": \"string\",\n \"key_30\": false\n }\n }\n ]\n}", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"is_predefined\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 6238,\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": 7670,\n \"key_6\": 9783,\n \"key_7\": false,\n \"key_8\": 7685\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"is_predefined\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 9311,\n \"key_2\": false,\n \"key_3\": \"string\",\n \"key_4\": true,\n \"key_5\": 1882.0575638827086,\n \"key_6\": 6154,\n \"key_7\": 9702,\n \"key_8\": \"string\",\n \"key_9\": \"string\",\n \"key_10\": 6881.961397681751,\n \"key_11\": 6315.946817385289,\n \"key_12\": false,\n \"key_13\": false,\n \"key_14\": false,\n \"key_15\": true,\n \"key_16\": \"string\",\n \"key_17\": 4415,\n \"key_18\": 8576,\n \"key_19\": 8482,\n \"key_20\": false,\n \"key_21\": \"string\",\n \"key_22\": true,\n \"key_23\": true,\n \"key_24\": false,\n \"key_25\": \"string\",\n \"key_26\": false,\n \"key_27\": 2463,\n \"key_28\": false,\n \"key_29\": 4005.4301076709685,\n \"key_30\": false,\n \"key_31\": 7283,\n \"key_32\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0f7427be-b9c6-4aa3-920f-614ab41ab823", + "id": "0d9edb35-6a09-4838-b71d-39301c1ffd22", "name": "Merchant not found.", "originalRequest": { "url": { @@ -11260,7 +11260,7 @@ } }, { - "id": "c877c420-58b1-4618-ab91-e14af94e8eee", + "id": "940e68b7-fe53-4b21-af9e-52fbb3474b97", "name": "Create a role", "request": { "name": "Create a role", @@ -11305,7 +11305,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 9935,\n \"key_3\": \"string\",\n \"key_4\": false,\n \"key_5\": 4720.949321352595,\n \"key_6\": 560,\n \"key_7\": 5432,\n \"key_8\": false,\n \"key_9\": true,\n \"key_10\": 8108,\n \"key_11\": \"string\",\n \"key_12\": false,\n \"key_13\": 576,\n \"key_14\": 4319.410315607548,\n \"key_15\": false,\n \"key_16\": false,\n \"key_17\": \"string\",\n \"key_18\": false,\n \"key_19\": 1416,\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": 8340,\n \"key_23\": 8364,\n \"key_24\": 6626.127941102915,\n \"key_25\": true,\n \"key_26\": \"string\",\n \"key_27\": true,\n \"key_28\": 1102.1186187661126,\n \"key_29\": \"string\",\n \"key_30\": 29,\n \"key_31\": 5507,\n \"key_32\": false,\n \"key_33\": 7152,\n \"key_34\": \"string\",\n \"key_35\": 8447.151654658008,\n \"key_36\": true,\n \"key_37\": \"string\",\n \"key_38\": \"string\"\n },\n \"description\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": true,\n \"key_3\": 5584,\n \"key_4\": 6261,\n \"key_5\": \"string\",\n \"key_6\": 7374.961768804127,\n \"key_7\": 6738.483715409016,\n \"key_8\": 1202,\n \"key_9\": 8449,\n \"key_10\": false,\n \"key_11\": false,\n \"key_12\": false,\n \"key_13\": 1390.8128607482518,\n \"key_14\": 4664,\n \"key_15\": 1818,\n \"key_16\": 6988.820003743912,\n \"key_17\": 1694\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -11325,7 +11325,7 @@ }, "response": [ { - "id": "1dd9d8b3-ad98-4fe6-8450-e2fd12cf5d0b", + "id": "76218351-5094-4818-8db5-9d0df43a6162", "name": "Returns the Role object after successful custom role creation.", "originalRequest": { "url": { @@ -11365,7 +11365,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 9935,\n \"key_3\": \"string\",\n \"key_4\": false,\n \"key_5\": 4720.949321352595,\n \"key_6\": 560,\n \"key_7\": 5432,\n \"key_8\": false,\n \"key_9\": true,\n \"key_10\": 8108,\n \"key_11\": \"string\",\n \"key_12\": false,\n \"key_13\": 576,\n \"key_14\": 4319.410315607548,\n \"key_15\": false,\n \"key_16\": false,\n \"key_17\": \"string\",\n \"key_18\": false,\n \"key_19\": 1416,\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": 8340,\n \"key_23\": 8364,\n \"key_24\": 6626.127941102915,\n \"key_25\": true,\n \"key_26\": \"string\",\n \"key_27\": true,\n \"key_28\": 1102.1186187661126,\n \"key_29\": \"string\",\n \"key_30\": 29,\n \"key_31\": 5507,\n \"key_32\": false,\n \"key_33\": 7152,\n \"key_34\": \"string\",\n \"key_35\": 8447.151654658008,\n \"key_36\": true,\n \"key_37\": \"string\",\n \"key_38\": \"string\"\n },\n \"description\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": true,\n \"key_3\": 5584,\n \"key_4\": 6261,\n \"key_5\": \"string\",\n \"key_6\": 7374.961768804127,\n \"key_7\": 6738.483715409016,\n \"key_8\": 1202,\n \"key_9\": 8449,\n \"key_10\": false,\n \"key_11\": false,\n \"key_12\": false,\n \"key_13\": 1390.8128607482518,\n \"key_14\": 4664,\n \"key_15\": 1818,\n \"key_16\": 6988.820003743912,\n \"key_17\": 1694\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -11382,12 +11382,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"is_predefined\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 490.68206030906447,\n \"key_2\": 7874.969889078676,\n \"key_3\": 8159.629113556457,\n \"key_4\": \"string\",\n \"key_5\": false,\n \"key_6\": 681.5806694207582,\n \"key_7\": 444,\n \"key_8\": \"string\",\n \"key_9\": false,\n \"key_10\": 4245.192869436909,\n \"key_11\": \"string\",\n \"key_12\": 674.9586439709443,\n \"key_13\": true,\n \"key_14\": \"string\",\n \"key_15\": \"string\",\n \"key_16\": \"string\",\n \"key_17\": 5089,\n \"key_18\": true\n }\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"is_predefined\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 5819,\n \"key_2\": 8837.525152217602,\n \"key_3\": 8686,\n \"key_4\": true,\n \"key_5\": 4008,\n \"key_6\": true,\n \"key_7\": \"string\",\n \"key_8\": false,\n \"key_9\": \"string\",\n \"key_10\": \"string\",\n \"key_11\": true,\n \"key_12\": \"string\",\n \"key_13\": 2869.0915318078946,\n \"key_14\": 213,\n \"key_15\": true,\n \"key_16\": true,\n \"key_17\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "228dea71-7835-47c7-b5e3-874b312fb3c6", + "id": "74eb932b-42da-47aa-aa9a-293957d747d2", "name": "Invalid request.", "originalRequest": { "url": { @@ -11427,7 +11427,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 9935,\n \"key_3\": \"string\",\n \"key_4\": false,\n \"key_5\": 4720.949321352595,\n \"key_6\": 560,\n \"key_7\": 5432,\n \"key_8\": false,\n \"key_9\": true,\n \"key_10\": 8108,\n \"key_11\": \"string\",\n \"key_12\": false,\n \"key_13\": 576,\n \"key_14\": 4319.410315607548,\n \"key_15\": false,\n \"key_16\": false,\n \"key_17\": \"string\",\n \"key_18\": false,\n \"key_19\": 1416,\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": 8340,\n \"key_23\": 8364,\n \"key_24\": 6626.127941102915,\n \"key_25\": true,\n \"key_26\": \"string\",\n \"key_27\": true,\n \"key_28\": 1102.1186187661126,\n \"key_29\": \"string\",\n \"key_30\": 29,\n \"key_31\": 5507,\n \"key_32\": false,\n \"key_33\": 7152,\n \"key_34\": \"string\",\n \"key_35\": 8447.151654658008,\n \"key_36\": true,\n \"key_37\": \"string\",\n \"key_38\": \"string\"\n },\n \"description\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": true,\n \"key_3\": 5584,\n \"key_4\": 6261,\n \"key_5\": \"string\",\n \"key_6\": 7374.961768804127,\n \"key_7\": 6738.483715409016,\n \"key_8\": 1202,\n \"key_9\": 8449,\n \"key_10\": false,\n \"key_11\": false,\n \"key_12\": false,\n \"key_13\": 1390.8128607482518,\n \"key_14\": 4664,\n \"key_15\": 1818,\n \"key_16\": 6988.820003743912,\n \"key_17\": 1694\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -11449,7 +11449,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6dc1428f-311d-4dbb-bf95-61eda027b13b", + "id": "829252b4-c829-4945-9bf2-e0d287ddb05c", "name": "Merchant not found.", "originalRequest": { "url": { @@ -11489,7 +11489,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 9935,\n \"key_3\": \"string\",\n \"key_4\": false,\n \"key_5\": 4720.949321352595,\n \"key_6\": 560,\n \"key_7\": 5432,\n \"key_8\": false,\n \"key_9\": true,\n \"key_10\": 8108,\n \"key_11\": \"string\",\n \"key_12\": false,\n \"key_13\": 576,\n \"key_14\": 4319.410315607548,\n \"key_15\": false,\n \"key_16\": false,\n \"key_17\": \"string\",\n \"key_18\": false,\n \"key_19\": 1416,\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": 8340,\n \"key_23\": 8364,\n \"key_24\": 6626.127941102915,\n \"key_25\": true,\n \"key_26\": \"string\",\n \"key_27\": true,\n \"key_28\": 1102.1186187661126,\n \"key_29\": \"string\",\n \"key_30\": 29,\n \"key_31\": 5507,\n \"key_32\": false,\n \"key_33\": 7152,\n \"key_34\": \"string\",\n \"key_35\": 8447.151654658008,\n \"key_36\": true,\n \"key_37\": \"string\",\n \"key_38\": \"string\"\n },\n \"description\": \"\"\n}", + "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": true,\n \"key_3\": 5584,\n \"key_4\": 6261,\n \"key_5\": \"string\",\n \"key_6\": 7374.961768804127,\n \"key_7\": 6738.483715409016,\n \"key_8\": 1202,\n \"key_9\": 8449,\n \"key_10\": false,\n \"key_11\": false,\n \"key_12\": false,\n \"key_13\": 1390.8128607482518,\n \"key_14\": 4664,\n \"key_15\": 1818,\n \"key_16\": 6988.820003743912,\n \"key_17\": 1694\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -11517,7 +11517,7 @@ } }, { - "id": "27059616-cc17-4a54-aea8-c72dd401d3ad", + "id": "855c41c9-873a-4415-89ef-2eea10fedb1a", "name": "Retrieve a role", "request": { "name": "Retrieve a role", @@ -11580,7 +11580,7 @@ }, "response": [ { - "id": "86e9a211-303a-4fe8-b1eb-79a8c3e8eed3", + "id": "c5bc6774-b19f-491d-8d48-2a4586a487b2", "name": "Returns the Role object for a valid identifier.", "originalRequest": { "url": { @@ -11635,12 +11635,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"is_predefined\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 490.68206030906447,\n \"key_2\": 7874.969889078676,\n \"key_3\": 8159.629113556457,\n \"key_4\": \"string\",\n \"key_5\": false,\n \"key_6\": 681.5806694207582,\n \"key_7\": 444,\n \"key_8\": \"string\",\n \"key_9\": false,\n \"key_10\": 4245.192869436909,\n \"key_11\": \"string\",\n \"key_12\": 674.9586439709443,\n \"key_13\": true,\n \"key_14\": \"string\",\n \"key_15\": \"string\",\n \"key_16\": \"string\",\n \"key_17\": 5089,\n \"key_18\": true\n }\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"is_predefined\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 5819,\n \"key_2\": 8837.525152217602,\n \"key_3\": 8686,\n \"key_4\": true,\n \"key_5\": 4008,\n \"key_6\": true,\n \"key_7\": \"string\",\n \"key_8\": false,\n \"key_9\": \"string\",\n \"key_10\": \"string\",\n \"key_11\": true,\n \"key_12\": \"string\",\n \"key_13\": 2869.0915318078946,\n \"key_14\": 213,\n \"key_15\": true,\n \"key_16\": true,\n \"key_17\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0529b3e3-003c-4bfa-902b-c2e45a317c7b", + "id": "9fd25214-315e-4d8f-9360-5a0083b27d58", "name": "Merchant or role not found.", "originalRequest": { "url": { @@ -11706,7 +11706,7 @@ } }, { - "id": "697597a2-0c77-43d6-b596-979db4f63687", + "id": "1c0cac41-daf6-4725-82dd-0cb58abf31e4", "name": "Delete a role", "request": { "name": "Delete a role", @@ -11769,7 +11769,7 @@ }, "response": [ { - "id": "c2b480e4-923e-4e86-9fc2-63a1fbd62544", + "id": "8421d753-ee9c-4960-9e2a-34b56448035f", "name": "Returns an empty response if the role deletion succeeded.", "originalRequest": { "url": { @@ -11817,7 +11817,7 @@ "_postman_previewlanguage": "text" }, { - "id": "8649f4a8-33e3-4a34-a109-4aaea3918d00", + "id": "982e27b2-d45d-430f-bc8e-94c729230fdf", "name": "Invalid request.", "originalRequest": { "url": { @@ -11877,7 +11877,7 @@ "_postman_previewlanguage": "json" }, { - "id": "aab6882d-f542-48a3-a74e-7f4b4728f8d1", + "id": "fc2cf62e-a2b4-4852-8f4c-7385802e6468", "name": "Merchant not found.", "originalRequest": { "url": { @@ -11943,7 +11943,7 @@ } }, { - "id": "b4d98839-91d6-41e6-9cc1-802ce07ec1c3", + "id": "0001afeb-f276-4ee0-a223-0689dcd7df33", "name": "Update a role", "request": { "name": "Update a role", @@ -12019,7 +12019,7 @@ }, "response": [ { - "id": "453ecb8a-42f1-4ecc-b2dd-1b7567f1c5d5", + "id": "27568876-fda4-41bd-9019-f70a27388ff1", "name": "Returns the updated Role object if the update succeeded.", "originalRequest": { "url": { @@ -12087,12 +12087,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"is_predefined\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": 490.68206030906447,\n \"key_2\": 7874.969889078676,\n \"key_3\": 8159.629113556457,\n \"key_4\": \"string\",\n \"key_5\": false,\n \"key_6\": 681.5806694207582,\n \"key_7\": 444,\n \"key_8\": \"string\",\n \"key_9\": false,\n \"key_10\": 4245.192869436909,\n \"key_11\": \"string\",\n \"key_12\": 674.9586439709443,\n \"key_13\": true,\n \"key_14\": \"string\",\n \"key_15\": \"string\",\n \"key_16\": \"string\",\n \"key_17\": 5089,\n \"key_18\": true\n }\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"is_predefined\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 5819,\n \"key_2\": 8837.525152217602,\n \"key_3\": 8686,\n \"key_4\": true,\n \"key_5\": 4008,\n \"key_6\": true,\n \"key_7\": \"string\",\n \"key_8\": false,\n \"key_9\": \"string\",\n \"key_10\": \"string\",\n \"key_11\": true,\n \"key_12\": \"string\",\n \"key_13\": 2869.0915318078946,\n \"key_14\": 213,\n \"key_15\": true,\n \"key_16\": true,\n \"key_17\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "37bea637-9d81-4efd-a263-8f89bb722140", + "id": "4b3a3ae5-3576-42d4-bcc3-e15dca2e11d2", "name": "Invalid request.", "originalRequest": { "url": { @@ -12165,7 +12165,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e40100c6-1991-49f4-834b-1202a7448c94", + "id": "ff6ad1ef-f555-492d-a96b-31453c99f819", "name": "Merchant not found.", "originalRequest": { "url": { @@ -12250,7 +12250,7 @@ "description": "A Merchant represents a single business which can use SumUp products like payment processing.", "item": [ { - "id": "da4db07b-380d-4f26-9ae7-af3bd5e9ffef", + "id": "f49fcac4-8e31-4086-a5e3-e2a564884d7a", "name": "Get Merchant", "request": { "name": "Get Merchant", @@ -12301,7 +12301,7 @@ }, "response": [ { - "id": "c7805f89-acfc-45c9-8399-30bf02218d3b", + "id": "169b6831-6d97-46a3-8ae2-af2b9252697e", "name": "Returns a Merchant for a valid identifier.", "originalRequest": { "url": { @@ -12344,12 +12344,12 @@ "value": "application/json" } ], - "body": "{\n \"country\": \"DP\",\n \"created_at\": \"\",\n \"default_currency\": \"\",\n \"default_locale\": \"\",\n \"merchant_code\": \"\",\n \"updated_at\": \"\",\n \"organization_id\": \"\",\n \"business_type\": \"\",\n \"company\": {\n \"name\": \"\",\n \"merchant_category_code\": \"9368\",\n \"legal_type\": \"zx.i\",\n \"address\": {\n \"country\": \"DP\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"post_code\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"region\": \"\",\n \"county\": \"\",\n \"autonomous_community\": \"\",\n \"post_town\": \"\",\n \"state\": \"\",\n \"neighborhood\": \"\",\n \"commune\": \"\",\n \"department\": \"\",\n \"municipality\": \"\",\n \"district\": \"\",\n \"zip_code\": \"\",\n \"eircode\": \"\"\n },\n \"trading_address\": {\n \"country\": \"QR\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"post_code\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"region\": \"\",\n \"county\": \"\",\n \"autonomous_community\": \"\",\n \"post_town\": \"\",\n \"state\": \"\",\n \"neighborhood\": \"\",\n \"commune\": \"\",\n \"department\": \"\",\n \"municipality\": \"\",\n \"district\": \"\",\n \"zip_code\": \"\",\n \"eircode\": \"\"\n },\n \"identifiers\": [\n {\n \"ref\": \"dn.ytts\",\n \"value\": \"\"\n },\n {\n \"ref\": \"hq.aeaidsy\",\n \"value\": \"\"\n }\n ],\n \"phone_number\": \"\",\n \"website\": \"\",\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 5839.1365222413615,\n \"key_2\": true\n }\n },\n \"business_profile\": {\n \"name\": \"\",\n \"dynamic_descriptor\": \"FDU3oRvSp\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"country\": \"YZ\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"post_code\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"region\": \"\",\n \"county\": \"\",\n \"autonomous_community\": \"\",\n \"post_town\": \"\",\n \"state\": \"\",\n \"neighborhood\": \"\",\n \"commune\": \"\",\n \"department\": \"\",\n \"municipality\": \"\",\n \"district\": \"\",\n \"zip_code\": \"\",\n \"eircode\": \"\"\n },\n \"branding\": {\n \"footer_text\": \"\",\n \"icon\": \"\",\n \"logo\": \"\",\n \"hero\": \"\",\n \"primary_color\": \"\",\n \"primary_color_fg\": \"\",\n \"secondary_color\": \"\",\n \"secondary_color_fg\": \"\",\n \"background_color\": \"\"\n }\n },\n \"avatar\": \"\",\n \"alias\": \"\",\n \"sandbox\": \"\",\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"classic\": {\n \"id\": \"\"\n },\n \"version\": \"\",\n \"change_status\": \"\"\n}", + "body": "{\n \"country\": \"OU\",\n \"created_at\": \"\",\n \"default_currency\": \"\",\n \"default_locale\": \"\",\n \"merchant_code\": \"\",\n \"updated_at\": \"\",\n \"organization_id\": \"\",\n \"business_type\": \"\",\n \"company\": {\n \"name\": \"\",\n \"merchant_category_code\": \"5801\",\n \"legal_type\": \"hx._taknapwh\",\n \"address\": {\n \"country\": \"LM\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"post_code\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"region\": \"\",\n \"county\": \"\",\n \"autonomous_community\": \"\",\n \"post_town\": \"\",\n \"state\": \"\",\n \"neighborhood\": \"\",\n \"commune\": \"\",\n \"department\": \"\",\n \"municipality\": \"\",\n \"district\": \"\",\n \"zip_code\": \"\",\n \"eircode\": \"\"\n },\n \"trading_address\": {\n \"country\": \"CQ\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"post_code\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"region\": \"\",\n \"county\": \"\",\n \"autonomous_community\": \"\",\n \"post_town\": \"\",\n \"state\": \"\",\n \"neighborhood\": \"\",\n \"commune\": \"\",\n \"department\": \"\",\n \"municipality\": \"\",\n \"district\": \"\",\n \"zip_code\": \"\",\n \"eircode\": \"\"\n },\n \"identifiers\": [\n {\n \"ref\": \"vb.nks_mydsxrb\",\n \"value\": \"\"\n },\n {\n \"ref\": \"wk.claqsjv\",\n \"value\": \"\"\n }\n ],\n \"phone_number\": \"\",\n \"website\": \"\",\n \"attributes\": {\n \"key_0\": \"string\",\n \"key_1\": true\n }\n },\n \"business_profile\": {\n \"name\": \"\",\n \"dynamic_descriptor\": \"mvITQI\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"country\": \"FO\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"post_code\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"region\": \"\",\n \"county\": \"\",\n \"autonomous_community\": \"\",\n \"post_town\": \"\",\n \"state\": \"\",\n \"neighborhood\": \"\",\n \"commune\": \"\",\n \"department\": \"\",\n \"municipality\": \"\",\n \"district\": \"\",\n \"zip_code\": \"\",\n \"eircode\": \"\"\n },\n \"branding\": {\n \"footer_text\": \"\",\n \"icon\": \"\",\n \"logo\": \"\",\n \"hero\": \"\",\n \"primary_color\": \"\",\n \"primary_color_fg\": \"\",\n \"secondary_color\": \"\",\n \"secondary_color_fg\": \"\",\n \"background_color\": \"\"\n }\n },\n \"avatar\": \"\",\n \"alias\": \"\",\n \"sandbox\": \"\",\n \"meta\": {\n \"key_0\": \"\"\n },\n \"classic\": {\n \"id\": \"\"\n },\n \"version\": \"\",\n \"change_status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ca0a59c4-53d7-45d3-bc5e-8896ff8378a7", + "id": "277b7482-c28d-4c8b-b110-f72f5a45837d", "name": "The requested Merchant does not exist.", "originalRequest": { "url": { @@ -12403,7 +12403,7 @@ } }, { - "id": "8a5144bc-7500-473b-adc4-47cf56b9c149", + "id": "7f2f803e-6571-4b4a-966b-fbbd154b93ae", "name": "List Persons", "request": { "name": "List Persons", @@ -12455,7 +12455,7 @@ }, "response": [ { - "id": "e9b4a526-608d-4a0b-9fc8-1ec971d8a619", + "id": "de00b7d0-df23-476f-b869-a315ab4d89cb", "name": "Returns a list of Persons for a valid Merchant identifier.", "originalRequest": { "url": { @@ -12499,12 +12499,12 @@ "value": "application/json" } ], - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"birthdate\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"middle_name\": \"\",\n \"phone_number\": \"\",\n \"relationships\": [\n \"\"\n ],\n \"ownership\": {\n \"share\": \"\"\n },\n \"address\": {\n \"country\": \"SK\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"post_code\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"region\": \"\",\n \"county\": \"\",\n \"autonomous_community\": \"\",\n \"post_town\": \"\",\n \"state\": \"\",\n \"neighborhood\": \"\",\n \"commune\": \"\",\n \"department\": \"\",\n \"municipality\": \"\",\n \"district\": \"\",\n \"zip_code\": \"\",\n \"eircode\": \"\"\n },\n \"identifiers\": [\n {\n \"ref\": \"\",\n \"value\": \"\"\n },\n {\n \"ref\": \"\",\n \"value\": \"\"\n }\n ],\n \"citizenship\": \"LO\",\n \"nationality\": \"DV\",\n \"country_of_residence\": \"ND\",\n \"version\": \"\",\n \"change_status\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"birthdate\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"middle_name\": \"\",\n \"phone_number\": \"\",\n \"relationships\": [\n \"\"\n ],\n \"ownership\": {\n \"share\": \"\"\n },\n \"address\": {\n \"country\": \"PS\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"post_code\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"region\": \"\",\n \"county\": \"\",\n \"autonomous_community\": \"\",\n \"post_town\": \"\",\n \"state\": \"\",\n \"neighborhood\": \"\",\n \"commune\": \"\",\n \"department\": \"\",\n \"municipality\": \"\",\n \"district\": \"\",\n \"zip_code\": \"\",\n \"eircode\": \"\"\n },\n \"identifiers\": [\n {\n \"ref\": \"\",\n \"value\": \"\"\n },\n {\n \"ref\": \"\",\n \"value\": \"\"\n }\n ],\n \"citizenship\": \"NP\",\n \"nationality\": \"IL\",\n \"country_of_residence\": \"BX\",\n \"version\": \"\",\n \"change_status\": \"\"\n }\n ]\n}", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"birthdate\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"middle_name\": \"\",\n \"phone_number\": \"\",\n \"relationships\": [\n \"\"\n ],\n \"ownership\": {\n \"share\": \"\"\n },\n \"address\": {\n \"country\": \"XC\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"post_code\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"region\": \"\",\n \"county\": \"\",\n \"autonomous_community\": \"\",\n \"post_town\": \"\",\n \"state\": \"\",\n \"neighborhood\": \"\",\n \"commune\": \"\",\n \"department\": \"\",\n \"municipality\": \"\",\n \"district\": \"\",\n \"zip_code\": \"\",\n \"eircode\": \"\"\n },\n \"identifiers\": [\n {\n \"ref\": \"\",\n \"value\": \"\"\n },\n {\n \"ref\": \"\",\n \"value\": \"\"\n }\n ],\n \"citizenship\": \"OX\",\n \"nationality\": \"ZQ\",\n \"country_of_residence\": \"CU\",\n \"version\": \"\",\n \"change_status\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"birthdate\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"middle_name\": \"\",\n \"phone_number\": \"\",\n \"relationships\": [\n \"\"\n ],\n \"ownership\": {\n \"share\": \"\"\n },\n \"address\": {\n \"country\": \"QL\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"post_code\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"region\": \"\",\n \"county\": \"\",\n \"autonomous_community\": \"\",\n \"post_town\": \"\",\n \"state\": \"\",\n \"neighborhood\": \"\",\n \"commune\": \"\",\n \"department\": \"\",\n \"municipality\": \"\",\n \"district\": \"\",\n \"zip_code\": \"\",\n \"eircode\": \"\"\n },\n \"identifiers\": [\n {\n \"ref\": \"\",\n \"value\": \"\"\n },\n {\n \"ref\": \"\",\n \"value\": \"\"\n }\n ],\n \"citizenship\": \"JJ\",\n \"nationality\": \"NV\",\n \"country_of_residence\": \"KY\",\n \"version\": \"\",\n \"change_status\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "319ef056-ce01-4ab5-b78b-21aa5b527f69", + "id": "b45cecac-ff01-4f3a-abf5-e49e55df4494", "name": "The requested Merchant does not exist.", "originalRequest": { "url": { @@ -12559,7 +12559,7 @@ } }, { - "id": "adeeb8d0-70b1-4ea0-8384-bf16b46dd572", + "id": "173b772e-4d87-4d14-973a-b1aa0e3cddf0", "name": "Get Person", "request": { "name": "Get Person", @@ -12622,7 +12622,7 @@ }, "response": [ { - "id": "e61a0e0c-94d0-4392-8d44-fb4cf8522a00", + "id": "79ebc7b7-5d99-42de-afe9-24c364d3bcba", "name": "Returns a Person for a valid identifier.", "originalRequest": { "url": { @@ -12677,12 +12677,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"user_id\": \"\",\n \"birthdate\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"middle_name\": \"\",\n \"phone_number\": \"\",\n \"relationships\": [\n \"\"\n ],\n \"ownership\": {\n \"share\": \"\"\n },\n \"address\": {\n \"country\": \"TZ\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"post_code\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"region\": \"\",\n \"county\": \"\",\n \"autonomous_community\": \"\",\n \"post_town\": \"\",\n \"state\": \"\",\n \"neighborhood\": \"\",\n \"commune\": \"\",\n \"department\": \"\",\n \"municipality\": \"\",\n \"district\": \"\",\n \"zip_code\": \"\",\n \"eircode\": \"\"\n },\n \"identifiers\": [\n {\n \"ref\": \"\",\n \"value\": \"\"\n },\n {\n \"ref\": \"\",\n \"value\": \"\"\n }\n ],\n \"citizenship\": \"CE\",\n \"nationality\": \"FK\",\n \"country_of_residence\": \"WP\",\n \"version\": \"\",\n \"change_status\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"user_id\": \"\",\n \"birthdate\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"middle_name\": \"\",\n \"phone_number\": \"\",\n \"relationships\": [\n \"\"\n ],\n \"ownership\": {\n \"share\": \"\"\n },\n \"address\": {\n \"country\": \"WY\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"post_code\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"region\": \"\",\n \"county\": \"\",\n \"autonomous_community\": \"\",\n \"post_town\": \"\",\n \"state\": \"\",\n \"neighborhood\": \"\",\n \"commune\": \"\",\n \"department\": \"\",\n \"municipality\": \"\",\n \"district\": \"\",\n \"zip_code\": \"\",\n \"eircode\": \"\"\n },\n \"identifiers\": [\n {\n \"ref\": \"\",\n \"value\": \"\"\n },\n {\n \"ref\": \"\",\n \"value\": \"\"\n }\n ],\n \"citizenship\": \"DY\",\n \"nationality\": \"LC\",\n \"country_of_residence\": \"AJ\",\n \"version\": \"\",\n \"change_status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "110ff115-5cb3-4832-8cf8-c3f90d0d134f", + "id": "3d211e13-d689-4e90-82e6-c602d196bf0d", "name": "The requested Person does not exist.", "originalRequest": { "url": { @@ -12758,11 +12758,11 @@ } ], "info": { - "_postman_id": "467f7625-f018-4375-a029-deb102241276", + "_postman_id": "d1e179f0-52a6-44e9-bed7-914bd80ea652", "name": "SumUp REST API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { - "content": "SumUp’s REST API operates with [JSON](https://www.json.org/json-en.html) HTTP requests and responses. The request bodies are sent through resource-oriented URLs and use the standard [HTTP response codes](https://developer.mozilla.org/docs/Web/HTTP/Status).\n\nYou can experiment and work on your integration in a sandbox that doesn't affect your regular data and doesn't process real transactions. To create a sandbox merchant account visit the [dashboard](https://me.sumup.com/settings/developer). To use the sandbox when interacting with SumUp APIs [create an API](https://me.sumup.com/settings/api-keys) key and use it for [authentication](https://developer.sumup.com/api/authentication).", + "content": "SumUp's REST API lets you create and process payments, manage saved customers and payment instruments, and retrieve transactions, payouts, and receipt details. It uses resource-oriented URLs and standard [HTTP response codes](https://developer.mozilla.org/docs/Web/HTTP/Status). Send request bodies as [JSON](https://www.json.org/json-en.html) with `Content-Type: application/json`, unless an endpoint specifies another format.\n\nYou can experiment and work on your integration in a sandbox that doesn't affect your regular data and doesn't process real transactions. To create a sandbox merchant account visit the [dashboard](https://me.sumup.com/settings/developer). To use the sandbox when interacting with SumUp APIs [create an API](https://me.sumup.com/settings/api-keys) key and use it for [authentication](https://developer.sumup.com/api/authentication).", "type": "text/plain" } } diff --git a/openapi.json b/openapi.json index e1f8a4e..265913c 100755 --- a/openapi.json +++ b/openapi.json @@ -3,7 +3,7 @@ "info": { "title": "SumUp REST API", "version": "1.0.0", - "description": "SumUp’s REST API operates with [JSON](https://www.json.org/json-en.html) HTTP requests and responses. The request bodies are sent through resource-oriented URLs and use the standard [HTTP response codes](https://developer.mozilla.org/docs/Web/HTTP/Status).\n\nYou can experiment and work on your integration in a sandbox that doesn't affect your regular data and doesn't process real transactions. To create a sandbox merchant account visit the [dashboard](https://me.sumup.com/settings/developer). To use the sandbox when interacting with SumUp APIs [create an API](https://me.sumup.com/settings/api-keys) key and use it for [authentication](https://developer.sumup.com/api/authentication).", + "description": "SumUp's REST API lets you create and process payments, manage saved customers and payment instruments, and retrieve transactions, payouts, and receipt details. It uses resource-oriented URLs and standard [HTTP response codes](https://developer.mozilla.org/docs/Web/HTTP/Status). Send request bodies as [JSON](https://www.json.org/json-en.html) with `Content-Type: application/json`, unless an endpoint specifies another format.\n\nYou can experiment and work on your integration in a sandbox that doesn't affect your regular data and doesn't process real transactions. To create a sandbox merchant account visit the [dashboard](https://me.sumup.com/settings/developer). To use the sandbox when interacting with SumUp APIs [create an API](https://me.sumup.com/settings/api-keys) key and use it for [authentication](https://developer.sumup.com/api/authentication).", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" @@ -27,7 +27,7 @@ }, { "name": "Customers", - "description": "Allow your regular customers to save their information with the Customers model.\n\nThis will prevent re-entering payment instrument information for recurring payments on your platform.\n\nDepending on the needs you can allow, creating, listing or deactivating payment instruments \u0026 creating, retrieving and updating customers.", + "description": "Customers represent payers in your integration. Create a customer with your own `customer_id` to associate their personal details and saved payment instruments with your business records.\n\nTo save a card, create a checkout for that customer with `purpose = SETUP_RECURRING_PAYMENT`, then process it with the payer's consent and mandate details. See the [tokenization guide](https://developer.sumup.com/online-payments/guides/tokenization-with-payment-sdk/).\n\nUse the Customers endpoints to create, retrieve, or update customer details and to list or deactivate saved payment instruments. For subsequent payments, process a new checkout with the saved instrument's `token` and its associated `customer_id`.", "x-core-objects": [ { "$ref": "#/components/schemas/Customer" @@ -49,7 +49,7 @@ }, { "name": "Receipts", - "description": "The Receipts model obtains receipt-like details for specific transactions.", + "description": "Retrieve structured receipt data for a transaction, including payment, merchant, and acquirer details. Use this data to display a receipt in your application. The response is JSON, rather than a rendered receipt document.", "x-core-objects": [ { "$ref": "#/components/schemas/Receipt" @@ -110,7 +110,7 @@ "get": { "operationId": "GetPaymentMethods", "summary": "Get available payment methods", - "description": "Get payment methods available for the given merchant to use with a checkout.", + "description": "Lists the payment methods available to the merchant for checkout payments. Use the optional amount and currency filters to check eligibility for a particular payment before presenting payment options to the payer.", "tags": [ "Checkouts" ], @@ -133,7 +133,7 @@ "in": "query", "name": "amount", "required": false, - "description": "The amount for which the payment methods should be eligible, in major units.", + "description": "Payment amount in major units, for example `9.99` for EUR 9.99. When filtering by `amount`, also provide `currency`.", "schema": { "type": "number", "example": 9.99 @@ -143,7 +143,7 @@ "in": "query", "name": "currency", "required": false, - "description": "The currency for which the payment methods should be eligible.", + "description": "Three-letter ISO 4217 currency code for which the payment methods should be eligible, for example `EUR`.", "schema": { "type": "string", "example": "EUR" @@ -282,7 +282,7 @@ "currency": "EUR", "merchant_code": "MH4H92C7", "description": "Purchase", - "valid_until": "2020-02-29T10:56:56+00:00", + "valid_until": "2030-12-31T23:59:59Z", "redirect_url": "https://sumup.com" } }, @@ -349,7 +349,7 @@ "id": "88fcf8de-304d-4820-8f1c-ec880290eb92", "status": "PENDING", "date": "2020-02-29T10:56:56+00:00", - "valid_until": "2020-02-29T10:56:56+00:00", + "valid_until": "2030-12-31T23:59:59Z", "customer_id": "831ff8d4cd5958ab5670", "mandate": { "type": "recurrent", @@ -386,7 +386,7 @@ "id": "88fcf8de-304d-4820-8f1c-ec880290eb92", "status": "PENDING", "date": "2020-02-29T10:56:56+00:00", - "valid_until": "2020-02-29T10:56:56+00:00", + "valid_until": "2030-12-31T23:59:59Z", "customer_id": "831ff8d4cd5958ab5670", "redirect_url": "https://mysite.com/completed_purchase", "transactions": [ @@ -580,7 +580,7 @@ { "name": "checkout_reference", "in": "query", - "description": "Filters the list of checkout resources by the unique reference of the checkout.", + "description": "Filters checkouts by the merchant-defined `checkout_reference` supplied when creating the checkout. This is separate from the SumUp-generated checkout `id`.", "required": false, "schema": { "type": "string", @@ -645,7 +645,7 @@ "name": "checkout_id", "in": "path", "required": true, - "description": "Unique identifier of the checkout resource.", + "description": "SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "schema": { "type": "string", "example": "4e425463-3e1b-431d-83fa-1e51c2925e99" @@ -655,7 +655,7 @@ "get": { "operationId": "GetCheckout", "summary": "Retrieve a checkout", - "description": "Retrieves an identified checkout resource. Use this request after processing a checkout to confirm its status and inform the end user respectively.", + "description": "Retrieves a checkout by its SumUp `checkout_id`. After processing a payment, returning from a redirect, or receiving a checkout notification, retrieve the checkout to confirm its current `status` before updating your order or displaying the payment outcome to the payer.", "tags": [ "Checkouts" ], @@ -781,7 +781,7 @@ "currency": "EUR", "description": "Updated purchase", "checkout_reference": "f00a8f74-b05d-4605-bd73-2a901bae5802", - "valid_until": "2020-02-29T10:56:56+00:00", + "valid_until": "2030-12-31T23:59:59Z", "customer_id": "831ff8d4cd5958ab5670" } } @@ -805,7 +805,7 @@ "id": "88fcf8de-304d-4820-8f1c-ec880290eb92", "status": "PENDING", "date": "2020-02-29T10:56:56+00:00", - "valid_until": "2020-02-29T10:56:56+00:00", + "valid_until": "2030-12-31T23:59:59Z", "customer_id": "831ff8d4cd5958ab5670", "transactions": [] } @@ -858,7 +858,7 @@ "put": { "operationId": "ProcessCheckout", "summary": "Process a checkout", - "description": ":::caution[PCI DSS compliance required]\nWhen you submit raw card details directly to the Checkout API, your systems store, process, or transmit cardholder data and are therefore subject to applicable [PCI DSS requirements](https://www.pcisecuritystandards.org/document_library/). You should only use this integration if your environment is appropriately PCI DSS compliant.\n:::\n\nProcessing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resource initiated in the `Create a checkout` endpoint.\n\nFollow this request with `Retrieve a checkout` to confirm its status.", + "description": ":::caution[PCI DSS compliance required]\nWhen you submit raw card details directly to the Checkout API, your systems store, process, or transmit cardholder data and are therefore subject to applicable [PCI DSS requirements](https://www.pcisecuritystandards.org/document_library/). You should only use this integration if your environment is appropriately PCI DSS compliant.\n:::\n\nProcessing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resource initiated in the `Create a checkout` endpoint.\n\nA processing response can require an additional payer action, such as a 3DS challenge or a payment-provider redirect. If `next_step` is returned, follow its instructions to continue the payment flow.\n\nRetrieve the checkout afterwards to confirm its payment status. Acceptance of the processing request does not by itself mean the checkout is paid.", "tags": [ "Checkouts" ], @@ -1033,9 +1033,9 @@ "description": "Purchase", "return_url": "http://example.com", "id": "4e425463-3e1b-431d-83fa-1e51c2925e99", - "status": "PENDING", + "status": "PAID", "date": "2020-02-29T10:56:56+00:00", - "valid_until": "2020-02-29T10:56:56+00:00", + "valid_until": "2030-12-31T23:59:59Z", "customer_id": "831ff8d4cd5958ab5670", "mandate": { "type": "recurrent", @@ -1072,7 +1072,7 @@ "merchant_code": "MH4H92C7", "description": "Purchase with token", "id": "4e425463-3e1b-431d-83fa-1e51c2925e99", - "status": "PENDING", + "status": "PAID", "date": "2020-02-29T10:56:56+00:00", "transaction_code": "TEENSK4W2K", "transaction_id": "410fc44a-5956-44e1-b5cc-19c6f8d727a4", @@ -1102,7 +1102,7 @@ } }, "CheckoutSuccessBoleto": { - "description": "Successfully processed checkout with Boleto", + "description": "Boleto payment initiated, awaiting payment by the payer", "value": { "checkout_reference": "f00a8f74-b05d-4605-bd73-2a901bae5802", "amount": 10.1, @@ -1138,7 +1138,7 @@ } }, "CheckoutSuccessiDeal": { - "description": "Successfully processed checkout with iDeal", + "description": "iDEAL processing response requiring a payer redirect", "value": { "next_step": { "url": "https://r3.girogate.de/ti/simideal", @@ -1156,7 +1156,7 @@ } }, "CheckoutSuccessBancontact": { - "description": "Successfully processed checkout with Bancontact", + "description": "Bancontact processing response requiring a payer redirect", "value": { "next_step": { "url": "https://r3.girogate.de/ti/simbcmc", @@ -1335,7 +1335,7 @@ }, "example": { "checkout_reference": "f00a8f74-b05d-4605-bd73-2a901bae5802", - "id": "817340ce-f1d9-4609-b90a-6152f8ee267j", + "id": "817340ce-f1d9-4609-b90a-6152f8ee267a", "amount": 2, "currency": "EUR", "merchant_code": "MH4H92C7", @@ -1343,7 +1343,7 @@ "purpose": "CHECKOUT", "status": "EXPIRED", "date": "2020-02-29T10:56:56+00:00", - "valid_until": "2020-02-29T10:56:56+00:00", + "valid_until": "2030-12-31T23:59:59Z", "merchant_name": "Sample Merchant", "transactions": [] } @@ -1426,7 +1426,7 @@ "name": "checkout_id", "in": "path", "required": true, - "description": "Unique identifier of the checkout resource.", + "description": "SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "schema": { "type": "string", "example": "4e425463-3e1b-431d-83fa-1e51c2925e99" @@ -1438,7 +1438,7 @@ }, "x-scopes": [], "requestBody": { - "description": "The data needed to create an apple pay session for a checkout.", + "description": "Merchant validation details from the Apple Pay session in the payer's browser.", "content": { "application/json": { "schema": { @@ -1450,13 +1450,13 @@ "properties": { "context": { "type": "string", - "description": "the context to create this apple pay session.", + "description": "Hostname of the website displaying the Apple Pay payment sheet, without a URL scheme or path. Use the domain registered for Apple Pay.", "format": "hostname", "example": "example.com" }, "target": { "type": "string", - "description": "The target url to create this apple pay session.", + "description": "Apple Pay validation URL received as `validationURL` in the browser's `onvalidatemerchant` event.", "format": "uri", "example": "https://apple-pay-gateway-cert.apple.com/paymentservices/startSession" } @@ -1548,7 +1548,7 @@ "post": { "operationId": "CreateCustomer", "summary": "Create a customer", - "description": "Creates a new saved customer resource which you can later manipulate and save payment instruments to.", + "description": "Creates a customer using the `customer_id` you supply. Choose an identifier that maps to the payer in your own system and reuse it when retrieving the customer or associating checkouts and saved payment instruments with them.", "tags": [ "Customers" ], @@ -1711,7 +1711,7 @@ "name": "customer_id", "in": "path", "required": true, - "description": "Unique identifier of the saved customer resource.", + "description": "The `customer_id` you supplied when creating the customer.", "schema": { "type": "string", "example": "831ff8d4cd5958ab5670" @@ -1721,7 +1721,7 @@ "get": { "operationId": "GetCustomer", "summary": "Retrieve a customer", - "description": "Retrieves an identified saved customer resource through the unique `customer_id` parameter, generated upon customer creation.", + "description": "Retrieves a saved customer using the `customer_id` you supplied when creating the customer.", "tags": [ "Customers" ], @@ -1939,7 +1939,7 @@ "name": "customer_id", "in": "path", "required": true, - "description": "Unique identifier of the saved customer resource.", + "description": "The `customer_id` you supplied when creating the customer.", "schema": { "type": "string", "example": "831ff8d4cd5958ab5670" @@ -2055,7 +2055,7 @@ "name": "customer_id", "in": "path", "required": true, - "description": "Unique identifier of the saved customer resource.", + "description": "The `customer_id` you supplied when creating the customer.", "schema": { "type": "string", "example": "831ff8d4cd5958ab5670" @@ -2210,7 +2210,7 @@ "post": { "operationId": "RefundTransaction", "summary": "Refund a transaction", - "description": "Refunds an identified transaction either in full or partially.", + "description": "Refunds a transaction identified by its SumUp transaction ID. Omit the request body to request a full refund, or provide `amount` for a partial refund in the transaction's currency.\n\nRetrieve the transaction afterwards to inspect its refunded amount and refund events. The transaction must be eligible for a refund; see the error responses for invalid amounts, permissions, and processing failures.", "tags": [ "Transactions" ], @@ -2246,7 +2246,7 @@ "amount": { "type": "number", "format": "float", - "description": "Amount to be refunded. Eligible amount can't exceed the amount of the transaction and varies based on country and currency. If you do not specify a value, the system performs a full refund of the transaction.", + "description": "Amount to refund in major units of the transaction's currency, for example `5` for EUR 5.00. It must be greater than zero and cannot exceed the amount eligible for a refund. Eligibility depends on the transaction and country/currency rules. If omitted, the system requests a full refund.", "example": 5 } } @@ -2260,7 +2260,8 @@ "content": { "application/json": { "schema": { - "type": "object" + "type": "object", + "properties": {} }, "example": {} } @@ -2532,7 +2533,7 @@ "get": { "operationId": "ListTransactionsV2.1", "summary": "List transactions", - "description": "Lists detailed history of all transactions associated with the merchant profile.", + "description": "Lists transaction history for the merchant, with optional filters for payment type, status, and date range. The response contains the current page in `items` and pagination query strings in `links`.\n\nTo request another page, use the query string from the relevant link's `href` with this history endpoint. Use `changes_since` when retrieving transactions modified since a previous synchronization, including transactions created earlier whose status has changed.", "tags": [ "Transactions" ], @@ -2578,7 +2579,7 @@ { "name": "order", "in": "query", - "description": "Specifies the order in which the returned results are displayed.", + "description": "Sort direction for the transaction history. Use `ascending` or `descending`; the default is `ascending`.", "schema": { "type": "string", "enum": [ @@ -2591,7 +2592,7 @@ { "name": "limit", "in": "query", - "description": "Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will return 10 results.", + "description": "Maximum number of transactions per page. Must be a positive integer. Defaults to `10` when omitted; a page can contain fewer results.", "schema": { "type": "integer", "example": 10 @@ -2600,7 +2601,7 @@ { "name": "users[]", "in": "query", - "description": "Filters the returned results by user email.", + "description": "Filters transactions by user email. For multiple values, repeat the query parameter, for example `users[]=first@example.com\u0026users[]=second@example.com`.", "required": false, "example": [ "merchant@example.com" @@ -2619,7 +2620,7 @@ { "name": "statuses[]", "in": "query", - "description": "Filters the returned results by the specified list of final statuses of the transactions.", + "description": "Filters transactions by the listed final statuses. For multiple values, repeat the query parameter, for example `statuses[]=SUCCESSFUL\u0026statuses[]=REFUNDED`.", "required": false, "schema": { "type": "array", @@ -2717,7 +2718,7 @@ { "name": "newest_ref", "in": "query", - "description": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *smaller* than the specified value. This parameters supersedes the `newest_time` parameter (if both are provided in the request).", + "description": "Pagination reference that returns results before the specified reference. Use the value from a returned pagination link rather than constructing it yourself. This parameter takes precedence over `newest_time` when both are provided.", "required": false, "schema": { "type": "string", @@ -2738,7 +2739,7 @@ { "name": "oldest_ref", "in": "query", - "description": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *greater* than the specified value. This parameters supersedes the `oldest_time` parameter (if both are provided in the request).", + "description": "Pagination reference that returns results after the specified reference. Use the value from a returned pagination link rather than constructing it yourself. This parameter takes precedence over `oldest_time` when both are provided.", "required": false, "schema": { "type": "string", @@ -3060,7 +3061,7 @@ "get": { "operationId": "GetReceipt", "summary": "Retrieve receipt details", - "description": "Retrieves receipt specific data for a transaction.", + "description": "Retrieves structured receipt data for a transaction belonging to the merchant specified by `mid`. The path accepts either the SumUp transaction ID or transaction code. Provide `tx_event_id` to include a specific transaction event, such as a refund, on the receipt.", "tags": [ "Receipts" ], @@ -6242,7 +6243,7 @@ }, "payment_account_reference": { "type": "string", - "description": "PAR (Payment account reference) if available for the card.", + "description": "Payment Account Reference (PAR) defined by [EMVCo](https://www.emvco.com/emv-technologies/payment-tokenisation/). It links a card's primary account number (PAN) with its affiliated payment tokens, allowing transactions made with the physical card and tokenized versions of that card, such as digital wallets, to be correlated when PAR is available.\n\nThis reference cannot be used to initiate a payment and is separate from the saved payment instrument `token` used to process checkouts. Returned only when available for the card; integrations must handle its absence.", "example": "5665ABCDEFGHIJKLMNOPQRSTUVWXY" } } @@ -6328,7 +6329,7 @@ "properties": { "checkout_reference": { "type": "string", - "maxLength": 90, + "maxLength": 64, "description": "Merchant-defined reference for the checkout. Use it to correlate the SumUp checkout with your own order, cart, subscription, or payment attempt in your systems.", "example": "f00a8f74-b05d-4605-bd73-2a901bae5802" }, @@ -6354,7 +6355,7 @@ "return_url": { "type": "string", "format": "uri", - "description": "Optional backend callback URL used by SumUp to notify your platform about processing updates for the checkout.", + "description": "Optional backend callback URL for checkout status notifications. SumUp sends an HTTP POST with `event_type` and the checkout `id`. Retrieve the checkout to verify its current status before updating your order. See the [webhook guide](https://developer.sumup.com/online-payments/webhooks/) for the payload and response requirements.", "example": "http://example.com" }, "id": { @@ -6382,7 +6383,7 @@ }, "valid_until": { "type": "string", - "example": "2020-02-29T10:56:56+00:00", + "example": "2030-12-31T23:59:59Z", "format": "date-time", "description": "Optional expiration timestamp. The checkout must be processed before this moment, otherwise it becomes unusable. If omitted, the checkout does not have an explicit expiry time.", "nullable": true @@ -6444,7 +6445,7 @@ "checkout_reference": { "type": "string", "maxLength": 64, - "description": "Merchant-defined reference for the new checkout. It should be unique enough for you to identify the payment attempt in your own systems.", + "description": "Merchant-defined reference for the new checkout, up to 64 characters. Use it to correlate the checkout with an order or payment attempt in your own system. If a checkout already exists for the supplied unique parameters, creation returns `409` with `DUPLICATED_CHECKOUT`; see the conflict response.", "example": "f00a8f74-b05d-4605-bd73-2a901bae5802" }, "amount": { @@ -6469,7 +6470,7 @@ "return_url": { "type": "string", "format": "uri", - "description": "Optional backend callback URL used by SumUp to notify your platform about processing updates for the checkout.", + "description": "Optional backend callback URL for checkout status notifications. SumUp sends an HTTP POST with `event_type` and the checkout `id`. Retrieve the checkout to verify its current status before updating your order. See the [webhook guide](https://developer.sumup.com/online-payments/webhooks/) for the payload and response requirements.", "example": "http://example.com/" }, "customer_id": { @@ -6488,7 +6489,7 @@ }, "valid_until": { "type": "string", - "example": "2020-02-29T10:56:56+00:00", + "example": "2030-12-31T23:59:59Z", "format": "date-time", "description": "Optional expiration timestamp. The checkout must be processed before this moment, otherwise it becomes unusable. If omitted, the checkout does not have an explicit expiry time.", "nullable": true @@ -6530,13 +6531,13 @@ }, "checkout_reference": { "type": "string", - "maxLength": 90, + "maxLength": 64, "description": "Updated merchant-defined reference for the checkout.", "example": "f00a8f74-b05d-4605-bd73-2a901bae5802" }, "valid_until": { "type": "string", - "example": "2020-02-29T10:56:56+00:00", + "example": "2030-12-31T23:59:59Z", "format": "date-time", "description": "Updated expiration timestamp. The checkout must be processed before this moment, otherwise it becomes unusable.", "nullable": true @@ -6626,7 +6627,7 @@ }, "token": { "type": "string", - "description": "Saved-card token to use instead of raw card details when processing with a previously stored payment instrument.", + "description": "Token of a saved payment instrument returned by checkout processing or the customer's payment-instruments endpoint. To charge a saved card, set `payment_type` to `card` and provide both this `token` and the associated `customer_id` instead of raw card details.", "example": "ba85dfee-c3cf-48a6-84f5-d7d761fbba50" }, "customer_id": { @@ -6746,14 +6747,14 @@ "Customer": { "type": "object", "title": "Customer", - "description": "Saved customer details.", + "description": "Saved payer details identified by the `customer_id` supplied by your integration. A customer can have saved payment instruments for subsequent payments.", "required": [ "customer_id" ], "properties": { "customer_id": { "type": "string", - "description": "Unique identifier of the customer.", + "description": "Identifier you supply when creating the customer. Use an ID from your own system and retain it for subsequent customer, checkout, and saved-payment-instrument requests.", "example": "831ff8d4cd5958ab5670" }, "personal_details": { @@ -7086,12 +7087,12 @@ "properties": { "rel": { "type": "string", - "description": "Relation.", + "description": "Pagination relation indicating which page the link retrieves, for example `next`.", "example": "next" }, "href": { "type": "string", - "description": "Location.", + "description": "Query string to use with the transaction history endpoint when requesting the linked page. Preserve the returned pagination references and query parameters.", "example": "limit=10\u0026oldest_ref=090df9bf-93b7-40f1-8181-fbdb236568a1\u0026order=ascending" } }, @@ -7172,7 +7173,7 @@ "properties": { "token": { "type": "string", - "description": "Unique token identifying the saved payment card for a customer.", + "description": "Token identifying the customer's saved payment card. Pass it as `token`, together with the associated `customer_id` and `payment_type = card`, when processing a checkout with this instrument.", "readOnly": true, "example": "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3" }, @@ -7260,7 +7261,7 @@ }, "birth_date": { "type": "string", - "description": "Date of birth of the customer.", + "description": "Date of birth of the customer in `YYYY-MM-DD` format, without a time or timezone.", "format": "date", "example": "1993-12-31" }, @@ -7299,7 +7300,7 @@ "vat_rate": { "type": "number", "format": "decimal", - "description": "VAT rate applied to the product price.", + "description": "VAT rate as a decimal fraction, for example `0.19` for 19%.", "example": 0.19 }, "single_vat_amount": { @@ -7342,7 +7343,7 @@ "Receipt": { "type": "object", "title": "Receipt", - "description": "Receipt details for a transaction.", + "description": "Structured receipt details for a transaction. The transaction's `amount`, `vat_amount`, and `tip_amount`, as well as event amounts, are returned as decimal strings in major currency units, for example `\"10.10\"` for EUR 10.10.", "properties": { "transaction_data": { "$ref": "#/components/schemas/ReceiptTransaction" @@ -7791,7 +7792,7 @@ "amount": { "type": "number", "format": "decimal", - "description": "Amount of the event.", + "description": "Amount of the event in major units of the associated transaction's currency.", "example": 58.8 }, "due_date": { @@ -7808,7 +7809,7 @@ }, "installment_number": { "type": "integer", - "description": "Consecutive number of the installment that is paid. Applicable only payout events, i.e. `event_type = PAYOUT`.", + "description": "Consecutive number of the installment that is paid. Applicable only to payout events, i.e. `event_type = PAYOUT`.", "example": 1 }, "timestamp": { @@ -7831,13 +7832,13 @@ }, "transaction_code": { "type": "string", - "description": "Transaction code returned by the acquirer/processing entity after processing the transaction.", + "description": "SumUp transaction code, for example `TEENSK4W2K`. Use it to look up the transaction with the `transaction_code` query parameter. This is separate from the transaction's `id` and the card issuer's `auth_code`.", "example": "TEENSK4W2K" }, "amount": { "type": "number", "format": "float", - "description": "Total amount of the transaction.", + "description": "Total amount of the transaction in major units of `currency`, for example `10.1` for EUR 10.10.", "example": 10.1 }, "currency": { @@ -7876,13 +7877,13 @@ "vat_amount": { "type": "number", "format": "float", - "description": "Amount of the applicable VAT (out of the total transaction amount).", + "description": "VAT included in the total transaction amount, in major units of the transaction's currency.", "example": 6 }, "tip_amount": { "type": "number", "format": "float", - "description": "Amount of the tip (out of the total transaction amount).", + "description": "Tip included in the total transaction amount, in major units of the transaction's currency.", "example": 3 }, "entry_mode": { @@ -7985,7 +7986,7 @@ "refunded_amount": { "type": "number", "format": "decimal", - "description": "Total refunded amount.", + "description": "Total amount refunded for this transaction, in major units of the transaction's currency.", "example": 0 } } @@ -7995,7 +7996,7 @@ "PaymentType": { "title": "Payment Type", "type": "string", - "description": "Payment type used for the transaction.", + "description": "Payment category recorded on a transaction, for example `POS` for a point-of-sale card payment, `ECOM` for an online card payment, or `RECURRING` for a recurring card payment. These reporting values are separate from the lowercase `payment_type` values used to process checkouts.", "enum": [ "CASH", "POS", @@ -8014,7 +8015,7 @@ "EntryMode": { "title": "Entry Mode", "type": "string", - "description": "Entry mode of the payment details.", + "description": "How the payment details were captured, for example `CHIP` or `CONTACTLESS` for card-present payments and `CUSTOMER_ENTRY` for card details entered by the payer. For wallet and alternative payment methods, this can identify the method, such as `APPLE_PAY` or `BLIK`.", "enum": [ "BOLETO", "SOFORT", @@ -8113,7 +8114,7 @@ "fee_amount": { "type": "number", "format": "decimal", - "description": "Transaction SumUp total fee amount.", + "description": "Total SumUp transaction fee in major units of the transaction's currency.", "example": 8 }, "lat": { @@ -8345,7 +8346,7 @@ "TransactionEventType": { "title": "Transaction Event Type", "type": "string", - "description": "Type of the transaction event.", + "description": "Financial event associated with a transaction.\n\n- `PAYOUT`: Funds from the transaction being prepared for or included in a merchant payout. Check the event status to determine whether they have been paid out.\n- `REFUND`: Money returned to the payer.\n- `CHARGE_BACK`: A reversal of the payment following a chargeback.\n- `PAYOUT_DEDUCTION`: An amount deducted from a merchant payout, for example to cover a refund or chargeback.", "enum": [ "PAYOUT", "CHARGE_BACK", @@ -8373,7 +8374,7 @@ "title": "Transaction Event ID", "type": "integer", "format": "int64", - "description": "Unique identifier of the transaction event.", + "description": "Numeric identifier of a transaction event. Use it as `tx_event_id` when requesting receipt details for a specific event. This is separate from the transaction ID and the transaction history pagination references.", "example": 9567461191 }, "HorizontalAccuracy": { @@ -8388,7 +8389,7 @@ "type": "number", "format": "float", "description": "Latitude value from the coordinates of the payment location (as received from the payment terminal reader).", - "minimum": 0, + "minimum": -90, "maximum": 90, "example": 52.520008 }, @@ -8397,7 +8398,7 @@ "type": "number", "format": "float", "description": "Longitude value from the coordinates of the payment location (as received from the payment terminal reader).", - "minimum": 0, + "minimum": -180, "maximum": 180, "example": 13.404954 }, @@ -8453,7 +8454,15 @@ "ReaderPaymentRequestParams": { "properties": { "affiliate": { - "$ref": "#/components/schemas/Affiliate" + "allOf": [ + { + "description": "Optional caller-supplied context about the integration initiating the payment.", + "type": "object" + }, + { + "$ref": "#/components/schemas/Affiliate" + } + ] }, "client_transaction_id": { "description": "Caller-supplied correlation identifier, used as the idempotency key.", @@ -8466,7 +8475,18 @@ "type": "integer" }, "total_amount": { - "$ref": "#/components/schemas/Amount" + "allOf": [ + { + "description": "Amount structure. The amount is represented as an integer value altogether with the currency and the minor unit. For example, MXN 10.00 is represented as value 1000 with minor unit of 2.", + "example": { + "currency": "MXN", + "value": 1000 + } + }, + { + "$ref": "#/components/schemas/Amount" + } + ] } }, "required": [ @@ -8969,7 +8989,15 @@ "example": "10999" }, "country": { - "$ref": "#/components/schemas/CountryCode" + "allOf": [ + { + "description": "The ISO3166-1 Alpha-2 code of the address country.\n", + "example": "DE" + }, + { + "$ref": "#/components/schemas/CountryCode" + } + ] }, "city": { "type": "string", @@ -9290,9 +9318,7 @@ "description": "Footer text rendered on receipts and other customer-facing products.\n", "minLength": 1, "maxLength": 500, - "examples": [ - "Thanks for shopping with us." - ] + "example": "Thanks for shopping with us." }, "icon": { "type": "string", @@ -9312,47 +9338,27 @@ "primary_color": { "type": "string", "description": "A hex color value representing the primary branding color of this merchant (your brand color).\n", - "examples": [ - "#FF4B3A", - "#0072C6", - "#F68B20" - ] + "example": "#FF4B3A" }, "primary_color_fg": { "type": "string", "description": "A hex color value representing the color of the text displayed on branding color of this merchant.\n", - "examples": [ - "#FF4B3A", - "#0072C6", - "#F68B20" - ] + "example": "#FF4B3A" }, "secondary_color": { "type": "string", "description": "A hex color value representing the secondary branding color of this merchant (accent color used for buttons).\n", - "examples": [ - "#FF4B3A", - "#0072C6", - "#F68B20" - ] + "example": "#FF4B3A" }, "secondary_color_fg": { "type": "string", "description": "A hex color value representing the color of the text displayed on secondary branding color of this merchant.\n", - "examples": [ - "#FF4B3A", - "#0072C6", - "#F68B20" - ] + "example": "#FF4B3A" }, "background_color": { "type": "string", "description": "A hex color value representing the preferred background color of this merchant.\n", - "examples": [ - "#FF4B3A", - "#0072C6", - "#F68B20" - ] + "example": "#FF4B3A" } } }, @@ -9366,12 +9372,7 @@ "minLength": 4, "maxLength": 64, "pattern": "^[a-z]{2}\\.[a-z_]+$", - "examples": [ - "de.freiberufler", - "br.ltda", - "gb.partnership", - "bg.private_limited_company" - ] + "example": "de.freiberufler" }, "CompanyIdentifiers": { "type": "array", @@ -9395,26 +9396,20 @@ "type": "string", "pattern": "^[a-z]{2}\\.[a-z_]+$", "description": "The unique reference for the company identifier type as defined in the country SDK.\n", - "examples": [ - "de.gmbh" - ] + "example": "de.gmbh" }, "value": { "type": "string", "minLength": 1, "maxLength": 100, "description": "The company identifier value.\n", - "examples": [ - "HRB 123456" - ] + "example": "HRB 123456" } }, - "examples": [ - { - "ref": "de.gmbh", - "value": "HRB 123456" - } - ] + "example": { + "ref": "de.gmbh", + "value": "HRB 123456" + } }, "Ownership": { "type": "object", @@ -9435,9 +9430,7 @@ "Version": { "type": "string", "description": "The version of the resource. The version reflects a specific change submitted to the API via one of the `PATCH` endpoints.\n", - "examples": [ - "chng_01HS0KG3MPVEVWW85E3KNXH55J" - ] + "example": "chng_01HS0KG3MPVEVWW85E3KNXH55J" }, "ChangeStatus": { "type": "string", @@ -9459,16 +9452,12 @@ "type": "string", "readOnly": true, "description": "The unique identifier for the Person. This is a [typeid](https://github.com/sumup/typeid).\n", - "examples": [ - "pers_2EGQ057R6C8J791RVCG5NWAEAB" - ] + "example": "pers_2EGQ057R6C8J791RVCG5NWAEAB" }, "user_id": { "type": "string", "description": "A corresponding identity user ID for the Person, if they have a user account.\n", - "examples": [ - "ef263f37-8701-4181-9758-acddbb778ee9" - ] + "example": "ef263f37-8701-4181-9758-acddbb778ee9" }, "birthdate": { "type": "string", @@ -9498,7 +9487,14 @@ "maxLength": 60 }, "phone_number": { - "$ref": "#/components/schemas/PhoneNumber" + "allOf": [ + { + "description": "The (mobile) phone number of the individual (used for verification) in [E.164](https://en.wikipedia.org/wiki/E.164) format.\n" + }, + { + "$ref": "#/components/schemas/PhoneNumber" + } + ] }, "relationships": { "type": "array", @@ -9508,24 +9504,41 @@ "items": { "type": "string", "description": "* `representative`: The Person is the primary contact for SumUp and has full administrative power over the merchant account.\n* `owner`: The Person is a business owner. If this value is set, the `ownership_percent` should be set as well.\n* `officer`: The Person is an officer at the company.\n", - "examples": [ - "representative", - "owner", - "officer" - ] + "example": "representative" } }, "ownership": { - "$ref": "#/components/schemas/Ownership" + "allOf": [ + { + "description": "Details about the ownership relationship between the Person and the Merchant. This is only set if the Person has a relationship of type `owner`.\n" + }, + { + "$ref": "#/components/schemas/Ownership" + } + ] }, "address": { - "$ref": "#/components/schemas/Address" + "allOf": [ + { + "description": "The address of the individual." + }, + { + "$ref": "#/components/schemas/Address" + } + ] }, "identifiers": { "$ref": "#/components/schemas/PersonalIdentifiers" }, "citizenship": { - "$ref": "#/components/schemas/CountryCode" + "allOf": [ + { + "description": "The Alpha-2 ISO code of the country where the Person is a citizen.\n" + }, + { + "$ref": "#/components/schemas/CountryCode" + } + ] }, "nationality": { "type": "string", @@ -9569,28 +9582,54 @@ "pattern": "^[0-9]{4}$" }, "legal_type": { - "$ref": "#/components/schemas/LegalType" + "allOf": [ + { + "description": "The category identifying the legal structure of the company or legal entity.\n" + }, + { + "$ref": "#/components/schemas/LegalType" + } + ] }, "address": { - "$ref": "#/components/schemas/Address" + "allOf": [ + { + "description": "The company's primary address." + }, + { + "$ref": "#/components/schemas/Address" + } + ] }, "trading_address": { - "$ref": "#/components/schemas/Address" + "allOf": [ + { + "description": "A trading address is where your suppliers, banks or customers send you correspondence to. Trading address can be different to the company's registered address (`address`).\n" + }, + { + "$ref": "#/components/schemas/Address" + } + ] }, "identifiers": { "$ref": "#/components/schemas/CompanyIdentifiers" }, "phone_number": { - "$ref": "#/components/schemas/PhoneNumber" + "allOf": [ + { + "description": "The company's phone number (used for verification) in [E.164](https://en.wikipedia.org/wiki/E.164) format.\n" + }, + { + "$ref": "#/components/schemas/PhoneNumber" + } + ] }, "website": { "description": "HTTP(S) URL of the company's website.\n", "type": "string", "minLength": 1, "maxLength": 255, - "examples": [ - "https://www.sumup.com" - ] + "example": "https://www.sumup.com" }, "attributes": { "$ref": "#/components/schemas/Attributes" @@ -9620,18 +9659,14 @@ "format": "date-time", "description": "The date and time when the resource was created. This is a string as defined in [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).\n", "readOnly": true, - "examples": [ - "2021-08-31T12:00:00Z" - ] + "example": "2021-08-31T12:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "The date and time when the resource was last updated. This is a string as defined in [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).\n", "readOnly": true, - "examples": [ - "2021-08-31T12:00:00Z" - ] + "example": "2021-08-31T12:00:00Z" } }, "required": [ @@ -10524,7 +10559,7 @@ "currency": "EUR", "merchant_code": "MH4H92C7", "description": "Purchase", - "valid_until": "2020-02-29T10:56:56+00:00", + "valid_until": "2030-12-31T23:59:59Z", "redirect_url": "https://sumup.com" } }, @@ -10582,7 +10617,7 @@ "currency": "EUR", "description": "Updated purchase", "checkout_reference": "f00a8f74-b05d-4605-bd73-2a901bae5802", - "valid_until": "2020-02-29T10:56:56+00:00", + "valid_until": "2030-12-31T23:59:59Z", "customer_id": "831ff8d4cd5958ab5670" } } @@ -10629,7 +10664,7 @@ "amount": { "type": "number", "format": "float", - "description": "Amount to be refunded. Eligible amount can't exceed the amount of the transaction and varies based on country and currency. If you do not specify a value, the system performs a full refund of the transaction.", + "description": "Amount to refund in major units of the transaction's currency, for example `5` for EUR 5.00. It must be greater than zero and cannot exceed the amount eligible for a refund. Eligibility depends on the transaction and country/currency rules. If omitted, the system requests a full refund.", "example": 5 } } @@ -10660,7 +10695,7 @@ "id": "88fcf8de-304d-4820-8f1c-ec880290eb92", "status": "PENDING", "date": "2020-02-29T10:56:56+00:00", - "valid_until": "2020-02-29T10:56:56+00:00", + "valid_until": "2030-12-31T23:59:59Z", "customer_id": "831ff8d4cd5958ab5670", "mandate": { "type": "recurrent", @@ -10697,7 +10732,7 @@ "id": "88fcf8de-304d-4820-8f1c-ec880290eb92", "status": "PENDING", "date": "2020-02-29T10:56:56+00:00", - "valid_until": "2020-02-29T10:56:56+00:00", + "valid_until": "2030-12-31T23:59:59Z", "customer_id": "831ff8d4cd5958ab5670", "redirect_url": "https://mysite.com/completed_purchase", "transactions": [ @@ -10796,7 +10831,7 @@ "id": "88fcf8de-304d-4820-8f1c-ec880290eb92", "status": "PENDING", "date": "2020-02-29T10:56:56+00:00", - "valid_until": "2020-02-29T10:56:56+00:00", + "valid_until": "2030-12-31T23:59:59Z", "customer_id": "831ff8d4cd5958ab5670", "transactions": [] } @@ -11116,7 +11151,7 @@ "CheckoutReference": { "name": "checkout_reference", "in": "query", - "description": "Filters the list of checkout resources by the unique reference of the checkout.", + "description": "Filters checkouts by the merchant-defined `checkout_reference` supplied when creating the checkout. This is separate from the SumUp-generated checkout `id`.", "required": false, "schema": { "type": "string", @@ -11127,7 +11162,7 @@ "name": "checkout_id", "in": "path", "required": true, - "description": "Unique identifier of the checkout resource.", + "description": "SumUp-generated `id` returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.", "schema": { "type": "string", "example": "4e425463-3e1b-431d-83fa-1e51c2925e99" @@ -11137,7 +11172,7 @@ "name": "customer_id", "in": "path", "required": true, - "description": "Unique identifier of the saved customer resource.", + "description": "The `customer_id` you supplied when creating the customer.", "schema": { "type": "string", "example": "831ff8d4cd5958ab5670" @@ -11166,7 +11201,7 @@ "OrderFilter": { "name": "order", "in": "query", - "description": "Specifies the order in which the returned results are displayed.", + "description": "Sort direction for the transaction history. Use `ascending` or `descending`; the default is `ascending`.", "schema": { "type": "string", "enum": [ @@ -11179,7 +11214,7 @@ "LimitFilter": { "name": "limit", "in": "query", - "description": "Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will return 10 results.", + "description": "Maximum number of transactions per page. Must be a positive integer. Defaults to `10` when omitted; a page can contain fewer results.", "schema": { "type": "integer", "example": 10 @@ -11188,7 +11223,7 @@ "UsersFilter": { "name": "users[]", "in": "query", - "description": "Filters the returned results by user email.", + "description": "Filters transactions by user email. For multiple values, repeat the query parameter, for example `users[]=first@example.com\u0026users[]=second@example.com`.", "required": false, "example": [ "merchant@example.com" @@ -11207,7 +11242,7 @@ "StatusesFilter": { "name": "statuses[]", "in": "query", - "description": "Filters the returned results by the specified list of final statuses of the transactions.", + "description": "Filters transactions by the listed final statuses. For multiple values, repeat the query parameter, for example `statuses[]=SUCCESSFUL\u0026statuses[]=REFUNDED`.", "required": false, "schema": { "type": "array", @@ -11305,7 +11340,7 @@ "NewestRefFilter": { "name": "newest_ref", "in": "query", - "description": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *smaller* than the specified value. This parameters supersedes the `newest_time` parameter (if both are provided in the request).", + "description": "Pagination reference that returns results before the specified reference. Use the value from a returned pagination link rather than constructing it yourself. This parameter takes precedence over `newest_time` when both are provided.", "required": false, "schema": { "type": "string", @@ -11325,13 +11360,13 @@ }, "securitySchemes": { "apiKey": { - "description": "API keys allow you easily interact with SumUp APIs. API keys are static tokens. You can create API keys from the [Dashboard](https://me.sumup.com/settings/api-keys)", + "description": "Authenticate requests with an API key created in the [Dashboard](https://me.sumup.com/settings/api-keys). Send the key in the HTTP `Authorization` header as `Bearer YOUR_API_KEY`. See the [API key guide](https://developer.sumup.com/tools/authorization/api-keys/).", "type": "http", "scheme": "Bearer" }, "oauth2": { "type": "oauth2", - "description": "SumUp supports [OAuth 2.0](https://tools.ietf.org/html/rfc6749) authentication for platforms that want to offer their services to SumUp users.\n\nTo integrate via OAuth 2.0 you will need a client credentials that you can create in the [SumUp Dashboard](https://me.sumup.com/settings/oauth2-applications).\n\nTo maintain security of our users, we highly recommend that you use one of the [recommended OAuth 2.0 libraries](https://oauth.net/code/) for authentication.", + "description": "SumUp supports [OAuth 2.0](https://tools.ietf.org/html/rfc6749) authentication for platforms that want to offer their services to SumUp users.\n\nRegister an application in the [SumUp Dashboard](https://me.sumup.com/settings/oauth2-applications) to obtain a client ID and client secret. Use the authorization code flow to request a merchant's consent, then send the issued access token in the HTTP `Authorization` header as `Bearer ACCESS_TOKEN`. Request the scopes needed for the endpoints your integration calls.\n\nTo maintain security of our users, we highly recommend that you use one of the [recommended OAuth 2.0 libraries](https://oauth.net/code/) for authentication.", "flows": { "authorizationCode": { "authorizationUrl": "https://api.sumup.com/authorize", @@ -11391,227 +11426,5 @@ "description": "Delete the reader." } } - }, - "webhooks": { - "readers.created": { - "post": { - "operationId": "ReaderCreatedWebhook", - "tags": [ - "Readers" - ], - "summary": "Reader created", - "description": "Sent when a reader is paired to a merchant account and becomes available through the Readers API.", - "x-object": { - "$ref": "#/components/schemas/Reader" - }, - "x-object-type": "reader", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Event" - }, - "examples": { - "created": { - "summary": "A reader created webhook event.", - "value": { - "id": "evt_reader_123", - "type": "readers.created", - "created_at": "2023-05-09T14:52:58.714Z", - "object": { - "id": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65", - "type": "reader", - "url": "https://api.sumup.com/v0.1/merchants/MC0DE/readers/rdr_3MSAFM23CK82VSTT4BN6RWSQ65" - } - } - } - } - } - } - }, - "responses": { - "2XX": { - "description": "Return any 2xx response to acknowledge successful delivery." - } - } - } - }, - "readers.deleted": { - "post": { - "operationId": "ReaderDeletedWebhook", - "tags": [ - "Readers" - ], - "summary": "Reader deleted", - "description": "Sent when a reader is unpaired from a merchant account and is no longer available through the Readers API.", - "x-object": { - "$ref": "#/components/schemas/Reader" - }, - "x-object-type": "reader", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Event" - }, - "examples": { - "deleted": { - "summary": "A reader deleted webhook event.", - "value": { - "id": "evt_reader_456", - "type": "readers.deleted", - "created_at": "2023-05-10T09:21:33.004Z", - "object": { - "id": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65", - "type": "reader", - "url": "https://api.sumup.com/v0.1/merchants/MC0DE/readers/rdr_3MSAFM23CK82VSTT4BN6RWSQ65" - } - } - } - } - } - } - }, - "responses": { - "2XX": { - "description": "Return any 2xx response to acknowledge successful delivery." - } - } - } - }, - "members.created": { - "post": { - "operationId": "MemberCreatedWebhook", - "tags": [ - "Members" - ], - "summary": "Member created", - "description": "Sent when a member is created, invited, or accepts an invitation for a merchant account.", - "x-object": { - "$ref": "#/components/schemas/Member" - }, - "x-object-type": "member", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Event" - }, - "examples": { - "created": { - "summary": "A member created webhook event.", - "value": { - "id": "evt_membership_123", - "type": "members.created", - "created_at": "2026-05-14T08:30:00Z", - "object": { - "id": "mem_123", - "type": "member", - "url": "https://api.sumup.com/v0.1/merchants/MC0DE/members/mem_123" - } - } - } - } - } - } - }, - "responses": { - "2XX": { - "description": "Return any 2xx response to acknowledge successful delivery." - } - } - } - }, - "members.updated": { - "post": { - "operationId": "MemberUpdatedWebhook", - "tags": [ - "Members" - ], - "summary": "Member updated", - "description": "Sent when a member is updated, disabled, rejected, or expires for a merchant account.", - "x-object": { - "$ref": "#/components/schemas/Member" - }, - "x-object-type": "member", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Event" - }, - "examples": { - "updated": { - "summary": "A member updated webhook event.", - "value": { - "id": "evt_membership_456", - "type": "members.updated", - "created_at": "2026-05-14T09:15:00Z", - "object": { - "id": "mem_123", - "type": "member", - "url": "https://api.sumup.com/v0.1/merchants/MC0DE/members/mem_123" - } - } - } - } - } - } - }, - "responses": { - "2XX": { - "description": "Return any 2xx response to acknowledge successful delivery." - } - } - } - }, - "members.deleted": { - "post": { - "operationId": "MemberDeletedWebhook", - "tags": [ - "Members" - ], - "summary": "Member deleted", - "description": "Sent when a member is deleted from a merchant account.", - "x-object": { - "$ref": "#/components/schemas/Member" - }, - "x-object-type": "member", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Event" - }, - "examples": { - "deleted": { - "summary": "A member deleted webhook event.", - "value": { - "id": "evt_membership_789", - "type": "members.deleted", - "created_at": "2026-05-14T10:45:00Z", - "object": { - "id": "mem_123", - "type": "member", - "url": "https://api.sumup.com/v0.1/merchants/MC0DE/members/mem_123" - } - } - } - } - } - } - }, - "responses": { - "2XX": { - "description": "Return any 2xx response to acknowledge successful delivery." - } - } - } - } } } \ No newline at end of file