Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
Payments

UpdatePayment

Updates a payment with the APPROVED status. You can update the amount_money and tip_money using this endpoint.

put/v2/payments/{payment_id}

Path parameters

payment_idstring required

The ID of the payment to update.

Request body

idempotency_keystring 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.

Example request

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

Response

Success

Example response

{
  "payment": {
    "amount_money": {
      "amount": 1000,
      "currency": "USD"
    },
    "approved_money": {
      "amount": 1000,
      "currency": "USD"
    },
    "capabilities": [
      "EDIT_AMOUNT_UP",
      "EDIT_AMOUNT_DOWN",
      "EDIT_TIP_AMOUNT_UP",
      "EDIT_TIP_AMOUNT_DOWN"
    ],
    "card_details": {
      "auth_result_code": "ajM2ZF",
      "avs_status": "AVS_ACCEPTED",
      "card": {
        "bin": "411111",
        "card_brand": "VISA",
        "card_type": "CREDIT",
        "exp_month": 2,
        "exp_year": 2022,
        "fingerprint": "sq-1-n_BL15KP87ClDa4-h2nXOI0fp5VnxNH6hfhzqhptTfAgxgLuGFcg6jIPngDz4IkkTQ",
        "last_4": "1111"
      },
      "card_payment_timeline": {
        "authorized_at": "2021-02-24T03:33:43.681Z"
      },
      "cvv_status": "CVV_ACCEPTED",
      "entry_method": "KEYED",
      "statement_description": "SQ *MY BUSINESS GOSQ.COM",
      "status": "AUTHORIZED"
    },
    "created_at": "2021-03-02T19:53:31.055Z",
    "delay_action": "CANCEL",
    "delay_duration": "PT168H",
    "delayed_until": "2021-03-09T19:53:31.055Z",
    "id": "XllelosAAfmkf9mOa0YB4PqSZACZY",
    "location_id": "XTI0H92143A39",
    "order_id": "B6qiKWus1d3TBoN2Qn5kfDiWZlfZY",
    "receipt_number": "Xlle",
    "source_type": "CARD",
    "status": "APPROVED",
    "tip_money": {
      "amount": 300,
      "currency": "USD"
    },
    "total_money": {
      "amount": 1300,
      "currency": "USD"
    },
    "updated_at": "2021-03-02T19:53:31.164Z",
    "version_token": "9TKsTawsWZvdZZD5uhAZFWfd3chxFXB49cgFpD2Kujf6o"
  }
}