update-payment-request.md

Update Payment Request

Describes a request to update a payment using UpdatePayment.

Structure

Update Payment Request

Fields

Name	Type	Tags	Description
payment	Payment	Optional	Represents a payment processed by the Square API.
idempotency_key	string	Required	A unique string that identifies this UpdatePayment request. Keys can be any valid string but must be unique for every UpdatePayment request. The maximum is 45 characters. For more information, see Idempotency. Constraints: Minimum Length: 1, Maximum Length: 45

Example (as JSON)

{
  "idempotency_key": "3d3c3b22-9572-4fc6-1111-e4d2f41b4122",
  "payment": {
    "amount_money": {
      "amount": 1000,
      "currency": "USD"
    },
    "tip_money": {
      "amount": 300,
      "currency": "USD"
    },
    "version_token": "Z3okDzm2VRv5m5nE3WGx381ItTNhvjkB4VapByyz54h6o"
  }
}