curl --request POST \
--url https://sandbox-api.borderless.xyz/v1/transactions/{id}/refund \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"supported": true,
"requiresManualAction": true,
"destination": {},
"reason": {},
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z"
}Manually dispatch a refund for a failed or cancelled transaction
Starts the refund workflow for the transaction’s existing RefundPlan. Bypasses the autoRefund: false preference, so this is the way to trigger refunds for transactions that were created with auto-refund disabled. Optionally accepts a refundDestination override which is validated against the PFI capability and replaces the stored destination before dispatch. Only plans in Created or Eligible status can be dispatched manually.
curl --request POST \
--url https://sandbox-api.borderless.xyz/v1/transactions/{id}/refund \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"supported": true,
"requiresManualAction": true,
"destination": {},
"reason": {},
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z"
}Documentation Index
Fetch the complete documentation index at: https://docs.borderless.xyz/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
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.
Show child attributes
Show child attributes
Response
Refund workflow dispatched. Returns the current RefundResolution.
InlineProvider, ProviderBalance, SourceReturn, ProviderObserved, ManualRequired, Unsupported, NotNeeded Created, Eligible, InProgress, Succeeded, Failed, Blocked, ManualRequired, Unsupported, NotNeeded, Cancelled None, PollOnly, WebhookOnly, WebhookAndPoll, SubmitAndPoll, SubmitAndWebhook, Manual None, PerTransaction, OrganizationDefault, OriginalSender, ProviderLocked, Manual Was this page helpful?