Refund Request

Refund an amount by order, either partial or in full. An example use-case is when an order was captured but the customer returned item(s) that requires them to be refunded.

POST /v1/orders/{order_reference_id}/refund

Refund Request

cURL

curl --request POST \
  --url https://sandbox.gateway.sezzle.com/v1/orders/{order_reference_id}/refund \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refund_id": "41a2O9Lv-7",
  "amount": {
    "amount_in_cents": 500,
    "currency": "USD"
  },
  "refund_reason": "Item returned by user"
}
'

200

{
  "amount": {
    "amount_in_cents": 500,
    "currency": "USD"
  },
  "refund_id": "41a2O9Lv-7",
  "refund_reason": "Item returned by user"
}

You are viewing Version 1 of the Sezzle API. Check out the current version!

Authorizations

Authorization · string · header · required

The authentication token generated from providing API Keys to Sezzle Gateway

Path Parameters

order_reference_id · string · required

The Order Reference ID to update

Body

application/json

amount · object · required

A price object that defines the amount to be refunded. Amount may not be 0, negative, or exceed the total order amount. Currency must either be the order’s currency or the customer’s paying currency. This field is optional if the is_full_refund parameter is true.

Hide child attributes

amount. amount_in_cents · integer · required

The amount in cents

amount. currency · string · required

The 3 character currency code as defined by ISO 4217

refund_id · string

UUID for the Refund. Must be unique to a Merchant

refund_reason · string

A reason for the refund

is_full_refund · boolean

Overrides amount. If true, the order will be fully refunded. If omitted, will default to false.

Response

200

application/json

Successful Operation

amount · object

Hide child attributes

amount. amount_in_cents · integer · required

The amount in cents

amount. currency · string · required

The 3 character currency code as defined by ISO 4217

refund_id · string

The refund ID provided in the request

refund_reason · string

The refund reason provided in the request