Refund all instruments in a transaction

This endpoint requires the transactions.write scope.

Authorizations

Authorization

string

headerrequired

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

Path Parameters

transaction_id

string

required

The ID for the transaction to get the information for.

Body

application/json

A request to fully refund a transaction.

reason

string | null

The reason to refund for. This can be used to attach a written reason to the refund request.

Maximum length: 100

external_identifier

string | null

An external identifier that can be used to match the refund against your own records.

Required string length: 1 - 300

Response

201 - application/json

A list of refunds.

items

object[]

A list of refunds.

items.type

enum<string>

The type of this resource. Is always refund.

Available options:

refund

items.id

string

The unique ID of the refund.

items.transaction_id

string

The ID of the transaction associated with this refund.

items.payment_service_refund_id

string

The payment service's unique ID for the refund.

items.status

enum<string>

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

items.currency

string

The currency code for this refund. Will always match that of the associated transaction.

items.amount

integer

The amount requested for this refund.

Required range: 0 < x < 99999999

items.reason

string | null

The reason for this refund. Could be a multiline string.

Maximum length: 100

items.created_at

string

The date and time when this refund was created.

items.updated_at

string

The date and time when this refund was last updated.

items.target_type

enum<string>

The type of the instrument that was refunded.

Available options:

payment-method,

gift-card-redemption

items.target_id

string | null

The optional ID of the instrument that was refunded. This may be null if the instrument was not stored.

items.external_identifier

string | null

An external identifier that can be used to match the refund against your own records.

Required string length: 1 - 300

items.reconciliation_id

string

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.

items.transaction_external_identifier

string | null

The external identifier of the related transaction.

items.transaction_reconciliation_id

string

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.

limit

integer

default: 20

The limit applied to request. This represents the number of items that are at maximum returned by this request.

Required range: 1 < x < 100

next_cursor

string | null

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

previous_cursor

string | null

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

Payments

Instruments

Vault

Connections

Dashboard

Errors

Refund all instruments in a transaction

Authorizations

Path Parameters

Body

Response