Refund Payment

Refund a payment. The payment must be captured first.

Request

Path Params

string

required

The ID of the Payment.

Body Params application/json

amount

integer

required

The amount to refund.

reason

string

required

The reason for the Refund.

note

string

optional

A note with additional details about the Refund.

Example

{
  "amount": 0,
  "reason": "string",
  "note": "string"
}

Responses

🟢200OK

application/json

Body

refund

object (Refund)

required

A refund represents an amount of money transfered back to the customer for a given reason. Refunds may occur in relation to Returns, Swaps and Claims, but can also be initiated by an admin for an order.

string

required

The refund's ID

Example:

ref_01G1G5V27GYX4QXNARRQCW1N8T

order_id

string | null

required

The ID of the order this refund was created for.

Example:

order_01G8TJSYT9M6AVS5N4EMNFS1EK

order

object | null

optional

The details of the order this refund was created for.

payment_id

string | null

required

The payment's ID, if available.

Example:

pay_01G8ZCC5W42ZNY842124G7P5R9

payment

object | null

optional

The details of the payment associated with the refund.

amount

integer

required

The amount that has be refunded to the Customer.

Example:

1000

note

string | null

required

An optional note explaining why the amount was refunded.

Example:

I didn't like it

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

reason

enum<string>

required

The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.

Allowed values:

discountreturnswapclaimother

Example:

return

idempotency_key

string | null

required

Randomly generated key used to continue the completion of the refund in case of failure.

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

Example

{
  "refund": {
    "id": "ref_01G1G5V27GYX4QXNARRQCW1N8T",
    "order_id": "order_01G8TJSYT9M6AVS5N4EMNFS1EK",
    "order": {},
    "payment_id": "pay_01G8ZCC5W42ZNY842124G7P5R9",
    "payment": {},
    "amount": 1000,
    "note": "I didn't like it",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "reason": "discount",
    "idempotency_key": "string",
    "metadata": {
      "car": "white"
    }
  }
}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Refund Payment

Request

Request samples

Responses