PaymentUpdateRequest

Request parameters for updating mutable payment fields. Provide at least one of client_reference_id, description, or metadata.

  • client_reference_id
    Type: string | null
    max length:  
    100

    A free-form reference from your system, such as an order ID, cart ID, or customer reference.

    This field is write-once. You can set it when the payment does not already have a client_reference_id, and you can safely retry the same value. Changing an existing value to a different value is rejected.

  • metadata
    Type: object

    Key-value metadata to merge into the payment. Provided keys overwrite existing values for the same keys. Omitted keys remain unchanged.

    Properties: 1
  • description
    Type: string | null

    A free-form description for the payment. It can be changed at any time.