Release Notes for Incoming Transfer Return Flow

A new return initiation capability has been introduced for existing Incoming Transfers via the returnContext object.

Key Highlights

• Added returnContext object to the Incoming Transfer response model.
• Returns can now be triggered by PATCH /incoming-transfers/{id}.
• The return process is state-driven and initiated by setting:
  • returnContext.status = processing
  • returnContext.reason = {valid_reason}

Return Context Fields

The new returnContext object includes:

• enabled – Indicates whether a return is allowed (read-only).
• cutOffDateTime – Last date-time when a return can be initiated (read-only).
• status – Current return lifecycle status (processing, released, completed, failed).
• reason – Mandatory reason code for initiating a return.

Eligibility Conditions

A return can be initiated only when:

• returnContext.enabled = true
• Incoming Transfer status is completed or failed
• cutOffDateTime (if present) has not passed
• A valid return reason is provided

Return Reasons

Supported return reason codes include:

• account-inactivated
• account-closed
• account-not-found
• user-requested
• user-requested-duplicate
• user-requested-wrong-amount
• sender-recalled
• rejected-by-compliance

For the full integration flow, see the Return Incoming Transfer