API explorerPay APIsData APIs
API explorer
Pay APIs
Data APIs

Theme switcher

Get Link

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
link_idstring Required

UUID of the payment link to retrieve

Min length
36
Max length
36

Response

200
Object

Link details retrieved successfully

Response Attributes

statusstring

Payment link lifecycle status:

  • created: Link created via API, not yet accessed by user
  • started: Link accessed, payment session created
  • requested: User pressed Pay button, payment intent submission initiated
  • intent_accepted: Payment intent sent and accepted by bank, SCA URL retrieved
  • awaiting_authz: User opened bank SCA URL for authentication
  • received: Bank redirect received, status refresh in progress
  • submitted: Payment flow completed, awaiting final status ...
Enum values:
createdstartedrequestedintent_acceptedawaiting_authzreceivedsubmittedcompletedfailedrevoked
... 2 other enums
expires_atstring

Timestamp when the link expires

is_expiredboolean

Whether the link has expired

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

web_urlstring | null

URL for completing the payment (null for direct_sca type)

request_idstring

Unique identifier for the API request

payment_methodobject | null

Selected payment method details (available after user selection)

Show child attributes

service_providerobject | null

Selected bank/provider details (available after user selection)

Show child attributes

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
  • internal_error: AIS-side unexpected internal error
  • external_api_unavailable: External provider HTTP failure (timeout, connection refused, DNS, etc.). Surfaced as HTTP 400 instead of a gateway 504.
  • external_api_error: External provider returned a structured error during the AIS ...
Enum values:
bad_requestvalidation_errorinvalid_inputinternal_errorexternal_api_unavailableexternal_api_errorcooldown_failedconsent_not_activejob_in_progressmethod_selection_error
... 2 other enums
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

404
Object

Resource not found

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 404 errors:

  • not_found: Generic resource not found
  • consent_not_found: Specified consent does not exist
  • job_not_found: Specified job does not exist or outside accessible date range
Enum values:
not_foundconsent_not_foundjob_not_found
messagestring Required

Human-readable error message

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot