Skip to main content
GET /service/payments/link

Retrieves all pay-by-links

Query Parameters
    state LinkState

    Possible values: [enabled, disabled, consumed, expired]

    created_from date
    created_to date
    expired_from date
    expired_to date
    locked_until_from date-time
    locked_until_to date-time
    environment Environment

    Possible values: [production, sandbox]

    pointOfSaleId integer
    name string
    description string
    amount decimal
    currency string
Responses

OK

Schema
  • Array [
    • id LinkId
    point_of_sale_code PointOfSaleCode

    Point of sale code

    environment Environment

    Possible values: [production, sandbox]

    Environment processing the payment transaction. This can be either the sandbox or the production environment.

    state LinkState

    Possible values: [enabled, disabled, consumed, expired]

    Current state of the pay-by-link:

    • enabled: Link is active and can be used by customers
    • disabled: Link has been manually disabled
    • consumed: Single-use link that was successfully paid — permanently blocked
    • expired: Link has passed its expiration date
    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]

    Controls how many times the link can be used:

    • single: Link can only be used once; transitions to consumed after a successful payment. A failed or abandoned payment releases the lock and allows a retry.
    • multiple: Link can be reused indefinitely, subject to the expiration date.
    type LinkType

    Possible values: [payment, accountInfo]

    The dialog type shown when the link is opened:

    • payment: Opens the payment dialog
    • accountInfo: Opens the account info dialog
    name string
    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

    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.

    locked_until date-time

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

  • ]
Loading...