payment
refund

Retrieve a refund

get/payment/{connection_id}/refund/{id}

Request

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

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Refund

Query parameters

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

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.