Skip to main content
POST
Manually dispatch a refund for a failed or cancelled transaction

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json
refundDestination
object

Optional override for the refund destination. When provided, replaces the stored RefundPlan.destination before the workflow is dispatched. The override is re-validated against the PFI's refund capability using the same rules as on transaction creation.

Response

202 - application/json

Refund workflow dispatched. Returns the current RefundResolution.

supported
boolean
required
requiresManualAction
boolean
required
path
enum<string>
required
Available options:
InlineProvider,
ProviderBalance,
SourceReturn,
ProviderObserved,
ManualRequired,
Unsupported,
NotNeeded
status
enum<string>
required
Available options:
Created,
Eligible,
InProgress,
Succeeded,
Failed,
Blocked,
ManualRequired,
Unsupported,
NotNeeded,
Cancelled
dispatchMode
enum<string>
required
Available options:
None,
PollOnly,
WebhookOnly,
WebhookAndPoll,
SubmitAndPoll,
SubmitAndWebhook,
Manual
destinationSource
enum<string>
required
Available options:
None,
PerTransaction,
OrganizationDefault,
OriginalSender,
ProviderLocked,
Manual
destination
object | null
reason
object | null
completedAt
string<date-time> | null
failedAt
string<date-time> | null