From 30bdff732101e60e6097777cfafcad05e0a04475 Mon Sep 17 00:00:00 2001 From: appscisumup Date: Fri, 24 Jul 2026 14:05:36 +0000 Subject: [PATCH 1/2] chore: synced local 'openapi.json' with remote 'specs/openapi.json' --- openapi.json | 622 +++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 605 insertions(+), 17 deletions(-) diff --git a/openapi.json b/openapi.json index de333ee..04f9652 100755 --- a/openapi.json +++ b/openapi.json @@ -3030,6 +3030,171 @@ ] } }, + "/v0/merchants/{merchant_code}/readers/{reader_id}/go-checkout": { + "post": { + "operationId": "CreateGoReaderCheckout", + "summary": "Create a Go Reader Payment", + "description": "Initiates a payment on the SumUp Go terminal identified by the reader ID.\n\nUse `client_transaction_id` as an idempotency key: retrying the request with the same value returns the result of the original payment instead of creating a duplicate.", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Access token in the format 'Bearer {token}'.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "merchant_code", + "in": "path", + "description": "Short unique identifier for the merchant.", + "required": true, + "schema": { + "type": "string", + "example": "MK10CL2A" + } + }, + { + "name": "reader_id", + "in": "path", + "description": "The unique identifier of the reader.", + "required": true, + "schema": { + "$ref": "#/components/schemas/ReaderID" + } + } + ], + "requestBody": { + "description": "Payment details to initiate on the reader.", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReaderPaymentRequestParams" + } + } + } + }, + "responses": { + "200": { + "description": "Returns the result of the payment initiated on the reader.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReaderPaymentResponse" + } + } + } + }, + "400": { + "description": "The request is invalid.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/Problem" + }, + "example": { + "type": "https://developer.sumup.com/problem/bad-request", + "title": "Bad Request", + "status": 400, + "detail": "Request validation failed." + } + } + } + }, + "401": { + "description": "Authentication failed or missing required scope.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/Problem" + }, + "example": { + "type": "https://developer.sumup.com/problem/unauthorized", + "title": "Unauthorized", + "status": 401, + "detail": "Authentication credentials are missing or invalid." + } + } + } + }, + "404": { + "description": "The requested Reader resource does not exist.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/Problem" + }, + "example": { + "type": "https://developer.sumup.com/problem/not-found", + "title": "Requested resource couldn't be found.", + "status": 404, + "detail": "The requested resource doesn't exist or does not belong to you." + } + } + } + }, + "422": { + "description": "The request could not be processed as it violates a business rule.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/Problem" + }, + "example": { + "type": "https://developer.sumup.com/problem/validation-error", + "title": "Unprocessable Entity", + "status": 422, + "detail": "Validation failed." + } + } + } + }, + "500": { + "description": "An unexpected error occurred while processing the request.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/Problem" + }, + "example": { + "type": "https://developer.sumup.com/problem/internal-server-error", + "title": "Internal Server Error", + "status": 500, + "detail": "An unexpected error occurred while processing the request." + } + } + } + } + }, + "security": [ + { + "apiKey": [] + }, + { + "oauth2": [ + "payments", + "readers.write" + ] + } + ], + "tags": [ + "Readers" + ], + "x-codegen": { + "method_name": "create_go_checkout", + "ignore": true + }, + "x-permissions": [ + "readers_checkout_create" + ], + "x-scopes": [ + "payments", + "readers.write" + ] + } + }, "/v0.1/memberships": { "get": { "operationId": "ListMemberships", @@ -5711,6 +5876,122 @@ "readers.write" ] } + }, + "/v0.1/merchants/{merchant_code}/readers/{reader_id}/checkout/{checkout_id}": { + "get": { + "operationId": "GetReaderCheckout", + "summary": "Get a Reader Checkout", + "description": "Get a Checkout for a Reader.\n", + "parameters": [ + { + "name": "merchant_code", + "in": "path", + "description": "Merchant Code", + "required": true, + "schema": { + "type": "string" + }, + "example": "MC0X0ABC" + }, + { + "name": "reader_id", + "in": "path", + "description": "The unique identifier of the Reader", + "required": true, + "schema": { + "type": "string" + }, + "example": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65" + }, + { + "name": "checkout_id", + "in": "path", + "description": "The unique identifier of the Checkout", + "required": true, + "schema": { + "type": "string" + }, + "example": "74ecff66-1655-43ed-8ce3-193f49fa602f" + } + ], + "responses": { + "200": { + "description": "The Checkout got successfully retrieved for the given reader.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetReaderCheckoutResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateReaderCheckoutError" + } + }, + "application/problem+json": { + "example": { + "detail": "Unauthorized", + "status": 401, + "title": "Unauthorized", + "type": "https://developer.sumup.com/problem/unauthorized" + }, + "schema": { + "$ref": "#/components/schemas/Problem" + } + } + } + }, + "404": { + "description": "Response when given reader or checkout is not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotFound" + } + }, + "application/problem+json": { + "example": { + "detail": "The requested resource doesn't exist or does not belong to you.", + "status": 404, + "title": "Requested resource couldn't be found.", + "type": "https://developer.sumup.com/problem/not-found" + }, + "schema": { + "$ref": "#/components/schemas/Problem" + } + } + } + } + }, + "callbacks": {}, + "security": [ + { + "apiKey": [] + }, + { + "oauth2": [ + "readers.read" + ] + } + ], + "tags": [ + "Readers" + ], + "x-codegen": { + "method_name": "get_checkout" + }, + "x-permissions": [ + "readers_checkout_view" + ], + "x-scopes": [ + "readers.read" + ] + } } }, "components": { @@ -8066,6 +8347,97 @@ "type": "string", "title": "Transaction ID" }, + "Affiliate": { + "type": "object", + "properties": { + "app_id": { + "type": "string", + "example": "com.example.app" + }, + "key": { + "type": "string", + "example": "123e4567-e89b-12d3-a456-426614174000" + } + }, + "required": [ + "app_id", + "key" + ] + }, + "Amount": { + "type": "object", + "properties": { + "currency": { + "description": "Currency ISO 4217 code", + "type": "string", + "example": "MXN" + }, + "value": { + "description": "Amount in minor units (e.g. cents).", + "type": "integer", + "example": 1000 + } + }, + "required": [ + "currency", + "value" + ] + }, + "ReaderID": { + "description": "Unique identifier of the reader that the payment is initiated on.", + "type": "string", + "example": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65", + "maxLength": 30, + "minLength": 30 + }, + "ReaderPaymentRequestParams": { + "type": "object", + "properties": { + "affiliate": { + "$ref": "#/components/schemas/Affiliate" + }, + "client_transaction_id": { + "description": "Caller-supplied correlation identifier, used as the idempotency key.", + "type": "string", + "example": "19e12390-72cf-4f9f-80b5-b0c8a67fa43f" + }, + "tip_amount": { + "description": "Optional tip amount in minor units, added on top of total_amount.", + "type": "integer", + "example": 100 + }, + "total_amount": { + "$ref": "#/components/schemas/Amount" + } + }, + "required": [ + "total_amount", + "client_transaction_id" + ] + }, + "ReaderPaymentResponse": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ReaderPaymentResponseData" + } + } + }, + "ReaderPaymentResponseData": { + "type": "object", + "properties": { + "client_transaction_id": { + "description": "Caller-supplied correlation identifier that was provided in the request.", + "type": "string", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + "transaction_code": { + "description": "Transaction code returned by the acquirer/processing entity after processing the transaction.", + "type": "string", + "example": "TEENSK4W2K" + } + } + }, "MembershipStatus": { "description": "The status of the membership.", "type": "string", @@ -9246,13 +9618,6 @@ ], "title": "Reader" }, - "ReaderID": { - "description": "Unique identifier of the object.\n\nNote that this identifies the instance of the physical devices pairing with your SumUp account. If you [delete](https://developer.sumup.com/api/readers/delete-reader) a reader, and pair the device again, the ID will be different. Do not use this ID to refer to a physical device.", - "type": "string", - "example": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65", - "maxLength": 30, - "minLength": 30 - }, "ReaderName": { "description": "Custom human-readable, user-defined name for easier identification of the reader.", "type": "string", @@ -9393,6 +9758,165 @@ ], "title": "CreateReaderCheckoutError" }, + "GetReaderCheckoutResponse": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "card_type": { + "description": "Type of the card. Required for some countries", + "type": "string", + "enum": [ + "credit", + "debit" + ], + "nullable": true + }, + "checkout_id": { + "description": "Unique identifier for the checkout", + "type": "string", + "format": "uuid" + }, + "client_transaction_id": { + "description": "Client transaction identifier associated with the checkout", + "type": "string" + }, + "created_at": { + "description": "Checkout creation timestamp", + "type": "string", + "format": "date-time" + }, + "installments": { + "description": "Number of installments for the transaction. Required for some countries.", + "type": "integer", + "nullable": true + }, + "payment_failure_reason": { + "description": "Payment failure reason", + "type": "string", + "nullable": true + }, + "payment_status": { + "description": "Payment status from payments v2 event", + "type": "string", + "nullable": true + }, + "payment_type": { + "description": "Type of the payment. Required for some countries", + "type": "string", + "enum": [ + "card", + "pix" + ] + }, + "reader_firmware_version": { + "description": "Reader firmware version", + "type": "string" + }, + "reader_serial_number": { + "description": "Device serial number", + "type": "string" + }, + "status": { + "description": "Current status of the checkout", + "type": "string", + "enum": [ + "pending", + "successful", + "failed", + "cancelled" + ] + }, + "total_amount": { + "description": "Amount structure.\n\nThe amount is represented as an integer value altogether with the currency and the minor unit.\n\nFor example, EUR 1.00 is represented as value 100 with minor unit of 2.\n", + "type": "object", + "example": { + "currency": "EUR", + "minor_unit": 2, + "value": 1000 + }, + "properties": { + "currency": { + "description": "Currency ISO 4217 code", + "type": "string", + "example": "EUR" + }, + "minor_unit": { + "description": "The minor units of the currency.\nIt represents the number of decimals of the currency. For the currencies CLP, COP and HUF, the minor unit is 0.\n", + "type": "integer", + "example": 2, + "minimum": 0 + }, + "value": { + "description": "Integer value of the amount.", + "type": "integer", + "example": 1000, + "minimum": 0 + } + }, + "required": [ + "currency", + "minor_unit", + "value" + ], + "title": "Money" + }, + "updated_at": { + "description": "Checkout last update timestamp", + "type": "string", + "format": "date-time" + }, + "valid_until": { + "description": "Checkout expiration timestamp. After this time, the checkout will be automatically cancelled.", + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "checkout_id", + "client_transaction_id", + "reader_serial_number", + "payment_type", + "card_type", + "reader_firmware_version", + "installments", + "payment_status", + "valid_until", + "created_at", + "updated_at", + "status", + "total_amount" + ] + } + }, + "example": { + "data": { + "card_type": "credit", + "checkout_id": "00e33a36-c99b-4cb2-b635-b90c1455c9c8", + "client_transaction_id": "00e33a36-c99b-4cb2-b635-b90c1455c9c8", + "created_at": "2026-07-07T20:41:16.315434Z", + "installments": 1, + "payment_status": "pending", + "payment_type": "card", + "reader_firmware_version": "3.3.3.21", + "reader_serial_number": "1234567890", + "status": "pending", + "total_amount": { + "currency": "EUR", + "minor_unit": 2, + "value": 10000 + }, + "updated_at": "2026-07-07T20:42:18.117244Z", + "valid_until": "2026-07-07T20:41:16.315434Z" + } + }, + "required": [ + "data" + ], + "title": "GetReaderCheckoutResponse" + }, "StatusResponse": { "description": "Status of a device", "type": "object", @@ -9577,6 +10101,11 @@ "data": { "type": "object", "properties": { + "checkout_id": { + "description": "The checkout ID is a unique identifier for the checkout.\n", + "type": "string", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, "client_transaction_id": { "description": "The client transaction ID is a unique identifier for the transaction that is generated for the client.\n\nIt can be used later to fetch the transaction details via the [Transactions API](https://developer.sumup.com/api/transactions/get).\n", "type": "string", @@ -9590,6 +10119,7 @@ }, "example": { "data": { + "checkout_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "client_transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, @@ -10676,6 +11206,70 @@ } } }, + "BadRequest": { + "description": "The request is invalid.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/Problem" + }, + "example": { + "type": "https://developer.sumup.com/problem/bad-request", + "title": "Bad Request", + "status": 400, + "detail": "Request validation failed." + } + } + } + }, + "Unauthorized": { + "description": "Authentication failed or missing required scope.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/Problem" + }, + "example": { + "type": "https://developer.sumup.com/problem/unauthorized", + "title": "Unauthorized", + "status": 401, + "detail": "Authentication credentials are missing or invalid." + } + } + } + }, + "NotFound": { + "description": "The requested Reader resource does not exist.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/Problem" + }, + "example": { + "type": "https://developer.sumup.com/problem/not-found", + "title": "Requested resource couldn't be found.", + "status": 404, + "detail": "The requested resource doesn't exist or does not belong to you." + } + } + } + }, + "InternalError": { + "description": "An unexpected error occurred while processing the request.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/Problem" + }, + "example": { + "type": "https://developer.sumup.com/problem/internal-server-error", + "title": "Internal Server Error", + "status": 500, + "detail": "An unexpected error occurred while processing the request." + } + } + } + }, "ListMemberships": { "description": "Returns a list of Membership objects.", "content": { @@ -10848,6 +11442,9 @@ } ] }, + { + "name": "Readers" + }, { "name": "Members", "description": "Endpoints to manage account members. Members are users that have membership within merchant accounts.", @@ -10886,15 +11483,6 @@ "$ref": "#/components/schemas/Merchant" } ] - }, - { - "name": "Readers", - "description": "A reader represents a device that accepts payments. You can use the SumUp Solo to accept in-person payments.", - "x-core-objects": [ - { - "$ref": "#/components/schemas/Reader" - } - ] } ] -} +} \ No newline at end of file From d30ebe3123fb1bb25c84b44ebe729a076d62f4ba Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 24 Jul 2026 14:06:05 +0000 Subject: [PATCH 2/2] chore: generate code --- SumUpAPICollection.json | 5760 ++++++++++++++++++++++----------------- 1 file changed, 3292 insertions(+), 2468 deletions(-) diff --git a/SumUpAPICollection.json b/SumUpAPICollection.json index 9d1af8d..36d58df 100644 --- a/SumUpAPICollection.json +++ b/SumUpAPICollection.json @@ -5,7 +5,7 @@ "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": "799a63d1-a4e3-4679-95e2-bc1e8d85d9c2", + "id": "17229d2a-2b06-4792-bd90-3871651913f6", "name": "Get available payment methods", "request": { "name": "Get available payment methods", @@ -76,7 +76,7 @@ }, "response": [ { - "id": "434d2456-9cc8-494d-9f47-93d32f5a0a28", + "id": "de232c3a-7aeb-442a-b20c-85557950ff68", "name": "Available payment methods", "originalRequest": { "url": { @@ -144,7 +144,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c427d774-2749-415a-b17f-542f94e0b585", + "id": "a6d80b68-c12e-400c-b9fd-47b882197142", "name": "The request is invalid for the submitted query parameters.", "originalRequest": { "url": { @@ -218,7 +218,7 @@ } }, { - "id": "1f193dcb-1f3f-4304-89fe-806862077586", + "id": "8b0665e4-ac31-4494-bb09-f4985dd757bf", "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\": \"SEK\",\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": "bf308785-d172-455c-b563-97a1c13b940f", + "id": "392c9dcf-837e-4e4d-8456-e703537f927e", "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\": \"SEK\",\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\": \"BRL\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"EXPIRED\",\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\": \"NOK\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"DIRECT_DEBIT\",\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\": \"PLN\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"CASH\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"IDEAL\",\n \"auth_code\": \"\"\n }\n ]\n}", + "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"CZK\",\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\": \"CLP\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"BITCOIN\",\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\": \"PLN\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"CASH\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"BLIK\",\n \"auth_code\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "67887f0b-720b-4c6d-9c36-9b0d9d45594c", + "id": "5e9c4482-34df-4c9b-8046-db1a29675f7b", "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\": \"SEK\",\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": "7aa9957b-1dc5-45a0-ae8c-57f6bd8f4de5", + "id": "a26684f5-a076-4acb-b435-b7dd1c4751bc", "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\": \"SEK\",\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": "1fba05cc-c148-4cc4-906e-255f35100006", + "id": "6e633e0e-a67b-44b1-8ece-289fe2576091", "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\": \"SEK\",\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": "488ccecc-ebec-4352-a9b4-28c0e056c0df", + "id": "cab89a37-e595-4142-aa79-85042a5ca8ec", "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\": \"SEK\",\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": "605cbe47-85bb-49ce-9385-bd7c56538cf2", + "id": "24398efb-60c1-4593-b85c-1e1af005edb4", "name": "List checkouts", "request": { "name": "List checkouts", @@ -570,7 +570,7 @@ }, "response": [ { - "id": "d97f2a76-af8c-434f-ba53-985e8a557174", + "id": "510cbfaa-9557-4b70-b0e5-91c7f4d9c727", "name": "Returns a list of checkout resources.", "originalRequest": { "url": { @@ -611,12 +611,12 @@ "value": "application/json" } ], - "body": "[\n {\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"HUF\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"EXPIRED\",\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\": \"BGN\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"RECURRING\",\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\": \"DKK\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"ECOM\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"DIRECT_DEBIT\",\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\": \"DKK\",\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\": \"COP\",\n \"timestamp\": \"\",\n \"status\": \"CANCELLED\",\n \"payment_type\": \"POS\",\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\": \"GBP\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"BITCOIN\",\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 }\n]", + "body": "[\n {\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"COP\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"EXPIRED\",\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\": \"COP\",\n \"timestamp\": \"\",\n \"status\": \"SUCCESSFUL\",\n \"payment_type\": \"APM\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"NONE\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"NOK\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"BITCOIN\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"GOOGLE_PAY\",\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\": \"SEK\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"EXPIRED\",\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\": \"PENDING\",\n \"payment_type\": \"BOLETO\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"DIRECT_DEBIT\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"NOK\",\n \"timestamp\": \"\",\n \"status\": \"SUCCESSFUL\",\n \"payment_type\": \"POS\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"MYBANK\",\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": "88f6edf0-2b52-475b-aeb3-7dcf98022173", + "id": "0f6bb629-805f-463d-9469-f53a2274f75e", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -668,7 +668,7 @@ } }, { - "id": "2bf1e46c-ea22-4c52-8bd2-0d9097a6c578", + "id": "644147ef-6cf4-499e-a572-a566c1df5c19", "name": "Retrieve a checkout", "request": { "name": "Retrieve a checkout", @@ -719,7 +719,7 @@ }, "response": [ { - "id": "86605d74-d5ef-4a50-b608-40d700b393ce", + "id": "227e03b7-5708-49c7-85de-90deb658bf59", "name": "Returns the requested checkout resource.", "originalRequest": { "url": { @@ -762,12 +762,12 @@ "value": "application/json" } ], - "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"BRL\",\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\": \"GBP\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"APM\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"BLIK\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"GBP\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"APM\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"APPLE_PAY\",\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\": \"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\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"RON\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"BOLETO\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"BOLETO\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"RON\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"UNKNOWN\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"P24\",\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": "65425991-6a9c-4f71-9834-cba88061a8df", + "id": "5bb65ec8-d136-4e02-9383-a5938529e46e", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -815,7 +815,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6fcb64e7-72ea-4e40-a5da-26d74499f372", + "id": "b53a0a67-d172-43ea-9606-83f94a74a22e", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -869,7 +869,7 @@ } }, { - "id": "30346cb1-d2ad-476f-ab69-4e9a0b35272b", + "id": "80db0e22-fb04-4601-ba83-607452b33e3f", "name": "Update a checkout", "request": { "name": "Update a checkout", @@ -913,7 +913,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"currency\": \"CHF\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", + "raw": "{\n \"amount\": \"\",\n \"currency\": \"RON\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -933,7 +933,7 @@ }, "response": [ { - "id": "58491458-5dac-46f9-9f3f-03c2a83973cc", + "id": "e410020d-f3da-4ba9-90f5-cb02ed0c78ee", "name": "Returns the updated checkout resource.", "originalRequest": { "url": { @@ -972,7 +972,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"currency\": \"CHF\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", + "raw": "{\n \"amount\": \"\",\n \"currency\": \"RON\",\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\": \"BRL\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"EXPIRED\",\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\": \"NOK\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"DIRECT_DEBIT\",\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\": \"PLN\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"CASH\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"IDEAL\",\n \"auth_code\": \"\"\n }\n ]\n}", + "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"CZK\",\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\": \"CLP\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"BITCOIN\",\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\": \"PLN\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"CASH\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"BLIK\",\n \"auth_code\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8bb8dcf3-0ed6-4495-86d7-0767a9ead8d7", + "id": "fec0e27b-a109-40c7-ac8b-e89d05a237b3", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -1033,7 +1033,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"currency\": \"CHF\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", + "raw": "{\n \"amount\": \"\",\n \"currency\": \"RON\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -1055,7 +1055,7 @@ "_postman_previewlanguage": "json" }, { - "id": "586de7f2-72e3-48d3-bb7c-06f591a3e0ba", + "id": "e2f47ca3-e973-4728-b3e9-4bcb9ecf7f9a", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -1094,7 +1094,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"currency\": \"CHF\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", + "raw": "{\n \"amount\": \"\",\n \"currency\": \"RON\",\n \"description\": \"\",\n \"checkout_reference\": \"\",\n \"valid_until\": \"\",\n \"customer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -1122,7 +1122,7 @@ } }, { - "id": "4400c8b6-6713-4870-b6bf-6f69d7314ae6", + "id": "19ee5af8-5d96-4175-8e15-9d7d29fd1903", "name": "Process a checkout", "request": { "name": "Process a checkout", @@ -1166,7 +1166,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"ideal\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"06\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"MAESTRO\",\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\": \"boleto\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"01\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"ELV\",\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": "449d18f0-55f5-4024-82c5-46d256b6829d", + "id": "073f71a6-3739-413d-a7b3-3b01540564d4", "name": "Returns the checkout resource after a processing attempt.", "originalRequest": { "url": { @@ -1225,7 +1225,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"ideal\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"06\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"MAESTRO\",\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\": \"boleto\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"01\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"ELV\",\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\": \"BRL\",\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\": \"GBP\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"APM\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"BLIK\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"GBP\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"APM\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"APPLE_PAY\",\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\": \"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\": \"active\",\n \"merchant_code\": \"\"\n },\n \"hosted_checkout_url\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"RON\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"BOLETO\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"BOLETO\",\n \"auth_code\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"RON\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"UNKNOWN\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"P24\",\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": "2a8e7d93-c562-4809-a6cd-0a25d0805eaa", + "id": "9bd526da-0d23-4997-a73c-f4128d75f855", "name": "Returns the next required action for asynchronous checkout processing.", "originalRequest": { "url": { @@ -1286,7 +1286,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"ideal\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"06\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"MAESTRO\",\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\": \"boleto\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"01\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"ELV\",\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 }\n }\n}", + "body": "{\n \"next_step\": {\n \"url\": \"\",\n \"method\": \"\",\n \"redirect_url\": \"\",\n \"mechanism\": [\n \"browser\",\n \"browser\"\n ],\n \"payload\": {\n \"key_0\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4a489454-29f1-4074-acbb-605aaf7622e7", + "id": "991dccee-fb02-4cab-bedb-fe32c2f33e4d", "name": "The request body is invalid for processing the checkout.", "originalRequest": { "url": { @@ -1347,7 +1347,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"ideal\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"06\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"MAESTRO\",\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\": \"boleto\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"01\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"ELV\",\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": "bfc9e0c9-3414-41f0-9870-88ebe5cf4cee", + "id": "330271bb-3356-459b-b1fa-9b8d006f8711", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -1408,7 +1408,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"ideal\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"06\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"MAESTRO\",\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\": \"boleto\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"01\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"ELV\",\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": "78ad2a64-d66e-4ca3-9c26-e793bb5f8541", + "id": "6eea2258-0cca-4b7d-a6da-1cd565f35c50", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -1469,7 +1469,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"ideal\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"06\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"MAESTRO\",\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\": \"boleto\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"01\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"ELV\",\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": "0426598d-6827-4123-a61b-ba5d617f6b49", + "id": "04f8f856-79cc-4a5e-8895-69792b45ce8c", "name": "The request conflicts with the current state of the resource.", "originalRequest": { "url": { @@ -1530,7 +1530,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"payment_type\": \"ideal\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"06\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"MAESTRO\",\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\": \"boleto\",\n \"installments\": \"\",\n \"mandate\": {\n \"type\": \"recurrent\",\n \"user_agent\": \"\",\n \"user_ip\": \"\"\n },\n \"card\": {\n \"name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"01\",\n \"expiry_year\": \"\",\n \"cvv\": \"\",\n \"type\": \"ELV\",\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": "09654fa4-9a8f-4172-abcd-8c62c58377be", + "id": "e0957de8-258c-465b-84e1-a57d3a66e4b6", "name": "Deactivate a checkout", "request": { "name": "Deactivate a checkout", @@ -1609,7 +1609,7 @@ }, "response": [ { - "id": "69126584-7157-4763-b1d8-2f4d5455da86", + "id": "4fc44578-4c2c-4ec7-8120-4e26ef374be4", "name": "Returns the checkout object after successful deactivation.", "originalRequest": { "url": { @@ -1652,12 +1652,12 @@ "value": "application/json" } ], - "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"BRL\",\n \"merchant_code\": \"\",\n \"description\": \"\",\n \"return_url\": \"\",\n \"id\": \"\",\n \"status\": \"EXPIRED\",\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\": \"NOK\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"DIRECT_DEBIT\",\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\": \"PLN\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"CASH\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"IDEAL\",\n \"auth_code\": \"\"\n }\n ]\n}", + "body": "{\n \"checkout_reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"CZK\",\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\": \"CLP\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"BITCOIN\",\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\": \"PLN\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"CASH\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"BLIK\",\n \"auth_code\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "31517765-2544-4ec8-af1e-6fdae70663ae", + "id": "270aac14-2113-4230-b3b6-02700a9b23e7", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -1705,7 +1705,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9894e3ca-be5c-4eeb-a55f-3d8a223ee3af", + "id": "aad2f5d2-7e76-4e4f-853e-589664acd2f9", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -1753,7 +1753,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e0ceb3c2-8031-4010-919b-95fab8d0e8ce", + "id": "f6629abc-20ba-4fbf-a28a-6e5ebac945ea", "name": "The request conflicts with the current state of the resource.", "originalRequest": { "url": { @@ -1807,7 +1807,7 @@ } }, { - "id": "171ce5f1-845d-4f9e-9a7e-7f9425f8eda4", + "id": "552c6942-cfaa-46fb-9d70-a55e1ff7500e", "name": "Create an Apple Pay session", "request": { "name": "Create an Apple Pay session", @@ -1872,7 +1872,7 @@ }, "response": [ { - "id": "1c1ea6eb-d233-4a60-a6ec-7aa6b17123b5", + "id": "e205d995-340f-474f-874c-d2481e75697c", "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": { @@ -1934,7 +1934,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0ee52c5f-688d-416b-8c31-9e6fcdb4b064", + "id": "d806163b-a9fc-4872-a58c-a33ab129b0d9", "name": "Bad Request", "originalRequest": { "url": { @@ -1996,7 +1996,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a1c2b29c-a53f-4647-b1b7-cd2cc1d9adb1", + "id": "b6e560a2-7482-47a3-82cd-5b593815468d", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -2070,7 +2070,7 @@ "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.", "item": [ { - "id": "2dc33796-327a-432a-9cdc-7f3108b6eac7", + "id": "b88b8871-6fe6-443e-a96e-a5fa6a98b8f4", "name": "Create a customer", "request": { "name": "Create a customer", @@ -2122,7 +2122,7 @@ }, "response": [ { - "id": "5be7b4cd-eb60-4fda-95c9-cca3d825bf28", + "id": "333f0251-bda2-4398-ad26-b86cbb51f830", "name": "Returns the customer resource.", "originalRequest": { "url": { @@ -2171,7 +2171,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9f38952e-6160-4965-9603-5ea8bc4ccc87", + "id": "69fa9389-64b5-42ef-82d6-2fb594c129c9", "name": "The request body is invalid.", "originalRequest": { "url": { @@ -2220,7 +2220,7 @@ "_postman_previewlanguage": "json" }, { - "id": "01a8ab33-0c48-4476-9ddc-7ea9bee55e32", + "id": "d82e383b-ae15-4ad4-9934-b08ab068fb1f", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -2269,7 +2269,7 @@ "_postman_previewlanguage": "json" }, { - "id": "575e2ee8-a6e6-4aa5-8445-89bbcdcff96a", + "id": "7a6c6b34-0cfc-45a6-b551-d2b472bdf220", "name": "The request is authenticated but not permitted for this operation.", "originalRequest": { "url": { @@ -2318,7 +2318,7 @@ "_postman_previewlanguage": "json" }, { - "id": "799d785c-3ce4-44f8-ba4e-aaade6d2da07", + "id": "574bf263-2fc7-4203-a638-d4965c112114", "name": "A customer with the provided identifier already exists.", "originalRequest": { "url": { @@ -2373,7 +2373,7 @@ } }, { - "id": "0f9aa99e-effa-45f1-a523-f84eb46d2500", + "id": "c0cdc108-c920-4078-b20c-7fbe6e516192", "name": "Retrieve a customer", "request": { "name": "Retrieve a customer", @@ -2424,7 +2424,7 @@ }, "response": [ { - "id": "439bde73-e74c-414a-b21b-89327ce1cb0b", + "id": "7967a641-21eb-49cb-b06f-fb8fc2705045", "name": "Returns the customer resource.", "originalRequest": { "url": { @@ -2472,7 +2472,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a72b040f-0aad-44ca-ad6d-8b0d4fdf915a", + "id": "1b6a88cd-a8af-4817-936b-efda1d9356e8", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -2520,7 +2520,7 @@ "_postman_previewlanguage": "json" }, { - "id": "14267b2a-ef0c-44ad-9c20-4e41af2b74bf", + "id": "8ce61dba-26f1-449c-a7f5-bcdd62e02443", "name": "The request is authenticated but not permitted for this operation.", "originalRequest": { "url": { @@ -2568,7 +2568,7 @@ "_postman_previewlanguage": "json" }, { - "id": "67287eb7-7eba-4b72-9cd0-f87d3213a7ee", + "id": "ef02b588-9ab5-47b7-80bf-a69659f54177", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -2622,7 +2622,7 @@ } }, { - "id": "8dc8a758-baf2-4e80-8ffb-2b0268152859", + "id": "34178ea0-7dbe-43f4-bff9-eeabc6cec340", "name": "Update a customer", "request": { "name": "Update a customer", @@ -2686,7 +2686,7 @@ }, "response": [ { - "id": "04893b27-31e0-47c7-8ea4-ec7b9f5b191a", + "id": "9d6be85e-f798-4e1a-a06a-a53cb60524f9", "name": "Returns the customer resource.", "originalRequest": { "url": { @@ -2747,7 +2747,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1d5a42d5-6649-470c-a650-5cd0e7887291", + "id": "66766081-5047-4673-aebd-453c82ffe59a", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -2808,7 +2808,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b03e2920-cb17-4e94-ada9-94ae848bbaf8", + "id": "27ccea42-7ce2-4fd4-bd0b-875f47bb15c5", "name": "The request is authenticated but not permitted for this operation.", "originalRequest": { "url": { @@ -2869,7 +2869,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c1aa829e-6e63-4e1c-8f07-fe56da6004bd", + "id": "00ba3091-6825-4a38-9be9-53b6394b9cac", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -2936,7 +2936,7 @@ } }, { - "id": "fc270630-6575-47c8-96b5-ded2a2b7fb3d", + "id": "2c85027e-6cc9-4b4d-a3b1-83185b3db35b", "name": "List payment instruments", "request": { "name": "List payment instruments", @@ -2988,7 +2988,7 @@ }, "response": [ { - "id": "b792cca7-80bc-43a7-a216-672f4cf6da48", + "id": "00756c45-3d40-439d-b603-c2ddde1d6acb", "name": "Returns the list of saved payment instruments for the customer.", "originalRequest": { "url": { @@ -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\": \"active\",\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\": \"DINERS\"\n },\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"active\",\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\": \"EFTPOS\"\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\": \"EFTPOS\"\n },\n \"mandate\": {\n \"type\": \"\",\n \"status\": \"inactive\",\n \"merchant_code\": \"\"\n },\n \"created_at\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0e87dc3f-e004-443c-8f2b-431b918ae5dc", + "id": "2ad66e9c-a9c9-4c58-9702-9357ba8f4f4f", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -3086,7 +3086,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7a5adf4d-8496-4835-af22-70b3dd06226a", + "id": "651ab5ad-ba5d-4514-b1a9-012b83b5c443", "name": "The request is authenticated but not permitted for this operation.", "originalRequest": { "url": { @@ -3135,7 +3135,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0609b899-7890-409f-a03b-6b5c17a3fb70", + "id": "3c3ace69-722e-4bd7-b146-ca397bfff4fc", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -3190,7 +3190,7 @@ } }, { - "id": "5b67d724-8a15-454e-97f5-f373302d3a3d", + "id": "8d4bc47b-730e-4be5-a845-24ca6c4fcad1", "name": "Deactivate a payment instrument", "request": { "name": "Deactivate a payment instrument", @@ -3253,7 +3253,7 @@ }, "response": [ { - "id": "dc54d315-6fa6-406d-9e25-2d0049c8e9a6", + "id": "d853257e-354e-4329-bae3-6d8d840820fc", "name": "Returns an empty response body when the operation succeeds.", "originalRequest": { "url": { @@ -3301,7 +3301,7 @@ "_postman_previewlanguage": "text" }, { - "id": "a954c2f3-f5f2-4bf8-9cc2-430c2ab86bcf", + "id": "77bd677c-2500-4861-9e79-84ef7d9aedb6", "name": "The request is invalid.", "originalRequest": { "url": { @@ -3361,7 +3361,7 @@ "_postman_previewlanguage": "json" }, { - "id": "212de95d-97e3-40a1-9c8b-33f8465d6513", + "id": "ba59f5eb-a1d9-4910-929a-dfe9fe4123df", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -3421,7 +3421,7 @@ "_postman_previewlanguage": "json" }, { - "id": "01fbf86f-407b-4112-b65b-7537f368cc53", + "id": "0707714b-f568-4dea-b6c3-de4da1e5fd1d", "name": "The request is authenticated but not permitted for this operation.", "originalRequest": { "url": { @@ -3481,7 +3481,7 @@ "_postman_previewlanguage": "json" }, { - "id": "dae9505a-3cbb-47e0-9ed7-74af2851a352", + "id": "5245629d-753a-4c1d-ae4c-a86366934be4", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -3553,7 +3553,7 @@ "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": "094fda4c-e405-49e9-85bb-0a66566a5f0a", + "id": "3e42cf96-beb4-489a-a9e7-a09dc249b47a", "name": "Refund a transaction", "request": { "name": "Refund a transaction", @@ -3630,7 +3630,7 @@ }, "response": [ { - "id": "51602210-4032-4cdb-9d2e-ffa3a08ff8dc", + "id": "60b5b7c5-112c-451b-ab13-6e640fc5794f", "name": "The transaction was refunded in full or partially based on the request.", "originalRequest": { "url": { @@ -3704,7 +3704,7 @@ "_postman_previewlanguage": "json" }, { - "id": "87bc0dfc-0505-4992-9b3f-c10d5a4fd160", + "id": "7a463699-4da8-4a47-b946-590e550b98e2", "name": "The refund request is invalid.", "originalRequest": { "url": { @@ -3778,7 +3778,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6dc8e11d-0b3f-4bf2-b791-38caba519e59", + "id": "30591275-87d3-4e90-a72d-a198b8ac5d5a", "name": "The request is authenticated but not permitted for this operation.", "originalRequest": { "url": { @@ -3852,7 +3852,7 @@ "_postman_previewlanguage": "json" }, { - "id": "42f589d9-0e2b-4c92-9120-7ed0e9b77ce4", + "id": "9753ea82-de97-418f-9287-db5a7355b91a", "name": "The requested transaction does not exist or does not belong to the merchant.", "originalRequest": { "url": { @@ -3926,7 +3926,7 @@ "_postman_previewlanguage": "json" }, { - "id": "17c9f429-c390-49cf-a3f4-5adf40dc9e79", + "id": "9eb3df87-9ca2-4fb1-a694-3195d59265ed", "name": "The transaction cannot be refunded due to business constraints.", "originalRequest": { "url": { @@ -4000,7 +4000,7 @@ "_postman_previewlanguage": "json" }, { - "id": "32f32b53-c967-4440-a429-2b1626ab90e8", + "id": "3a57be07-7015-44cb-8f26-092330aff8c4", "name": "The refund could not be processed by the payment processor.", "originalRequest": { "url": { @@ -4080,7 +4080,7 @@ } }, { - "id": "00316352-b12b-4f30-bdad-dad400f88229", + "id": "d8fa12f4-65d0-421c-9619-4461d838c551", "name": "Retrieve a transaction", "request": { "name": "Retrieve a transaction", @@ -4169,7 +4169,7 @@ }, "response": [ { - "id": "ec7ad19b-dcdc-4e0d-94d5-fe8ac0e07d00", + "id": "d57722e8-2ce9-4522-abc9-b8e223958a74", "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\": \"EUR\",\n \"timestamp\": \"\",\n \"status\": \"FAILED\",\n \"payment_type\": \"BOLETO\",\n \"installments_count\": \"\",\n \"merchant_code\": \"\",\n \"vat_amount\": \"\",\n \"tip_amount\": \"\",\n \"entry_mode\": \"SATISPAY\",\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\": \"CC_CUSTOMER_ENTERED\",\n \"verification_method\": \"offline PIN\",\n \"card\": {\n \"last_4_digits\": \"\",\n \"type\": \"MASTERCARD\"\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\": \"BANK_ACCOUNT\",\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\",\n \"status\": \"PAID_OUT\",\n \"amount\": \"\",\n \"due_date\": \"\",\n \"date\": \"\",\n \"installment_number\": \"\",\n \"timestamp\": \"\"\n },\n {\n \"id\": \"\",\n \"event_type\": \"REFUND\",\n \"status\": \"FAILED\",\n \"amount\": \"\",\n \"due_date\": \"\",\n \"date\": \"\",\n \"installment_number\": \"\",\n \"timestamp\": \"\"\n }\n ],\n \"simple_status\": \"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\": \"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\",\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\": \"HRK\",\n \"timestamp\": \"\",\n \"status\": \"SUCCESSFUL\",\n \"payment_type\": \"BALANCE\",\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\": \"BALANCE\",\n \"verification_method\": \"none\",\n \"card\": {\n \"last_4_digits\": \"\",\n \"type\": \"VPAY\"\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\": \"REFUND\",\n \"status\": \"SUCCESSFUL\",\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\": \"CANCEL_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\": \"PENDING\",\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\": \"PAID_OUT\",\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": "92dd438b-3f13-40e1-a1df-17254bd72ed4", + "id": "c159a937-a40f-4fdb-a824-62269dfdd3c4", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -4341,7 +4341,7 @@ "_postman_previewlanguage": "json" }, { - "id": "db5483f5-0de4-4020-b304-9110e23ff0f6", + "id": "59e31793-f3e1-4ec4-8ee6-b97f39a3101b", "name": "The requested resource does not exist.", "originalRequest": { "url": { @@ -4433,7 +4433,7 @@ } }, { - "id": "f9956297-d9d4-4955-a3ab-bf12b4efd060", + "id": "ba93d7b4-b2cd-465a-a60d-1eae61148f7f", "name": "List transactions", "request": { "name": "List transactions", @@ -4505,7 +4505,7 @@ "type": "text/plain" }, "key": "statuses[]", - "value": "FAILED" + "value": "CHARGE_BACK" }, { "disabled": false, @@ -4523,7 +4523,7 @@ "type": "text/plain" }, "key": "payment_types[]", - "value": "MOTO" + "value": "DIRECT_DEBIT" }, { "disabled": false, @@ -4541,7 +4541,7 @@ "type": "text/plain" }, "key": "entry_modes[]", - "value": "BANCONTACT" + "value": "BLIK" }, { "disabled": false, @@ -4550,7 +4550,7 @@ "type": "text/plain" }, "key": "entry_modes[]", - "value": "MAGSTRIPE" + "value": "BOLETO" }, { "disabled": false, @@ -4568,7 +4568,7 @@ "type": "text/plain" }, "key": "types[]", - "value": "CHARGE_BACK" + "value": "REFUND" }, { "disabled": false, @@ -4649,7 +4649,7 @@ }, "response": [ { - "id": "f5e24d49-c436-45ec-bc27-e0f8f9c9d5d8", + "id": "fa3171d8-5dfb-422c-930f-f1cb4c8fa23f", "name": "Returns a page of transaction history items.", "originalRequest": { "url": { @@ -4725,7 +4725,7 @@ "type": "text/plain" }, "key": "entry_modes[]", - "value": "MAGSTRIPE" + "value": "BOLETO" }, { "disabled": false, @@ -4734,7 +4734,7 @@ "type": "text/plain" }, "key": "types[]", - "value": "CHARGE_BACK" + "value": "REFUND" }, { "disabled": false, @@ -4812,12 +4812,12 @@ "value": "application/json" } ], - "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"RON\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"APM\",\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\": \"CONECS\",\n \"payout_date\": \"\",\n \"payout_type\": \"PREPAID_CARD\",\n \"refunded_amount\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"timestamp\": \"\",\n \"status\": \"CANCELLED\",\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\": \"REFUND\",\n \"card_type\": \"EFTPOS\",\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\": \"HRK\",\n \"timestamp\": \"\",\n \"status\": \"PENDING\",\n \"payment_type\": \"CASH\",\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\": \"CHARGE_BACK\",\n \"card_type\": \"CUP\",\n \"payout_date\": \"\",\n \"payout_type\": \"BANK_ACCOUNT\",\n \"refunded_amount\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_code\": \"\",\n \"amount\": \"\",\n \"currency\": \"CHF\",\n \"timestamp\": \"\",\n \"status\": \"REFUNDED\",\n \"payment_type\": \"CASH\",\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\": \"CHARGE_BACK\",\n \"card_type\": \"JCB\",\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}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e7887fa0-b12d-4965-a1cb-a4d142666015", + "id": "8fb6f2d7-add4-4a12-b86d-74bf5d174e87", "name": "The request is invalid for the submitted query parameters.", "originalRequest": { "url": { @@ -4893,7 +4893,7 @@ "type": "text/plain" }, "key": "entry_modes[]", - "value": "MAGSTRIPE" + "value": "BOLETO" }, { "disabled": false, @@ -4902,7 +4902,7 @@ "type": "text/plain" }, "key": "types[]", - "value": "CHARGE_BACK" + "value": "REFUND" }, { "disabled": false, @@ -4985,7 +4985,7 @@ "_postman_previewlanguage": "json" }, { - "id": "233c5351-eb32-4fe4-a4aa-5fb2160fd578", + "id": "c50dd3c6-0158-4592-b994-f51d7fed30f2", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -5061,7 +5061,7 @@ "type": "text/plain" }, "key": "entry_modes[]", - "value": "MAGSTRIPE" + "value": "BOLETO" }, { "disabled": false, @@ -5070,7 +5070,7 @@ "type": "text/plain" }, "key": "types[]", - "value": "CHARGE_BACK" + "value": "REFUND" }, { "disabled": false, @@ -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": "4ff010f1-e4f2-4d0c-927e-208697573904", + "id": "e09dc843-fa33-4be3-b225-6493ffeff757", "name": "List payouts", "request": { "name": "List payouts", @@ -5263,7 +5263,7 @@ }, "response": [ { - "id": "43f79938-0925-4c3f-8feb-0fdc84d530e3", + "id": "ce5d04dd-39f1-4977-a2f5-f597b694b835", "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\": \"BALANCE_DEDUCTION\",\n \"amount\": \"\",\n \"date\": \"\",\n \"currency\": \"\",\n \"fee\": \"\",\n \"status\": \"FAILED\",\n \"reference\": \"\",\n \"transaction_code\": \"\"\n }\n]", + "body": "[\n {\n \"id\": \"\",\n \"type\": \"CHARGE_BACK_DEDUCTION\",\n \"amount\": \"\",\n \"date\": \"\",\n \"currency\": \"\",\n \"fee\": \"\",\n \"status\": \"FAILED\",\n \"reference\": \"\",\n \"transaction_code\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"REFUND_DEDUCTION\",\n \"amount\": \"\",\n \"date\": \"\",\n \"currency\": \"\",\n \"fee\": \"\",\n \"status\": \"FAILED\",\n \"reference\": \"\",\n \"transaction_code\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7b3d7c0a-8771-4535-b23f-a2a619d8a2fe", + "id": "04ac0171-6627-4cfd-b064-439973dd1f85", "name": "The request is invalid for the submitted query parameters.", "originalRequest": { "url": { @@ -5453,7 +5453,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f788e316-9580-481b-8ccb-86107d348db2", + "id": "77ff031a-70a8-4f27-b189-d3a220f82f1a", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -5560,7 +5560,7 @@ "description": "The Receipts model obtains receipt-like details for specific transactions.", "item": [ { - "id": "3ff7fecc-877f-425d-8a87-8f6e58520471", + "id": "c81f486b-6267-453a-82e7-02a065e0d918", "name": "Retrieve receipt details", "request": { "name": "Retrieve receipt details", @@ -5630,7 +5630,7 @@ }, "response": [ { - "id": "975c2d89-945c-4367-845d-6dadf5e12706", + "id": "b598a49e-1886-4b8a-9e60-dc7942c9ff2c", "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\": \"FAILED\",\n \"amount\": \"\",\n \"timestamp\": \"\",\n \"receipt_no\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_id\": \"\",\n \"type\": \"PAYOUT_DEDUCTION\",\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}", + "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\": \"CREDIT\",\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\": \"CHARGE_BACK\",\n \"status\": \"SUCCESSFUL\",\n \"amount\": \"\",\n \"timestamp\": \"\",\n \"receipt_no\": \"\"\n },\n {\n \"id\": \"\",\n \"transaction_id\": \"\",\n \"type\": \"CHARGE_BACK\",\n \"status\": \"SUCCESSFUL\",\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": "1bba0bd6-27d1-4172-be24-5b58a32e8855", + "id": "eb144ead-4062-45cc-be75-3b907431db86", "name": "The request is invalid for the submitted parameters.", "originalRequest": { "url": { @@ -5764,7 +5764,7 @@ "_postman_previewlanguage": "json" }, { - "id": "900fb2bb-b571-4763-a956-5474a308d363", + "id": "13306597-aa23-45c4-bf76-e653dca268eb", "name": "The request is not authorized.", "originalRequest": { "url": { @@ -5831,7 +5831,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fa404b6d-b24c-49b0-ba74-199cf2ea9313", + "id": "1553b5f7-a256-41c5-8f4d-9d52d6d65bd7", "name": "The requested transaction event does not exist for the provided transaction.", "originalRequest": { "url": { @@ -5906,123 +5906,75 @@ ] }, { - "name": "Members", - "description": "Endpoints to manage account members. Members are users that have membership within merchant accounts.", + "name": "Readers", + "description": "", "item": [ { - "id": "2e50d55b-4441-4c15-84b5-714a6ba0d332", - "name": "List members", + "id": "e03505d6-ae52-45b7-88b1-3de7196c91d5", + "name": "Create a Go Reader Payment", "request": { - "name": "List members", + "name": "Create a Go Reader Payment", "description": { - "content": "Lists merchant members.", + "content": "Initiates a payment on the SumUp Go terminal identified by the reader ID.\n\nUse `client_transaction_id` as an idempotency key: retrying the request with the same value returns the result of the original payment instead of creating a duplicate.", "type": "text/plain" }, "url": { "path": [ - "v0.1", + "v0", "merchants", ":merchant_code", - "members" + "readers", + ":reader_id", + "go-checkout" ], "host": [ "{{baseUrl}}" ], - "query": [ - { - "disabled": false, - "description": { - "content": "Offset of the first member to return.", - "type": "text/plain" - }, - "key": "offset", - "value": "0" - }, - { - "disabled": false, - "description": { - "content": "Maximum number of members to return.", - "type": "text/plain" - }, - "key": "limit", - "value": "10" - }, - { - "disabled": false, - "description": { - "content": "Indicates to skip count query.", - "type": "text/plain" - }, - "key": "scroll", - "value": "false" - }, - { - "disabled": false, - "description": { - "content": "Filter the returned members by email address prefix.", - "type": "text/plain" - }, - "key": "email", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Search for a member by user id.", - "type": "text/plain" - }, - "key": "user.id", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter the returned members by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", - "type": "text/plain" - }, - "key": "status", - "value": "pending" - }, + "query": [], + "variable": [ { + "type": "any", + "value": "", + "key": "merchant_code", "disabled": false, "description": { - "content": "Filter the returned members by role.", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" - }, - "key": "roles", - "value": "" + } }, - { - "disabled": false, - "description": { - "content": "Filter the returned members by role.", - "type": "text/plain" - }, - "key": "roles", - "value": "" - } - ], - "variable": [ { "type": "any", "value": "", - "key": "merchant_code", + "key": "reader_id", "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) The unique identifier of the reader.", "type": "text/plain" } } ] }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", - "body": {}, + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"client_transaction_id\": \"\",\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\"\n },\n \"tip_amount\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, "auth": { "type": "bearer", "bearer": [ @@ -6035,105 +5987,66 @@ }, "response": [ { - "id": "b1d20e36-f379-43ae-9b86-802b5a644801", - "name": "Returns a list of Member objects.", + "id": "b6840d25-769f-40a9-882a-15860f5f46c7", + "name": "Returns the result of the payment initiated on the reader.", "originalRequest": { "url": { "path": [ - "v0.1", + "v0", "merchants", ":merchant_code", - "members" + "readers", + ":reader_id", + "go-checkout" ], "host": [ "{{baseUrl}}" ], - "query": [ - { - "disabled": false, - "description": { - "content": "Offset of the first member to return.", - "type": "text/plain" - }, - "key": "offset", - "value": "0" - }, - { - "disabled": false, - "description": { - "content": "Maximum number of members to return.", - "type": "text/plain" - }, - "key": "limit", - "value": "10" - }, - { - "disabled": false, - "description": { - "content": "Indicates to skip count query.", - "type": "text/plain" - }, - "key": "scroll", - "value": "false" - }, - { - "disabled": false, - "description": { - "content": "Filter the returned members by email address prefix.", - "type": "text/plain" - }, - "key": "email", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Search for a member by user id.", - "type": "text/plain" - }, - "key": "user.id", - "value": "" - }, + "query": [], + "variable": [ { "disabled": false, "description": { - "content": "Filter the returned members by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, - "key": "status", - "value": "pending" + "type": "any", + "value": "", + "key": "merchant_code" }, { "disabled": false, "description": { - "content": "Filter the returned members by role.", - "type": "text/plain" - }, - "key": "roles", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) The unique identifier of the reader.", "type": "text/plain" }, "type": "any", "value": "", - "key": "merchant_code" + "key": "reader_id" } ] }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", - "body": {} + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"client_transaction_id\": \"\",\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\"\n },\n \"tip_amount\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } }, "status": "OK", "code": 200, @@ -6143,113 +6056,74 @@ "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\": \"disabled\",\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\": 5402,\n \"key_1\": 5585,\n \"key_2\": false\n },\n \"attributes\": {\n \"key_0\": 5703.557320267665,\n \"key_1\": 1554.3994733258537,\n \"key_2\": \"string\",\n \"key_3\": 8388\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\": \"string\",\n \"key_1\": 7031.412766540181,\n \"key_2\": true,\n \"key_3\": 1964,\n \"key_4\": 1207.5168618011478\n },\n \"attributes\": {\n \"key_0\": \"string\"\n }\n }\n ],\n \"total_count\": \"\"\n}", + "body": "{\n \"data\": {\n \"client_transaction_id\": \"\",\n \"transaction_code\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7b8e2845-dddf-4438-b103-ed808acf6aba", - "name": "Merchant not found.", + "id": "d614f912-4740-46da-992a-cb79ad233e86", + "name": "The request is invalid.", "originalRequest": { "url": { "path": [ - "v0.1", + "v0", "merchants", ":merchant_code", - "members" + "readers", + ":reader_id", + "go-checkout" ], "host": [ "{{baseUrl}}" ], - "query": [ - { - "disabled": false, - "description": { - "content": "Offset of the first member to return.", - "type": "text/plain" - }, - "key": "offset", - "value": "0" - }, - { - "disabled": false, - "description": { - "content": "Maximum number of members to return.", - "type": "text/plain" - }, - "key": "limit", - "value": "10" - }, - { - "disabled": false, - "description": { - "content": "Indicates to skip count query.", - "type": "text/plain" - }, - "key": "scroll", - "value": "false" - }, - { - "disabled": false, - "description": { - "content": "Filter the returned members by email address prefix.", - "type": "text/plain" - }, - "key": "email", - "value": "" - }, + "query": [], + "variable": [ { "disabled": false, "description": { - "content": "Search for a member by user id.", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, - "key": "user.id", - "value": "" + "type": "any", + "value": "", + "key": "merchant_code" }, { "disabled": false, "description": { - "content": "Filter the returned members by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", - "type": "text/plain" - }, - "key": "status", - "value": "pending" - }, - { - "disabled": false, - "description": { - "content": "Filter the returned members by role.", - "type": "text/plain" - }, - "key": "roles", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) The unique identifier of the reader.", "type": "text/plain" }, "type": "any", "value": "", - "key": "merchant_code" + "key": "reader_id" } ] }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/problem+json" } ], - "method": "GET", - "body": {} + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"client_transaction_id\": \"\",\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\"\n },\n \"tip_amount\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } }, - "status": "Not Found", - "code": 404, + "status": "Bad Request", + "code": 400, "header": [ { "key": "Content-Type", @@ -6259,88 +6133,19 @@ "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, - { - "id": "63466862-d0e2-4b09-b256-9c9bbd38fff7", - "name": "Create a member", - "request": { - "name": "Create a member", - "description": { - "content": "Create a merchant member.", - "type": "text/plain" - }, - "url": { - "path": [ - "v0.1", - "merchants", - ":merchant_code", - "members" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "merchant_code", - "disabled": false, - "description": { - "content": "(Required) Short unique identifier for the merchant.", - "type": "text/plain" - } - } - ] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": 5957.654764993871,\n \"key_1\": 9392,\n \"key_2\": 7062.603988487286,\n \"key_3\": 7902,\n \"key_4\": \"string\",\n \"key_5\": 3879,\n \"key_6\": 9592,\n \"key_7\": 7448,\n \"key_8\": 406,\n \"key_9\": true,\n \"key_10\": 7130.990589320511,\n \"key_11\": \"string\",\n \"key_12\": 1714.3953274224177,\n \"key_13\": 5548,\n \"key_14\": true,\n \"key_15\": 5316,\n \"key_16\": 2203,\n \"key_17\": 6020,\n \"key_18\": 2437.5625941297185,\n \"key_19\": false,\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": false,\n \"key_23\": 2078.9768609446455,\n \"key_24\": 894,\n \"key_25\": false,\n \"key_26\": false,\n \"key_27\": 388.8927136153475,\n \"key_28\": false,\n \"key_29\": \"string\",\n \"key_30\": 3925,\n \"key_31\": false,\n \"key_32\": \"string\",\n \"key_33\": true,\n \"key_34\": \"string\",\n \"key_35\": 8103.061271937327,\n \"key_36\": 3601,\n \"key_37\": 7327.702446520419,\n \"key_38\": true,\n \"key_39\": \"string\",\n \"key_40\": 9334.09713657602,\n \"key_41\": 6074,\n \"key_42\": \"string\",\n \"key_43\": false\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 8234\n }\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } }, - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{bearerToken}}" - } - ] - } - }, - "response": [ { - "id": "9887bfc4-80bf-460a-a4b7-95df32c28df6", - "name": "Returns the Member object if the creation succeeded.", + "id": "051a7486-0949-4fa6-8cae-b7d2d783be16", + "name": "Authentication failed or missing required scope.", "originalRequest": { "url": { "path": [ - "v0.1", + "v0", "merchants", ":merchant_code", - "members" + "readers", + ":reader_id", + "go-checkout" ], "host": [ "{{baseUrl}}" @@ -6356,6 +6161,16 @@ "type": "any", "value": "", "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the reader.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "reader_id" } ] }, @@ -6366,13 +6181,13 @@ }, { "key": "Accept", - "value": "application/json" + "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": 5957.654764993871,\n \"key_1\": 9392,\n \"key_2\": 7062.603988487286,\n \"key_3\": 7902,\n \"key_4\": \"string\",\n \"key_5\": 3879,\n \"key_6\": 9592,\n \"key_7\": 7448,\n \"key_8\": 406,\n \"key_9\": true,\n \"key_10\": 7130.990589320511,\n \"key_11\": \"string\",\n \"key_12\": 1714.3953274224177,\n \"key_13\": 5548,\n \"key_14\": true,\n \"key_15\": 5316,\n \"key_16\": 2203,\n \"key_17\": 6020,\n \"key_18\": 2437.5625941297185,\n \"key_19\": false,\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": false,\n \"key_23\": 2078.9768609446455,\n \"key_24\": 894,\n \"key_25\": false,\n \"key_26\": false,\n \"key_27\": 388.8927136153475,\n \"key_28\": false,\n \"key_29\": \"string\",\n \"key_30\": 3925,\n \"key_31\": false,\n \"key_32\": \"string\",\n \"key_33\": true,\n \"key_34\": \"string\",\n \"key_35\": 8103.061271937327,\n \"key_36\": 3601,\n \"key_37\": 7327.702446520419,\n \"key_38\": true,\n \"key_39\": \"string\",\n \"key_40\": 9334.09713657602,\n \"key_41\": 6074,\n \"key_42\": \"string\",\n \"key_43\": false\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 8234\n }\n}", + "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"client_transaction_id\": \"\",\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\"\n },\n \"tip_amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -6381,28 +6196,30 @@ } } }, - "status": "Created", - "code": 201, + "status": "Unauthorized", + "code": 401, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "application/problem+json" } ], - "body": "{\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\": \"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\": 4703,\n \"key_1\": 2346,\n \"key_2\": 5807.378064657458,\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": 89.26180084764646,\n \"key_7\": false,\n \"key_8\": 5146,\n \"key_9\": 4441,\n \"key_10\": 1814,\n \"key_11\": 6540.462375764464,\n \"key_12\": 6764,\n \"key_13\": 706,\n \"key_14\": false,\n \"key_15\": \"string\",\n \"key_16\": true,\n \"key_17\": true,\n \"key_18\": 8593,\n \"key_19\": 5684,\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": \"string\"\n },\n \"attributes\": {\n \"key_0\": 8207\n }\n}", + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1872b660-8b56-4344-98ea-602fce70ec56", - "name": "Invalid request.", + "id": "72633ee9-786c-4e64-9100-f79e36076de0", + "name": "The requested Reader resource does not exist.", "originalRequest": { "url": { "path": [ - "v0.1", + "v0", "merchants", ":merchant_code", - "members" + "readers", + ":reader_id", + "go-checkout" ], "host": [ "{{baseUrl}}" @@ -6418,6 +6235,16 @@ "type": "any", "value": "", "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the reader.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "reader_id" } ] }, @@ -6434,7 +6261,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": 5957.654764993871,\n \"key_1\": 9392,\n \"key_2\": 7062.603988487286,\n \"key_3\": 7902,\n \"key_4\": \"string\",\n \"key_5\": 3879,\n \"key_6\": 9592,\n \"key_7\": 7448,\n \"key_8\": 406,\n \"key_9\": true,\n \"key_10\": 7130.990589320511,\n \"key_11\": \"string\",\n \"key_12\": 1714.3953274224177,\n \"key_13\": 5548,\n \"key_14\": true,\n \"key_15\": 5316,\n \"key_16\": 2203,\n \"key_17\": 6020,\n \"key_18\": 2437.5625941297185,\n \"key_19\": false,\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": false,\n \"key_23\": 2078.9768609446455,\n \"key_24\": 894,\n \"key_25\": false,\n \"key_26\": false,\n \"key_27\": 388.8927136153475,\n \"key_28\": false,\n \"key_29\": \"string\",\n \"key_30\": 3925,\n \"key_31\": false,\n \"key_32\": \"string\",\n \"key_33\": true,\n \"key_34\": \"string\",\n \"key_35\": 8103.061271937327,\n \"key_36\": 3601,\n \"key_37\": 7327.702446520419,\n \"key_38\": true,\n \"key_39\": \"string\",\n \"key_40\": 9334.09713657602,\n \"key_41\": 6074,\n \"key_42\": \"string\",\n \"key_43\": false\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 8234\n }\n}", + "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"client_transaction_id\": \"\",\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\"\n },\n \"tip_amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -6443,8 +6270,8 @@ } } }, - "status": "Bad Request", - "code": 400, + "status": "Not Found", + "code": 404, "header": [ { "key": "Content-Type", @@ -6456,15 +6283,17 @@ "_postman_previewlanguage": "json" }, { - "id": "f33a2aca-8107-4aa0-9d03-5b5a770a2559", - "name": "Merchant not found.", + "id": "20e77dca-2238-47cd-9e58-0c33d7d2ef53", + "name": "The request could not be processed as it violates a business rule.", "originalRequest": { "url": { "path": [ - "v0.1", + "v0", "merchants", ":merchant_code", - "members" + "readers", + ":reader_id", + "go-checkout" ], "host": [ "{{baseUrl}}" @@ -6480,6 +6309,16 @@ "type": "any", "value": "", "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the reader.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "reader_id" } ] }, @@ -6496,7 +6335,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": 5957.654764993871,\n \"key_1\": 9392,\n \"key_2\": 7062.603988487286,\n \"key_3\": 7902,\n \"key_4\": \"string\",\n \"key_5\": 3879,\n \"key_6\": 9592,\n \"key_7\": 7448,\n \"key_8\": 406,\n \"key_9\": true,\n \"key_10\": 7130.990589320511,\n \"key_11\": \"string\",\n \"key_12\": 1714.3953274224177,\n \"key_13\": 5548,\n \"key_14\": true,\n \"key_15\": 5316,\n \"key_16\": 2203,\n \"key_17\": 6020,\n \"key_18\": 2437.5625941297185,\n \"key_19\": false,\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": false,\n \"key_23\": 2078.9768609446455,\n \"key_24\": 894,\n \"key_25\": false,\n \"key_26\": false,\n \"key_27\": 388.8927136153475,\n \"key_28\": false,\n \"key_29\": \"string\",\n \"key_30\": 3925,\n \"key_31\": false,\n \"key_32\": \"string\",\n \"key_33\": true,\n \"key_34\": \"string\",\n \"key_35\": 8103.061271937327,\n \"key_36\": 3601,\n \"key_37\": 7327.702446520419,\n \"key_38\": true,\n \"key_39\": \"string\",\n \"key_40\": 9334.09713657602,\n \"key_41\": 6074,\n \"key_42\": \"string\",\n \"key_43\": false\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 8234\n }\n}", + "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"client_transaction_id\": \"\",\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\"\n },\n \"tip_amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -6505,8 +6344,8 @@ } } }, - "status": "Not Found", - "code": 404, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, "header": [ { "key": "Content-Type", @@ -6518,15 +6357,17 @@ "_postman_previewlanguage": "json" }, { - "id": "47da9d4e-6a93-4de6-9f23-09f97a14cc40", - "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.", + "id": "7a94ac2d-9a24-4757-ae1a-a999beaa3f94", + "name": "An unexpected error occurred while processing the request.", "originalRequest": { "url": { "path": [ - "v0.1", + "v0", "merchants", ":merchant_code", - "members" + "readers", + ":reader_id", + "go-checkout" ], "host": [ "{{baseUrl}}" @@ -6542,6 +6383,16 @@ "type": "any", "value": "", "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the reader.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "reader_id" } ] }, @@ -6558,7 +6409,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": 5957.654764993871,\n \"key_1\": 9392,\n \"key_2\": 7062.603988487286,\n \"key_3\": 7902,\n \"key_4\": \"string\",\n \"key_5\": 3879,\n \"key_6\": 9592,\n \"key_7\": 7448,\n \"key_8\": 406,\n \"key_9\": true,\n \"key_10\": 7130.990589320511,\n \"key_11\": \"string\",\n \"key_12\": 1714.3953274224177,\n \"key_13\": 5548,\n \"key_14\": true,\n \"key_15\": 5316,\n \"key_16\": 2203,\n \"key_17\": 6020,\n \"key_18\": 2437.5625941297185,\n \"key_19\": false,\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": false,\n \"key_23\": 2078.9768609446455,\n \"key_24\": 894,\n \"key_25\": false,\n \"key_26\": false,\n \"key_27\": 388.8927136153475,\n \"key_28\": false,\n \"key_29\": \"string\",\n \"key_30\": 3925,\n \"key_31\": false,\n \"key_32\": \"string\",\n \"key_33\": true,\n \"key_34\": \"string\",\n \"key_35\": 8103.061271937327,\n \"key_36\": 3601,\n \"key_37\": 7327.702446520419,\n \"key_38\": true,\n \"key_39\": \"string\",\n \"key_40\": 9334.09713657602,\n \"key_41\": 6074,\n \"key_42\": \"string\",\n \"key_43\": false\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 8234\n }\n}", + "raw": "{\n \"total_amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"client_transaction_id\": \"\",\n \"affiliate\": {\n \"app_id\": \"\",\n \"key\": \"\"\n },\n \"tip_amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -6567,8 +6418,8 @@ } } }, - "status": "Too Many Requests", - "code": 429, + "status": "Internal Server Error", + "code": 500, "header": [ { "key": "Content-Type", @@ -6586,12 +6437,12 @@ } }, { - "id": "fcaea1f9-6937-4ffa-acbe-d3d7df54ee3d", - "name": "Retrieve a member", + "id": "f32905bf-c7da-446f-b98c-e09bc488ed4d", + "name": "List Readers", "request": { - "name": "Retrieve a member", + "name": "List Readers", "description": { - "content": "Retrieve a merchant member.", + "content": "List all readers of the merchant.", "type": "text/plain" }, "url": { @@ -6599,8 +6450,7 @@ "v0.1", "merchants", ":merchant_code", - "members", - ":member_id" + "readers" ], "host": [ "{{baseUrl}}" @@ -6616,16 +6466,6 @@ "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" } - }, - { - "type": "any", - "value": "", - "key": "member_id", - "disabled": false, - "description": { - "content": "(Required) The ID of the member to retrieve.", - "type": "text/plain" - } } ] }, @@ -6649,16 +6489,15 @@ }, "response": [ { - "id": "24c96ec3-b640-4b7f-9737-80719a49f9a0", - "name": "Returns the Member object for a valid identifier.", + "id": "ae8a9374-9bcc-47d5-b21d-445e682dd730", + "name": "Returns a list Reader objects.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "members", - ":member_id" + "readers" ], "host": [ "{{baseUrl}}" @@ -6674,16 +6513,6 @@ "type": "any", "value": "", "key": "merchant_code" - }, - { - "disabled": false, - "description": { - "content": "(Required) The ID of the member to retrieve.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "member_id" } ] }, @@ -6704,21 +6533,20 @@ "value": "application/json" } ], - "body": "{\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\": \"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\": 4703,\n \"key_1\": 2346,\n \"key_2\": 5807.378064657458,\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": 89.26180084764646,\n \"key_7\": false,\n \"key_8\": 5146,\n \"key_9\": 4441,\n \"key_10\": 1814,\n \"key_11\": 6540.462375764464,\n \"key_12\": 6764,\n \"key_13\": 706,\n \"key_14\": false,\n \"key_15\": \"string\",\n \"key_16\": true,\n \"key_17\": true,\n \"key_18\": 8593,\n \"key_19\": 5684,\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": \"string\"\n },\n \"attributes\": {\n \"key_0\": 8207\n }\n}", + "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"paired\",\n \"device\": {\n \"identifier\": \"\",\n \"model\": \"solo\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false,\n \"key_4\": true,\n \"key_5\": 199,\n \"key_6\": \"string\",\n \"key_7\": 4909,\n \"key_8\": true,\n \"key_9\": \"string\",\n \"key_10\": 6318.1462545954755,\n \"key_11\": \"string\",\n \"key_12\": true,\n \"key_13\": \"string\",\n \"key_14\": false,\n \"key_15\": 6738,\n \"key_16\": true,\n \"key_17\": 607.4896124220074,\n \"key_18\": 4795.818382997572,\n \"key_19\": \"string\",\n \"key_20\": true,\n \"key_21\": 2215,\n \"key_22\": \"string\",\n \"key_23\": 2036.1506433807385,\n \"key_24\": 9603.070965310679,\n \"key_25\": true,\n \"key_26\": 3866.1577948085956,\n \"key_27\": true,\n \"key_28\": 6964,\n \"key_29\": 5668.907297724746,\n \"key_30\": 7965,\n \"key_31\": \"string\",\n \"key_32\": false,\n \"key_33\": true,\n \"key_34\": true,\n \"key_35\": 3695,\n \"key_36\": false,\n \"key_37\": 8583.610786419453,\n \"key_38\": 4781,\n \"key_39\": false,\n \"key_40\": \"string\",\n \"key_41\": true,\n \"key_42\": false,\n \"key_43\": 5163.018337278,\n \"key_44\": true,\n \"key_45\": false,\n \"key_46\": 2181,\n \"key_47\": 7038,\n \"key_48\": false,\n \"key_49\": \"string\"\n },\n \"service_account_id\": \"\"\n },\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\": 3787.1841759267054,\n \"key_1\": 6486,\n \"key_2\": true,\n \"key_3\": true,\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": 3880,\n \"key_7\": true,\n \"key_8\": 6691,\n \"key_9\": \"string\",\n \"key_10\": 2767,\n \"key_11\": true,\n \"key_12\": \"string\",\n \"key_13\": true,\n \"key_14\": \"string\",\n \"key_15\": 8969,\n \"key_16\": true\n },\n \"service_account_id\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bbcdb321-380a-4fa3-923d-8f7534a59e62", - "name": "Merchant or member not found.", + "id": "b0876af6-87c0-49c0-84f7-6be8f92ca430", + "name": "Authentication failed or missing required scope.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "members", - ":member_id" + "readers" ], "host": [ "{{baseUrl}}" @@ -6734,16 +6562,6 @@ "type": "any", "value": "", "key": "merchant_code" - }, - { - "disabled": false, - "description": { - "content": "(Required) The ID of the member to retrieve.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "member_id" } ] }, @@ -6756,8 +6574,8 @@ "method": "GET", "body": {} }, - "status": "Not Found", - "code": 404, + "status": "Unauthorized", + "code": 401, "header": [ { "key": "Content-Type", @@ -6775,12 +6593,12 @@ } }, { - "id": "f3de5925-ba5d-4f2a-b95f-85ae0fed7b88", - "name": "Update a member", + "id": "62028c22-83f7-4b86-80ae-bb230175784a", + "name": "Create a Reader", "request": { - "name": "Update a member", + "name": "Create a Reader", "description": { - "content": "Update the merchant member.", + "content": "Create a new Reader for the merchant account.", "type": "text/plain" }, "url": { @@ -6788,8 +6606,7 @@ "v0.1", "merchants", ":merchant_code", - "members", - ":member_id" + "readers" ], "host": [ "{{baseUrl}}" @@ -6805,16 +6622,6 @@ "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" } - }, - { - "type": "any", - "value": "", - "key": "member_id", - "disabled": false, - "description": { - "content": "(Required) The ID of the member to retrieve.", - "type": "text/plain" - } } ] }, @@ -6828,10 +6635,10 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"roles\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 9404.552988474587,\n \"key_1\": 5062.898135121741,\n \"key_2\": 5722.444739882433,\n \"key_3\": \"string\",\n \"key_4\": 8658,\n \"key_5\": 3966,\n \"key_6\": true,\n \"key_7\": false,\n \"key_8\": 8332.184645039304,\n \"key_9\": true,\n \"key_10\": true,\n \"key_11\": 96.42356440145994,\n \"key_12\": false,\n \"key_13\": 4282.935954057174,\n \"key_14\": 1098.3337506361802,\n \"key_15\": 5102.887815791286\n },\n \"attributes\": {\n \"key_0\": 5004\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 4514,\n \"key_1\": 2980.51114313405\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6851,16 +6658,15 @@ }, "response": [ { - "id": "7f9f73fe-55ed-412d-9063-35b16913a432", - "name": "Returns the updated Member object if the update succeeded.", + "id": "d5612eed-f829-4616-9b3c-7c123f79f0fd", + "name": "Returns the Reader object if the creation succeeded.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "members", - ":member_id" + "readers" ], "host": [ "{{baseUrl}}" @@ -6876,16 +6682,6 @@ "type": "any", "value": "", "key": "merchant_code" - }, - { - "disabled": false, - "description": { - "content": "(Required) The ID of the member to retrieve.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "member_id" } ] }, @@ -6899,10 +6695,10 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"roles\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 9404.552988474587,\n \"key_1\": 5062.898135121741,\n \"key_2\": 5722.444739882433,\n \"key_3\": \"string\",\n \"key_4\": 8658,\n \"key_5\": 3966,\n \"key_6\": true,\n \"key_7\": false,\n \"key_8\": 8332.184645039304,\n \"key_9\": true,\n \"key_10\": true,\n \"key_11\": 96.42356440145994,\n \"key_12\": false,\n \"key_13\": 4282.935954057174,\n \"key_14\": 1098.3337506361802,\n \"key_15\": 5102.887815791286\n },\n \"attributes\": {\n \"key_0\": 5004\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 4514,\n \"key_1\": 2980.51114313405\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6911,29 +6707,28 @@ } } }, - "status": "OK", - "code": 200, + "status": "Created", + "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], - "body": "{\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\": \"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\": 4703,\n \"key_1\": 2346,\n \"key_2\": 5807.378064657458,\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": 89.26180084764646,\n \"key_7\": false,\n \"key_8\": 5146,\n \"key_9\": 4441,\n \"key_10\": 1814,\n \"key_11\": 6540.462375764464,\n \"key_12\": 6764,\n \"key_13\": 706,\n \"key_14\": false,\n \"key_15\": \"string\",\n \"key_16\": true,\n \"key_17\": true,\n \"key_18\": 8593,\n \"key_19\": 5684,\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": \"string\"\n },\n \"attributes\": {\n \"key_0\": 8207\n }\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\": 4862.543276264883,\n \"key_1\": true,\n \"key_2\": 6734,\n \"key_3\": false,\n \"key_4\": 999,\n \"key_5\": \"string\",\n \"key_6\": false,\n \"key_7\": false,\n \"key_8\": 7630,\n \"key_9\": 4240,\n \"key_10\": false,\n \"key_11\": 934,\n \"key_12\": 641,\n \"key_13\": false,\n \"key_14\": 7614,\n \"key_15\": 7411.972556858776,\n \"key_16\": 2424.5368388559996,\n \"key_17\": 7415.200760287644,\n \"key_18\": \"string\",\n \"key_19\": true,\n \"key_20\": \"string\",\n \"key_21\": 2577,\n \"key_22\": \"string\",\n \"key_23\": false,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": 1654.1925067255381,\n \"key_27\": false,\n \"key_28\": true,\n \"key_29\": 1100.4355069667104,\n \"key_30\": \"string\",\n \"key_31\": false,\n \"key_32\": false,\n \"key_33\": true,\n \"key_34\": 3508.3191262723412,\n \"key_35\": \"string\",\n \"key_36\": false,\n \"key_37\": true,\n \"key_38\": 1542,\n \"key_39\": \"string\",\n \"key_40\": 7518.229463500204,\n \"key_41\": \"string\",\n \"key_42\": 2577,\n \"key_43\": \"string\",\n \"key_44\": 6445\n },\n \"service_account_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7ec6925c-85b2-4fa0-a0da-9ca565f13963", - "name": "Cannot set password or nickname for an invited user.", + "id": "69bd6665-37ed-43ab-a1dd-94da5a3cf4b3", + "name": "The request is invalid.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "members", - ":member_id" + "readers" ], "host": [ "{{baseUrl}}" @@ -6949,16 +6744,6 @@ "type": "any", "value": "", "key": "merchant_code" - }, - { - "disabled": false, - "description": { - "content": "(Required) The ID of the member to retrieve.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "member_id" } ] }, @@ -6972,10 +6757,10 @@ "value": "application/problem+json" } ], - "method": "PUT", + "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"roles\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 9404.552988474587,\n \"key_1\": 5062.898135121741,\n \"key_2\": 5722.444739882433,\n \"key_3\": \"string\",\n \"key_4\": 8658,\n \"key_5\": 3966,\n \"key_6\": true,\n \"key_7\": false,\n \"key_8\": 8332.184645039304,\n \"key_9\": true,\n \"key_10\": true,\n \"key_11\": 96.42356440145994,\n \"key_12\": false,\n \"key_13\": 4282.935954057174,\n \"key_14\": 1098.3337506361802,\n \"key_15\": 5102.887815791286\n },\n \"attributes\": {\n \"key_0\": 5004\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 4514,\n \"key_1\": 2980.51114313405\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6997,89 +6782,15 @@ "_postman_previewlanguage": "json" }, { - "id": "26766ac6-cede-4b10-987d-1a490b77bd8e", - "name": "Cannot change password for managed user. Password was already used before.", - "originalRequest": { - "url": { - "path": [ - "v0.1", - "merchants", - ":merchant_code", - "members", - ":member_id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Short unique identifier for the merchant.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "merchant_code" - }, - { - "disabled": false, - "description": { - "content": "(Required) The ID of the member to retrieve.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "member_id" - } - ] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/problem+json" - } - ], - "method": "PUT", - "body": { - "mode": "raw", - "raw": "{\n \"roles\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 9404.552988474587,\n \"key_1\": 5062.898135121741,\n \"key_2\": 5722.444739882433,\n \"key_3\": \"string\",\n \"key_4\": 8658,\n \"key_5\": 3966,\n \"key_6\": true,\n \"key_7\": false,\n \"key_8\": 8332.184645039304,\n \"key_9\": true,\n \"key_10\": true,\n \"key_11\": 96.42356440145994,\n \"key_12\": false,\n \"key_13\": 4282.935954057174,\n \"key_14\": 1098.3337506361802,\n \"key_15\": 5102.887815791286\n },\n \"attributes\": {\n \"key_0\": 5004\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "6bd8b2a1-33dd-4c20-a313-744ea6243109", - "name": "Merchant or member not found.", + "id": "e5dc3c64-671b-4933-80d8-06e61b3c2d0d", + "name": "There's no pending reader for the submitted pairing code.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "members", - ":member_id" + "readers" ], "host": [ "{{baseUrl}}" @@ -7095,16 +6806,6 @@ "type": "any", "value": "", "key": "merchant_code" - }, - { - "disabled": false, - "description": { - "content": "(Required) The ID of the member to retrieve.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "member_id" } ] }, @@ -7118,10 +6819,10 @@ "value": "application/problem+json" } ], - "method": "PUT", + "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"roles\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 9404.552988474587,\n \"key_1\": 5062.898135121741,\n \"key_2\": 5722.444739882433,\n \"key_3\": \"string\",\n \"key_4\": 8658,\n \"key_5\": 3966,\n \"key_6\": true,\n \"key_7\": false,\n \"key_8\": 8332.184645039304,\n \"key_9\": true,\n \"key_10\": true,\n \"key_11\": 96.42356440145994,\n \"key_12\": false,\n \"key_13\": 4282.935954057174,\n \"key_14\": 1098.3337506361802,\n \"key_15\": 5102.887815791286\n },\n \"attributes\": {\n \"key_0\": 5004\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 4514,\n \"key_1\": 2980.51114313405\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -7143,16 +6844,15 @@ "_postman_previewlanguage": "json" }, { - "id": "655a42ca-a91d-4f23-9fe9-f9837230bbf5", - "name": "Cannot update member as some data conflict with existing members.", + "id": "04e4f757-034f-420c-8816-796da194ec15", + "name": "The Reader is not in a pending state.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "members", - ":member_id" + "readers" ], "host": [ "{{baseUrl}}" @@ -7168,16 +6868,6 @@ "type": "any", "value": "", "key": "merchant_code" - }, - { - "disabled": false, - "description": { - "content": "(Required) The ID of the member to retrieve.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "member_id" } ] }, @@ -7191,10 +6881,10 @@ "value": "application/problem+json" } ], - "method": "PUT", + "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"roles\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 9404.552988474587,\n \"key_1\": 5062.898135121741,\n \"key_2\": 5722.444739882433,\n \"key_3\": \"string\",\n \"key_4\": 8658,\n \"key_5\": 3966,\n \"key_6\": true,\n \"key_7\": false,\n \"key_8\": 8332.184645039304,\n \"key_9\": true,\n \"key_10\": true,\n \"key_11\": 96.42356440145994,\n \"key_12\": false,\n \"key_13\": 4282.935954057174,\n \"key_14\": 1098.3337506361802,\n \"key_15\": 5102.887815791286\n },\n \"attributes\": {\n \"key_0\": 5004\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 4514,\n \"key_1\": 2980.51114313405\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -7222,12 +6912,12 @@ } }, { - "id": "bcd29d5a-c708-4122-9b5e-128ad7fb6e37", - "name": "Delete a member", + "id": "24121249-23f9-4eb9-86aa-441d83f6cbe0", + "name": "Retrieve a Reader", "request": { - "name": "Delete a member", + "name": "Retrieve a Reader", "description": { - "content": "Deletes a merchant member.", + "content": "Retrieve a Reader.", "type": "text/plain" }, "url": { @@ -7235,8 +6925,8 @@ "v0.1", "merchants", ":merchant_code", - "members", - ":member_id" + "readers", + ":reader_id" ], "host": [ "{{baseUrl}}" @@ -7256,22 +6946,31 @@ { "type": "any", "value": "", - "key": "member_id", + "key": "reader_id", "disabled": false, "description": { - "content": "(Required) The ID of the member to retrieve.", + "content": "(Required) The unique identifier of the reader.", "type": "text/plain" } } ] }, "header": [ + { + "disabled": false, + "description": { + "content": "Return the reader only if it has been modified after the specified timestamp given in the headers.\n\nTimestamps are accepted in the following formats:\n\n - HTTP Standard: [IMF format (RFC 5322)](https://www.rfc-editor.org/rfc/rfc5322#section-3.3), sometimes also referred to as [RFC 7231](https://www.rfc-editor.org/rfc/rfc7231#section-7.1.1.1).\n - RFC 3339: Used for timestamps in JSON payloads on this API.", + "type": "text/plain" + }, + "key": "If-Modified-Since", + "value": "" + }, { "key": "Accept", - "value": "application/problem+json" + "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "body": {}, "auth": { "type": "bearer", @@ -7285,16 +6984,16 @@ }, "response": [ { - "id": "f7414f36-1369-4c61-9193-cba5332ad8a1", - "name": "Returns an empty response if the deletion succeeded.", + "id": "f5c5c7b8-fbaa-41bd-9178-9d9017a946c7", + "name": "Returns a Reader object for a valid identifier.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "members", - ":member_id" + "readers", + ":reader_id" ], "host": [ "{{baseUrl}}" @@ -7314,35 +7013,56 @@ { "disabled": false, "description": { - "content": "(Required) The ID of the member to retrieve.", + "content": "(Required) The unique identifier of the reader.", "type": "text/plain" }, "type": "any", "value": "", - "key": "member_id" + "key": "reader_id" } ] }, - "method": "DELETE", + "header": [ + { + "disabled": false, + "description": { + "content": "Return the reader only if it has been modified after the specified timestamp given in the headers.\n\nTimestamps are accepted in the following formats:\n\n - HTTP Standard: [IMF format (RFC 5322)](https://www.rfc-editor.org/rfc/rfc5322#section-3.3), sometimes also referred to as [RFC 7231](https://www.rfc-editor.org/rfc/rfc7231#section-7.1.1.1).\n - RFC 3339: Used for timestamps in JSON payloads on this API.", + "type": "text/plain" + }, + "key": "If-Modified-Since", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "body": {} }, "status": "OK", "code": 200, - "header": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "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\": 4862.543276264883,\n \"key_1\": true,\n \"key_2\": 6734,\n \"key_3\": false,\n \"key_4\": 999,\n \"key_5\": \"string\",\n \"key_6\": false,\n \"key_7\": false,\n \"key_8\": 7630,\n \"key_9\": 4240,\n \"key_10\": false,\n \"key_11\": 934,\n \"key_12\": 641,\n \"key_13\": false,\n \"key_14\": 7614,\n \"key_15\": 7411.972556858776,\n \"key_16\": 2424.5368388559996,\n \"key_17\": 7415.200760287644,\n \"key_18\": \"string\",\n \"key_19\": true,\n \"key_20\": \"string\",\n \"key_21\": 2577,\n \"key_22\": \"string\",\n \"key_23\": false,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": 1654.1925067255381,\n \"key_27\": false,\n \"key_28\": true,\n \"key_29\": 1100.4355069667104,\n \"key_30\": \"string\",\n \"key_31\": false,\n \"key_32\": false,\n \"key_33\": true,\n \"key_34\": 3508.3191262723412,\n \"key_35\": \"string\",\n \"key_36\": false,\n \"key_37\": true,\n \"key_38\": 1542,\n \"key_39\": \"string\",\n \"key_40\": 7518.229463500204,\n \"key_41\": \"string\",\n \"key_42\": 2577,\n \"key_43\": \"string\",\n \"key_44\": 6445\n },\n \"service_account_id\": \"\"\n}", "cookie": [], - "_postman_previewlanguage": "text" + "_postman_previewlanguage": "json" }, { - "id": "8fec2ffd-5cad-42b4-b990-82dcdaa7f595", - "name": "Member deletion was forbidden.", + "id": "7167c026-6b34-4d98-bd6f-0ed66f575560", + "name": "The requested Reader resource does not exist.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "members", - ":member_id" + "readers", + ":reader_id" ], "host": [ "{{baseUrl}}" @@ -7362,26 +7082,35 @@ { "disabled": false, "description": { - "content": "(Required) The ID of the member to retrieve.", + "content": "(Required) The unique identifier of the reader.", "type": "text/plain" }, "type": "any", "value": "", - "key": "member_id" + "key": "reader_id" } ] }, "header": [ + { + "disabled": false, + "description": { + "content": "Return the reader only if it has been modified after the specified timestamp given in the headers.\n\nTimestamps are accepted in the following formats:\n\n - HTTP Standard: [IMF format (RFC 5322)](https://www.rfc-editor.org/rfc/rfc5322#section-3.3), sometimes also referred to as [RFC 7231](https://www.rfc-editor.org/rfc/rfc7231#section-7.1.1.1).\n - RFC 3339: Used for timestamps in JSON payloads on this API.", + "type": "text/plain" + }, + "key": "If-Modified-Since", + "value": "" + }, { "key": "Accept", "value": "application/problem+json" } ], - "method": "DELETE", + "method": "GET", "body": {} }, - "status": "Forbidden", - "code": 403, + "status": "Not Found", + "code": 404, "header": [ { "key": "Content-Type", @@ -7391,18 +7120,87 @@ "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "3235098c-8e27-4d9d-a267-eb32856cd231", + "name": "Delete a reader", + "request": { + "name": "Delete a reader", + "description": { + "content": "Delete a reader.", + "type": "text/plain" }, - { - "id": "69a5f344-1fd6-4949-aca3-fc5d5198fb51", - "name": "Merchant or member not found.", - "originalRequest": { - "url": { - "path": [ + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "readers", + ":reader_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "merchant_code", + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "reader_id", + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the reader.", + "type": "text/plain" + } + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/problem+json" + } + ], + "method": "DELETE", + "body": {}, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}" + } + ] + } + }, + "response": [ + { + "id": "dbfc14e1-149b-4460-8291-4e9304aece65", + "name": "Returns an empty response if the deletion succeeded.", + "originalRequest": { + "url": { + "path": [ "v0.1", "merchants", ":merchant_code", - "members", - ":member_id" + "readers", + ":reader_id" ], "host": [ "{{baseUrl}}" @@ -7422,12 +7220,60 @@ { "disabled": false, "description": { - "content": "(Required) The ID of the member to retrieve.", + "content": "(Required) The unique identifier of the reader.", "type": "text/plain" }, "type": "any", "value": "", - "key": "member_id" + "key": "reader_id" + } + ] + }, + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "5e40259e-86f4-4513-a7a8-00d9ad901c44", + "name": "The requested Reader resource does not exist.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "readers", + ":reader_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the reader.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "reader_id" } ] }, @@ -7457,141 +7303,72 @@ "protocolProfileBehavior": { "disableBodyPruning": true } - } - ] - }, - { - "name": "Memberships", - "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": "f20664ad-a878-4b0c-aaf3-70aceff736bb", - "name": "List memberships", + "id": "127850bb-282e-4689-ad70-6c923c28eb93", + "name": "Update a Reader", "request": { - "name": "List memberships", + "name": "Update a Reader", "description": { - "content": "List memberships of the current user.", + "content": "Update a Reader.", "type": "text/plain" }, "url": { "path": [ "v0.1", - "memberships" + "merchants", + ":merchant_code", + "readers", + ":reader_id" ], "host": [ "{{baseUrl}}" ], - "query": [ - { - "disabled": false, - "description": { - "content": "Offset of the first member to return.", - "type": "text/plain" - }, - "key": "offset", - "value": "0" - }, - { - "disabled": false, - "description": { - "content": "Maximum number of members to return.", - "type": "text/plain" - }, - "key": "limit", - "value": "10" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by resource kind.", - "type": "text/plain" - }, - "key": "kind", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter the returned memberships by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", - "type": "text/plain" - }, - "key": "status", - "value": "pending" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by resource kind.", - "type": "text/plain" - }, - "key": "resource.type", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the sandbox status of the resource the membership is in.", - "type": "text/plain" - }, - "key": "resource.attributes.sandbox", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the name of the resource the membership is in.", - "type": "text/plain" - }, - "key": "resource.name", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", - "type": "text/plain" - }, - "key": "resource.parent.id", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", - "type": "text/plain" - }, - "key": "resource.parent.type", - "value": "" - }, + "query": [], + "variable": [ { + "type": "any", + "value": "", + "key": "merchant_code", "disabled": false, "description": { - "content": "Filter the returned memberships by role.", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" - }, - "key": "roles", - "value": "" + } }, { + "type": "any", + "value": "", + "key": "reader_id", "disabled": false, "description": { - "content": "Filter the returned memberships by role.", + "content": "(Required) The unique identifier of the reader.", "type": "text/plain" - }, - "key": "roles", - "value": "" + } } - ], - "variable": [] + ] }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", - "body": {}, + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 312.4201222145695,\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": 5674.804401298658,\n \"key_5\": 3926.949757363587,\n \"key_6\": 6660.267113369627\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, "auth": { "type": "bearer", "bearer": [ @@ -7604,119 +7381,65 @@ }, "response": [ { - "id": "3a5acce2-a791-4bdd-ba3f-9c86d0b9c065", - "name": "Returns a list of Membership objects.", + "id": "8f0c094b-89f5-43af-a798-37bec261ce1a", + "name": "Returns the updated Reader object if the update succeeded.", "originalRequest": { "url": { "path": [ "v0.1", - "memberships" + "merchants", + ":merchant_code", + "readers", + ":reader_id" ], "host": [ "{{baseUrl}}" ], - "query": [ - { - "disabled": false, - "description": { - "content": "Offset of the first member to return.", - "type": "text/plain" - }, - "key": "offset", - "value": "0" - }, - { - "disabled": false, - "description": { - "content": "Maximum number of members to return.", - "type": "text/plain" - }, - "key": "limit", - "value": "10" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by resource kind.", - "type": "text/plain" - }, - "key": "kind", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter the returned memberships by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", - "type": "text/plain" - }, - "key": "status", - "value": "pending" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by resource kind.", - "type": "text/plain" - }, - "key": "resource.type", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the sandbox status of the resource the membership is in.", - "type": "text/plain" - }, - "key": "resource.attributes.sandbox", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the name of the resource the membership is in.", - "type": "text/plain" - }, - "key": "resource.name", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", - "type": "text/plain" - }, - "key": "resource.parent.id", - "value": "" - }, + "query": [], + "variable": [ { "disabled": false, "description": { - "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, - "key": "resource.parent.type", - "value": "" + "type": "any", + "value": "", + "key": "merchant_code" }, { "disabled": false, "description": { - "content": "Filter the returned memberships by role.", + "content": "(Required) The unique identifier of the reader.", "type": "text/plain" }, - "key": "roles", - "value": "" + "type": "any", + "value": "", + "key": "reader_id" } - ], - "variable": [] + ] }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", - "body": {} + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 312.4201222145695,\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": 5674.804401298658,\n \"key_5\": 3926.949757363587,\n \"key_6\": 6660.267113369627\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } }, "status": "OK", "code": 200, @@ -7726,127 +7449,73 @@ "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\": 8785.68387369842,\n \"key_1\": 5646,\n \"key_2\": \"string\"\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 2244,\n \"key_2\": 8812.767990271324,\n \"key_3\": \"string\",\n \"key_4\": 8784,\n \"key_5\": true,\n \"key_6\": \"string\",\n \"key_7\": 9376,\n \"key_8\": 3420,\n \"key_9\": 5670,\n \"key_10\": true,\n \"key_11\": \"string\",\n \"key_12\": 1325.2153202414174,\n \"key_13\": 6576.39949798156,\n \"key_14\": 6251.745415416294,\n \"key_15\": 8037.7997394850745,\n \"key_16\": \"string\"\n },\n \"attributes\": {\n \"key_0\": 3578,\n \"key_1\": 4507,\n \"key_2\": \"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\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 7948.727645453335,\n \"key_3\": false\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 3445.0521206115336,\n \"key_3\": 1428,\n \"key_4\": false,\n \"key_5\": false,\n \"key_6\": \"string\",\n \"key_7\": \"string\",\n \"key_8\": true,\n \"key_9\": true,\n \"key_10\": 5828.6394867292765,\n \"key_11\": 2403,\n \"key_12\": 3702,\n \"key_13\": 3236,\n \"key_14\": 9369,\n \"key_15\": 1608.3619648215254,\n \"key_16\": 4652.389781453207,\n \"key_17\": \"string\",\n \"key_18\": 5118.030024361815,\n \"key_19\": 1824,\n \"key_20\": 525,\n \"key_21\": 7118.983106141579,\n \"key_22\": 8595,\n \"key_23\": \"string\"\n },\n \"attributes\": {\n \"key_0\": 1327,\n \"key_1\": 2131.813031018428,\n \"key_2\": 6432\n }\n }\n ]\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\": 4862.543276264883,\n \"key_1\": true,\n \"key_2\": 6734,\n \"key_3\": false,\n \"key_4\": 999,\n \"key_5\": \"string\",\n \"key_6\": false,\n \"key_7\": false,\n \"key_8\": 7630,\n \"key_9\": 4240,\n \"key_10\": false,\n \"key_11\": 934,\n \"key_12\": 641,\n \"key_13\": false,\n \"key_14\": 7614,\n \"key_15\": 7411.972556858776,\n \"key_16\": 2424.5368388559996,\n \"key_17\": 7415.200760287644,\n \"key_18\": \"string\",\n \"key_19\": true,\n \"key_20\": \"string\",\n \"key_21\": 2577,\n \"key_22\": \"string\",\n \"key_23\": false,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": 1654.1925067255381,\n \"key_27\": false,\n \"key_28\": true,\n \"key_29\": 1100.4355069667104,\n \"key_30\": \"string\",\n \"key_31\": false,\n \"key_32\": false,\n \"key_33\": true,\n \"key_34\": 3508.3191262723412,\n \"key_35\": \"string\",\n \"key_36\": false,\n \"key_37\": true,\n \"key_38\": 1542,\n \"key_39\": \"string\",\n \"key_40\": 7518.229463500204,\n \"key_41\": \"string\",\n \"key_42\": 2577,\n \"key_43\": \"string\",\n \"key_44\": 6445\n },\n \"service_account_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9b77b2e6-6d5e-4948-ad80-ae55b7254b37", - "name": "Invalid query parameter combination.", + "id": "b80ec401-5acd-48bf-8c91-7f9a2e665555", + "name": "The request isn't sufficiently authorized to modify the reader.", "originalRequest": { "url": { "path": [ "v0.1", - "memberships" + "merchants", + ":merchant_code", + "readers", + ":reader_id" ], "host": [ "{{baseUrl}}" ], - "query": [ - { - "disabled": false, - "description": { - "content": "Offset of the first member to return.", - "type": "text/plain" - }, - "key": "offset", - "value": "0" - }, - { - "disabled": false, - "description": { - "content": "Maximum number of members to return.", - "type": "text/plain" - }, - "key": "limit", - "value": "10" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by resource kind.", - "type": "text/plain" - }, - "key": "kind", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter the returned memberships by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", - "type": "text/plain" - }, - "key": "status", - "value": "pending" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by resource kind.", - "type": "text/plain" - }, - "key": "resource.type", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the sandbox status of the resource the membership is in.", - "type": "text/plain" - }, - "key": "resource.attributes.sandbox", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the name of the resource the membership is in.", - "type": "text/plain" - }, - "key": "resource.name", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", - "type": "text/plain" - }, - "key": "resource.parent.id", - "value": "" - }, + "query": [], + "variable": [ { "disabled": false, "description": { - "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, - "key": "resource.parent.type", - "value": "" + "type": "any", + "value": "", + "key": "merchant_code" }, { "disabled": false, "description": { - "content": "Filter the returned memberships by role.", + "content": "(Required) The unique identifier of the reader.", "type": "text/plain" }, - "key": "roles", - "value": "" + "type": "any", + "value": "", + "key": "reader_id" } - ], - "variable": [] + ] }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/problem+json" } ], - "method": "GET", - "body": {} + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 312.4201222145695,\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": 5674.804401298658,\n \"key_5\": 3926.949757363587,\n \"key_6\": 6660.267113369627\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } }, - "status": "Bad Request", - "code": 400, + "status": "Forbidden", + "code": 403, "header": [ { "key": "Content-Type", @@ -7858,122 +7527,68 @@ "_postman_previewlanguage": "json" }, { - "id": "7b2edfc5-5242-4ec5-9c2e-959152b7e676", - "name": "Authentication failed or missing required scope.", + "id": "98d48e52-6692-4cbe-bf88-7e8aa2fce193", + "name": "The requested Reader resource does not exist.", "originalRequest": { "url": { "path": [ "v0.1", - "memberships" + "merchants", + ":merchant_code", + "readers", + ":reader_id" ], "host": [ "{{baseUrl}}" ], - "query": [ + "query": [], + "variable": [ { "disabled": false, "description": { - "content": "Offset of the first member to return.", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, - "key": "offset", - "value": "0" + "type": "any", + "value": "", + "key": "merchant_code" }, { "disabled": false, "description": { - "content": "Maximum number of members to return.", + "content": "(Required) The unique identifier of the reader.", "type": "text/plain" }, - "key": "limit", - "value": "10" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by resource kind.", - "type": "text/plain" - }, - "key": "kind", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter the returned memberships by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", - "type": "text/plain" - }, - "key": "status", - "value": "pending" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by resource kind.", - "type": "text/plain" - }, - "key": "resource.type", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the sandbox status of the resource the membership is in.", - "type": "text/plain" - }, - "key": "resource.attributes.sandbox", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the name of the resource the membership is in.", - "type": "text/plain" - }, - "key": "resource.name", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", - "type": "text/plain" - }, - "key": "resource.parent.id", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", - "type": "text/plain" - }, - "key": "resource.parent.type", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Filter the returned memberships by role.", - "type": "text/plain" - }, - "key": "roles", - "value": "" + "type": "any", + "value": "", + "key": "reader_id" } - ], - "variable": [] + ] }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/problem+json" } ], - "method": "GET", - "body": {} + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 312.4201222145695,\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": 5674.804401298658,\n \"key_5\": 3926.949757363587,\n \"key_6\": 6660.267113369627\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } }, - "status": "Unauthorized", - "code": 401, + "status": "Not Found", + "code": 404, "header": [ { "key": "Content-Type", @@ -7989,20 +7604,14 @@ "protocolProfileBehavior": { "disableBodyPruning": true } - } - ] - }, - { - "name": "Roles", - "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": "72cb0eb8-e60f-421f-985f-51765192112b", - "name": "List roles", + "id": "5879130e-fa90-4905-b76b-6a654fce9907", + "name": "Create a Reader Checkout", "request": { - "name": "List roles", + "name": "Create a Reader Checkout", "description": { - "content": "List merchant's custom roles.", + "content": "Creates a Checkout for a Reader.\n\nThis process is asynchronous and the actual transaction may take some time to be started on the device.\n\n\nThere are some caveats when using this endpoint:\n* The target device must be online, otherwise checkout won't be accepted\n* After the checkout is accepted, the system has 60 seconds to start the payment on the target device. During this time, any other checkout for the same device will be rejected.\n\n\n**Note**: If the target device is a Solo, it must be in version 3.3.24.3 or higher.\n", "type": "text/plain" }, "url": { @@ -8010,7 +7619,9 @@ "v0.1", "merchants", ":merchant_code", - "roles" + "readers", + ":reader_id", + "checkout" ], "host": [ "{{baseUrl}}" @@ -8023,20 +7634,43 @@ "key": "merchant_code", "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "reader_id", + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" } } ] }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", - "body": {}, + "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\": true\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", + "language": "json" + } + } + }, "auth": { "type": "bearer", "bearer": [ @@ -8049,15 +7683,17 @@ }, "response": [ { - "id": "d9f3e02c-84cd-4ac3-8969-6bf296eb78b0", - "name": "Returns a list of Role objects.", + "id": "31967c70-2946-454f-9e7c-321b6d99354d", + "name": "The Checkout got successfully created for the given reader.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "roles" + "readers", + ":reader_id", + "checkout" ], "host": [ "{{baseUrl}}" @@ -8067,46 +7703,71 @@ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", "value": "", "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the Reader", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "reader_id" } ] }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", - "body": {} + "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\": true\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", + "language": "json" + } + } + } }, - "status": "OK", - "code": 200, + "status": "Created", + "code": 201, "header": [ { "key": "Content-Type", "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\": 2574,\n \"key_1\": true,\n \"key_2\": 251,\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": 129.82022026789554,\n \"key_6\": true,\n \"key_7\": 7692.072126064442,\n \"key_8\": 8722,\n \"key_9\": \"string\",\n \"key_10\": 2624,\n \"key_11\": \"string\",\n \"key_12\": 8059,\n \"key_13\": \"string\",\n \"key_14\": \"string\",\n \"key_15\": 1839.764139538691,\n \"key_16\": \"string\",\n \"key_17\": \"string\",\n \"key_18\": \"string\",\n \"key_19\": \"string\",\n \"key_20\": false,\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": 1008,\n \"key_24\": 5277.7650129100875,\n \"key_25\": 1888,\n \"key_26\": 2490,\n \"key_27\": 8088,\n \"key_28\": 5117.8700564530245,\n \"key_29\": true,\n \"key_30\": 3954.5811111405314,\n \"key_31\": 3349,\n \"key_32\": 5228,\n \"key_33\": 894.130115844245,\n \"key_34\": \"string\",\n \"key_35\": 6694,\n \"key_36\": 2196,\n \"key_37\": false,\n \"key_38\": 6784\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\": \"string\",\n \"key_1\": true,\n \"key_2\": true,\n \"key_3\": true,\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": true,\n \"key_7\": false,\n \"key_8\": 1033.0817111707536,\n \"key_9\": false,\n \"key_10\": 138.8258090659633,\n \"key_11\": \"string\",\n \"key_12\": 2905,\n \"key_13\": 1961,\n \"key_14\": \"string\",\n \"key_15\": 1530,\n \"key_16\": false,\n \"key_17\": 9558,\n \"key_18\": false,\n \"key_19\": 10.526033191717854,\n \"key_20\": 1794.3188561732782,\n \"key_21\": false,\n \"key_22\": \"string\",\n \"key_23\": 7636,\n \"key_24\": 6484,\n \"key_25\": 1769.827474240695,\n \"key_26\": \"string\",\n \"key_27\": \"string\",\n \"key_28\": 8681,\n \"key_29\": true,\n \"key_30\": 9768.428972755617,\n \"key_31\": 600.0449105627625,\n \"key_32\": 2440,\n \"key_33\": \"string\",\n \"key_34\": 5262.308254934671,\n \"key_35\": 2563,\n \"key_36\": true,\n \"key_37\": \"string\",\n \"key_38\": true,\n \"key_39\": 646.1955434240884,\n \"key_40\": \"string\",\n \"key_41\": \"string\",\n \"key_42\": 4555.525495690569,\n \"key_43\": false,\n \"key_44\": true,\n \"key_45\": 8541,\n \"key_46\": 3260,\n \"key_47\": false,\n \"key_48\": 9199.43705176359,\n \"key_49\": 5838.3563529066505,\n \"key_50\": \"string\",\n \"key_51\": 657,\n \"key_52\": 8158.090824603257,\n \"key_53\": true,\n \"key_54\": \"string\",\n \"key_55\": 1060.8810791727242,\n \"key_56\": 9190.681069622204,\n \"key_57\": 9669.256145397412,\n \"key_58\": 5468,\n \"key_59\": \"string\",\n \"key_60\": true,\n \"key_61\": 9652.40925535497,\n \"key_62\": 3928\n }\n }\n ]\n}", + "body": "{\n \"data\": {\n \"client_transaction_id\": \"\",\n \"checkout_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5127ea64-3406-4486-bf0a-1da836e1967f", - "name": "Merchant not found.", + "id": "58d9b252-7e66-4d66-a260-a1d315460449", + "name": "Response when given params (or one of them) are invalid", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "roles" + "readers", + ":reader_id", + "checkout" ], "host": [ "{{baseUrl}}" @@ -8116,117 +7777,71 @@ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", "value": "", "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the Reader", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "reader_id" } ] }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", - "value": "application/problem+json" + "value": "application/json" } ], - "method": "GET", - "body": {} + "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\": true\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", + "language": "json" + } + } + } }, - "status": "Not Found", - "code": 404, + "status": "Bad Request", + "code": 400, "header": [ { "key": "Content-Type", - "value": "application/problem+json" + "value": "application/json" } ], - "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "body": "{\n \"errors\": {\n \"type\": \"\",\n \"detail\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, - { - "id": "16639029-a577-4fbf-88b8-10148a393bc8", - "name": "Create a role", - "request": { - "name": "Create a role", - "description": { - "content": "Create a custom role for the merchant. Roles are defined by the set of permissions that they grant to the members that they are assigned to.", - "type": "text/plain" }, - "url": { - "path": [ - "v0.1", - "merchants", - ":merchant_code", - "roles" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "merchant_code", - "disabled": false, - "description": { - "content": "(Required) Short unique identifier for the merchant.", - "type": "text/plain" - } - } - ] - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 14,\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": 9195,\n \"key_4\": \"string\",\n \"key_5\": 8443,\n \"key_6\": 9070.551241813957,\n \"key_7\": \"string\",\n \"key_8\": true,\n \"key_9\": 328.9238515970139,\n \"key_10\": false,\n \"key_11\": true,\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": \"string\",\n \"key_15\": 5165.692270109727,\n \"key_16\": \"string\",\n \"key_17\": 8673.57486215532,\n \"key_18\": 8755,\n \"key_19\": 5774.937966067361,\n \"key_20\": 4302,\n \"key_21\": \"string\"\n },\n \"description\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{bearerToken}}" - } - ] - } - }, - "response": [ { - "id": "7b4ab3a2-27cd-40d6-982a-25370a7dc424", - "name": "Returns the Role object after successful custom role creation.", + "id": "d065966a-0168-425f-aeaa-e1caeb9ff80e", + "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "roles" + "readers", + ":reader_id", + "checkout" ], "host": [ "{{baseUrl}}" @@ -8236,12 +7851,22 @@ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", "value": "", "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the Reader", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "reader_id" } ] }, @@ -8258,7 +7883,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 14,\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": 9195,\n \"key_4\": \"string\",\n \"key_5\": 8443,\n \"key_6\": 9070.551241813957,\n \"key_7\": \"string\",\n \"key_8\": true,\n \"key_9\": 328.9238515970139,\n \"key_10\": false,\n \"key_11\": true,\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": \"string\",\n \"key_15\": 5165.692270109727,\n \"key_16\": \"string\",\n \"key_17\": 8673.57486215532,\n \"key_18\": 8755,\n \"key_19\": 5774.937966067361,\n \"key_20\": 4302,\n \"key_21\": \"string\"\n },\n \"description\": \"\"\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\": true\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", @@ -8267,28 +7892,30 @@ } } }, - "status": "Created", - "code": 201, + "status": "Unauthorized", + "code": 401, "header": [ { "key": "Content-Type", "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\": 6142.234754265423,\n \"key_1\": \"string\",\n \"key_2\": 2295.111463964339,\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": true,\n \"key_6\": 7108.612073933274,\n \"key_7\": 4953.609802340924,\n \"key_8\": 2279,\n \"key_9\": \"string\",\n \"key_10\": 7172,\n \"key_11\": \"string\",\n \"key_12\": true,\n \"key_13\": \"string\",\n \"key_14\": 6066,\n \"key_15\": true,\n \"key_16\": true,\n \"key_17\": false,\n \"key_18\": 3335.1136619326003,\n \"key_19\": false,\n \"key_20\": true,\n \"key_21\": 4243.183883497332,\n \"key_22\": false,\n \"key_23\": 439,\n \"key_24\": 9648,\n \"key_25\": \"string\",\n \"key_26\": 2400,\n \"key_27\": 1678.6023474696399,\n \"key_28\": false,\n \"key_29\": 8208,\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": 7922,\n \"key_33\": \"string\",\n \"key_34\": 273.50238410233317,\n \"key_35\": 4191,\n \"key_36\": 6343.855115895565,\n \"key_37\": 1776.8722368090416,\n \"key_38\": false,\n \"key_39\": false,\n \"key_40\": \"string\",\n \"key_41\": \"string\",\n \"key_42\": true,\n \"key_43\": true,\n \"key_44\": \"string\",\n \"key_45\": \"string\",\n \"key_46\": 5969.103864570895,\n \"key_47\": \"string\"\n }\n}", + "body": "{\n \"errors\": {\n \"type\": \"\",\n \"detail\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a7c4be08-a756-402b-ba8e-7dc775a2fe04", - "name": "Invalid request.", + "id": "3caa0b0e-453f-4596-ad1d-ac6be8e98562", + "name": "Response when given reader is not found", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "roles" + "readers", + ":reader_id", + "checkout" ], "host": [ "{{baseUrl}}" @@ -8298,12 +7925,22 @@ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", "value": "", "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the Reader", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "reader_id" } ] }, @@ -8314,13 +7951,13 @@ }, { "key": "Accept", - "value": "application/problem+json" + "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 14,\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": 9195,\n \"key_4\": \"string\",\n \"key_5\": 8443,\n \"key_6\": 9070.551241813957,\n \"key_7\": \"string\",\n \"key_8\": true,\n \"key_9\": 328.9238515970139,\n \"key_10\": false,\n \"key_11\": true,\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": \"string\",\n \"key_15\": 5165.692270109727,\n \"key_16\": \"string\",\n \"key_17\": 8673.57486215532,\n \"key_18\": 8755,\n \"key_19\": 5774.937966067361,\n \"key_20\": 4302,\n \"key_21\": \"string\"\n },\n \"description\": \"\"\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\": true\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", @@ -8329,28 +7966,30 @@ } } }, - "status": "Bad Request", - "code": 400, + "status": "Not Found", + "code": 404, "header": [ { "key": "Content-Type", - "value": "application/problem+json" + "value": "application/json" } ], - "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "body": "{\n \"errors\": {\n \"detail\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7356c27b-740e-4d38-a86f-1134b2e8c770", - "name": "Merchant not found.", + "id": "82871a15-d26c-4b3b-b288-079a7b6e92cf", + "name": "Response when given params (or one of them) are invalid", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "roles" + "readers", + ":reader_id", + "checkout" ], "host": [ "{{baseUrl}}" @@ -8360,12 +7999,22 @@ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", "value": "", "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the Reader", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "reader_id" } ] }, @@ -8376,13 +8025,13 @@ }, { "key": "Accept", - "value": "application/problem+json" + "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 14,\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": 9195,\n \"key_4\": \"string\",\n \"key_5\": 8443,\n \"key_6\": 9070.551241813957,\n \"key_7\": \"string\",\n \"key_8\": true,\n \"key_9\": 328.9238515970139,\n \"key_10\": false,\n \"key_11\": true,\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": \"string\",\n \"key_15\": 5165.692270109727,\n \"key_16\": \"string\",\n \"key_17\": 8673.57486215532,\n \"key_18\": 8755,\n \"key_19\": 5774.937966067361,\n \"key_20\": 4302,\n \"key_21\": \"string\"\n },\n \"description\": \"\"\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\": true\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", @@ -8391,15 +8040,15 @@ } } }, - "status": "Not Found", - "code": 404, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, "header": [ { "key": "Content-Type", - "value": "application/problem+json" + "value": "application/json" } ], - "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "body": "{\n \"errors\": {\n \"key_0\": \"string\",\n \"key_1\": 5499.601066448565,\n \"key_2\": 232,\n \"key_3\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -8410,12 +8059,12 @@ } }, { - "id": "2bc19792-9b09-41ed-92b3-417126d4b4e3", - "name": "Retrieve a role", + "id": "2adddca7-8d5e-416b-a2dd-2dc66f9f5372", + "name": "Get a Reader Status", "request": { - "name": "Retrieve a role", + "name": "Get a Reader Status", "description": { - "content": "Retrieve a custom role by ID.", + "content": "Provides the last known status for a Reader.\n\nThis endpoint allows you to retrieve updates from the connected card reader, including the current screen being displayed during the payment process and the device status (battery level, connectivity, and update state).\n\nSupported States\n\n* `IDLE` – Reader ready for next transaction\n* `SELECTING_TIP` – Waiting for tip input\n* `WAITING_FOR_CARD` – Awaiting card insert/tap\n* `WAITING_FOR_PIN` – Waiting for PIN entry\n* `WAITING_FOR_SIGNATURE` – Waiting for customer signature\n* `UPDATING_FIRMWARE` – Firmware update in progress\n\nDevice Status\n\n* `ONLINE` – Device connected and operational\n* `OFFLINE` – Device disconnected (last state persisted)\n\n**Note**: If the target device is a Solo, it must be in version 3.3.39.0 or higher.\n", "type": "text/plain" }, "url": { @@ -8423,8 +8072,9 @@ "v0.1", "merchants", ":merchant_code", - "roles", - ":role_id" + "readers", + ":reader_id", + "status" ], "host": [ "{{baseUrl}}" @@ -8437,17 +8087,17 @@ "key": "merchant_code", "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" } }, { "type": "any", "value": "", - "key": "role_id", + "key": "reader_id", "disabled": false, "description": { - "content": "(Required) The ID of the role to retrieve.", + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" } } @@ -8473,16 +8123,17 @@ }, "response": [ { - "id": "dd3e92dd-cfa3-4c06-9ce6-a0c384b13433", - "name": "Returns the Role object for a valid identifier.", + "id": "ccb391a2-cbc8-4754-91a1-1d2d28546366", + "name": "Response with the device status.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "roles", - ":role_id" + "readers", + ":reader_id", + "status" ], "host": [ "{{baseUrl}}" @@ -8492,7 +8143,7 @@ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", @@ -8502,12 +8153,12 @@ { "disabled": false, "description": { - "content": "(Required) The ID of the role to retrieve.", + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" }, "type": "any", "value": "", - "key": "role_id" + "key": "reader_id" } ] }, @@ -8528,21 +8179,22 @@ "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\": 6142.234754265423,\n \"key_1\": \"string\",\n \"key_2\": 2295.111463964339,\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": true,\n \"key_6\": 7108.612073933274,\n \"key_7\": 4953.609802340924,\n \"key_8\": 2279,\n \"key_9\": \"string\",\n \"key_10\": 7172,\n \"key_11\": \"string\",\n \"key_12\": true,\n \"key_13\": \"string\",\n \"key_14\": 6066,\n \"key_15\": true,\n \"key_16\": true,\n \"key_17\": false,\n \"key_18\": 3335.1136619326003,\n \"key_19\": false,\n \"key_20\": true,\n \"key_21\": 4243.183883497332,\n \"key_22\": false,\n \"key_23\": 439,\n \"key_24\": 9648,\n \"key_25\": \"string\",\n \"key_26\": 2400,\n \"key_27\": 1678.6023474696399,\n \"key_28\": false,\n \"key_29\": 8208,\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": 7922,\n \"key_33\": \"string\",\n \"key_34\": 273.50238410233317,\n \"key_35\": 4191,\n \"key_36\": 6343.855115895565,\n \"key_37\": 1776.8722368090416,\n \"key_38\": false,\n \"key_39\": false,\n \"key_40\": \"string\",\n \"key_41\": \"string\",\n \"key_42\": true,\n \"key_43\": true,\n \"key_44\": \"string\",\n \"key_45\": \"string\",\n \"key_46\": 5969.103864570895,\n \"key_47\": \"string\"\n }\n}", + "body": "{\n \"data\": {\n \"status\": \"ONLINE\",\n \"battery_level\": \"\",\n \"battery_temperature\": \"\",\n \"connection_type\": \"btle\",\n \"firmware_version\": \"\",\n \"last_activity\": \"\",\n \"state\": \"UPDATING_FIRMWARE\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e654af05-0b01-41d4-a756-7084e53f604e", - "name": "Merchant or role not found.", + "id": "36a43cdf-645b-434c-833f-25cd45cd737e", + "name": "Response when given params (or one of them) are invalid", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "roles", - ":role_id" + "readers", + ":reader_id", + "status" ], "host": [ "{{baseUrl}}" @@ -8552,7 +8204,7 @@ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", @@ -8562,116 +8214,48 @@ { "disabled": false, "description": { - "content": "(Required) The ID of the role to retrieve.", + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" }, "type": "any", "value": "", - "key": "role_id" + "key": "reader_id" } ] }, "header": [ { "key": "Accept", - "value": "application/problem+json" + "value": "application/json" } ], "method": "GET", "body": {} }, - "status": "Not Found", - "code": 404, + "status": "Bad Request", + "code": 400, "header": [ { "key": "Content-Type", - "value": "application/problem+json" + "value": "application/json" } ], - "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "body": "{\n \"errors\": {\n \"type\": \"DUPLICATE_HEADERS\",\n \"detail\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, - { - "id": "fec8862f-4e40-40e1-88a9-8b02d31ba4bc", - "name": "Delete a role", - "request": { - "name": "Delete a role", - "description": { - "content": "Delete a custom role.", - "type": "text/plain" - }, - "url": { - "path": [ - "v0.1", - "merchants", - ":merchant_code", - "roles", - ":role_id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "type": "any", - "value": "", - "key": "merchant_code", - "disabled": false, - "description": { - "content": "(Required) Short unique identifier for the merchant.", - "type": "text/plain" - } - }, - { - "type": "any", - "value": "", - "key": "role_id", - "disabled": false, - "description": { - "content": "(Required) The ID of the role to retrieve.", - "type": "text/plain" - } - } - ] }, - "header": [ - { - "key": "Accept", - "value": "application/problem+json" - } - ], - "method": "DELETE", - "body": {}, - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{bearerToken}}" - } - ] - } - }, - "response": [ { - "id": "1c6047bb-d390-4ecd-ad53-8335e2563ac3", - "name": "Returns an empty response if the role deletion succeeded.", + "id": "d1751275-b0aa-4183-aedd-c0bdf018261b", + "name": "Response when given merchant's token is invalid", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "roles", - ":role_id" + "readers", + ":reader_id", + "status" ], "host": [ "{{baseUrl}}" @@ -8681,7 +8265,7 @@ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", @@ -8691,95 +8275,48 @@ { "disabled": false, "description": { - "content": "(Required) The ID of the role to retrieve.", + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" }, "type": "any", "value": "", - "key": "role_id" + "key": "reader_id" } ] }, - "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "body": {} }, - "status": "OK", - "code": 200, - "header": [], - "cookie": [], - "_postman_previewlanguage": "text" - }, - { - "id": "f5bce57e-b204-4f04-9a4b-5b7f4d24f571", - "name": "Invalid request.", - "originalRequest": { - "url": { - "path": [ - "v0.1", - "merchants", - ":merchant_code", - "roles", - ":role_id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Short unique identifier for the merchant.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "merchant_code" - }, - { - "disabled": false, - "description": { - "content": "(Required) The ID of the role to retrieve.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "role_id" - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/problem+json" - } - ], - "method": "DELETE", - "body": {} - }, - "status": "Bad Request", - "code": 400, + "status": "Unauthorized", + "code": 401, "header": [ { "key": "Content-Type", - "value": "application/problem+json" + "value": "application/json" } ], - "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "body": "{\n \"errors\": {\n \"detail\": \"\",\n \"type\": \"INVALID_PASSWORD\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6ad2afb7-b8b9-480a-a5eb-d73fc5592249", - "name": "Merchant not found.", + "id": "0943ffa2-5912-45a6-bf0d-e41c1a2286a6", + "name": "Response when given reader is not found", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "roles", - ":role_id" + "readers", + ":reader_id", + "status" ], "host": [ "{{baseUrl}}" @@ -8789,7 +8326,7 @@ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", @@ -8799,22 +8336,22 @@ { "disabled": false, "description": { - "content": "(Required) The ID of the role to retrieve.", + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" }, "type": "any", "value": "", - "key": "role_id" + "key": "reader_id" } ] }, "header": [ { "key": "Accept", - "value": "application/problem+json" + "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "body": {} }, "status": "Not Found", @@ -8822,10 +8359,10 @@ "header": [ { "key": "Content-Type", - "value": "application/problem+json" + "value": "application/json" } ], - "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "body": "{\n \"errors\": {\n \"detail\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -8836,12 +8373,12 @@ } }, { - "id": "14cc2c6f-c10c-477d-8878-95149381d5e4", - "name": "Update a role", + "id": "d0b632c6-18a0-43f7-a232-9f34369071fc", + "name": "Terminate a Reader Checkout", "request": { - "name": "Update a role", + "name": "Terminate a Reader Checkout", "description": { - "content": "Update a custom role.", + "content": "Terminate a Reader Checkout stops the current transaction on the target device.\n\nThis process is asynchronous and the actual termination may take some time to be performed on the device.\n\n\nThere are some caveats when using this endpoint:\n* The target device must be online, otherwise terminate won't be accepted\n* The action will succeed only if the device is waiting for cardholder action: e.g: waiting for card, waiting for PIN, etc.\n* There is no confirmation of the termination.\n\nIf a transaction is successfully terminated and `return_url` was provided on Checkout, the transaction status will be sent as `failed` to the provided URL.\n\n\n**Note**: If the target device is a Solo, it must be in version 3.3.28.0 or higher.\n", "type": "text/plain" }, "url": { @@ -8849,8 +8386,9 @@ "v0.1", "merchants", ":merchant_code", - "roles", - ":role_id" + "readers", + ":reader_id", + "terminate" ], "host": [ "{{baseUrl}}" @@ -8863,17 +8401,17 @@ "key": "merchant_code", "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" } }, { "type": "any", "value": "", - "key": "role_id", + "key": "reader_id", "disabled": false, "description": { - "content": "(Required) The ID of the role to retrieve.", + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" } } @@ -8889,10 +8427,10 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"description\": \"\"\n}", + "raw": "", "options": { "raw": { "headerFamily": "json", @@ -8912,16 +8450,17 @@ }, "response": [ { - "id": "93515dac-32ba-4c1e-80ec-155f7f59b3e0", - "name": "Returns the updated Role object if the update succeeded.", + "id": "0758decc-9b31-4cf9-8483-6ca688aafda9", + "name": "Response when given params (or one of them) are invalid", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "roles", - ":role_id" + "readers", + ":reader_id", + "terminate" ], "host": [ "{{baseUrl}}" @@ -8931,7 +8470,7 @@ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", @@ -8941,12 +8480,12 @@ { "disabled": false, "description": { - "content": "(Required) The ID of the role to retrieve.", + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" }, "type": "any", "value": "", - "key": "role_id" + "key": "reader_id" } ] }, @@ -8960,10 +8499,10 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"description\": \"\"\n}", + "raw": "", "options": { "raw": { "headerFamily": "json", @@ -8972,29 +8511,30 @@ } } }, - "status": "OK", - "code": 200, + "status": "Bad Request", + "code": 400, "header": [ { "key": "Content-Type", "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\": 6142.234754265423,\n \"key_1\": \"string\",\n \"key_2\": 2295.111463964339,\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": true,\n \"key_6\": 7108.612073933274,\n \"key_7\": 4953.609802340924,\n \"key_8\": 2279,\n \"key_9\": \"string\",\n \"key_10\": 7172,\n \"key_11\": \"string\",\n \"key_12\": true,\n \"key_13\": \"string\",\n \"key_14\": 6066,\n \"key_15\": true,\n \"key_16\": true,\n \"key_17\": false,\n \"key_18\": 3335.1136619326003,\n \"key_19\": false,\n \"key_20\": true,\n \"key_21\": 4243.183883497332,\n \"key_22\": false,\n \"key_23\": 439,\n \"key_24\": 9648,\n \"key_25\": \"string\",\n \"key_26\": 2400,\n \"key_27\": 1678.6023474696399,\n \"key_28\": false,\n \"key_29\": 8208,\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": 7922,\n \"key_33\": \"string\",\n \"key_34\": 273.50238410233317,\n \"key_35\": 4191,\n \"key_36\": 6343.855115895565,\n \"key_37\": 1776.8722368090416,\n \"key_38\": false,\n \"key_39\": false,\n \"key_40\": \"string\",\n \"key_41\": \"string\",\n \"key_42\": true,\n \"key_43\": true,\n \"key_44\": \"string\",\n \"key_45\": \"string\",\n \"key_46\": 5969.103864570895,\n \"key_47\": \"string\"\n }\n}", + "body": "{\n \"errors\": {\n \"type\": \"\",\n \"detail\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "14fb4448-1d69-4084-bdd6-f258b3644228", - "name": "Invalid request.", + "id": "9865ec03-4063-4c44-90b7-97fda172f0cf", + "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "roles", - ":role_id" + "readers", + ":reader_id", + "terminate" ], "host": [ "{{baseUrl}}" @@ -9004,7 +8544,7 @@ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", @@ -9014,12 +8554,12 @@ { "disabled": false, "description": { - "content": "(Required) The ID of the role to retrieve.", + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" }, "type": "any", "value": "", - "key": "role_id" + "key": "reader_id" } ] }, @@ -9030,13 +8570,13 @@ }, { "key": "Accept", - "value": "application/problem+json" + "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"description\": \"\"\n}", + "raw": "", "options": { "raw": { "headerFamily": "json", @@ -9045,29 +8585,30 @@ } } }, - "status": "Bad Request", - "code": 400, + "status": "Unauthorized", + "code": 401, "header": [ { "key": "Content-Type", - "value": "application/problem+json" + "value": "application/json" } ], - "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "body": "{\n \"errors\": {\n \"type\": \"\",\n \"detail\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6851c80f-ce4d-4e2d-a85c-b15b7f9dca4c", - "name": "Merchant not found.", + "id": "a6d0efdb-403f-4996-9335-17cbd9aa5985", + "name": "Response when given reader is not found", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "roles", - ":role_id" + "readers", + ":reader_id", + "terminate" ], "host": [ "{{baseUrl}}" @@ -9077,7 +8618,7 @@ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", @@ -9087,12 +8628,12 @@ { "disabled": false, "description": { - "content": "(Required) The ID of the role to retrieve.", + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" }, "type": "any", "value": "", - "key": "role_id" + "key": "reader_id" } ] }, @@ -9103,13 +8644,13 @@ }, { "key": "Accept", - "value": "application/problem+json" + "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"description\": \"\"\n}", + "raw": "", "options": { "raw": { "headerFamily": "json", @@ -9123,199 +8664,84 @@ "header": [ { "key": "Content-Type", - "value": "application/problem+json" + "value": "application/json" } ], - "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "body": "{\n \"errors\": {\n \"detail\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - } - ] - }, - { - "name": "Merchants", - "description": "A Merchant represents a single business which can use SumUp products like payment processing.", - "item": [ - { - "id": "aad51b79-9970-4e0c-ae47-178f22b387c9", - "name": "Get Merchant", - "request": { - "name": "Get Merchant", - "description": { - "content": "Returns a Merchant for a valid Merchant code.", - "type": "text/plain" - }, - "url": { - "path": [ - "v1", - "merchants", - ":merchant_code" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", - "type": "text/plain" - }, - "key": "version", - "value": "" - } - ], - "variable": [ - { - "type": "any", - "value": "", - "key": "merchant_code", - "disabled": false, - "description": { - "content": "(Required) Short unique identifier for the merchant.", - "type": "text/plain" - } - } - ] }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{bearerToken}}" - } - ] - } - }, - "response": [ { - "id": "8acb8ef7-c22b-4692-a692-787c7180a728", - "name": "Returns a Merchant for a valid identifier.", + "id": "e788cd7d-2921-47df-8db6-f72fc8bcf900", + "name": "Response when given params (or one of them) are invalid", "originalRequest": { "url": { "path": [ - "v1", + "v0.1", "merchants", - ":merchant_code" + ":merchant_code", + "readers", + ":reader_id", + "terminate" ], "host": [ "{{baseUrl}}" ], - "query": [ + "query": [], + "variable": [ { "disabled": false, "description": { - "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", - "type": "text/plain" - }, - "key": "version", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", "value": "", "key": "merchant_code" - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"country\": \"HW\",\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\": \"7836\",\n \"legal_type\": \"\",\n \"address\": {\n \"country\": \"NV\",\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\": \"PT\",\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 \"phone_number\": \"\",\n \"website\": \"\",\n \"attributes\": {\n \"key_0\": 8045,\n \"key_1\": \"string\"\n }\n },\n \"business_profile\": {\n \"name\": \"\",\n \"dynamic_descriptor\": \"IMyF GiuMGzoaB\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"country\": \"XZ\",\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 \"key_2\": \"\"\n },\n \"classic\": {\n \"id\": \"\"\n },\n \"version\": \"\",\n \"change_status\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "a35b7085-4b52-4b8c-ad4b-f65e36f3d1a9", - "name": "The requested Merchant does not exist.", - "originalRequest": { - "url": { - "path": [ - "v1", - "merchants", - ":merchant_code" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", - "type": "text/plain" - }, - "key": "version", - "value": "" - } - ], - "variable": [ + }, { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" }, "type": "any", "value": "", - "key": "merchant_code" + "key": "reader_id" } ] }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", - "value": "application/problem+json" + "value": "application/json" } ], - "method": "GET", - "body": {} + "method": "POST", + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } }, - "status": "Not Found", - "code": 404, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, "header": [ { "key": "Content-Type", - "value": "application/problem+json" + "value": "application/json" } ], - "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "body": "{\n \"errors\": {\n \"key_0\": false,\n \"key_1\": 6192.4224253946995\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -9326,43 +8752,56 @@ } }, { - "id": "4b9330c1-3400-4240-aaa7-ad0a0661c936", - "name": "List Persons", + "id": "6966c3ba-b70a-4312-b016-a771efd31814", + "name": "Get a Reader Checkout", "request": { - "name": "List Persons", + "name": "Get a Reader Checkout", "description": { - "content": "Returns the Persons related to a Merchant.", + "content": "Get a Checkout for a Reader.\n", "type": "text/plain" }, "url": { "path": [ - "v1", + "v0.1", "merchants", ":merchant_code", - "persons" + "readers", + ":reader_id", + "checkout", + ":checkout_id" ], "host": [ "{{baseUrl}}" ], - "query": [ + "query": [], + "variable": [ { + "type": "any", + "value": "", + "key": "merchant_code", "disabled": false, "description": { - "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", + "content": "(Required) Merchant Code", "type": "text/plain" - }, - "key": "version", - "value": "" - } - ], - "variable": [ + } + }, { "type": "any", "value": "", - "key": "merchant_code", + "key": "reader_id", "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) The unique identifier of the Reader", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "checkout_id", + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the Checkout", "type": "text/plain" } } @@ -9388,40 +8827,53 @@ }, "response": [ { - "id": "c680ebe7-7a24-481b-89e5-d9bcbffe4922", - "name": "Returns a list of Persons for a valid Merchant identifier.", + "id": "efae0913-46d5-465d-b676-62be46ec5d56", + "name": "The Checkout got successfully retrieved for the given reader.", "originalRequest": { "url": { "path": [ - "v1", + "v0.1", "merchants", ":merchant_code", - "persons" + "readers", + ":reader_id", + "checkout", + ":checkout_id" ], "host": [ "{{baseUrl}}" ], - "query": [ + "query": [], + "variable": [ { "disabled": false, "description": { - "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", + "content": "(Required) Merchant Code", "type": "text/plain" }, - "key": "version", - "value": "" - } - ], - "variable": [ + "type": "any", + "value": "", + "key": "merchant_code" + }, { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" }, "type": "any", "value": "", - "key": "merchant_code" + "key": "reader_id" + }, + { + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the Checkout", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "checkout_id" } ] }, @@ -9442,179 +8894,105 @@ "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\": \"AK\",\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\": \"WS\",\n \"nationality\": \"\",\n \"country_of_residence\": \"\",\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\": \"PO\",\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\": \"LD\",\n \"nationality\": \"\",\n \"country_of_residence\": \"\",\n \"version\": \"\",\n \"change_status\": \"\"\n }\n ]\n}", + "body": "{\n \"data\": {\n \"checkout_id\": \"\",\n \"client_transaction_id\": \"\",\n \"reader_serial_number\": \"\",\n \"payment_type\": \"card\",\n \"card_type\": \"credit\",\n \"reader_firmware_version\": \"\",\n \"installments\": \"\",\n \"payment_status\": \"\",\n \"valid_until\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"successful\",\n \"total_amount\": {\n \"currency\": \"\",\n \"minor_unit\": \"\",\n \"value\": \"\"\n },\n \"payment_failure_reason\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "fee565d9-dfac-4f6d-86ce-38f3922bec63", - "name": "The requested Merchant does not exist.", + "id": "ebbd0a34-bbe5-4af6-8b01-3b87e68a6608", + "name": "Unauthorized", "originalRequest": { "url": { "path": [ - "v1", + "v0.1", "merchants", ":merchant_code", - "persons" + "readers", + ":reader_id", + "checkout", + ":checkout_id" ], "host": [ "{{baseUrl}}" ], - "query": [ + "query": [], + "variable": [ { "disabled": false, "description": { - "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", + "content": "(Required) Merchant Code", "type": "text/plain" }, - "key": "version", - "value": "" - } - ], - "variable": [ + "type": "any", + "value": "", + "key": "merchant_code" + }, { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" }, "type": "any", "value": "", - "key": "merchant_code" + "key": "reader_id" + }, + { + "disabled": false, + "description": { + "content": "(Required) The unique identifier of the Checkout", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "checkout_id" } ] }, "header": [ { "key": "Accept", - "value": "application/problem+json" + "value": "application/json" } ], "method": "GET", "body": {} }, - "status": "Not Found", - "code": 404, + "status": "Unauthorized", + "code": 401, "header": [ { "key": "Content-Type", - "value": "application/problem+json" + "value": "application/json" } ], - "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "body": "{\n \"errors\": {\n \"type\": \"\",\n \"detail\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, - { - "id": "86d17fe3-5912-4778-85f3-f33dc476bacd", - "name": "Get Person", - "request": { - "name": "Get Person", - "description": { - "content": "Returns a single Person related to a Merchant.", - "type": "text/plain" }, - "url": { - "path": [ - "v1", - "merchants", - ":merchant_code", - "persons", - ":person_id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", - "type": "text/plain" - }, - "key": "version", - "value": "" - } - ], - "variable": [ - { - "type": "any", - "value": "", - "key": "merchant_code", - "disabled": false, - "description": { - "content": "(Required) Short unique identifier for the merchant.", - "type": "text/plain" - } - }, - { - "type": "any", - "value": "", - "key": "person_id", - "disabled": false, - "description": { - "content": "(Required) Person ID", - "type": "text/plain" - } - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{bearerToken}}" - } - ] - } - }, - "response": [ { - "id": "909da899-ebd7-4518-8ab2-8a2ee9873384", - "name": "Returns a Person for a valid identifier.", + "id": "05ad8d42-79d8-4f1e-a6fd-c5898bd512cb", + "name": "Response when given reader or checkout is not found", "originalRequest": { "url": { "path": [ - "v1", + "v0.1", "merchants", ":merchant_code", - "persons", - ":person_id" + "readers", + ":reader_id", + "checkout", + ":checkout_id" ], "host": [ "{{baseUrl}}" ], - "query": [ - { - "disabled": false, - "description": { - "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", - "type": "text/plain" - }, - "key": "version", - "value": "" - } - ], + "query": [], "variable": [ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Merchant Code", "type": "text/plain" }, "type": "any", @@ -9624,89 +9002,29 @@ { "disabled": false, "description": { - "content": "(Required) Person ID", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "person_id" - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "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\": \"GM\",\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\": \"JN\",\n \"nationality\": \"\",\n \"country_of_residence\": \"\",\n \"version\": \"\",\n \"change_status\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "b4f65afe-7b54-47a2-bfda-38369f1a4791", - "name": "The requested Person does not exist.", - "originalRequest": { - "url": { - "path": [ - "v1", - "merchants", - ":merchant_code", - "persons", - ":person_id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", - "type": "text/plain" - }, - "key": "version", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) The unique identifier of the Reader", "type": "text/plain" }, "type": "any", "value": "", - "key": "merchant_code" + "key": "reader_id" }, { "disabled": false, "description": { - "content": "(Required) Person ID", + "content": "(Required) The unique identifier of the Checkout", "type": "text/plain" }, "type": "any", "value": "", - "key": "person_id" + "key": "checkout_id" } ] }, "header": [ { "key": "Accept", - "value": "application/problem+json" + "value": "application/json" } ], "method": "GET", @@ -9717,10 +9035,10 @@ "header": [ { "key": "Content-Type", - "value": "application/problem+json" + "value": "application/json" } ], - "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "body": "{\n \"errors\": {\n \"detail\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -9733,16 +9051,16 @@ ] }, { - "name": "Readers", - "description": "A reader represents a device that accepts payments. You can use the SumUp Solo to accept in-person payments.", + "name": "Members", + "description": "Endpoints to manage account members. Members are users that have membership within merchant accounts.", "item": [ { - "id": "24fe2edb-8f8f-4607-869c-a3aa575cb7f3", - "name": "List Readers", + "id": "33f5a619-b407-4e73-bd79-e838a4ed3820", + "name": "List members", "request": { - "name": "List Readers", + "name": "List members", "description": { - "content": "List all readers of the merchant.", + "content": "Lists merchant members.", "type": "text/plain" }, "url": { @@ -9750,12 +9068,85 @@ "v0.1", "merchants", ":merchant_code", - "readers" + "members" ], "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset of the first member to return.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Maximum number of members to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Indicates to skip count query.", + "type": "text/plain" + }, + "key": "scroll", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned members by email address prefix.", + "type": "text/plain" + }, + "key": "email", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Search for a member by user id.", + "type": "text/plain" + }, + "key": "user.id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned members by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", + "type": "text/plain" + }, + "key": "status", + "value": "unknown" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned members by role.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned members by role.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + } + ], "variable": [ { "type": "any", @@ -9789,70 +9180,198 @@ }, "response": [ { - "id": "45113181-6368-4c21-9966-e5daeb947284", - "name": "Returns a list Reader objects.", + "id": "8ec31b42-9fa7-41df-86ea-6b3d4d07d144", + "name": "Returns a list of Member objects.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers" + "members" ], "host": [ "{{baseUrl}}" ], - "query": [], - "variable": [ + "query": [ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "Offset of the first member to return.", "type": "text/plain" }, - "type": "any", - "value": "", - "key": "merchant_code" - } - ] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "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\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 2236.14817337076,\n \"key_3\": \"string\",\n \"key_4\": false,\n \"key_5\": 2462.0768587499665,\n \"key_6\": 9895,\n \"key_7\": false,\n \"key_8\": \"string\",\n \"key_9\": 8981,\n \"key_10\": 7315.480479110088,\n \"key_11\": 3680,\n \"key_12\": 1247.150849037084,\n \"key_13\": \"string\",\n \"key_14\": \"string\",\n \"key_15\": 7171.354194903945,\n \"key_16\": 7874,\n \"key_17\": 711,\n \"key_18\": 3043.690396813472,\n \"key_19\": 9047.414692682725,\n \"key_20\": 6929.776234536768,\n \"key_21\": 4954.677241087193,\n \"key_22\": true,\n \"key_23\": 8747,\n \"key_24\": 69,\n \"key_25\": \"string\",\n \"key_26\": 1857,\n \"key_27\": 748,\n \"key_28\": \"string\",\n \"key_29\": 6228.117804061186,\n \"key_30\": 6040.977208889329,\n \"key_31\": 7863.179643820066,\n \"key_32\": 1086,\n \"key_33\": 4355.4546813974375,\n \"key_34\": true,\n \"key_35\": 8810.00214133876,\n \"key_36\": \"string\",\n \"key_37\": true,\n \"key_38\": \"string\",\n \"key_39\": 5177.592257545085,\n \"key_40\": false,\n \"key_41\": 7452.086035391754\n },\n \"service_account_id\": \"\"\n },\n {\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\": 2663.843071551573,\n \"key_1\": 6586.641674086715,\n \"key_2\": 6957,\n \"key_3\": 9886.728767555403,\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": 9007,\n \"key_7\": false,\n \"key_8\": 6960,\n \"key_9\": 8886.734702933276,\n \"key_10\": false,\n \"key_11\": false,\n \"key_12\": 2263,\n \"key_13\": 1383,\n \"key_14\": \"string\",\n \"key_15\": false,\n \"key_16\": \"string\",\n \"key_17\": 6955,\n \"key_18\": 2664.7239724724805,\n \"key_19\": 1237.3980667010965,\n \"key_20\": \"string\",\n \"key_21\": false,\n \"key_22\": 3575,\n \"key_23\": 4215,\n \"key_24\": 3426,\n \"key_25\": \"string\",\n \"key_26\": \"string\",\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": true,\n \"key_30\": 5476.104555133399,\n \"key_31\": false,\n \"key_32\": 4992.068633140323,\n \"key_33\": false,\n \"key_34\": true,\n \"key_35\": 5914,\n \"key_36\": 8495,\n \"key_37\": false,\n \"key_38\": 8912.004634300869,\n \"key_39\": 1338,\n \"key_40\": \"string\"\n },\n \"service_account_id\": \"\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "74920e04-db1d-411c-8ddb-13475670c011", - "name": "Authentication failed or missing required scope.", - "originalRequest": { - "url": { - "path": [ - "v0.1", - "merchants", - ":merchant_code", - "readers" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Maximum number of members to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Indicates to skip count query.", + "type": "text/plain" + }, + "key": "scroll", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned members by email address prefix.", + "type": "text/plain" + }, + "key": "email", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Search for a member by user id.", + "type": "text/plain" + }, + "key": "user.id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned members by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", + "type": "text/plain" + }, + "key": "status", + "value": "unknown" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned members by role.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + } + ], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "merchant_code" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "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\": \"accepted\",\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\": true,\n \"key_1\": true,\n \"key_2\": \"string\",\n \"key_3\": 8883,\n \"key_4\": \"string\",\n \"key_5\": 1876.3034873459917,\n \"key_6\": \"string\",\n \"key_7\": true,\n \"key_8\": true,\n \"key_9\": 5415,\n \"key_10\": 3458,\n \"key_11\": 1893.4129652611787,\n \"key_12\": 6422.649047146736,\n \"key_13\": true,\n \"key_14\": 3737.3354889219577,\n \"key_15\": \"string\",\n \"key_16\": true,\n \"key_17\": 2700.000677439327,\n \"key_18\": false,\n \"key_19\": 2127,\n \"key_20\": 8131,\n \"key_21\": 333,\n \"key_22\": \"string\",\n \"key_23\": \"string\",\n \"key_24\": true,\n \"key_25\": 4509.27519537955,\n \"key_26\": 5928.492829444529,\n \"key_27\": false,\n \"key_28\": 7792,\n \"key_29\": 4945,\n \"key_30\": 6727\n },\n \"attributes\": {\n \"key_0\": 2119\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\": \"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\": 8214,\n \"key_2\": 3512.4943581264056,\n \"key_3\": \"string\",\n \"key_4\": 1007.0099022849078,\n \"key_5\": 9212.332032525132,\n \"key_6\": 5192,\n \"key_7\": true,\n \"key_8\": 2211,\n \"key_9\": \"string\",\n \"key_10\": 3379.9679334185284,\n \"key_11\": 6922,\n \"key_12\": 9927,\n \"key_13\": false,\n \"key_14\": 8551,\n \"key_15\": 4457,\n \"key_16\": 8996,\n \"key_17\": 2835,\n \"key_18\": 8749.07267289681,\n \"key_19\": 1510.9196708152429,\n \"key_20\": 2765,\n \"key_21\": \"string\",\n \"key_22\": 5517,\n \"key_23\": 4512,\n \"key_24\": 90.5378407936297,\n \"key_25\": false,\n \"key_26\": true,\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": \"string\",\n \"key_30\": false,\n \"key_31\": 1378,\n \"key_32\": false,\n \"key_33\": 2931.905721150143,\n \"key_34\": \"string\",\n \"key_35\": \"string\",\n \"key_36\": false,\n \"key_37\": \"string\",\n \"key_38\": 9270.595068436713,\n \"key_39\": \"string\",\n \"key_40\": false,\n \"key_41\": 6428.737230191064\n },\n \"attributes\": {\n \"key_0\": false\n }\n }\n ],\n \"total_count\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11e530aa-f4ab-462b-843a-a28f0af96915", + "name": "Merchant not found.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "members" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset of the first member to return.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Maximum number of members to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Indicates to skip count query.", + "type": "text/plain" + }, + "key": "scroll", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned members by email address prefix.", + "type": "text/plain" + }, + "key": "email", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Search for a member by user id.", + "type": "text/plain" + }, + "key": "user.id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned members by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", + "type": "text/plain" + }, + "key": "status", + "value": "unknown" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned members by role.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + } + ], + "variable": [ { "disabled": false, "description": { @@ -9874,8 +9393,8 @@ "method": "GET", "body": {} }, - "status": "Unauthorized", - "code": 401, + "status": "Not Found", + "code": 404, "header": [ { "key": "Content-Type", @@ -9893,12 +9412,12 @@ } }, { - "id": "2830d998-d1b9-40c2-8283-bdb85535302a", - "name": "Create a Reader", + "id": "3a12dc61-02bd-4635-bc30-4853f9b32ffe", + "name": "Create a member", "request": { - "name": "Create a Reader", + "name": "Create a member", "description": { - "content": "Create a new Reader for the merchant account.", + "content": "Create a merchant member.", "type": "text/plain" }, "url": { @@ -9906,7 +9425,7 @@ "v0.1", "merchants", ":merchant_code", - "readers" + "members" ], "host": [ "{{baseUrl}}" @@ -9938,7 +9457,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 1686,\n \"key_1\": true,\n \"key_2\": true,\n \"key_3\": false,\n \"key_4\": 1978,\n \"key_5\": \"string\",\n \"key_6\": 9921,\n \"key_7\": \"string\",\n \"key_8\": true,\n \"key_9\": true,\n \"key_10\": 3070.270814378078,\n \"key_11\": false,\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": true,\n \"key_15\": 4084,\n \"key_16\": true,\n \"key_17\": 9235.670716001701,\n \"key_18\": 1207.336359428175,\n \"key_19\": \"string\",\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": true,\n \"key_23\": 2267,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": 1079,\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": \"string\"\n }\n}", + "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": 8141,\n \"key_1\": true,\n \"key_2\": 3079,\n \"key_3\": 6486.804791460851,\n \"key_4\": 2308,\n \"key_5\": true,\n \"key_6\": true\n },\n \"attributes\": {\n \"key_0\": 263.1904612959479\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -9958,15 +9477,15 @@ }, "response": [ { - "id": "626f1dff-85b2-4958-84c9-43ba3c8a3a7a", - "name": "Returns the Reader object if the creation succeeded.", + "id": "f2bc9fb2-2f63-4f54-b965-7888e3668f12", + "name": "Returns the Member object if the creation succeeded.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers" + "members" ], "host": [ "{{baseUrl}}" @@ -9998,7 +9517,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 1686,\n \"key_1\": true,\n \"key_2\": true,\n \"key_3\": false,\n \"key_4\": 1978,\n \"key_5\": \"string\",\n \"key_6\": 9921,\n \"key_7\": \"string\",\n \"key_8\": true,\n \"key_9\": true,\n \"key_10\": 3070.270814378078,\n \"key_11\": false,\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": true,\n \"key_15\": 4084,\n \"key_16\": true,\n \"key_17\": 9235.670716001701,\n \"key_18\": 1207.336359428175,\n \"key_19\": \"string\",\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": true,\n \"key_23\": 2267,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": 1079,\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": \"string\"\n }\n}", + "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": 8141,\n \"key_1\": true,\n \"key_2\": 3079,\n \"key_3\": 6486.804791460851,\n \"key_4\": 2308,\n \"key_5\": true,\n \"key_6\": true\n },\n \"attributes\": {\n \"key_0\": 263.1904612959479\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10015,20 +9534,20 @@ "value": "application/json" } ], - "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\": false,\n \"key_1\": false,\n \"key_2\": 4523.04952293483,\n \"key_3\": 3437.5227261847563,\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": false,\n \"key_7\": \"string\",\n \"key_8\": false,\n \"key_9\": 7511.8366154256555,\n \"key_10\": false,\n \"key_11\": 4102,\n \"key_12\": 903,\n \"key_13\": 7409.5045877781595,\n \"key_14\": \"string\",\n \"key_15\": 141,\n \"key_16\": 5526,\n \"key_17\": 37,\n \"key_18\": 3693.538310666171,\n \"key_19\": \"string\",\n \"key_20\": \"string\",\n \"key_21\": 823,\n \"key_22\": 4291.543547228798,\n \"key_23\": 9844.403371124123,\n \"key_24\": 1984.5180580020449,\n \"key_25\": \"string\",\n \"key_26\": true,\n \"key_27\": true,\n \"key_28\": \"string\",\n \"key_29\": \"string\",\n \"key_30\": 6780.238023570304,\n \"key_31\": false,\n \"key_32\": 9150,\n \"key_33\": \"string\",\n \"key_34\": 1945,\n \"key_35\": \"string\",\n \"key_36\": \"string\",\n \"key_37\": \"string\",\n \"key_38\": 5548.452356897711,\n \"key_39\": \"string\"\n },\n \"service_account_id\": \"\"\n}", + "body": "{\n \"id\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"disabled\",\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\": 1053.4445210087617,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 3573.3092906321585,\n \"key_4\": 8207,\n \"key_5\": true,\n \"key_6\": \"string\",\n \"key_7\": 2742,\n \"key_8\": 3638,\n \"key_9\": false,\n \"key_10\": true,\n \"key_11\": true,\n \"key_12\": true\n },\n \"attributes\": {\n \"key_0\": 9318.366150051253,\n \"key_1\": 4964.13695068287\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "43adef10-16e9-41db-9454-3c798a9242e7", - "name": "The request is invalid.", + "id": "cfb8a90d-10e8-4e42-aa05-c87f5a9a41c9", + "name": "Invalid request.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers" + "members" ], "host": [ "{{baseUrl}}" @@ -10060,7 +9579,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 1686,\n \"key_1\": true,\n \"key_2\": true,\n \"key_3\": false,\n \"key_4\": 1978,\n \"key_5\": \"string\",\n \"key_6\": 9921,\n \"key_7\": \"string\",\n \"key_8\": true,\n \"key_9\": true,\n \"key_10\": 3070.270814378078,\n \"key_11\": false,\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": true,\n \"key_15\": 4084,\n \"key_16\": true,\n \"key_17\": 9235.670716001701,\n \"key_18\": 1207.336359428175,\n \"key_19\": \"string\",\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": true,\n \"key_23\": 2267,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": 1079,\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": \"string\"\n }\n}", + "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": 8141,\n \"key_1\": true,\n \"key_2\": 3079,\n \"key_3\": 6486.804791460851,\n \"key_4\": 2308,\n \"key_5\": true,\n \"key_6\": true\n },\n \"attributes\": {\n \"key_0\": 263.1904612959479\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10082,15 +9601,15 @@ "_postman_previewlanguage": "json" }, { - "id": "567de7c2-59f3-4df0-9817-88ab65a61fe5", - "name": "There's no pending reader for the submitted pairing code.", + "id": "d64ef89a-ade0-405e-814f-5793f0f132b0", + "name": "Merchant not found.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers" + "members" ], "host": [ "{{baseUrl}}" @@ -10122,7 +9641,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 1686,\n \"key_1\": true,\n \"key_2\": true,\n \"key_3\": false,\n \"key_4\": 1978,\n \"key_5\": \"string\",\n \"key_6\": 9921,\n \"key_7\": \"string\",\n \"key_8\": true,\n \"key_9\": true,\n \"key_10\": 3070.270814378078,\n \"key_11\": false,\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": true,\n \"key_15\": 4084,\n \"key_16\": true,\n \"key_17\": 9235.670716001701,\n \"key_18\": 1207.336359428175,\n \"key_19\": \"string\",\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": true,\n \"key_23\": 2267,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": 1079,\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": \"string\"\n }\n}", + "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": 8141,\n \"key_1\": true,\n \"key_2\": 3079,\n \"key_3\": 6486.804791460851,\n \"key_4\": 2308,\n \"key_5\": true,\n \"key_6\": true\n },\n \"attributes\": {\n \"key_0\": 263.1904612959479\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10144,15 +9663,15 @@ "_postman_previewlanguage": "json" }, { - "id": "44c28072-e036-4f17-aafc-060b798f3e75", - "name": "The Reader is not in a pending state.", + "id": "f091bca8-0e48-404f-a85e-19884520e452", + "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": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers" + "members" ], "host": [ "{{baseUrl}}" @@ -10184,7 +9703,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"pairing_code\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": 1686,\n \"key_1\": true,\n \"key_2\": true,\n \"key_3\": false,\n \"key_4\": 1978,\n \"key_5\": \"string\",\n \"key_6\": 9921,\n \"key_7\": \"string\",\n \"key_8\": true,\n \"key_9\": true,\n \"key_10\": 3070.270814378078,\n \"key_11\": false,\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": true,\n \"key_15\": 4084,\n \"key_16\": true,\n \"key_17\": 9235.670716001701,\n \"key_18\": 1207.336359428175,\n \"key_19\": \"string\",\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": true,\n \"key_23\": 2267,\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": 1079,\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": \"string\"\n }\n}", + "raw": "{\n \"email\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"is_managed_user\": \"\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"metadata\": {\n \"key_0\": 8141,\n \"key_1\": true,\n \"key_2\": 3079,\n \"key_3\": 6486.804791460851,\n \"key_4\": 2308,\n \"key_5\": true,\n \"key_6\": true\n },\n \"attributes\": {\n \"key_0\": 263.1904612959479\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -10193,8 +9712,8 @@ } } }, - "status": "Conflict", - "code": 409, + "status": "Too Many Requests", + "code": 429, "header": [ { "key": "Content-Type", @@ -10212,12 +9731,12 @@ } }, { - "id": "db27ac51-633c-433f-b38d-5aace9e0151c", - "name": "Retrieve a Reader", + "id": "5ecec3b8-72b8-4bb9-85f2-4d1b935ad0bb", + "name": "Retrieve a member", "request": { - "name": "Retrieve a Reader", + "name": "Retrieve a member", "description": { - "content": "Retrieve a Reader.", + "content": "Retrieve a merchant member.", "type": "text/plain" }, "url": { @@ -10225,8 +9744,8 @@ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id" + "members", + ":member_id" ], "host": [ "{{baseUrl}}" @@ -10246,25 +9765,16 @@ { "type": "any", "value": "", - "key": "reader_id", + "key": "member_id", "disabled": false, "description": { - "content": "(Required) The unique identifier of the reader.", + "content": "(Required) The ID of the member to retrieve.", "type": "text/plain" } } ] }, "header": [ - { - "disabled": false, - "description": { - "content": "Return the reader only if it has been modified after the specified timestamp given in the headers.\n\nTimestamps are accepted in the following formats:\n\n - HTTP Standard: [IMF format (RFC 5322)](https://www.rfc-editor.org/rfc/rfc5322#section-3.3), sometimes also referred to as [RFC 7231](https://www.rfc-editor.org/rfc/rfc7231#section-7.1.1.1).\n - RFC 3339: Used for timestamps in JSON payloads on this API.", - "type": "text/plain" - }, - "key": "If-Modified-Since", - "value": "" - }, { "key": "Accept", "value": "application/json" @@ -10284,16 +9794,16 @@ }, "response": [ { - "id": "e0ea722b-7232-4019-ab82-e244bda61634", - "name": "Returns a Reader object for a valid identifier.", + "id": "dadafced-72e0-4da0-8410-e1600b6217ca", + "name": "Returns the Member object for a valid identifier.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id" + "members", + ":member_id" ], "host": [ "{{baseUrl}}" @@ -10303,104 +9813,1302 @@ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The ID of the member to retrieve.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "member_id" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"disabled\",\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\": 1053.4445210087617,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 3573.3092906321585,\n \"key_4\": 8207,\n \"key_5\": true,\n \"key_6\": \"string\",\n \"key_7\": 2742,\n \"key_8\": 3638,\n \"key_9\": false,\n \"key_10\": true,\n \"key_11\": true,\n \"key_12\": true\n },\n \"attributes\": {\n \"key_0\": 9318.366150051253,\n \"key_1\": 4964.13695068287\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "62a4b6c9-7ef8-4fc6-b732-7e7309edf75f", + "name": "Merchant or member not found.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "members", + ":member_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The ID of the member to retrieve.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "member_id" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/problem+json" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "1b2abecb-1919-4031-8078-41d5aacefd9c", + "name": "Update a member", + "request": { + "name": "Update a member", + "description": { + "content": "Update the merchant member.", + "type": "text/plain" + }, + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "members", + ":member_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "merchant_code", + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "member_id", + "disabled": false, + "description": { + "content": "(Required) The ID of the member to retrieve.", + "type": "text/plain" + } + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 8768,\n \"key_1\": 3052,\n \"key_2\": true,\n \"key_3\": 5904.047843079216,\n \"key_4\": 6992,\n \"key_5\": 5997,\n \"key_6\": 9757,\n \"key_7\": 8939,\n \"key_8\": true,\n \"key_9\": 7443.804309393505,\n \"key_10\": \"string\",\n \"key_11\": false,\n \"key_12\": true,\n \"key_13\": false,\n \"key_14\": \"string\",\n \"key_15\": 7136.2464746131145,\n \"key_16\": 8732.289631214393,\n \"key_17\": 7619,\n \"key_18\": 6987,\n \"key_19\": true,\n \"key_20\": \"string\",\n \"key_21\": 1090,\n \"key_22\": 1331.7661156763315,\n \"key_23\": 6769.162543030749,\n \"key_24\": 2092.4055624677208,\n \"key_25\": \"string\",\n \"key_26\": false,\n \"key_27\": \"string\",\n \"key_28\": 710.5854115263099,\n \"key_29\": 5365.366702940697,\n \"key_30\": 1034,\n \"key_31\": \"string\",\n \"key_32\": true,\n \"key_33\": true,\n \"key_34\": 9076.596390226874,\n \"key_35\": 5547.385496094488,\n \"key_36\": 3918.794301923041,\n \"key_37\": 1991,\n \"key_38\": 5931,\n \"key_39\": 8592.769553430915,\n \"key_40\": \"string\",\n \"key_41\": true,\n \"key_42\": \"string\",\n \"key_43\": 2439.0134653339746,\n \"key_44\": \"string\",\n \"key_45\": true,\n \"key_46\": \"string\",\n \"key_47\": 8875,\n \"key_48\": true,\n \"key_49\": true,\n \"key_50\": false,\n \"key_51\": 2107\n },\n \"attributes\": {\n \"key_0\": 813.5625921088784\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}" + } + ] + } + }, + "response": [ + { + "id": "800dfb27-adf3-4d62-b77f-5feefb1c4281", + "name": "Returns the updated Member object if the update succeeded.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "members", + ":member_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The ID of the member to retrieve.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "member_id" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 8768,\n \"key_1\": 3052,\n \"key_2\": true,\n \"key_3\": 5904.047843079216,\n \"key_4\": 6992,\n \"key_5\": 5997,\n \"key_6\": 9757,\n \"key_7\": 8939,\n \"key_8\": true,\n \"key_9\": 7443.804309393505,\n \"key_10\": \"string\",\n \"key_11\": false,\n \"key_12\": true,\n \"key_13\": false,\n \"key_14\": \"string\",\n \"key_15\": 7136.2464746131145,\n \"key_16\": 8732.289631214393,\n \"key_17\": 7619,\n \"key_18\": 6987,\n \"key_19\": true,\n \"key_20\": \"string\",\n \"key_21\": 1090,\n \"key_22\": 1331.7661156763315,\n \"key_23\": 6769.162543030749,\n \"key_24\": 2092.4055624677208,\n \"key_25\": \"string\",\n \"key_26\": false,\n \"key_27\": \"string\",\n \"key_28\": 710.5854115263099,\n \"key_29\": 5365.366702940697,\n \"key_30\": 1034,\n \"key_31\": \"string\",\n \"key_32\": true,\n \"key_33\": true,\n \"key_34\": 9076.596390226874,\n \"key_35\": 5547.385496094488,\n \"key_36\": 3918.794301923041,\n \"key_37\": 1991,\n \"key_38\": 5931,\n \"key_39\": 8592.769553430915,\n \"key_40\": \"string\",\n \"key_41\": true,\n \"key_42\": \"string\",\n \"key_43\": 2439.0134653339746,\n \"key_44\": \"string\",\n \"key_45\": true,\n \"key_46\": \"string\",\n \"key_47\": 8875,\n \"key_48\": true,\n \"key_49\": true,\n \"key_50\": false,\n \"key_51\": 2107\n },\n \"attributes\": {\n \"key_0\": 813.5625921088784\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"disabled\",\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\": 1053.4445210087617,\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 3573.3092906321585,\n \"key_4\": 8207,\n \"key_5\": true,\n \"key_6\": \"string\",\n \"key_7\": 2742,\n \"key_8\": 3638,\n \"key_9\": false,\n \"key_10\": true,\n \"key_11\": true,\n \"key_12\": true\n },\n \"attributes\": {\n \"key_0\": 9318.366150051253,\n \"key_1\": 4964.13695068287\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f06fc051-542e-4f99-bb36-50b50ee09e2d", + "name": "Cannot set password or nickname for an invited user.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "members", + ":member_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The ID of the member to retrieve.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "member_id" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/problem+json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 8768,\n \"key_1\": 3052,\n \"key_2\": true,\n \"key_3\": 5904.047843079216,\n \"key_4\": 6992,\n \"key_5\": 5997,\n \"key_6\": 9757,\n \"key_7\": 8939,\n \"key_8\": true,\n \"key_9\": 7443.804309393505,\n \"key_10\": \"string\",\n \"key_11\": false,\n \"key_12\": true,\n \"key_13\": false,\n \"key_14\": \"string\",\n \"key_15\": 7136.2464746131145,\n \"key_16\": 8732.289631214393,\n \"key_17\": 7619,\n \"key_18\": 6987,\n \"key_19\": true,\n \"key_20\": \"string\",\n \"key_21\": 1090,\n \"key_22\": 1331.7661156763315,\n \"key_23\": 6769.162543030749,\n \"key_24\": 2092.4055624677208,\n \"key_25\": \"string\",\n \"key_26\": false,\n \"key_27\": \"string\",\n \"key_28\": 710.5854115263099,\n \"key_29\": 5365.366702940697,\n \"key_30\": 1034,\n \"key_31\": \"string\",\n \"key_32\": true,\n \"key_33\": true,\n \"key_34\": 9076.596390226874,\n \"key_35\": 5547.385496094488,\n \"key_36\": 3918.794301923041,\n \"key_37\": 1991,\n \"key_38\": 5931,\n \"key_39\": 8592.769553430915,\n \"key_40\": \"string\",\n \"key_41\": true,\n \"key_42\": \"string\",\n \"key_43\": 2439.0134653339746,\n \"key_44\": \"string\",\n \"key_45\": true,\n \"key_46\": \"string\",\n \"key_47\": 8875,\n \"key_48\": true,\n \"key_49\": true,\n \"key_50\": false,\n \"key_51\": 2107\n },\n \"attributes\": {\n \"key_0\": 813.5625921088784\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "20bec28c-b2b4-4171-b812-f93ab9b95de9", + "name": "Cannot change password for managed user. Password was already used before.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "members", + ":member_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The ID of the member to retrieve.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "member_id" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/problem+json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 8768,\n \"key_1\": 3052,\n \"key_2\": true,\n \"key_3\": 5904.047843079216,\n \"key_4\": 6992,\n \"key_5\": 5997,\n \"key_6\": 9757,\n \"key_7\": 8939,\n \"key_8\": true,\n \"key_9\": 7443.804309393505,\n \"key_10\": \"string\",\n \"key_11\": false,\n \"key_12\": true,\n \"key_13\": false,\n \"key_14\": \"string\",\n \"key_15\": 7136.2464746131145,\n \"key_16\": 8732.289631214393,\n \"key_17\": 7619,\n \"key_18\": 6987,\n \"key_19\": true,\n \"key_20\": \"string\",\n \"key_21\": 1090,\n \"key_22\": 1331.7661156763315,\n \"key_23\": 6769.162543030749,\n \"key_24\": 2092.4055624677208,\n \"key_25\": \"string\",\n \"key_26\": false,\n \"key_27\": \"string\",\n \"key_28\": 710.5854115263099,\n \"key_29\": 5365.366702940697,\n \"key_30\": 1034,\n \"key_31\": \"string\",\n \"key_32\": true,\n \"key_33\": true,\n \"key_34\": 9076.596390226874,\n \"key_35\": 5547.385496094488,\n \"key_36\": 3918.794301923041,\n \"key_37\": 1991,\n \"key_38\": 5931,\n \"key_39\": 8592.769553430915,\n \"key_40\": \"string\",\n \"key_41\": true,\n \"key_42\": \"string\",\n \"key_43\": 2439.0134653339746,\n \"key_44\": \"string\",\n \"key_45\": true,\n \"key_46\": \"string\",\n \"key_47\": 8875,\n \"key_48\": true,\n \"key_49\": true,\n \"key_50\": false,\n \"key_51\": 2107\n },\n \"attributes\": {\n \"key_0\": 813.5625921088784\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "31fc5a68-4e8b-4fb7-b127-53550115df05", + "name": "Merchant or member not found.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "members", + ":member_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The ID of the member to retrieve.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "member_id" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/problem+json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 8768,\n \"key_1\": 3052,\n \"key_2\": true,\n \"key_3\": 5904.047843079216,\n \"key_4\": 6992,\n \"key_5\": 5997,\n \"key_6\": 9757,\n \"key_7\": 8939,\n \"key_8\": true,\n \"key_9\": 7443.804309393505,\n \"key_10\": \"string\",\n \"key_11\": false,\n \"key_12\": true,\n \"key_13\": false,\n \"key_14\": \"string\",\n \"key_15\": 7136.2464746131145,\n \"key_16\": 8732.289631214393,\n \"key_17\": 7619,\n \"key_18\": 6987,\n \"key_19\": true,\n \"key_20\": \"string\",\n \"key_21\": 1090,\n \"key_22\": 1331.7661156763315,\n \"key_23\": 6769.162543030749,\n \"key_24\": 2092.4055624677208,\n \"key_25\": \"string\",\n \"key_26\": false,\n \"key_27\": \"string\",\n \"key_28\": 710.5854115263099,\n \"key_29\": 5365.366702940697,\n \"key_30\": 1034,\n \"key_31\": \"string\",\n \"key_32\": true,\n \"key_33\": true,\n \"key_34\": 9076.596390226874,\n \"key_35\": 5547.385496094488,\n \"key_36\": 3918.794301923041,\n \"key_37\": 1991,\n \"key_38\": 5931,\n \"key_39\": 8592.769553430915,\n \"key_40\": \"string\",\n \"key_41\": true,\n \"key_42\": \"string\",\n \"key_43\": 2439.0134653339746,\n \"key_44\": \"string\",\n \"key_45\": true,\n \"key_46\": \"string\",\n \"key_47\": 8875,\n \"key_48\": true,\n \"key_49\": true,\n \"key_50\": false,\n \"key_51\": 2107\n },\n \"attributes\": {\n \"key_0\": 813.5625921088784\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "20ce6d9f-6f8b-4bd0-a8db-c27b329886a0", + "name": "Cannot update member as some data conflict with existing members.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "members", + ":member_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The ID of the member to retrieve.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "member_id" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/problem+json" + } + ], + "method": "PUT", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 8768,\n \"key_1\": 3052,\n \"key_2\": true,\n \"key_3\": 5904.047843079216,\n \"key_4\": 6992,\n \"key_5\": 5997,\n \"key_6\": 9757,\n \"key_7\": 8939,\n \"key_8\": true,\n \"key_9\": 7443.804309393505,\n \"key_10\": \"string\",\n \"key_11\": false,\n \"key_12\": true,\n \"key_13\": false,\n \"key_14\": \"string\",\n \"key_15\": 7136.2464746131145,\n \"key_16\": 8732.289631214393,\n \"key_17\": 7619,\n \"key_18\": 6987,\n \"key_19\": true,\n \"key_20\": \"string\",\n \"key_21\": 1090,\n \"key_22\": 1331.7661156763315,\n \"key_23\": 6769.162543030749,\n \"key_24\": 2092.4055624677208,\n \"key_25\": \"string\",\n \"key_26\": false,\n \"key_27\": \"string\",\n \"key_28\": 710.5854115263099,\n \"key_29\": 5365.366702940697,\n \"key_30\": 1034,\n \"key_31\": \"string\",\n \"key_32\": true,\n \"key_33\": true,\n \"key_34\": 9076.596390226874,\n \"key_35\": 5547.385496094488,\n \"key_36\": 3918.794301923041,\n \"key_37\": 1991,\n \"key_38\": 5931,\n \"key_39\": 8592.769553430915,\n \"key_40\": \"string\",\n \"key_41\": true,\n \"key_42\": \"string\",\n \"key_43\": 2439.0134653339746,\n \"key_44\": \"string\",\n \"key_45\": true,\n \"key_46\": \"string\",\n \"key_47\": 8875,\n \"key_48\": true,\n \"key_49\": true,\n \"key_50\": false,\n \"key_51\": 2107\n },\n \"attributes\": {\n \"key_0\": 813.5625921088784\n },\n \"user\": {\n \"nickname\": \"\",\n \"password\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Conflict", + "code": 409, + "header": [ + { + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "46a09565-e4de-4c75-9699-497e360bcfba", + "name": "Delete a member", + "request": { + "name": "Delete a member", + "description": { + "content": "Deletes a merchant member.", + "type": "text/plain" + }, + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "members", + ":member_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "merchant_code", + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "member_id", + "disabled": false, + "description": { + "content": "(Required) The ID of the member to retrieve.", + "type": "text/plain" + } + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/problem+json" + } + ], + "method": "DELETE", + "body": {}, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}" + } + ] + } + }, + "response": [ + { + "id": "ad350acd-7d7a-4a21-8138-392d99245dae", + "name": "Returns an empty response if the deletion succeeded.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "members", + ":member_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The ID of the member to retrieve.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "member_id" + } + ] + }, + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "c86031ca-a08c-417d-9ee6-4367031fe0aa", + "name": "Member deletion was forbidden.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "members", + ":member_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The ID of the member to retrieve.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "member_id" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/problem+json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "606d8575-8302-4a85-9665-5e26326343d4", + "name": "Merchant or member not found.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "members", + ":member_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The ID of the member to retrieve.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "member_id" + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/problem+json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "Memberships", + "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": "cd5f8e13-db96-41d1-aad8-114bb466985d", + "name": "List memberships", + "request": { + "name": "List memberships", + "description": { + "content": "List memberships of the current user.", + "type": "text/plain" + }, + "url": { + "path": [ + "v0.1", + "memberships" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset of the first member to return.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Maximum number of members to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by resource kind.", + "type": "text/plain" + }, + "key": "kind", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned memberships by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", + "type": "text/plain" + }, + "key": "status", + "value": "unknown" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by resource kind.", + "type": "text/plain" + }, + "key": "resource.type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the sandbox status of the resource the membership is in.", + "type": "text/plain" + }, + "key": "resource.attributes.sandbox", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the name of the resource the membership is in.", + "type": "text/plain" + }, + "key": "resource.name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", + "type": "text/plain" + }, + "key": "resource.parent.id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", + "type": "text/plain" + }, + "key": "resource.parent.type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned memberships by role.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned memberships by role.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}" + } + ] + } + }, + "response": [ + { + "id": "ed6e2ce8-e255-4c25-ba11-a141356e67e0", + "name": "Returns a list of Membership objects.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "memberships" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset of the first member to return.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Maximum number of members to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by resource kind.", + "type": "text/plain" + }, + "key": "kind", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned memberships by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", + "type": "text/plain" + }, + "key": "status", + "value": "unknown" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by resource kind.", + "type": "text/plain" + }, + "key": "resource.type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the sandbox status of the resource the membership is in.", + "type": "text/plain" + }, + "key": "resource.attributes.sandbox", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the name of the resource the membership is in.", + "type": "text/plain" + }, + "key": "resource.name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", + "type": "text/plain" + }, + "key": "resource.parent.id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", + "type": "text/plain" + }, + "key": "resource.parent.type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned memberships by role.", + "type": "text/plain" + }, + "key": "roles", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "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\": 8947,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": 3887.12423090811,\n \"key_2\": 1733,\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": 8911,\n \"key_6\": 3083.858097805463,\n \"key_7\": \"string\",\n \"key_8\": 3658,\n \"key_9\": 2358.581325330087,\n \"key_10\": 9417.149022848891,\n \"key_11\": 2624.084777628024,\n \"key_12\": \"string\",\n \"key_13\": 3245,\n \"key_14\": false,\n \"key_15\": 173.73491578859256,\n \"key_16\": \"string\",\n \"key_17\": false,\n \"key_18\": \"string\",\n \"key_19\": 8316,\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": 7574.6033530112045,\n \"key_23\": \"string\",\n \"key_24\": \"string\",\n \"key_25\": 3667,\n \"key_26\": 3541,\n \"key_27\": 9219.776066901177,\n \"key_28\": 5776.584285235073,\n \"key_29\": true,\n \"key_30\": 6238.545139287395,\n \"key_31\": \"string\",\n \"key_32\": 6776,\n \"key_33\": false,\n \"key_34\": \"string\",\n \"key_35\": 2876\n },\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": \"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\": 9048,\n \"key_1\": \"string\",\n \"key_2\": 1.9311293808654817\n }\n },\n \"invite\": {\n \"email\": \"\",\n \"expires_at\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true,\n \"key_3\": 3833,\n \"key_4\": true,\n \"key_5\": false,\n \"key_6\": 7599,\n \"key_7\": \"string\",\n \"key_8\": 5371,\n \"key_9\": \"string\",\n \"key_10\": true,\n \"key_11\": 7764.582741869092,\n \"key_12\": \"string\",\n \"key_13\": true,\n \"key_14\": 9194.56168903676,\n \"key_15\": \"string\",\n \"key_16\": 5194.85470607459,\n \"key_17\": \"string\",\n \"key_18\": true,\n \"key_19\": 758,\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": true,\n \"key_23\": 1321.9945651735966,\n \"key_24\": \"string\",\n \"key_25\": true,\n \"key_26\": \"string\",\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": \"string\",\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": 1922,\n \"key_33\": true,\n \"key_34\": \"string\",\n \"key_35\": false,\n \"key_36\": 5333,\n \"key_37\": true,\n \"key_38\": 8142.433264717106,\n \"key_39\": 3738.054211712929,\n \"key_40\": false,\n \"key_41\": \"string\",\n \"key_42\": 8051,\n \"key_43\": false,\n \"key_44\": 7537,\n \"key_45\": 1041.9790578053178,\n \"key_46\": 7084.430584562764,\n \"key_47\": \"string\",\n \"key_48\": 943.8071616245547,\n \"key_49\": false,\n \"key_50\": \"string\",\n \"key_51\": 3359,\n \"key_52\": true,\n \"key_53\": 879.6280096101317,\n \"key_54\": true,\n \"key_55\": true\n },\n \"attributes\": {\n \"key_0\": false\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d682606-f5ea-4fe6-b02d-70148b3104ef", + "name": "Invalid query parameter combination.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "memberships" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Offset of the first member to return.", + "type": "text/plain" + }, + "key": "offset", + "value": "0" + }, + { + "disabled": false, + "description": { + "content": "Maximum number of members to return.", + "type": "text/plain" + }, + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by resource kind.", + "type": "text/plain" + }, + "key": "kind", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned memberships by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", + "type": "text/plain" + }, + "key": "status", + "value": "unknown" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by resource kind.", + "type": "text/plain" + }, + "key": "resource.type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the sandbox status of the resource the membership is in.", "type": "text/plain" }, - "type": "any", - "value": "", - "key": "merchant_code" + "key": "resource.attributes.sandbox", + "value": "" }, { "disabled": false, "description": { - "content": "(Required) The unique identifier of the reader.", + "content": "Filter memberships by the name of the resource the membership is in.", "type": "text/plain" }, - "type": "any", - "value": "", - "key": "reader_id" + "key": "resource.name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", + "type": "text/plain" + }, + "key": "resource.parent.id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", + "type": "text/plain" + }, + "key": "resource.parent.type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned memberships by role.", + "type": "text/plain" + }, + "key": "roles", + "value": "" } - ] + ], + "variable": [] }, "header": [ - { - "disabled": false, - "description": { - "content": "Return the reader only if it has been modified after the specified timestamp given in the headers.\n\nTimestamps are accepted in the following formats:\n\n - HTTP Standard: [IMF format (RFC 5322)](https://www.rfc-editor.org/rfc/rfc5322#section-3.3), sometimes also referred to as [RFC 7231](https://www.rfc-editor.org/rfc/rfc7231#section-7.1.1.1).\n - RFC 3339: Used for timestamps in JSON payloads on this API.", - "type": "text/plain" - }, - "key": "If-Modified-Since", - "value": "" - }, { "key": "Accept", - "value": "application/json" + "value": "application/problem+json" } ], "method": "GET", "body": {} }, - "status": "OK", - "code": 200, + "status": "Bad Request", + "code": 400, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "application/problem+json" } ], - "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\": false,\n \"key_1\": false,\n \"key_2\": 4523.04952293483,\n \"key_3\": 3437.5227261847563,\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": false,\n \"key_7\": \"string\",\n \"key_8\": false,\n \"key_9\": 7511.8366154256555,\n \"key_10\": false,\n \"key_11\": 4102,\n \"key_12\": 903,\n \"key_13\": 7409.5045877781595,\n \"key_14\": \"string\",\n \"key_15\": 141,\n \"key_16\": 5526,\n \"key_17\": 37,\n \"key_18\": 3693.538310666171,\n \"key_19\": \"string\",\n \"key_20\": \"string\",\n \"key_21\": 823,\n \"key_22\": 4291.543547228798,\n \"key_23\": 9844.403371124123,\n \"key_24\": 1984.5180580020449,\n \"key_25\": \"string\",\n \"key_26\": true,\n \"key_27\": true,\n \"key_28\": \"string\",\n \"key_29\": \"string\",\n \"key_30\": 6780.238023570304,\n \"key_31\": false,\n \"key_32\": 9150,\n \"key_33\": \"string\",\n \"key_34\": 1945,\n \"key_35\": \"string\",\n \"key_36\": \"string\",\n \"key_37\": \"string\",\n \"key_38\": 5548.452356897711,\n \"key_39\": \"string\"\n },\n \"service_account_id\": \"\"\n}", + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "aaef1002-0c71-4605-9bbc-ccc82a639f2f", - "name": "The requested Reader resource does not exist.", + "id": "2ee42d6a-06c0-43cc-bc61-da3959f1817b", + "name": "Authentication failed or missing required scope.", "originalRequest": { "url": { "path": [ "v0.1", - "merchants", - ":merchant_code", - "readers", - ":reader_id" + "memberships" ], "host": [ "{{baseUrl}}" ], - "query": [], - "variable": [ + "query": [ { "disabled": false, "description": { - "content": "(Required) Short unique identifier for the merchant.", + "content": "Offset of the first member to return.", "type": "text/plain" }, - "type": "any", - "value": "", - "key": "merchant_code" + "key": "offset", + "value": "0" }, { "disabled": false, "description": { - "content": "(Required) The unique identifier of the reader.", + "content": "Maximum number of members to return.", "type": "text/plain" }, - "type": "any", - "value": "", - "key": "reader_id" + "key": "limit", + "value": "10" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by resource kind.", + "type": "text/plain" + }, + "key": "kind", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned memberships by the membership status. (This can only be one of accepted,pending,expired,disabled,unknown)", + "type": "text/plain" + }, + "key": "status", + "value": "unknown" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by resource kind.", + "type": "text/plain" + }, + "key": "resource.type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the sandbox status of the resource the membership is in.", + "type": "text/plain" + }, + "key": "resource.attributes.sandbox", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the name of the resource the membership is in.", + "type": "text/plain" + }, + "key": "resource.name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", + "type": "text/plain" + }, + "key": "resource.parent.id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter memberships by the parent of the resource the membership is in.\nWhen filtering by parent both `resource.parent.id` and `resource.parent.type` must be present. Pass explicit null to filter for resources without a parent.", + "type": "text/plain" + }, + "key": "resource.parent.type", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter the returned memberships by role.", + "type": "text/plain" + }, + "key": "roles", + "value": "" } - ] + ], + "variable": [] }, "header": [ - { - "disabled": false, - "description": { - "content": "Return the reader only if it has been modified after the specified timestamp given in the headers.\n\nTimestamps are accepted in the following formats:\n\n - HTTP Standard: [IMF format (RFC 5322)](https://www.rfc-editor.org/rfc/rfc5322#section-3.3), sometimes also referred to as [RFC 7231](https://www.rfc-editor.org/rfc/rfc7231#section-7.1.1.1).\n - RFC 3339: Used for timestamps in JSON payloads on this API.", - "type": "text/plain" - }, - "key": "If-Modified-Since", - "value": "" - }, { "key": "Accept", "value": "application/problem+json" @@ -10409,8 +11117,8 @@ "method": "GET", "body": {} }, - "status": "Not Found", - "code": 404, + "status": "Unauthorized", + "code": 401, "header": [ { "key": "Content-Type", @@ -10426,14 +11134,20 @@ "protocolProfileBehavior": { "disableBodyPruning": true } - }, + } + ] + }, + { + "name": "Roles", + "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": "c6d3aaef-7c42-45c9-aa75-cd04a30c6c6f", - "name": "Delete a reader", + "id": "9a2d286d-3d75-4f26-b9b3-df45ae97bdfc", + "name": "List roles", "request": { - "name": "Delete a reader", + "name": "List roles", "description": { - "content": "Delete a reader.", + "content": "List merchant's custom roles.", "type": "text/plain" }, "url": { @@ -10441,8 +11155,7 @@ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id" + "roles" ], "host": [ "{{baseUrl}}" @@ -10458,26 +11171,16 @@ "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" } - }, - { - "type": "any", - "value": "", - "key": "reader_id", - "disabled": false, - "description": { - "content": "(Required) The unique identifier of the reader.", - "type": "text/plain" - } } ] }, "header": [ { "key": "Accept", - "value": "application/problem+json" + "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "body": {}, "auth": { "type": "bearer", @@ -10491,16 +11194,15 @@ }, "response": [ { - "id": "80f665b1-ca18-4dd4-a6e2-f99a41663d2c", - "name": "Returns an empty response if the deletion succeeded.", + "id": "d22890e1-534c-4a4f-a190-cfde5f0a1488", + "name": "Returns a list of Role objects.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id" + "roles" ], "host": [ "{{baseUrl}}" @@ -10516,39 +11218,40 @@ "type": "any", "value": "", "key": "merchant_code" - }, - { - "disabled": false, - "description": { - "content": "(Required) The unique identifier of the reader.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "reader_id" } ] }, - "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "body": {} }, "status": "OK", "code": 200, - "header": [], + "header": [ + { + "key": "Content-Type", + "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\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 6366,\n \"key_3\": 7387.323653259185,\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": \"string\",\n \"key_7\": \"string\",\n \"key_8\": 2672.8836368715347,\n \"key_9\": \"string\",\n \"key_10\": 3657,\n \"key_11\": 9482.369131215313,\n \"key_12\": 4564.714893687201,\n \"key_13\": true,\n \"key_14\": \"string\",\n \"key_15\": true,\n \"key_16\": \"string\",\n \"key_17\": 2993,\n \"key_18\": \"string\",\n \"key_19\": true,\n \"key_20\": true,\n \"key_21\": false,\n \"key_22\": \"string\",\n \"key_23\": true,\n \"key_24\": \"string\",\n \"key_25\": 4946.140482710985,\n \"key_26\": 1159.090394050908,\n \"key_27\": false,\n \"key_28\": \"string\",\n \"key_29\": 5003,\n \"key_30\": \"string\",\n \"key_31\": 5752,\n \"key_32\": 6510,\n \"key_33\": 462.41037716879373,\n \"key_34\": false,\n \"key_35\": 1034.1812349016166,\n \"key_36\": 2736,\n \"key_37\": \"string\",\n \"key_38\": 8140.7562583822755,\n \"key_39\": 3203,\n \"key_40\": true,\n \"key_41\": 3589,\n \"key_42\": 5267.556485136848,\n \"key_43\": \"string\"\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\": 8461,\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": 9286,\n \"key_4\": \"string\",\n \"key_5\": 8418.822001812654,\n \"key_6\": \"string\",\n \"key_7\": 7576.450373086097,\n \"key_8\": \"string\"\n }\n }\n ]\n}", "cookie": [], - "_postman_previewlanguage": "text" + "_postman_previewlanguage": "json" }, { - "id": "b44e9ace-8c60-4418-99d6-b1a49c79c7c5", - "name": "The requested Reader resource does not exist.", + "id": "d23950dc-7788-47ac-a38f-933424f3ab15", + "name": "Merchant not found.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id" + "roles" ], "host": [ "{{baseUrl}}" @@ -10564,16 +11267,6 @@ "type": "any", "value": "", "key": "merchant_code" - }, - { - "disabled": false, - "description": { - "content": "(Required) The unique identifier of the reader.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "reader_id" } ] }, @@ -10583,7 +11276,7 @@ "value": "application/problem+json" } ], - "method": "DELETE", + "method": "GET", "body": {} }, "status": "Not Found", @@ -10605,12 +11298,12 @@ } }, { - "id": "bfbfb366-477a-4993-a12a-44bbc16a2fe2", - "name": "Update a Reader", + "id": "596af166-686c-400c-8437-14f448c06152", + "name": "Create a role", "request": { - "name": "Update a Reader", + "name": "Create a role", "description": { - "content": "Update a Reader.", + "content": "Create a custom role for the merchant. Roles are defined by the set of permissions that they grant to the members that they are assigned to.", "type": "text/plain" }, "url": { @@ -10618,8 +11311,7 @@ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id" + "roles" ], "host": [ "{{baseUrl}}" @@ -10635,16 +11327,6 @@ "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" } - }, - { - "type": "any", - "value": "", - "key": "reader_id", - "disabled": false, - "description": { - "content": "(Required) The unique identifier of the reader.", - "type": "text/plain" - } } ] }, @@ -10658,10 +11340,10 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": \"string\"\n }\n}", + "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 7400.63018548091,\n \"key_1\": true,\n \"key_2\": 2372,\n \"key_3\": 4759.578629446189,\n \"key_4\": false,\n \"key_5\": 3337.202798553791,\n \"key_6\": 9376.42702216191,\n \"key_7\": true,\n \"key_8\": true,\n \"key_9\": false,\n \"key_10\": false,\n \"key_11\": 3567,\n \"key_12\": false,\n \"key_13\": true,\n \"key_14\": \"string\",\n \"key_15\": 8934,\n \"key_16\": 4662.180634054387,\n \"key_17\": true,\n \"key_18\": \"string\",\n \"key_19\": 2747,\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": 1118\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -10681,16 +11363,15 @@ }, "response": [ { - "id": "f3d0d0d1-9a65-4158-aea8-9804f98b6b50", - "name": "Returns the updated Reader object if the update succeeded.", + "id": "993e4332-047c-45cf-bdf2-0b45644acf78", + "name": "Returns the Role object after successful custom role creation.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id" + "roles" ], "host": [ "{{baseUrl}}" @@ -10706,16 +11387,6 @@ "type": "any", "value": "", "key": "merchant_code" - }, - { - "disabled": false, - "description": { - "content": "(Required) The unique identifier of the reader.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "reader_id" } ] }, @@ -10729,10 +11400,10 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": \"string\"\n }\n}", + "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 7400.63018548091,\n \"key_1\": true,\n \"key_2\": 2372,\n \"key_3\": 4759.578629446189,\n \"key_4\": false,\n \"key_5\": 3337.202798553791,\n \"key_6\": 9376.42702216191,\n \"key_7\": true,\n \"key_8\": true,\n \"key_9\": false,\n \"key_10\": false,\n \"key_11\": 3567,\n \"key_12\": false,\n \"key_13\": true,\n \"key_14\": \"string\",\n \"key_15\": 8934,\n \"key_16\": 4662.180634054387,\n \"key_17\": true,\n \"key_18\": \"string\",\n \"key_19\": 2747,\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": 1118\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -10741,29 +11412,28 @@ } } }, - "status": "OK", - "code": 200, + "status": "Created", + "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], - "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\": false,\n \"key_1\": false,\n \"key_2\": 4523.04952293483,\n \"key_3\": 3437.5227261847563,\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": false,\n \"key_7\": \"string\",\n \"key_8\": false,\n \"key_9\": 7511.8366154256555,\n \"key_10\": false,\n \"key_11\": 4102,\n \"key_12\": 903,\n \"key_13\": 7409.5045877781595,\n \"key_14\": \"string\",\n \"key_15\": 141,\n \"key_16\": 5526,\n \"key_17\": 37,\n \"key_18\": 3693.538310666171,\n \"key_19\": \"string\",\n \"key_20\": \"string\",\n \"key_21\": 823,\n \"key_22\": 4291.543547228798,\n \"key_23\": 9844.403371124123,\n \"key_24\": 1984.5180580020449,\n \"key_25\": \"string\",\n \"key_26\": true,\n \"key_27\": true,\n \"key_28\": \"string\",\n \"key_29\": \"string\",\n \"key_30\": 6780.238023570304,\n \"key_31\": false,\n \"key_32\": 9150,\n \"key_33\": \"string\",\n \"key_34\": 1945,\n \"key_35\": \"string\",\n \"key_36\": \"string\",\n \"key_37\": \"string\",\n \"key_38\": 5548.452356897711,\n \"key_39\": \"string\"\n },\n \"service_account_id\": \"\"\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\": 8437.95370123823,\n \"key_2\": 5001,\n \"key_3\": 3616,\n \"key_4\": 5984.582531933284,\n \"key_5\": 6874.994140514265,\n \"key_6\": 8927.189886510296,\n \"key_7\": 4751.660020627491,\n \"key_8\": 4627.769161620497,\n \"key_9\": 784.679584209953,\n \"key_10\": 165.5635711990011,\n \"key_11\": 4154.956872034377,\n \"key_12\": 8571.652288688294,\n \"key_13\": true,\n \"key_14\": \"string\",\n \"key_15\": \"string\",\n \"key_16\": 856,\n \"key_17\": 2180,\n \"key_18\": 6496.850134489618,\n \"key_19\": false,\n \"key_20\": true,\n \"key_21\": true,\n \"key_22\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "aa8282e7-7622-4649-b449-7d389815b253", - "name": "The request isn't sufficiently authorized to modify the reader.", + "id": "c0faf3b7-f51d-4bfa-93e4-843002cedce7", + "name": "Invalid request.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id" + "roles" ], "host": [ "{{baseUrl}}" @@ -10779,16 +11449,6 @@ "type": "any", "value": "", "key": "merchant_code" - }, - { - "disabled": false, - "description": { - "content": "(Required) The unique identifier of the reader.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "reader_id" } ] }, @@ -10802,10 +11462,10 @@ "value": "application/problem+json" } ], - "method": "PATCH", + "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": \"string\"\n }\n}", + "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 7400.63018548091,\n \"key_1\": true,\n \"key_2\": 2372,\n \"key_3\": 4759.578629446189,\n \"key_4\": false,\n \"key_5\": 3337.202798553791,\n \"key_6\": 9376.42702216191,\n \"key_7\": true,\n \"key_8\": true,\n \"key_9\": false,\n \"key_10\": false,\n \"key_11\": 3567,\n \"key_12\": false,\n \"key_13\": true,\n \"key_14\": \"string\",\n \"key_15\": 8934,\n \"key_16\": 4662.180634054387,\n \"key_17\": true,\n \"key_18\": \"string\",\n \"key_19\": 2747,\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": 1118\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -10814,8 +11474,8 @@ } } }, - "status": "Forbidden", - "code": 403, + "status": "Bad Request", + "code": 400, "header": [ { "key": "Content-Type", @@ -10827,16 +11487,15 @@ "_postman_previewlanguage": "json" }, { - "id": "285e710f-adb6-4ce3-8e57-14ffa941ad1c", - "name": "The requested Reader resource does not exist.", + "id": "d734879e-bce7-4a4c-9a4d-2e5018d02a28", + "name": "Merchant not found.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id" + "roles" ], "host": [ "{{baseUrl}}" @@ -10852,16 +11511,6 @@ "type": "any", "value": "", "key": "merchant_code" - }, - { - "disabled": false, - "description": { - "content": "(Required) The unique identifier of the reader.", - "type": "text/plain" - }, - "type": "any", - "value": "", - "key": "reader_id" } ] }, @@ -10875,10 +11524,10 @@ "value": "application/problem+json" } ], - "method": "PATCH", + "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"metadata\": {\n \"key_0\": \"string\"\n }\n}", + "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"key_0\": 7400.63018548091,\n \"key_1\": true,\n \"key_2\": 2372,\n \"key_3\": 4759.578629446189,\n \"key_4\": false,\n \"key_5\": 3337.202798553791,\n \"key_6\": 9376.42702216191,\n \"key_7\": true,\n \"key_8\": true,\n \"key_9\": false,\n \"key_10\": false,\n \"key_11\": 3567,\n \"key_12\": false,\n \"key_13\": true,\n \"key_14\": \"string\",\n \"key_15\": 8934,\n \"key_16\": 4662.180634054387,\n \"key_17\": true,\n \"key_18\": \"string\",\n \"key_19\": 2747,\n \"key_20\": true,\n \"key_21\": \"string\",\n \"key_22\": 1118\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -10906,12 +11555,12 @@ } }, { - "id": "213185e9-2bb4-45c5-bbec-48250e08ff4d", - "name": "Create a Reader Checkout", + "id": "5f00d321-297a-488a-ae55-884a3445f3af", + "name": "Retrieve a role", "request": { - "name": "Create a Reader Checkout", + "name": "Retrieve a role", "description": { - "content": "Creates a Checkout for a Reader.\n\nThis process is asynchronous and the actual transaction may take some time to be started on the device.\n\n\nThere are some caveats when using this endpoint:\n* The target device must be online, otherwise checkout won't be accepted\n* After the checkout is accepted, the system has 60 seconds to start the payment on the target device. During this time, any other checkout for the same device will be rejected.\n\n\n**Note**: If the target device is a Solo, it must be in version 3.3.24.3 or higher.\n", + "content": "Retrieve a custom role by ID.", "type": "text/plain" }, "url": { @@ -10919,9 +11568,8 @@ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "checkout" + "roles", + ":role_id" ], "host": [ "{{baseUrl}}" @@ -10934,43 +11582,30 @@ "key": "merchant_code", "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" } }, { "type": "any", "value": "", - "key": "reader_id", + "key": "role_id", "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) The ID of the role to retrieve.", "type": "text/plain" } } ] }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "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\": 8206,\n \"key_1\": \"string\",\n \"key_2\": true\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", - "language": "json" - } - } - }, + "method": "GET", + "body": {}, "auth": { "type": "bearer", "bearer": [ @@ -10983,17 +11618,16 @@ }, "response": [ { - "id": "efe2fbd0-c586-43f1-94c6-5790056a1317", - "name": "The Checkout got successfully created for the given reader.", + "id": "6bb477c7-a840-457f-aaf9-211fcb5758e9", + "name": "Returns the Role object for a valid identifier.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "checkout" + "roles", + ":role_id" ], "host": [ "{{baseUrl}}" @@ -11003,7 +11637,7 @@ { "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, "type": "any", @@ -11013,61 +11647,47 @@ { "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) The ID of the role to retrieve.", "type": "text/plain" }, "type": "any", "value": "", - "key": "reader_id" + "key": "role_id" } ] }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "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\": 8206,\n \"key_1\": \"string\",\n \"key_2\": true\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", - "language": "json" - } - } - } + "method": "GET", + "body": {} }, - "status": "Created", - "code": 201, + "status": "OK", + "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], - "body": "{\n \"data\": {\n \"client_transaction_id\": \"\"\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\": 8437.95370123823,\n \"key_2\": 5001,\n \"key_3\": 3616,\n \"key_4\": 5984.582531933284,\n \"key_5\": 6874.994140514265,\n \"key_6\": 8927.189886510296,\n \"key_7\": 4751.660020627491,\n \"key_8\": 4627.769161620497,\n \"key_9\": 784.679584209953,\n \"key_10\": 165.5635711990011,\n \"key_11\": 4154.956872034377,\n \"key_12\": 8571.652288688294,\n \"key_13\": true,\n \"key_14\": \"string\",\n \"key_15\": \"string\",\n \"key_16\": 856,\n \"key_17\": 2180,\n \"key_18\": 6496.850134489618,\n \"key_19\": false,\n \"key_20\": true,\n \"key_21\": true,\n \"key_22\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d547f423-f8f0-4147-b9e2-f47b492fcba4", - "name": "Response when given params (or one of them) are invalid", + "id": "da20f0ac-b539-4348-a37e-76b10d69fb35", + "name": "Merchant or role not found.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "checkout" + "roles", + ":role_id" ], "host": [ "{{baseUrl}}" @@ -11077,7 +11697,7 @@ { "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, "type": "any", @@ -11087,61 +11707,116 @@ { "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) The ID of the role to retrieve.", "type": "text/plain" }, "type": "any", "value": "", - "key": "reader_id" + "key": "role_id" } ] }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "application/problem+json" } ], - "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\": 8206,\n \"key_1\": \"string\",\n \"key_2\": true\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", - "language": "json" - } - } - } + "method": "GET", + "body": {} }, - "status": "Bad Request", - "code": 400, + "status": "Not Found", + "code": 404, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "application/problem+json" } ], - "body": "{\n \"errors\": {\n \"type\": \"\",\n \"detail\": \"\"\n }\n}", + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "5c0c5ff7-5286-4531-862d-e1329d5f02c3", + "name": "Delete a role", + "request": { + "name": "Delete a role", + "description": { + "content": "Delete a custom role.", + "type": "text/plain" + }, + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "roles", + ":role_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "merchant_code", + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "role_id", + "disabled": false, + "description": { + "content": "(Required) The ID of the role to retrieve.", + "type": "text/plain" + } + } + ] }, + "header": [ + { + "key": "Accept", + "value": "application/problem+json" + } + ], + "method": "DELETE", + "body": {}, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}" + } + ] + } + }, + "response": [ { - "id": "cae630b4-108b-46d7-bb9d-7abf659997e9", - "name": "Unauthorized", + "id": "2d4218ca-5e19-41dc-a085-3635a777f3f5", + "name": "Returns an empty response if the role deletion succeeded.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "checkout" + "roles", + ":role_id" ], "host": [ "{{baseUrl}}" @@ -11151,7 +11826,7 @@ { "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, "type": "any", @@ -11161,61 +11836,35 @@ { "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) The ID of the role to retrieve.", "type": "text/plain" }, "type": "any", "value": "", - "key": "reader_id" + "key": "role_id" } ] }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "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\": 8206,\n \"key_1\": \"string\",\n \"key_2\": true\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", - "language": "json" - } - } - } + "method": "DELETE", + "body": {} }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"errors\": {\n \"type\": \"\",\n \"detail\": \"\"\n }\n}", + "status": "OK", + "code": 200, + "header": [], "cookie": [], - "_postman_previewlanguage": "json" + "_postman_previewlanguage": "text" }, { - "id": "11b5ae70-9672-4d7d-b8e1-98e5bb58f595", - "name": "Response when given reader is not found", + "id": "e70a6b82-d062-444d-b6e4-2470711f7cc8", + "name": "Invalid request.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "checkout" + "roles", + ":role_id" ], "host": [ "{{baseUrl}}" @@ -11225,7 +11874,7 @@ { "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, "type": "any", @@ -11235,61 +11884,47 @@ { "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) The ID of the role to retrieve.", "type": "text/plain" }, "type": "any", "value": "", - "key": "reader_id" + "key": "role_id" } ] }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "application/problem+json" } ], - "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\": 8206,\n \"key_1\": \"string\",\n \"key_2\": true\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", - "language": "json" - } - } - } + "method": "DELETE", + "body": {} }, - "status": "Not Found", - "code": 404, + "status": "Bad Request", + "code": 400, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "application/problem+json" } ], - "body": "{\n \"errors\": {\n \"detail\": \"\"\n }\n}", + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bb7e1baf-abe6-4a0b-8c1e-0f93a62e7a8c", - "name": "Response when given params (or one of them) are invalid", + "id": "9414c4d1-ff46-442d-be77-29aca653d87d", + "name": "Merchant not found.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "checkout" + "roles", + ":role_id" ], "host": [ "{{baseUrl}}" @@ -11299,7 +11934,7 @@ { "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, "type": "any", @@ -11309,46 +11944,33 @@ { "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) The ID of the role to retrieve.", "type": "text/plain" }, "type": "any", "value": "", - "key": "reader_id" + "key": "role_id" } ] }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "application/problem+json" } ], - "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\": 8206,\n \"key_1\": \"string\",\n \"key_2\": true\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", - "language": "json" - } - } - } + "method": "DELETE", + "body": {} }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, + "status": "Not Found", + "code": 404, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "application/problem+json" } ], - "body": "{\n \"errors\": {\n \"key_0\": 6075\n }\n}", + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -11359,12 +11981,12 @@ } }, { - "id": "07f5f87c-7160-4b1d-9fed-6e0941d6640e", - "name": "Get a Reader Status", + "id": "762dd460-4f43-4f65-95b0-4289b1fa106a", + "name": "Update a role", "request": { - "name": "Get a Reader Status", + "name": "Update a role", "description": { - "content": "Provides the last known status for a Reader.\n\nThis endpoint allows you to retrieve updates from the connected card reader, including the current screen being displayed during the payment process and the device status (battery level, connectivity, and update state).\n\nSupported States\n\n* `IDLE` – Reader ready for next transaction\n* `SELECTING_TIP` – Waiting for tip input\n* `WAITING_FOR_CARD` – Awaiting card insert/tap\n* `WAITING_FOR_PIN` – Waiting for PIN entry\n* `WAITING_FOR_SIGNATURE` – Waiting for customer signature\n* `UPDATING_FIRMWARE` – Firmware update in progress\n\nDevice Status\n\n* `ONLINE` – Device connected and operational\n* `OFFLINE` – Device disconnected (last state persisted)\n\n**Note**: If the target device is a Solo, it must be in version 3.3.39.0 or higher.\n", + "content": "Update a custom role.", "type": "text/plain" }, "url": { @@ -11372,9 +11994,8 @@ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "status" + "roles", + ":role_id" ], "host": [ "{{baseUrl}}" @@ -11387,30 +12008,43 @@ "key": "merchant_code", "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" } }, { "type": "any", "value": "", - "key": "reader_id", + "key": "role_id", "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) The ID of the role to retrieve.", "type": "text/plain" } } ] }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", - "body": {}, + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"description\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, "auth": { "type": "bearer", "bearer": [ @@ -11423,17 +12057,16 @@ }, "response": [ { - "id": "8e20d495-462d-43df-b606-a004524207b9", - "name": "Response with the device status.", + "id": "d5213982-1755-4c70-b544-0408cd91e33d", + "name": "Returns the updated Role object if the update succeeded.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "status" + "roles", + ":role_id" ], "host": [ "{{baseUrl}}" @@ -11443,7 +12076,7 @@ { "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, "type": "any", @@ -11453,48 +12086,133 @@ { "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) The ID of the role to retrieve.", "type": "text/plain" }, "type": "any", "value": "", - "key": "reader_id" + "key": "role_id" } ] }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", - "body": {} + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"description\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", - "value": "application/json" + "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\": \"string\",\n \"key_1\": 8437.95370123823,\n \"key_2\": 5001,\n \"key_3\": 3616,\n \"key_4\": 5984.582531933284,\n \"key_5\": 6874.994140514265,\n \"key_6\": 8927.189886510296,\n \"key_7\": 4751.660020627491,\n \"key_8\": 4627.769161620497,\n \"key_9\": 784.679584209953,\n \"key_10\": 165.5635711990011,\n \"key_11\": 4154.956872034377,\n \"key_12\": 8571.652288688294,\n \"key_13\": true,\n \"key_14\": \"string\",\n \"key_15\": \"string\",\n \"key_16\": 856,\n \"key_17\": 2180,\n \"key_18\": 6496.850134489618,\n \"key_19\": false,\n \"key_20\": true,\n \"key_21\": true,\n \"key_22\": \"string\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9b2885f8-ba02-484e-a66d-e887e8d1fe84", + "name": "Invalid request.", + "originalRequest": { + "url": { + "path": [ + "v0.1", + "merchants", + ":merchant_code", + "roles", + ":role_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "merchant_code" + }, + { + "disabled": false, + "description": { + "content": "(Required) The ID of the role to retrieve.", + "type": "text/plain" + }, + "type": "any", + "value": "", + "key": "role_id" + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/problem+json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"description\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/problem+json" } ], - "body": "{\n \"data\": {\n \"status\": \"ONLINE\",\n \"battery_level\": \"\",\n \"battery_temperature\": \"\",\n \"connection_type\": \"btle\",\n \"firmware_version\": \"\",\n \"last_activity\": \"\",\n \"state\": \"WAITING_FOR_PIN\"\n }\n}", + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2f60e4ee-24a0-4815-9592-0e405b0f3629", - "name": "Response when given params (or one of them) are invalid", + "id": "7575031b-ec79-476e-8aae-5045203607fa", + "name": "Merchant not found.", "originalRequest": { "url": { "path": [ "v0.1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "status" + "roles", + ":role_id" ], "host": [ "{{baseUrl}}" @@ -11504,7 +12222,7 @@ { "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, "type": "any", @@ -11514,73 +12232,156 @@ { "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) The ID of the role to retrieve.", "type": "text/plain" }, "type": "any", "value": "", - "key": "reader_id" + "key": "role_id" } ] }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/problem+json" } ], - "method": "GET", - "body": {} + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"description\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } }, - "status": "Bad Request", - "code": 400, + "status": "Not Found", + "code": 404, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "application/problem+json" } ], - "body": "{\n \"errors\": {\n \"type\": \"DUPLICATE_HEADERS\",\n \"detail\": \"\"\n }\n}", + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "Merchants", + "description": "A Merchant represents a single business which can use SumUp products like payment processing.", + "item": [ + { + "id": "2e573011-769d-4ead-942b-1615804525b4", + "name": "Get Merchant", + "request": { + "name": "Get Merchant", + "description": { + "content": "Returns a Merchant for a valid Merchant code.", + "type": "text/plain" + }, + "url": { + "path": [ + "v1", + "merchants", + ":merchant_code" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", + "type": "text/plain" + }, + "key": "version", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "merchant_code", + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + } + } + ] }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}" + } + ] + } + }, + "response": [ { - "id": "ec3676c7-fa0f-4f1c-8283-a40ede7b35e2", - "name": "Response when given merchant's token is invalid", + "id": "987d37ff-4192-4e39-81a8-9f721e2ff532", + "name": "Returns a Merchant for a valid identifier.", "originalRequest": { "url": { "path": [ - "v0.1", + "v1", "merchants", - ":merchant_code", - "readers", - ":reader_id", - "status" + ":merchant_code" ], "host": [ "{{baseUrl}}" ], - "query": [], - "variable": [ + "query": [ { "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", "type": "text/plain" }, - "type": "any", - "value": "", - "key": "merchant_code" - }, + "key": "version", + "value": "" + } + ], + "variable": [ { "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, "type": "any", "value": "", - "key": "reader_id" + "key": "merchant_code" } ] }, @@ -11593,62 +12394,59 @@ "method": "GET", "body": {} }, - "status": "Unauthorized", - "code": 401, + "status": "OK", + "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], - "body": "{\n \"errors\": {\n \"detail\": \"\",\n \"type\": \"INVALID_ACCESS_TOKEN\"\n }\n}", + "body": "{\n \"country\": \"OF\",\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\": \"1572\",\n \"legal_type\": \"\",\n \"address\": {\n \"country\": \"XB\",\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\": \"CR\",\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 \"phone_number\": \"\",\n \"website\": \"\",\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": 9490.034728503182\n }\n },\n \"business_profile\": {\n \"name\": \"\",\n \"dynamic_descriptor\": \"k63Kolg+O qYgkO19P3Uh\",\n \"website\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"address\": {\n \"country\": \"EQ\",\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 \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"classic\": {\n \"id\": \"\"\n },\n \"version\": \"\",\n \"change_status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "90f17913-92dd-4d00-bc0f-63387bbeff60", - "name": "Response when given reader is not found", + "id": "06c37f44-0e98-4fe2-8427-8ee866577848", + "name": "The requested Merchant does not exist.", "originalRequest": { "url": { "path": [ - "v0.1", + "v1", "merchants", - ":merchant_code", - "readers", - ":reader_id", - "status" + ":merchant_code" ], "host": [ "{{baseUrl}}" ], - "query": [], - "variable": [ + "query": [ { "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", "type": "text/plain" }, - "type": "any", - "value": "", - "key": "merchant_code" - }, + "key": "version", + "value": "" + } + ], + "variable": [ { "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, "type": "any", "value": "", - "key": "reader_id" + "key": "merchant_code" } ] }, "header": [ { "key": "Accept", - "value": "application/json" + "value": "application/problem+json" } ], "method": "GET", @@ -11659,10 +12457,10 @@ "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "application/problem+json" } ], - "body": "{\n \"errors\": {\n \"detail\": \"\"\n }\n}", + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -11673,71 +12471,56 @@ } }, { - "id": "d093a1d7-57d6-4faa-878e-3fd1d3150bdc", - "name": "Terminate a Reader Checkout", + "id": "2e9b3eab-4868-4a68-89cd-0595fe027b85", + "name": "List Persons", "request": { - "name": "Terminate a Reader Checkout", + "name": "List Persons", "description": { - "content": "Terminate a Reader Checkout stops the current transaction on the target device.\n\nThis process is asynchronous and the actual termination may take some time to be performed on the device.\n\n\nThere are some caveats when using this endpoint:\n* The target device must be online, otherwise terminate won't be accepted\n* The action will succeed only if the device is waiting for cardholder action: e.g: waiting for card, waiting for PIN, etc.\n* There is no confirmation of the termination.\n\nIf a transaction is successfully terminated and `return_url` was provided on Checkout, the transaction status will be sent as `failed` to the provided URL.\n\n\n**Note**: If the target device is a Solo, it must be in version 3.3.28.0 or higher.\n", + "content": "Returns the Persons related to a Merchant.", "type": "text/plain" }, "url": { "path": [ - "v0.1", + "v1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "terminate" + "persons" ], "host": [ "{{baseUrl}}" ], - "query": [], - "variable": [ + "query": [ { - "type": "any", - "value": "", - "key": "merchant_code", "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", "type": "text/plain" - } - }, + }, + "key": "version", + "value": "" + } + ], + "variable": [ { "type": "any", "value": "", - "key": "reader_id", + "key": "merchant_code", "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" } } ] }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, + "method": "GET", + "body": {}, "auth": { "type": "bearer", "bearer": [ @@ -11750,175 +12533,233 @@ }, "response": [ { - "id": "a9fe40ec-457f-43c4-80bd-2d8163372b8f", - "name": "Response when given params (or one of them) are invalid", + "id": "2b9c40f9-5413-4d8c-9361-c4b7b0218a94", + "name": "Returns a list of Persons for a valid Merchant identifier.", "originalRequest": { "url": { "path": [ - "v0.1", + "v1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "terminate" + "persons" ], "host": [ "{{baseUrl}}" ], - "query": [], - "variable": [ + "query": [ { "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", "type": "text/plain" }, - "type": "any", - "value": "", - "key": "merchant_code" - }, + "key": "version", + "value": "" + } + ], + "variable": [ { "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, "type": "any", "value": "", - "key": "reader_id" + "key": "merchant_code" } ] }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } + "method": "GET", + "body": {} }, - "status": "Bad Request", - "code": 400, + "status": "OK", + "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], - "body": "{\n \"errors\": {\n \"type\": \"\",\n \"detail\": \"\"\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\": \"QB\",\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\": \"OP\",\n \"nationality\": \"\",\n \"country_of_residence\": \"\",\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\": \"AA\",\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\": \"OC\",\n \"nationality\": \"\",\n \"country_of_residence\": \"\",\n \"version\": \"\",\n \"change_status\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "62d4392a-d8b4-4d7b-8d17-b7354c624359", - "name": "Unauthorized", + "id": "3bea1dfe-dd23-414b-8381-8c556f793bb4", + "name": "The requested Merchant does not exist.", "originalRequest": { "url": { "path": [ - "v0.1", + "v1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "terminate" + "persons" ], "host": [ "{{baseUrl}}" ], - "query": [], - "variable": [ + "query": [ { "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", "type": "text/plain" }, - "type": "any", - "value": "", - "key": "merchant_code" - }, + "key": "version", + "value": "" + } + ], + "variable": [ { "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, "type": "any", "value": "", - "key": "reader_id" + "key": "merchant_code" } ] }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "application/problem+json" } ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } + "method": "GET", + "body": {} }, - "status": "Unauthorized", - "code": 401, + "status": "Not Found", + "code": 404, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "application/problem+json" } ], - "body": "{\n \"errors\": {\n \"type\": \"\",\n \"detail\": \"\"\n }\n}", + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "720e917a-15ca-4436-a03b-1e0ee45fbe64", + "name": "Get Person", + "request": { + "name": "Get Person", + "description": { + "content": "Returns a single Person related to a Merchant.", + "type": "text/plain" + }, + "url": { + "path": [ + "v1", + "merchants", + ":merchant_code", + "persons", + ":person_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", + "type": "text/plain" + }, + "key": "version", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "merchant_code", + "disabled": false, + "description": { + "content": "(Required) Short unique identifier for the merchant.", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "person_id", + "disabled": false, + "description": { + "content": "(Required) Person ID", + "type": "text/plain" + } + } + ] }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}" + } + ] + } + }, + "response": [ { - "id": "d78f50f2-dc9c-430d-bf49-013dd216b1ea", - "name": "Response when given reader is not found", + "id": "a237db8a-1960-4d56-be6e-a56cb5852bb1", + "name": "Returns a Person for a valid identifier.", "originalRequest": { "url": { "path": [ - "v0.1", + "v1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "terminate" + "persons", + ":person_id" ], "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", + "type": "text/plain" + }, + "key": "version", + "value": "" + } + ], "variable": [ { "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, "type": "any", @@ -11928,71 +12769,67 @@ { "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) Person ID", "type": "text/plain" }, "type": "any", "value": "", - "key": "reader_id" + "key": "person_id" } ] }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } + "method": "GET", + "body": {} }, - "status": "Not Found", - "code": 404, + "status": "OK", + "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], - "body": "{\n \"errors\": {\n \"detail\": \"\"\n }\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\": \"MA\",\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\": \"JU\",\n \"nationality\": \"\",\n \"country_of_residence\": \"\",\n \"version\": \"\",\n \"change_status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "aefe1ef9-9993-4b86-9658-80550f7638f7", - "name": "Response when given params (or one of them) are invalid", + "id": "7bac8db3-9fa3-4ae6-a445-af2e90ee2f57", + "name": "The requested Person does not exist.", "originalRequest": { "url": { "path": [ - "v0.1", + "v1", "merchants", ":merchant_code", - "readers", - ":reader_id", - "terminate" + "persons", + ":person_id" ], "host": [ "{{baseUrl}}" ], - "query": [], + "query": [ + { + "disabled": false, + "description": { + "content": "The version of the resource. At the moment, the only supported value is `latest`. When provided and the requested resource's `change_status` is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The `change_status` in the response body will reflect the current state of the resource.\n", + "type": "text/plain" + }, + "key": "version", + "value": "" + } + ], "variable": [ { "disabled": false, "description": { - "content": "(Required) Merchant Code", + "content": "(Required) Short unique identifier for the merchant.", "type": "text/plain" }, "type": "any", @@ -12002,46 +12839,33 @@ { "disabled": false, "description": { - "content": "(Required) The unique identifier of the Reader", + "content": "(Required) Person ID", "type": "text/plain" }, "type": "any", "value": "", - "key": "reader_id" + "key": "person_id" } ] }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "application/problem+json" } ], - "method": "POST", - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - } + "method": "GET", + "body": {} }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, + "status": "Not Found", + "code": 404, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "application/problem+json" } ], - "body": "{\n \"errors\": {\n \"key_0\": true\n }\n}", + "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -12062,7 +12886,7 @@ } ], "info": { - "_postman_id": "9b13831d-bf0a-4f52-95a1-39f7e5487a7a", + "_postman_id": "ea5a9a20-0fe8-475f-872e-000f1356e1f5", "name": "SumUp REST API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": {