---
title: "Get payment link by id."
method: GET
path: "/v1/payment-links/{linkId}"
tags: ["Link Management"]
---

# Get payment link by id.

`GET /v1/payment-links/{linkId}`

## Path parameters

- `linkId` string, required

## Response `200`

default response

- LinkResponse
  - `accountId` string — identifier for the subaccount
  - `active` boolean — link activation status
  - `amount` integer — total amount of all shopping cart items in lowest denomination
  - `backgroundImage` string, css — backgroundImage css property
  - `billing` AddressDataDto
    - `addressAddition` string — customer additional address line
    - `city` string — customer city
    - `company` string — customer company name
    - `country` string — customer country code (2 letter ISO-3166 code)
    - `firstName` string — customer first name
    - `lastName` string — customer last name
    - `state` string — customer state code
    - `street` string — customer street name
    - `zip` string — customer postcode
  - `created` integer — created time in ISO 8601 format
  - `currency` 'ALL' | 'DZD' | 'ARS' | 'AUD' | 'BSD' | 'BHD' | 'BDT' | 'AMD' | 'BBD' | 'BMD' | 'BTN' | 'BOB' | 'BWP' | 'BZD' | 'SBD' | 'BND' | 'MMK' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'KYD' | 'LKR' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'SVC' | 'ETB' | 'ERN' | 'FKP' | 'FJD' | 'DJF' | 'GMD' | 'GIP' | 'GTQ' | 'GNF' | 'GYD' | 'HTG' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'KZT' | 'JOD' | 'KES' | 'KPW' | 'KRW' | 'KWD' | 'KGS' | 'LAK' | 'LBP' | 'LSL' | 'LRD' | 'LYD' | 'MOP' | 'MWK' | 'MYR' | 'MVR' | 'MUR' | 'MXN' | 'MNT' | 'MDL' | 'MAD' | 'OMR' | 'NAD' | 'NPR' | 'ANG' | 'AWG' | 'VUV' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'PKR' | 'PAB' | 'PGK' | 'PYG' | 'PEN' | 'PHP' | 'QAR' | 'RUB' | 'RWF' | 'SHP' | 'SAR' | 'SCR' | 'SLL' | 'SGD' | 'VND' | 'SOS' | 'ZAR' | 'SSP' | 'SZL' | 'SEK' | 'CHF' | 'SYP' | 'THB' | 'TOP' | 'TTD' | 'AED' | 'TND' | 'UGX' | 'MKD' | 'EGP' | 'GBP' | 'TZS' | 'USD' | 'UYU' | 'UZS' | 'WST' | 'YER' | 'TWD' | 'UYW' | 'VES' | 'MRU' | 'STN' | 'CUC' | 'ZWL' | 'BYN' | 'TMT' | 'GHS' | 'SDG' | 'UYI' | 'RSD' | 'MZN' | 'AZN' | 'RON' | 'CHE' | 'CHW' | 'TRY' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XAU' | 'XDR' | 'XAG' | 'XPT' | 'XTS' | 'XPD' | 'XUA' | 'ZMW' | 'SRD' | 'MGA' | 'COU' | 'AFN' | 'TJS' | 'AOA' | 'BGN' | 'CDF' | 'BAM' | 'EUR' | 'MXV' | 'UAH' | 'GEL' | 'BOV' | 'PLN' | 'BRL' | 'CLF' | 'XSU' | 'USN' — currency code
  - `description` string — free format description of the payment
  - `email` string — customer email for invoices or payment notification
  - `errorUrl` string — final redirect after a failed payment
  - `expiration` string, date — link expiration date, the link will only be executable until end of that day
  - `hash` string — hash for the client API
  - `id` string — link id
  - `intent` 'authorization' | 'preauthorization' — designates the type of transaction that will be created
  - `invoiceInformation` InvoiceInformationDto — relevant information for the invoice module
    - `invoiceId` string — id that should be put on the invoice
    - `invoiceText` string — short text that should be put after the invoice
  - `language` 'de_DE' | 'en_US' — link ISO language code
  - `link` string — customer payment link
  - `logo` string, url — logo url
  - `merchantId` string — identifier for the merchant
  - `mode` 'live' | 'test' — execution mode
  - `modified` integer — last modified time in ISO 8601 format
  - `notifyUrl` string — notify url. If unset no notification will be send
  - `paymentMethod` 'visa' | 'mastercard' | 'amex' | 'paypal' | 'sofort' | 'paydirekt' | 'postfinance-e' | 'postfinance-card' | 'bancontact' | 'przelewy24' | 'alipay' | 'ideal' | 'eps' | 'giropay' | 'sepa' — available payment methods
  - `paymentMethods` string[] — list of available payment methods
  - `paymentProcess` string — identifier of the created payment process.
  - `portalId` string — identifier for the portal
  - `redirectUrl` string — redirect url. empty if the payment process does not require a redirect.
  - `reference` string — payment reference number, has to be unique per merchant and mode
  - `shipping` AddressDataDto
    - `addressAddition` string — customer additional address line
    - `city` string — customer city
    - `company` string — customer company name
    - `country` string — customer country code (2 letter ISO-3166 code)
    - `firstName` string — customer first name
    - `lastName` string — customer last name
    - `state` string — customer state code
    - `street` string — customer street name
    - `zip` string — customer postcode
  - `shoppingCart` CartItemDto[]
    - `deliveryDateEnd` string, date — delivery period end date
    - `deliveryDateStart` string, date — delivery date
    - `description` string — item description
    - `number` string, required — item number
    - `price` integer, required — gross price of single item
    - `quantity` integer, required — total number of ordered items
    - `type` 'goods' | 'shipment' | 'handling' | 'voucher', required — item type
    - `vatRate` integer — vat rate (<100 in %, >=100 in bp)
  - `status` 'ready' | 'created' | 'executed' | 'expired' | 'deactivated' — link status
  - `successUrl` string — final redirect after a successful payment
  - `userId` string — identifier of the created user.

---

[API](https://skmtc.net/pay1/apis/link.md) · [All operations](https://skmtc.net/pay1/apis/link/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pay1/link/versions/badbc6587e86/schema)