Refund Order

POST 
/refunds

Refund an order by returning to the shopper the desired amount.

Payment Methods

Refunds can only be executed for orders paid with either Cards, Google Pay or Apple Pay.

Full vs Partial

Refunds can be either full or partial. This is determined by the optional amount attribute. When omitted a full refund will be triggered. In any other case only the provided amount will be returned to the shopper.

Multiple partial refunds can be executed as long as the sum of the refunded amounts does not exceed order's total amount. Performing a partial refund and then requesting a full refund will result in an error.

Note: amount must be provided in cents. For example for returning 10€ to the shopper amount should be set to 1000

Authentication

A POST request to https://merchant.simpler.so/api/v1/refunds requires basic authentication. Your API key & Secret must be used for authorizing this request.

Request

application/json

Body

required

order_id stringrequired

The id assigned to the order by your system

amount integer

The amount in cents to return to the shopper

Responses

200

OK

400

Bad Request

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "missing required property order_id"
}

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

404

Not Found

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Loading...