Handle Redirect
Handles the callback redirect from the bank's SCA authentication flow.
Used primarily for direct_sca payment flows where the bank redirects back
with an authorization code.
Execution Modes
- Async (default): Returns immediately with status
redirect_in_progress - Sync: Waits for final payment status (completed, failed, or submitted)
Response Status Codes
200: Redirect processed successfully201: Redirect already processed (idempotent retry)202: Redirect in progress (async mode or concurrent request)
Note: This endpoint is available for selected customers only (licensed entities).
Body Parameters
API client identifier
API client secret for authentication. Required for internal (non-OAuth2) authentication mode (e.g., test-only). Not required when using OAuth2 (Bearer token) authentication.
The query string received from the payment provider callback.
Must contain a state parameter for session identification.
Whether to wait for the payment to reach a final status.
false(default): Returns immediately with current statustrue: Waits for completed, failed, or submitted status
Response
Response Attributes
Current payment status or redirect status:
redirect_in_progress: Redirect is being processed- Other values: See LinkStatus enum
Name of the API client application
Internal UUID identifier for the payment link
Public identifier for the link
Unique identifier for the API request
Response Attributes
Current payment status or redirect status:
redirect_in_progress: Redirect is being processed- Other values: See LinkStatus enum
Name of the API client application
Internal UUID identifier for the payment link
Public identifier for the link
Unique identifier for the API request
Response Attributes
Current payment status or redirect status:
redirect_in_progress: Redirect is being processed- Other values: See LinkStatus enum
Name of the API client application
Internal UUID identifier for the payment link
Public identifier for the link
Unique identifier for the API request
Response Attributes
Unique identifier for this error instance
Request identifier for tracking and correlation
Machine-readable error code for 400 errors:
bad_request: Generic validation or request errorvalidation_error: Request payload validation failedinvalid_input: Invalid input data providedunprocessable_entity: Valid request but cannot be processedcooldown_failed: Data refresh cooldown period not yet elapsedconsent_not_active: Consent is not usable...
bad_requestvalidation_errorinvalid_inputunprocessable_entitycooldown_failedconsent_not_activemethod_selection_errormethod_input_validation_errorlink_expiredHuman-readable error message
Response Attributes
Unique identifier for this error instance
Request identifier for tracking and correlation
Machine-readable error code for 401 errors:
unauthorized: Authentication failed or insufficient permissions
unauthorizedHuman-readable error message