---
title: "Get payment session"
method: GET
path: "/api/sites/multiscreen/{site_name}/ecommerce/payment-sessions/{id}"
tags: ["Payment Gateways Runtime"]
---

# Get payment session

`GET /api/sites/multiscreen/{site_name}/ecommerce/payment-sessions/{id}`

## Request

- Base URL: `https://api.duda.co`
- URL: `https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/payment-sessions/{id}`
- Auth: HTTP basic

Returns the payment session with the given id, including its mode, cancel URL, and associated invoice.

## Path parameters

- `site_name` string, required
- `id` string, required

## Response `200`

OK

- PaymentSessionOutputDto
  - `id` string: System identifier of the payment session
  - `mode` 'LIVE' | 'TEST'
  - `cancel_url` string: URL to redirect the user to in case of cancellation
  - `invoice` InvoiceOutputDto
    - `target_id` string: Target ID associated to the invoice
    - `purchase_id` string: Target ID associated to the invoice
    - `purchase_type` string: Type of the purchase associated to the invoice
    - `email` string: Email address of the customer
    - `language` string: Language of the customer
    - `currency` string: Currency of the invoice
    - `total` number, double: Total amount of the invoice
    - `shipping_address` AddressOutputDto
      - `name` string, nullable
      - `first_name` string, nullable: First Name attached to the address.
      - `last_name` string, nullable: Last Name attached to the address.
      - `full_name` string, nullable: Full Name attached to the address.
      - `address_1` string, nullable: The first line of the address.
      - `address_2` string, nullable: The second line of the address.
      - `street_number` string, nullable: The street number Note: this may be part of the address1 or address_2 values, but is available here as a separate value._
      - `street_name` string, nullable: The street name Note: this may be part of the address1 or address_2 values, but is available here as a separate value._
      - `city` string, nullable: Name of city attached to the address.
      - `sub_locality` string, nullable: Sub-locality attached to the address (ex: county or district name).
      - `region` string, nullable: Region attached to the address (ex. the state or province name).
      - `country` string, nullable: Country attached to the address.
      - `postal_code` string, nullable: Postal code attached to the address.
      - `phone` string, nullable: Phone number of contact located at this address.
    - `billing_address` AddressOutputDto
      - `name` string, nullable
      - `first_name` string, nullable: First Name attached to the address.
      - `last_name` string, nullable: Last Name attached to the address.
      - `full_name` string, nullable: Full Name attached to the address.
      - `address_1` string, nullable: The first line of the address.
      - `address_2` string, nullable: The second line of the address.
      - `street_number` string, nullable: The street number Note: this may be part of the address1 or address_2 values, but is available here as a separate value._
      - `street_name` string, nullable: The street name Note: this may be part of the address1 or address_2 values, but is available here as a separate value._
      - `city` string, nullable: Name of city attached to the address.
      - `sub_locality` string, nullable: Sub-locality attached to the address (ex: county or district name).
      - `region` string, nullable: Region attached to the address (ex. the state or province name).
      - `country` string, nullable: Country attached to the address.
      - `postal_code` string, nullable: Postal code attached to the address.
      - `phone` string, nullable: Phone number of contact located at this address.
    - `items` InvoiceItemOutputDto[], nullable: Items of the invoice
      - `type` 'PHYSICAL' | 'DIGITAL' | 'TAX' | 'SHIPPING' | 'DISCOUNT' | 'BOOKING' | 'MEMBERSHIP' | 'AD_HOC'
      - `name` string: Name of the invoice line item
      - `unit_price` number, double, nullable: Price per unit of the invoice line item
      - `quantity` integer, nullable: Quantity of the invoice line item
      - `discount_amount` number, double: Amount discounted from the original price of the invoice line item
      - `total` number, double: Total for the invoice line item
  - `site_name` string, nullable: Enterprise specific property that is only fronted if the feature flag is opened
  - `site_external_id` string, nullable: Enterprise specific property that is only fronted if the feature flag is opened

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Content
- `429`: Too many requests. The rate limit was exceeded.

---

[API](https://skmtc.dev/duda/apis/duda-partner-api.md) - [All operations](https://skmtc.dev/duda/apis/duda-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/duda/apis/duda-partner-api/revisions/52be4d41cb12?raw)