API explorerPay APIsData APIs
API explorer
Pay APIs
Data APIs

Theme switcher

Handle Redirect

Body Parameters

client_idstring Required

API client identifier

Max length
128
client_secretstring

API client secret for authentication. Required for internal (non-OAuth2) authentication mode (e.g., test-only). Not required when using OAuth2 (Bearer token) authentication.

Max length
128
query_stringstring Required

The query string received from the payment provider callback. Must contain a state parameter for session identification.

Pattern
^(?:[^&=]+=[^&]*&)*state=[^&]*(?:&[^&=]+=[^&]*)*$
syncboolean

Whether to wait for the payment to reach a final status.

  • false (default): Returns immediately with current status
  • true: Waits for completed, failed, or submitted status
Default value
false

Response

200
Object
Redirect processed successfully

Response Attributes

statusstring

Current payment status or redirect status:

  • redirect_in_progress: Redirect is being processed
  • Other values: See LinkStatus enum
api_client_appstring

Name of the API client application

link_idstring

Internal UUID identifier for the payment link

web_idstring

Public identifier for the link

request_idstring

Unique identifier for the API request

201
Object
Redirect already processed (duplicate request)

Response Attributes

statusstring

Current payment status or redirect status:

  • redirect_in_progress: Redirect is being processed
  • Other values: See LinkStatus enum
api_client_appstring

Name of the API client application

link_idstring

Internal UUID identifier for the payment link

web_idstring

Public identifier for the link

request_idstring

Unique identifier for the API request

202
Object
Redirect in progress

Response Attributes

statusstring

Current payment status or redirect status:

  • redirect_in_progress: Redirect is being processed
  • Other values: See LinkStatus enum
api_client_appstring

Name of the API client application

link_idstring

Internal UUID identifier for the payment link

web_idstring

Public identifier for the link

request_idstring

Unique identifier for the API request

400
Object
Validation error or invalid request

Response Attributes

error_idstring Required

Unique identifier for this error instance

request_idstring Required

Request identifier for tracking and correlation

codestring Required

Machine-readable error code for 400 errors:

  • bad_request: Generic validation or request error
  • validation_error: Request payload validation failed
  • invalid_input: Invalid input data provided
  • unprocessable_entity: Valid request but cannot be processed
  • cooldown_failed: Data refresh cooldown period not yet elapsed
  • consent_not_active: Consent is not usable for this operation (e.g. expired, revoked, failed, suspended)
  • method_selection_error: No AIS method ma...
Enum values:
bad_requestvalidation_errorinvalid_inputunprocessable_entitycooldown_failedconsent_not_activemethod_selection_errormethod_input_validation_errorlink_expired
messagestring Required

Human-readable error message

401
Object
Authentication failed

Response Attributes

error_idstring Required

Unique identifier for this error instance

request_idstring Required

Request identifier for tracking and correlation

codestring Required

Machine-readable error code for 401 errors:

  • unauthorized: Authentication failed or insufficient permissions
Enum values:
unauthorized
messagestring Required

Human-readable error message

Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot