Developer Documentation
Developer Documentation
Home
PartPay
post

/order/{id}/refund

This resource performs a full or partial refund.

The resource is idempotent if a unique requestId is provided.

Authorization

oauth2 - clientCredentials

Request Parameters

1 Path Parameter

Request Body

Schema
object
requestId
string

A client created unique request ID required for safe retries. It is recommended that the client generate a GUID as this ID must be globally unique to the merchant.

amount
number

The refund amount. The refund amount can not exceed the associated order.

1 validation + required
merchantRefundReference
string

Merchant refund reference.

Responses

OK

Schema
object
id
string

The unique refund id.

refundedDateTime
string

The refund creation time (ISO 8601 UTC/Zulu time).

1 validation
merchantReference
string

The merchant’s refund id/reference that this refund corresponds to.

amount
number

The refund amount.

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
id
$$.env
1 variable not set
oauth_access_token