v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
payment
refund

List all refunds

get/payment/{connection_id}/refund

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

payment_idstring

The payment ID to filter by (reference to PaymentPayment)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
total_amountnumber
payment_idstring
currencystring
notesstring
status'SUCCEEDED' | 'PENDING' | 'FAILED' | 'CANCELED'
referencestring
rawobject