This endpoint requires the transactions.read scope.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The ID for the transaction to get the information for.
The amount requested for this refund.
Required range: 0 < x < 99999999
The date and time when this refund was created.
The currency code for this refund.
Will always match that of the associated transaction.
items. external_identifier
An external identifier that can be used to match the refund against your
own records.
Required string length: 1 - 300
The unique ID of the refund.
items. payment_service_refund_id
The payment service's unique ID for the refund.
The reason for this refund.
Could be a multiline string.
Maximum length: 100
The base62 encoded refund ID. This represents a shorter version
of this refund's id which is sent to payment services, anti-fraud services,
and other connectors. You can use this ID to reconcile a payment service's
refund against our system.
The status of the refund.
It may change over time as asynchronous processing events occur.
processing - The refund is being processed.succeeded - The refund was successful.declined - The refund was declined by the underlying PSP.failed - The refund could not proceed due to a technical issue.voided - The refund was voided and will not proceed. Available options:
processing,
succeeded,
declined,
failed,
voided
The optional ID of the instrument that was refunded. This may be null if
the instrument was not stored.
The type of the instrument that was refunded.
Available options:
payment-method,
gift-card-redemption
items. transaction_external_identifier
The external identifier of the related transaction.
The ID of the transaction associated with this refund.
items. transaction_reconciliation_id
The base62 encoded transaction ID. This represents a shorter version
of the related transaction's id which is sent to payment services,
anti-fraud services, and other connectors. You can use this ID to
reconcile a payment service's transaction against our system.
The type of this resource. Is always refund.
Available options:
refund
The date and time when this refund was last updated.
The limit applied to request. This represents the number of items that are at
maximum returned by this request.
Required range: 1 < x < 100
The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.
Required string length: 1 - 1000
The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.
Required string length: 1 - 1000
