payment
refund

List all refunds

Changed on
get/payment/{connection_id}/refund

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/payment/{connection_id}/refund
  • Auth: API key in header authorization

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

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

total_amountnumber
payment_idstring

(reference to PaymentPayment)

currencystring
notesstring
status'SUCCEEDED' | 'PENDING' | 'FAILED' | 'CANCELED'
referencestring
refunded_atstring date-time

Date and time the refund occurred (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

reason'DUPLICATE' | 'FRAUDULENT' | 'REQUESTED_BY_CUSTOMER' | 'OTHER'

Why the refund was issued

tender_type'CARD' | 'CASH' | 'GIFT_CARD' | 'BANK_TRANSFER' | 'WALLET' | 'CHECK' | 'STORE_CREDIT' | 'BUY_NOW_PAY_LATER' | 'EXTERNAL' | 'OTHER'

Normalized tender category the refund was returned to; mirrors PaymentPayment.tender_type

rawobject

Changes

  • 39502239a975Revision changes
    • info

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

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status