Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Refunds

Updates a refund for an order or a specific order charge

Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request only accepts metadata as an argument.

post/refunds/{id}

Path parameters

idstring required

Refund ID

Request body

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

Example request

{
  "metadata": {
    "coupon": "iOS"
  }
}

Response

200 OK

idstring

The unique identifier of the refund.

createdTimestring date-time

Time at which the refund was created.

orderIdstring

The unique identifier of the order.

invoiceIdstring

The unique identifier of the invoice.

currencystring

Three-letter ISO currency code.

type'shipping' | 'tax' | 'duty' | 'importer_tax'

The type of refund.

amountnumber double

The requested refund amount.

refundedAmountnumber double

The total amount refunded.

reasonstring

The reason for the refund.

failureReasonstring

The reason for the refund failure, if known.

state'pending_information' | 'pending' | 'succeeded' | 'failed' | 'expired'

The state of the refund.

expiresTimestring date-time

Time at which the information token expires.

liveModeboolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

sourcestring

The source of the refund.

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

Example response

{
  "id": "ref_5823594809",
  "createdTime": "2018-04-25T20:36:00Z",
  "orderId": "ord_6645940010",
  "invoiceId": "5823594809",
  "currency": "USD",
  "type": "shipping",
  "amount": 9.99,
  "refundedAmount": 9.99,
  "items": [
    {
      "type": "tax",
      "skuId": "sku_5823594809",
      "quantity": 1,
      "amount": 5.95,
      "percent": 10
    }
  ],
  "reason": "requested_by_customer",
  "failureReason": "expired_or_canceled_card",
  "state": "created",
  "tokenInformation": {
    "token": "bb3f0f17-567a-4c87-8cbd-76d93a750709",
    "expiresTime": "2019-12-25T20:36:00Z"
  },
  "expiresTime": "2019-12-25T20:36:00Z",
  "charges": [
    {
      "id": "c5b02ace-115d-4433-8841-8165d4c927a8",
      "refunds": [
        {
          "createdTime": "2018-04-25T20:36:00Z",
          "amount": 42.95,
          "state": "complete"
        }
      ],
      "sourceId": "376e6777-d92b-4d35-a460-44f29327a18e"
    }
  ],
  "source": "string",
  "metadata": {
    "coupon": "iOS"
  }
}