---
updatedAt: 2025-05-05T20:25:25.000Z
agentTools:
  projectIndex: https://developers.todaytixgroup.com/llms.txt
---

# /payments/{id}

Update payment amount for an order.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Payments API",
    "description": "Payments API for Encore Tickets Ltd.",
    "termsOfService": "https://encore.co.uk/terms",
    "contact": {
      "email": "admin@encore.co.uk"
    },
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://payment-service.tixuk.io/api/v1",
      "description": "Payments API host"
    }
  ],
  "paths": {
    "/payments/{id}": {
      "patch": {
        "tags": [
          "Payment"
        ],
        "description": "Update payment amount for an order.",
        "operationId": "2d0ab86ca211c31e2957487e1371dba1",
        "parameters": [
          {
            "$ref": "#/components/parameters/id"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Amount"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "If request is correct return data about updated amount",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Payment"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/invalidRequestError"
          },
          "404": {
            "$ref": "#/components/responses/domainNotFoundError"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "dateTime": {
        "description": "Date and time in ISO8601/RFC3339 format",
        "type": "string",
        "format": "date-time-RFC3339",
        "example": "2018-01-01T01:02:01+02:00"
      },
      "pspName": {
        "title": "pspName",
        "description": "Name of the Payment Service Provider",
        "type": "string",
        "example": "AdyenTest"
      },
      "pspReference": {
        "title": "pspReference",
        "description": "PSP reference for the payment",
        "type": "string",
        "example": "refund-123"
      },
      "uuid": {
        "type": "string",
        "format": "uuid",
        "example": "b08cd736-d6d9-47d6-a506-d5abd6194bf5"
      },
      "reason": {
        "title": "reason",
        "description": "Reason for the action",
        "type": "string",
        "example": "Order was cancelled"
      },
      "boolStatus": {
        "title": "Status",
        "description": "Status in boolean",
        "type": "boolean",
        "example": "true"
      },
      "Amount": {
        "title": "Amount entity",
        "description": "Stores amount and currency details",
        "properties": {
          "value": {
            "$ref": "#/components/schemas/amountValue"
          },
          "currency": {
            "$ref": "#/components/schemas/currency"
          },
          "exchangeRate": {
            "$ref": "#/components/schemas/exchangeRate"
          }
        },
        "type": "object"
      },
      "amountValue": {
        "title": "Value",
        "description": "Amount value",
        "type": "integer",
        "example": 100
      },
      "currency": {
        "title": "Currency",
        "description": "Currency in 3 letter ISO code",
        "type": "string",
        "example": "GBP"
      },
      "exchangeRate": {
        "title": "Exchange rate",
        "description": "Exchange rate for a currency is different from GBP",
        "type": "string",
        "example": "1.29282999"
      },
      "Compensation": {
        "title": "Compensation entity",
        "description": "stores compensation details",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/uuid"
          },
          "createdAt": {
            "$ref": "#/components/schemas/dateTime"
          },
          "pspReference": {
            "$ref": "#/components/schemas/pspReference"
          },
          "pspCreatedAt": {
            "$ref": "#/components/schemas/dateTime"
          },
          "stableId": {
            "$ref": "#/components/schemas/uuid"
          },
          "amount": {
            "$ref": "#/components/schemas/Amount"
          },
          "reason": {
            "$ref": "#/components/schemas/reason"
          }
        },
        "type": "object"
      },
      "OptionalAmount": {
        "title": "OptionalAmount Entity",
        "description": "Stores optional amount data",
        "properties": {
          "value": {
            "$ref": "#/components/schemas/amountValue"
          },
          "currency": {
            "$ref": "#/components/schemas/currency"
          }
        },
        "type": "object"
      },
      "Payment": {
        "title": "Payment entity",
        "description": "Stores payment details",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/uuid"
          },
          "createdAt": {
            "$ref": "#/components/schemas/dateTime"
          },
          "amount": {
            "$ref": "#/components/schemas/Amount"
          },
          "amountOriginal": {
            "$ref": "#/components/schemas/OptionalAmount"
          },
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentEvent"
            }
          },
          "paymentMethod": {
            "$ref": "#/components/schemas/PaymentMethod"
          },
          "refunds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Refund"
            }
          },
          "compensations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Compensation"
            }
          },
          "pspName": {
            "$ref": "#/components/schemas/pspName"
          },
          "pspMerchantAccount": {
            "type": "string",
            "example": "EncoreTicketsLtd"
          }
        },
        "type": "object"
      },
      "PaymentEvent": {
        "title": "PaymentEvent Entity",
        "description": "PaymentEvent entity stores details on all the payment events.",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/uuid"
          },
          "createdAt": {
            "$ref": "#/components/schemas/dateTime"
          },
          "pspCreatedAt": {
            "$ref": "#/components/schemas/dateTime"
          },
          "pspReference": {
            "$ref": "#/components/schemas/pspReference"
          },
          "type": {
            "title": "type",
            "description": "Payment event type: 'capture', 'authorisation' etc.",
            "type": "string",
            "example": "cancellation"
          },
          "status": {
            "$ref": "#/components/schemas/boolStatus"
          },
          "notificationUpdatedAt": {
            "$ref": "#/components/schemas/dateTime"
          }
        },
        "type": "object"
      },
      "PaymentMethod": {
        "title": "PaymentMethod Entity",
        "description": "PaymentMethod entity stores details on the payment method.",
        "properties": {
          "type": {
            "title": "type",
            "description": "Type of payment method. We currently support 'card', 'amex', 'paypal', 'applepay'.",
            "type": "string",
            "example": "card"
          },
          "scheme": {
            "title": "scheme",
            "description": "Payment method scheme. It can be visa, mc, amex etc. Only used when type is 'card' or 'applepay'.",
            "type": "string",
            "example": "visa"
          },
          "number": {
            "title": "number",
            "description": "Obfuscated card number or account ID. Only used when type is 'card', 'paypal', or 'applepay'.",
            "type": "string",
            "example": "555544******1111"
          },
          "expiryDate": {
            "title": "expiryDate",
            "description": "Expiry date of a card. Only used when type is 'card' or 'applepay'.",
            "type": "string",
            "example": "10/2020"
          },
          "holderName": {
            "title": "holderName",
            "description": "Holder name of a card or account. Only used when type is 'card', 'paypal', or 'applepay'.",
            "type": "string",
            "example": "Mr. Test HolderName"
          }
        },
        "type": "object"
      },
      "Refund": {
        "title": "Refund entity",
        "description": "stores refund details",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/uuid"
          },
          "createdAt": {
            "$ref": "#/components/schemas/dateTime"
          },
          "pspReference": {
            "$ref": "#/components/schemas/pspReference"
          },
          "pspCreatedAt": {
            "$ref": "#/components/schemas/dateTime"
          },
          "stableId": {
            "$ref": "#/components/schemas/uuid"
          },
          "amount": {
            "$ref": "#/components/schemas/Amount"
          },
          "reason": {
            "$ref": "#/components/schemas/reason"
          },
          "status": {
            "$ref": "#/components/schemas/boolStatus"
          }
        },
        "type": "object"
      }
    },
    "responses": {
      "invalidRequestError": {
        "description": "If request is invalid return 400 status code with error message."
      },
      "domainNotFoundError": {
        "description": "No order found for given id: return 404 status code."
      }
    },
    "parameters": {
      "id": {
        "name": "id",
        "in": "path",
        "required": true,
        "schema": {
          "properties": {
            "": {
              "$ref": "#/components/schemas/uuid"
            }
          },
          "type": "object"
        },
        "example": "b08cd736-d6d9-47d6-a506-d5abd6194bf5"
      }
    }
  },
  "tags": [
    {
      "name": "Payment",
      "description": "Payment related API calls"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```