API ReferenceRefunds

Fetch Refund

Fetch a refund

Required OAuth 2.0 scope: business/orders:read

Path parameters

refund_idstringRequired>=1 character<=100 characters
The unique identifier of the refund.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful Response
created_atstringformat: "date-time"
The refund creation date and time in ISO 8601 format.
currencystring
The currency code in ISO 4217 format.
display_namestring

A human-friendly label for the refund.

idstring
The unique identifier of the refund.
notestring or null
An optional note attached to the refund.
order_idstring or null
A reference to the original order.
order_numberstring or null

A human-friendly identifier for the order.

payment_idstring
A reference to the original payment.
payment_methodenum
The method used to refund the payment.
Allowed values:
processed_atstring or nullformat: "date-time"
The date and time the refund was processed in ISO 8601 format.
processing_feeslist of objects
The transaction fees that have been charged against the refund.
receipt_numberstring
The receipt number of the refund.
refund_typeenum
The type of refund.
Allowed values:
refunded_processing_feeslist of objects
The transaction fees that have been refunded.
statusenum
The current state of the refund.
Allowed values:
total_amountobject
The amount of money refunded to the buyer.
updated_atstring or nullformat: "date-time"
The date and time the refund was last modified in ISO 8601 format.

Errors