--- title: "Get Payment Link details" method: GET path: "/payment-links/{id}" tags: ["Payment Links"] --- # Get Payment Link details `GET /payment-links/{id}` ## Request - Base URL: `https://{prefix}.api.sandbox.checkout.com` - URL: `https://{prefix}.api.sandbox.checkout.com/payment-links/{id}` - Auth: API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieve details about a specific Payment Link using its ID returned when the link was created. In the response, you will see the status of the Payment Link.

For more information, see the Payment Links documentation. ## Path parameters - `id` string, required: The unique identifier for a Payment Link. ## Response `200` Payment Link details retrieved successfully - union - object: A Payment Link that is active and can accept a payment from a customer. - `id` string, required: The unique identifier for a Payment Link. - `status` 'Active', required: The status of the Payment Link: - `Active`: The Payment Link can accept a payment from the customer. A payment may have been attempted by the customer but not completed successfully. - `Payment Received`: A payment has been received successfully using this Payment Link. - `Expired`: The Payment Link has expired and can no longer be accessed. - `payment_id` string: Unique identifier for an in progress or completed payment for this Payment Link. - `amount` integer, required: The original payment amount. - `currency` string, required: The three-letter ISO currency code of the payment.
- `reference` string: Your reference for the payment. - `description` string: A description of the payment. - `created_on` string, date-time, required: The date and time when the Payment Link was created. - `expires_on` string, date-time, required: The date and time when the Payment Link expires. - `processing_channel_id` string: The processing channel to be used for the payment - `amount_allocations` object[]: The sub-entities that the payment is being processed on behalf of - `id` string, required: The id of the sub-entity. - `amount` integer, required: The split amount - this will be credited to your sub-entity's currency account. The sum of all split amounts must be equal to the payment amount. The amount must be provided in the minor currency unit. - `reference` string: A reference you can later use to identify this split, such as an order number. - `commission` object: Commission you'd like to collect from this split - this will be credited to your currency account. The commission cannot exceed the split amount. Commission = (`amount` * `commission.percentage`) + `commission.amount` - `amount` integer: Optional fixed amount of commission to collect. The amount must be provided in the minor currency unit. - `percentage` number: Optional percentage of commission to collect. Supports up to 8 decimal places. - `customer` object: The customer's details. - `email` string, email: The email address for the customer. - `name` string: The customer's name. - `shipping` object: The address any products are being sent to. - `address` object, required: The customer's address to ship to. - `address_line1` string: The first line of the address. - `address_line2` string: The second line of the address.

For SEPA payments, this value has a maximum length of 10 characters. - `city` string: The address city. - `state` string: The state or province of the address country ISO 3166-2 code (for example: CA for California in the United States). - `zip` string: The address zip or postal code. - `country` string, required: The two-letter ISO country code of the address. - `phone` object: The customer's phone number. - `country_code` string: The international country calling code. Required if `source.type` is `tamara`. - `number` string, required: The phone number. Required if `source.type` is `tamara`. - `products` object[]: Contains details about the products in the order. - `reference` string: The item reference or product stock keeping unit (SKU). - `url` string: Link to the line item's product page. - `name` string, required: The descriptive name of the line item. - `quantity` integer, required: The number of line items. - `price` integer, required: The price per item in minor units, including tax but excluding discounts. The exact format depends on the currency. See Calculating the amount. - `metadata` object: Any additional information stored at the point of creation. - `locale` 'ar' | 'da-DK' | 'de-DE' | 'el' | 'en-GB' | 'es-ES' | 'fi-FI' | 'fil-PH' | 'fr-FR' | 'hi-IN' | 'id-ID' | 'it-IT' | 'ja-JP' | 'ms-MY' | 'nb-NO' | 'nl-NL' | 'pt-PT' | 'sv-SE' | 'th-TH' | 'vi-VN' | 'zh-CN' | 'zh-HK' | 'zh-TW': The language that the Payment Link page is displayed in. - `return_url` string, uri: If provided, the success page will include a button that redirects your customer to the provided URL. - `_links` object, required: The links related to the Payment Link. - `self` object, required: The URI of the Payment Link details. - `href` string, required: The link URL - `redirect` object, required: The link to visit the Payment Link page. - `href` string, required: The link URL - `payment` object: The URI of the in progress or completed payment for this Payment Link. - `href` string, required: The link URL - `payment_actions` object: The URI of the actions associated with the in progress or completed payment for this Payment Link. - `href` string, required: The link URL - object: A Payment Link that has received a payment - `id` string, required: The unique identifier for a Payment Link. - `status` 'Payment Received', required: The status of the Payment Link: - `Active`: The Payment Link can accept a payment from the customer. A payment may have been attempted by the customer but not completed successfully. - `Payment Received`: A payment has been received successfully using this Payment Link. - `Expired`: The Payment Link has expired and can no longer be accessed. - `payment_id` string, required: Unique identifier for an in progress or completed payment for this Payment Link. - `amount` integer, required: The original payment amount. - `currency` string, required: The three-letter ISO currency code of the payment.
- `reference` string: Your reference for the payment. - `description` string: A description of the payment. - `created_on` string, date-time, required: The date and time when the Payment Link was created. - `expires_on` string, date-time, required: The date and time when the Payment Link expires. - `processing_channel_id` string: The processing channel to be used for the payment - `amount_allocations` object[]: The sub-entities that the payment is being processed on behalf of - `id` string, required: The id of the sub-entity. - `amount` integer, required: The split amount - this will be credited to your sub-entity's currency account. The sum of all split amounts must be equal to the payment amount. The amount must be provided in the minor currency unit. - `reference` string: A reference you can later use to identify this split, such as an order number. - `commission` object: Commission you'd like to collect from this split - this will be credited to your currency account. The commission cannot exceed the split amount. Commission = (`amount` * `commission.percentage`) + `commission.amount` - `amount` integer: Optional fixed amount of commission to collect. The amount must be provided in the minor currency unit. - `percentage` number: Optional percentage of commission to collect. Supports up to 8 decimal places. - `customer` object: The customer's details. - `email` string, email: The email address for the customer. - `name` string: The customer's name. - `shipping` object: The address any products are being sent to. - `address` object, required: The customer's address to ship to. - `address_line1` string: The first line of the address. - `address_line2` string: The second line of the address.

For SEPA payments, this value has a maximum length of 10 characters. - `city` string: The address city. - `state` string: The state or province of the address country ISO 3166-2 code (for example: CA for California in the United States). - `zip` string: The address zip or postal code. - `country` string, required: The two-letter ISO country code of the address. - `phone` object: The customer's phone number. - `country_code` string: The international country calling code. Required if `source.type` is `tamara`. - `number` string, required: The phone number. Required if `source.type` is `tamara`. - `products` object[]: Contains details about the products in the order. - `reference` string: The item reference or product stock keeping unit (SKU). - `url` string: Link to the line item's product page. - `name` string, required: The descriptive name of the line item. - `quantity` integer, required: The number of line items. - `price` integer, required: The price per item in minor units, including tax but excluding discounts. The exact format depends on the currency. See Calculating the amount. - `metadata` object: Any additional information stored at the point of creation. - `locale` 'ar' | 'da-DK' | 'de-DE' | 'el' | 'en-GB' | 'es-ES' | 'fi-FI' | 'fil-PH' | 'fr-FR' | 'hi-IN' | 'id-ID' | 'it-IT' | 'ja-JP' | 'ms-MY' | 'nb-NO' | 'nl-NL' | 'pt-PT' | 'sv-SE' | 'th-TH' | 'vi-VN' | 'zh-CN' | 'zh-HK' | 'zh-TW': The language that the Payment Link page is displayed in. - `return_url` string, uri: If provided, the success page will include a button that redirects your customer to the provided URL. - `_links` object, required: The links related to the Payment Link. - `self` object, required: The URI of the Payment Link details. - `href` string, required: The link URL - `redirect` object, required: The link to visit the Payment Link page. - `href` string, required: The link URL - `payment` object: The URI of the in progress or completed payment for this Payment Link. - `href` string, required: The link URL - `payment_actions` object: The URI of the actions associated with the in progress or completed payment for this Payment Link. - `href` string, required: The link URL - object: An expired Payment Link - `id` string, required: The unique identifier for a Payment Link. - `status` 'Expired', required: The status of the Payment Link: - `Active`: The Payment Link can accept a payment from the customer. A payment may have been attempted by the customer but not completed successfully. - `Payment Received`: A payment has been received successfully using this Payment Link. - `Expired`: The Payment Link has expired and can no longer be accessed. - `payment_id` string: Unique identifier for an in progress or completed payment for this Payment Link. - `amount` integer, required: The original payment amount. - `currency` string, required: The three-letter ISO currency code of the payment.
- `reference` string: Your reference for the payment. - `description` string: A description of the payment. - `created_on` string, date-time, required: The date and time when the Payment Link was created. - `expires_on` string, date-time, required: The date and time when the Payment Link expires. - `processing_channel_id` string: The processing channel to be used for the payment - `amount_allocations` object[]: The sub-entities that the payment is being processed on behalf of - `id` string, required: The id of the sub-entity. - `amount` integer, required: The split amount - this will be credited to your sub-entity's currency account. The sum of all split amounts must be equal to the payment amount. The amount must be provided in the minor currency unit. - `reference` string: A reference you can later use to identify this split, such as an order number. - `commission` object: Commission you'd like to collect from this split - this will be credited to your currency account. The commission cannot exceed the split amount. Commission = (`amount` * `commission.percentage`) + `commission.amount` - `amount` integer: Optional fixed amount of commission to collect. The amount must be provided in the minor currency unit. - `percentage` number: Optional percentage of commission to collect. Supports up to 8 decimal places. - `customer` object: The customer's details. - `email` string, email: The email address for the customer. - `name` string: The customer's name. - `shipping` object: The address any products are being sent to. - `address` object, required: The customer's address to ship to. - `address_line1` string: The first line of the address. - `address_line2` string: The second line of the address.