Refunds
Refund all instruments in a transaction
Refunds a transaction fully across all instruments.
POST
/
transactions
/
{transaction_id}
/
refunds
/
all
This endpoint requires the transactions.write
scope.
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
transaction_id
string
requiredThe ID for the transaction to get the information for.
Body
application/json
reason
string | null
The reason to refund for. This can be used to attach a written reason to the refund request.
Response
201 - application/json
items
object[]
A list of refunds.
limit
integer
default: 20The limit applied to request. This represents the number of items that are at maximum returned by this request.
next_cursor
string | null
The cursor that represents the next page of results. Use the cursor
query
parameter to fetch this page of items.
previous_cursor
string | null
The cursor that represents the next page of results. Use the cursor
query
parameter to fetch this page of items.
Was this page helpful?