diff --git a/openapi.json b/openapi.json index 3217c6bb..412977f4 100755 --- a/openapi.json +++ b/openapi.json @@ -543,10 +543,10 @@ ] } }, - "/v0.1/checkouts/{id}": { + "/v0.1/checkouts/{checkout_id}": { "parameters": [ { - "name": "id", + "name": "checkout_id", "in": "path", "description": "Unique ID of the checkout resource.", "required": true, @@ -1150,14 +1150,14 @@ ] } }, - "/v0.2/checkouts/{id}/apple-pay-session": { + "/v0.2/checkouts/{checkout_id}/apple-pay-session": { "put": { "operationId": "CreateApplePaySession", "summary": "Create an Apple Pay session", "description": "Creates an Apple Pay merchant session for the specified checkout.\n\nUse this endpoint after the customer selects Apple Pay and before calling\n`ApplePaySession.completeMerchantValidation(...)` in the browser.\nSumUp validates the merchant session request and returns the Apple Pay\nsession object that your frontend should pass to Apple's JavaScript API.\n", "parameters": [ { - "name": "id", + "name": "checkout_id", "in": "path", "description": "Unique ID of the checkout resource.", "required": true, @@ -1900,7 +1900,7 @@ ] } }, - "/v1.0/merchants/{merchant_code}/payments/{id}/refunds": { + "/v1.0/merchants/{merchant_code}/payments/{transaction_id}/refunds": { "parameters": [ { "name": "merchant_code", @@ -1913,7 +1913,7 @@ } }, { - "name": "id", + "name": "transaction_id", "in": "path", "description": "Unique ID of the transaction.", "required": true, @@ -2658,14 +2658,14 @@ ] } }, - "/v1.1/receipts/{id}": { + "/v1.1/receipts/{transaction_id}": { "get": { "operationId": "GetReceipt", "summary": "Retrieve receipt details", "description": "Retrieves receipt specific data for a transaction.", "parameters": [ { - "name": "id", + "name": "transaction_id", "in": "path", "description": "SumUp unique transaction ID or transaction code, e.g. TS7HDYLSKD.", "required": true, @@ -4549,14 +4549,14 @@ "UpdateReaderByID": { "operationId": "UpdateReader", "parameters": { - "id": "$response.body#/id" + "reader_id": "$response.body#/id" }, "description": "Update the reader object. This can be used to set a name after using this endpoint to verify the pairing code." }, "DeleteReaderByID": { "operationId": "DeleteReader", "parameters": { - "id": "$response.body#/id" + "reader_id": "$response.body#/id" }, "description": "Delete the reader." } @@ -4639,7 +4639,7 @@ ] } }, - "/v0.1/merchants/{merchant_code}/readers/{id}": { + "/v0.1/merchants/{merchant_code}/readers/{reader_id}": { "get": { "operationId": "GetReader", "summary": "Retrieve a Reader", @@ -4677,7 +4677,7 @@ } }, { - "name": "id", + "name": "reader_id", "in": "path", "description": "The unique identifier of the reader.", "required": true, @@ -4757,7 +4757,7 @@ } }, { - "name": "id", + "name": "reader_id", "in": "path", "description": "The unique identifier of the reader.", "required": true, @@ -4830,7 +4830,7 @@ } }, { - "name": "id", + "name": "reader_id", "in": "path", "description": "The unique identifier of the reader.", "required": true, @@ -5403,7 +5403,7 @@ } }, "CheckoutID": { - "name": "id", + "name": "checkout_id", "in": "path", "required": true, "description": "Unique ID of the checkout resource.", @@ -5539,15 +5539,6 @@ "type": "string" } }, - "TxnID": { - "in": "path", - "name": "txn_id", - "required": true, - "description": "Unique ID of the transaction.", - "schema": { - "type": "string" - } - }, "TypesFilter": { "name": "types", "in": "query", @@ -9595,14 +9586,14 @@ "UpdateReaderByID": { "operationId": "UpdateReader", "parameters": { - "id": "$response.body#/id" + "reader_id": "$response.body#/id" }, "description": "Update the reader object. This can be used to set a name after using this endpoint to verify the pairing code." }, "DeleteReaderByID": { "operationId": "DeleteReader", "parameters": { - "id": "$response.body#/id" + "reader_id": "$response.body#/id" }, "description": "Delete the reader." } diff --git a/openapi.yaml b/openapi.yaml index bf3f4470..ad1c2b33 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -385,9 +385,9 @@ paths: method_name: list x-scopes: - payments - /v0.1/checkouts/{id}: + /v0.1/checkouts/{checkout_id}: parameters: - - name: id + - name: checkout_id in: path description: Unique ID of the checkout resource. required: true @@ -812,7 +812,7 @@ paths: method_name: deactivate x-scopes: - payments - /v0.2/checkouts/{id}/apple-pay-session: + /v0.2/checkouts/{checkout_id}/apple-pay-session: put: operationId: CreateApplePaySession summary: Create an Apple Pay session @@ -824,7 +824,7 @@ paths: SumUp validates the merchant session request and returns the Apple Pay session object that your frontend should pass to Apple's JavaScript API. parameters: - - name: id + - name: checkout_id in: path description: Unique ID of the checkout resource. required: true @@ -1298,7 +1298,7 @@ paths: method_name: deactivate_payment_instrument x-scopes: - payment_instruments - /v1.0/merchants/{merchant_code}/payments/{id}/refunds: + /v1.0/merchants/{merchant_code}/payments/{transaction_id}/refunds: parameters: - name: merchant_code in: path @@ -1307,7 +1307,7 @@ paths: schema: type: string example: MH4H92C7 - - name: id + - name: transaction_id in: path description: Unique ID of the transaction. required: true @@ -1820,13 +1820,13 @@ paths: x-scopes: - user.profile - user.profile_readonly - /v1.1/receipts/{id}: + /v1.1/receipts/{transaction_id}: get: operationId: GetReceipt summary: Retrieve receipt details description: Retrieves receipt specific data for a transaction. parameters: - - name: id + - name: transaction_id in: path description: SumUp unique transaction ID or transaction code, e.g. TS7HDYLSKD. required: true @@ -3062,12 +3062,12 @@ paths: UpdateReaderByID: operationId: UpdateReader parameters: - id: $response.body#/id + reader_id: $response.body#/id description: Update the reader object. This can be used to set a name after using this endpoint to verify the pairing code. DeleteReaderByID: operationId: DeleteReader parameters: - id: $response.body#/id + reader_id: $response.body#/id description: Delete the reader. '400': description: The request is invalid. @@ -3116,7 +3116,7 @@ paths: object_id_param: merchant_code x-scopes: - readers.write - /v0.1/merchants/{merchant_code}/readers/{id}: + /v0.1/merchants/{merchant_code}/readers/{reader_id}: get: operationId: GetReader summary: Retrieve a Reader @@ -3148,7 +3148,7 @@ paths: schema: type: string example: MK10CL2A - - name: id + - name: reader_id in: path description: The unique identifier of the reader. required: true @@ -3198,7 +3198,7 @@ paths: schema: type: string example: MK10CL2A - - name: id + - name: reader_id in: path description: The unique identifier of the reader. required: true @@ -3244,7 +3244,7 @@ paths: schema: type: string example: MK10CL2A - - name: id + - name: reader_id in: path description: The unique identifier of the reader. required: true @@ -3658,7 +3658,7 @@ components: type: string format: date-time CheckoutID: - name: id + name: checkout_id in: path required: true description: Unique ID of the checkout resource. @@ -3763,13 +3763,6 @@ components: required: false schema: type: string - TxnID: - in: path - name: txn_id - required: true - description: Unique ID of the transaction. - schema: - type: string TypesFilter: name: types in: query @@ -7045,12 +7038,12 @@ components: UpdateReaderByID: operationId: UpdateReader parameters: - id: $response.body#/id + reader_id: $response.body#/id description: Update the reader object. This can be used to set a name after using this endpoint to verify the pairing code. DeleteReaderByID: operationId: DeleteReader parameters: - id: $response.body#/id + reader_id: $response.body#/id description: Delete the reader. requestBodies: CheckoutCreate: