COcommercelayer
stripe_payments

Update a stripe payment

Changed on

Update a stripe payment

patch/stripe_payments/{stripePaymentId}

Request

  • Base URL
    https://{your_organization_slug}.commercelayer.io/api
  • URL
    https://{your_organization_slug}.commercelayer.io/api/stripe_payments/{stripePaymentId}
  • Auth
    HTTP bearer

Path parameters

stripePaymentIdstring required

The resource's id

Request body

Example request

{
  "data": {
    "id": "XAyRWNUzyN",
    "attributes": {
      "options": {
        "customer": "cus_xxx",
        "payment_method": "pm_xxx"
      },
      "return_url": "https://yourdomain.com/thankyou",
      "_update": true,
      "_refresh": true,
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "order": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      }
    }
  }
}

Response

The updated stripe payment object

Changes

  • 859097ed3fe6Revision changes
    • breaking

      added the new required request property ///

    • breaking

      request property / was restricted to a list of enum values

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property default value stripe_payments was removed

    • info

      added the new stripe_payments enum value to the request property /

    • info

      added the media type application/vnd.api+json for the response with the status