SolutionsSystem status
API Reference
Create accountContact

Refund order

post
https://testapi.multisafepay.com/v1/json/orders//refunds

Process a full or partial refund for an order.

Refunding creates a new order linked to the original order. By default, it has the same order_id as the original order. To override this, include in the request refund_order_id.

Path Params
string
required

The unique identifier of the order.

To refund a Pay After Delivery partial shipment:

  • Before shipment: Refund the whole order using the invoice order order_id.
  • After shipment: Refund specific partial shipments using the shipment order_id returned in the Partially ship order response.

Max length: 50 characters.

Body Params
string
required

The currency to process the refund in. This must be the same as the original transaction.

Format: ISO-4217 currency code.

integer
≥ 0

The refund amount in the currency's smallest unit.

  • Decimal currencies: Value for 10 EUR = 1000 (1000 cents)
  • Zero-decimal currencies: Value for 10 JPY = 10

⚠️Note: A full refund will be processed if the amount parameter is omitted, left empty, or set to 0.

string
length ≤ 200

A description of the customer's order.

Appears on payment pages and customer bank statements (if supported by the bank).

Does not appear on FastCheckout pages (in your dashboard only).

string
length ≤ 50

Set a unique identifier for the refund order ID. If not included in the request, the refund order ID is the same as the original order ID.

string
length ≤ 500

Variable for storing additional data.

string
length ≤ 500

Variable for storing additional data.

string
length ≤ 500

Variable for storing additional data, including split payments metadata.

Responses

Updated 8 months ago

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago