API explorerPay APIsData APIs
API explorer
Pay APIs
Data APIs

Theme switcher

Get Link

Retrieves detailed information about a specific payment link. Returns the current status, expiration, selected payment method, and service provider details.

Response Fields

  • status: Current payment status (see LinkStatus enum for possible values)
  • is_expired: Whether the link has expired
  • payment_method: Details of the selected payment method (if user has selected one)
  • service_provider: Details of the selected bank (if user has selected one)

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

URL for completing the payment (null for direct_sca type)

Nullable:
True
request_idstring

Unique identifier for the API request

payment_methodobject

Selected payment method details (available after user selection)

Nullable:
True

Show child attributes

service_providerobject

Selected bank/provider details (available after user selection)

Nullable:
True

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
  • unprocessable_entity: Valid request but cannot be processed
  • cooldown_failed: Data refresh cooldown period not yet elapsed
  • consent_not_active: Consent is not usable...
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

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?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

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