Sign in
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
refunded_atstring date-time
reason'DUPLICATE' | 'FRAUDULENT' | 'REQUESTED_BY_CUSTOMER' | 'OTHER'
tender_type'CARD' | 'CASH' | 'GIFT_CARD' | 'BANK_TRANSFER' | 'WALLET' | 'CHECK' | 'STORE_CREDIT' | 'BUY_NOW_PAY_LATER' | 'EXTERNAL' | 'OTHER'
rawobject

Changes

Changed in 1 of the 34 revisions of this API.6

  • 669f9277e1736See the full diff
    • ○

      added the enum value reason to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the enum value refunded_at to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the enum value tender_type to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added