latestOpenAPI 3.0.32026-08-215925112.0 MB

36be0dca14e7

api
refunds

Get all refunds

get/api/payments/refunds

Query parameters

skipinteger required

The number of objects to skip for the requested result

The number of objects to skip for the requested result

topinteger required

A limit on the number of objects to be returned. Can range between 1 and 1000.

A limit on the number of objects to be returned. Can range between 1 and 1000.

gatewaystring

The payment gateway type to filter for

The payment gateway type to filter for

gatewayIdstring

The payment gateway id to filter for

The payment gateway id to filter for

$gtstring date-time

value is greater than

$gtestring date-time

value is greater than or equal

$ltstring date-time

value is less than

$ltestring date-time

value is less than or equal

$eqstring date-time

value is equal

$nestring date-time

value is not equal

Range of dates to filter by when the refund was created in ISO format.

target'origin' | 'voucher' | 'customer_balance'
pspRefstring

The payment service provider reference to filter for

The payment service provider reference to filter for

transactionIdstring

The transaction id to filter for

The transaction id to filter for

paymentIdstring

The payment id to filter for

The payment id to filter for

Response

OK

totalinteger