latestOpenAPI 3.0.32026-08-215925112.0 MB
36be0dca14e7
api
refunds
Get a refund
get/api/payments/refunds/{id}
Path parameters
idstring required
Response
OK
_idstring required
The ID of the refund
transactionIdstring
The ID of the transaction which the refund belongs to
eventIdstring
The ID of the event which the refund belongs to
sellerIdstring
The ID of the seller which the refund belongs to
pspRefstring
The ID of the payment service provider reference object
gateway'managed' | 'external' | 'local'
The gateway payment type of the refund
amountnumber float
The amount of the refund
currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK'
An ISO 4217 3-character code of the currency
createdAtstring date-time required
An ISO Timestamp indicating when the refund was created.
updatedAtstring date-time required
An ISO Timestamp indicating when the refund was updated.