API explorerPay APIsData APIs

Theme switcher

List Links

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
filterobject

Filter criteria for listing payment links. All filters are optional and combined with AND logic.

ShowΒ child attributes

paginationobject

Pagination parameters for list endpoints using keyset-based pagination. Keyset pagination provides stable, efficient pagination that works well with large datasets and concurrent updates.

ShowΒ child attributes

Response

200
Object
Links retrieved successfully

Response Attributes

api_client_appstring

Name of the API client application

client_idstring

API client identifier

request_idstring

Unique identifier for the API request

linksarray

List of payment links matching the filter criteria

ShowΒ child attributes

paginationobject

Pagination metadata included in list responses

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