GET /payment/link/:linkId

Get pay by link

Get a specific pay by link by id

Path Parameters

linkId string required

Id of payment link

Responses

• 200
• 401
• 404

---

Returns a pay by link

application/json

Schema

Example (from schema)

---

Schema

id LinkId
point_of_sale_id PointOfSaleId

Point of sale unique id

state LinkState

Possible values: [enabled, disabled, accepted]

created date-time

RFC 3339 date time format (2007-11-06T16:34:41.000Z)

updated date-time

RFC 3339 date time format (2007-11-06T16:34:41.000Z)

expires_on date-time

RFC 3339 date time format (2007-11-06T16:34:41.000Z)

reuse LinkReuse

Possible values: [single, multiple]

description string
amount decimal

Amount of transaction in format: 0.00 without thousand separator, exact to two decimal places. NOTE: If amount is provided with more than two decimal places then amount will be rounded to two decimal paces.

currency CurrencyCode

ISO 4217 currency code.

country CountryCode

Payment provider country code (ISO 3166 alpha-2 codes)

data object[]
Additional internal data to be stored alongside payment. This can be internal shopping basked id, customer profile id, or any other information to link payment to an internal process.
Array [
key string
unique key of internally stored data. For instance basked_id, customer_id ...
value string
value of internally stored data.
]
locale Locale

Two letter ISO 639-1 language/locale code.

{
  "id": "string",
  "point_of_sale_id": "my-point-of-sale-123",
  "state": "enabled",
  "created": "2025-10-30T15:47:48.724Z",
  "updated": "2025-10-30T15:47:48.724Z",
  "expires_on": "2025-10-30T15:47:48.724Z",
  "reuse": "single",
  "description": "string",
  "amount": 12.3,
  "currency": "EUR",
  "country": "AT",
  "data": [
    {
      "key": "customer_id",
      "value": "external_id_1234"
    }
  ],
  "locale": "en"
}

Unauthorized

application/json

Schema

Example (from schema)

Example

---

Schema

errorMessage string required

Description of error

errorCode ErrorCode required

Possible values: [invalid_parameter, unauthorized, forbidden, not_found, not_allowed, bad_request, other]

Error code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}

errorSubCode ErrorSubCode

Possible values: [api_key_secret_header_must_be_provided, authorization_header_must_be_provided, domain_not_allowed, access_not_allowed, access_token_expired, invalid_access_scope, not_authorized, phone_or_email_not_registered, phone_number_start_with_plus_and_country, phone_number_invalid, email_invalid, email_or_phone_number_required, invalid_pin, could_not_interpret_numbers_after_plus, supplied_string_not_phone_number, string_supplied_too_short_to_be_phone_number, string_supplied_too_long_to_be_phone_number, string_supplied_was_too_long_to_parse, unspecified]

Error sub code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}#{errorSubCode}

documentationUrl uri

Link to documentation if available, typically https://documentation.fliqa.io/api/errors/{errorCode}

requestId RequestId

Unique request id

resourceId ResourceId

Unique resource id

{
  "errorMessage": "string",
  "errorCode": "unauthorized",
  "errorSubCode": "phone_or_email_not_registered",
  "documentationUrl": "string",
  "requestId": "554099e7d0b648d7b96bc31c148425b8",
  "resourceId": "a683072aeeb746d58aa34dd5537c4aae"
}

{
  "errorCode": "unauthorized",
  "errorMessage": "Not authorized",
  "documentationUrl": "https://documentation.fliqa.io/api/errors/unauthorized"
}

Pay by link not found

application/json

Schema

Example (from schema)

Example

---

Schema

errorMessage string required

Description of error

errorCode ErrorCode required

Possible values: [invalid_parameter, unauthorized, forbidden, not_found, not_allowed, bad_request, other]

Error code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}

errorSubCode ErrorSubCode

Possible values: [api_key_secret_header_must_be_provided, authorization_header_must_be_provided, domain_not_allowed, access_not_allowed, access_token_expired, invalid_access_scope, not_authorized, phone_or_email_not_registered, phone_number_start_with_plus_and_country, phone_number_invalid, email_invalid, email_or_phone_number_required, invalid_pin, could_not_interpret_numbers_after_plus, supplied_string_not_phone_number, string_supplied_too_short_to_be_phone_number, string_supplied_too_long_to_be_phone_number, string_supplied_was_too_long_to_parse, unspecified]

Error sub code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}#{errorSubCode}

documentationUrl uri

Link to documentation if available, typically https://documentation.fliqa.io/api/errors/{errorCode}

requestId RequestId

Unique request id

resourceId ResourceId

Unique resource id

{
  "errorMessage": "string",
  "errorCode": "unauthorized",
  "errorSubCode": "phone_or_email_not_registered",
  "documentationUrl": "string",
  "requestId": "554099e7d0b648d7b96bc31c148425b8",
  "resourceId": "a683072aeeb746d58aa34dd5537c4aae"
}

{
  "errorCode": "not_found",
  "errorMessage": "Can't find pay by link '123-123-123'",
  "documentationUrl": "https://documentation.fliqa.io/api/errors/not_found"
}

Loading...