---
title: "Get session info"
method: GET
path: "/v1/session_info/{id}"
tags: ["session_info"]
---

# Get session info

`GET /v1/session_info/{id}`

## Request

- Base URL: `https://checkout-api.frisbii.com`
- URL: `https://checkout-api.frisbii.com/v1/session_info/{id}`
- Auth: HTTP basic

## Path parameters

- `id` string, required

## Response `200`

Successful operation

- SessionInfo
  - `id` string
  - `type` 'CHARGE' | 'RECURRING' | 'SUBSCRIPTION'
  - `configuration` string
  - `locale` string
  - `expires` string, date-time
  - `charge` string
  - `settle` boolean
  - `recurring` boolean
  - `customer` string
  - `subscription` string
  - `created` string, date-time
  - `currency` 'UNDEFINED' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
  - `agent` string
  - `url` string
  - `phone` string
  - `experimental` boolean
  - `alternativeReturnUrl` string
  - `site` string
  - `cancel_url` string
  - `accept_url` string
  - `payment_methods` string[]
  - `card_on_file` string
  - `card_on_file_require_cvv` boolean
  - `button_text` string
  - `subscription_session_done` boolean
  - `order_text` string
  - `recurring_optional` boolean
  - `recurring_optional_text` string
  - `recurring_average_amount` integer
  - `sca_data` ScaData: Customer data used in strong customer authentication to reduce the need for a lengthy authentication process and ensure less fraud. The data is not stored at Reepay and only used in the process of strong customer authentication. The data is used by card issuer to determine if a frictionless authentication flow can be used.
    - `name` string: Cardholder Name. If not provided information will be taken from customer or invoice addresses.
    - `email` string: Cardholder Email. If not provided information will be taken from customer or invoice addresses. Must be RFC5322 compliant.
    - `home_phone` ScaPhoneNumber: ITU-E.164 phone number. See https://en.wikipedia.org/wiki/E.164
      - `cc` string, required: Country code (1-3 digits). See https://en.wikipedia.org/wiki/List_of_country_calling_codes.
      - `subscriber` string, required: Subscriber number (1-12 digits)
    - `mobile_phone` ScaPhoneNumber: ITU-E.164 phone number. See https://en.wikipedia.org/wiki/E.164
      - `cc` string, required: Country code (1-3 digits). See https://en.wikipedia.org/wiki/List_of_country_calling_codes.
      - `subscriber` string, required: Subscriber number (1-12 digits)
    - `work_phone` ScaPhoneNumber: ITU-E.164 phone number. See https://en.wikipedia.org/wiki/E.164
      - `cc` string, required: Country code (1-3 digits). See https://en.wikipedia.org/wiki/List_of_country_calling_codes.
      - `subscriber` string, required: Subscriber number (1-12 digits)
    - `billing_address` ScaBillingAddress: Cardholder Billing Address. If not provided it will be taken from invoice billing address or customer.
      - `address1` string: Address line 1
      - `address2` string: Address line 2
      - `address3` string: Address line 3
      - `city` string: City
      - `country` string: Country in ISO 3166-1 alpha-2
      - `postal_code` string: Postal code
      - `state_or_province` string: State or province in country subdivision code defined in ISO 3166-2
    - `shipping_address` ScaShippingAddress: Cardholder Shipping Address. If not provided it will be taken from invoice shipping address or customer.
      - `address1` string: Address line 1
      - `address2` string: Address line 2
      - `address3` string: Address line 3
      - `city` string: City
      - `country` string: Country in ISO 3166-1 alpha-2
      - `postal_code` string: Postal code
      - `state_or_province` string: State or province in country subdivision code defined in ISO 3166-2
    - `address_match` boolean: Indicate if Shipping Address and Billing Address are the same
    - `account_id` string: Cardholder Account Identifier. Customer id from own system. If not provided customer handle will be used.
    - `challenge_indicator` 'preference' | 'mandate': Optional argument to control whether the cardholder should be posed with a challenge instead of a potential frictionless authentication flow. This could e.g. be used the first time a new customer makes a purchase to make sure they are strongly authenticated. Two values can be used: `preference` - cardholder should be given a challenge if issuer supports challenges, `mandate` - cardholder must be given a challenge and the authentication should be declined if the issuer does not support challenges.
    - `risk_indicator` ScaRiskIndicator: Optional argument to help the issuer in determining whether to use a frictionless authentication flow. The object represents the assessed level of fraud risk.
      - `delivery_email` string: For Electronic delivery, the email address to which the merchandise was delivered. Must be RFC5322 compliant.
      - `delivery_timeframe` 'electronic' | 'same_day_shipping' | 'overnight_shipping' | 'two_day_or_more_shipping': Indicates the merchandise delivery timeframe: `electronic` - Electronic Delivery, `same_day_shipping` - Same day shipping, `overnight_shipping` - Overnight shipping, `two_day_or_more_shipping` - Two-day or more shipping
      - `gift_card_amount` integer: For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in major units (for example, USD 123.45 is 123).
      - `gift_card_count` integer: For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
      - `gift_card_currency` string: For prepaid or gift card purchase, currency code of the gift card in [ISO 4217](http://da.wikipedia.org/wiki/ISO_4217) three letter alpha code.
      - `pre_order_date` string: For a pre-ordered purchase, the expected local date that the merchandise will be available. Local date on the form `yyyy-MM-dd`
      - `pre_order_purchase_indicator` 'merchandise_available' | 'future_availability': Indicates whether cardholder is placing an order for merchandise with a future availability or release date. Either: `merchandise_available` or `future_availability`
      - `reorder_items_indicator` 'first_time_ordered' | 'reordered': Indicates whether the cardholder is reordering previously purchased merchandise. Either: `first_time_ordered` or `reordered`
      - `shipping_indicator` 'billing_address' | 'verified' | 'non_billing_address' | 'ship_to_store' | 'digital_goods' | 'travel_and_event_tickets' | 'other': Indicates shipping method chosen for the transaction. The Shipping Indicator code that most accurately describes the cardholder’s specific transaction must be used, not the general business. If one or more items are included in the sale, use the Shipping Indicator code for the physical goods, or if all digital goods, use the Shipping Indicator code that describes the most expensive item. Possible values: `billing_address` - Ship to cardholder’s billing address, `verified` - Ship to another verified address on file, `non_billing_address` - Ship to address that is different than the cardholder’s billing address, `ship_to_store` - Pick-up at local store (Store address shall be populated in shipping address fields), `digital_goods` - Digital goods (includes online services, electronic gift cards and redemption codes), `travel_and_event_tickets` - Travel and Event tickets, not shipped, `other` - Other (for example, Gaming, digital services not shipped, emedia subscriptions, etc.)
    - `account_info` ScaAccountInfo: Optional additional information about the Cardholder’s account.
      - `created` string: Date that the cardholder created the account. Format: `yyyy-MM-dd`
      - `changed` string: Date that the cardholder’s account was last changed, including Billing or Shipping address, new payment method, or new user(s) added. Format: `yyyy-MM-dd`
      - `age_indicator` 'guest_account' | 'this_transaction' | 'less_than_30_days' | 'from_30_to_60_days' | 'more_than_60_days': Length of time that the cardholder has had the account. One off: `guest_account` - No account (guest check-out), `this_transaction` - Created during this transaction, `less_than_30_days` - Less than 30 days, `from_30_to_60_days` - 30−60 days, `more_than_60_days` - More than 60 days
      - `change_indicator` 'this_transaction' | 'less_than_30_days' | 'from_30_to_60_days' | 'more_than_60_days': Length of time since the cardholder’s account information was last changed, including Billing or Shipping address, new payment account, or new user(s) added. One off: `this_transaction` - Changed during this transaction, `less_than_30_days` - Less than 30 days, `from_30_to_60_days` - 30−60 days, `more_than_60_days` - More than 60 days
      - `password_change` string: Date that cardholder’s account had a password change or account reset. Format: `yyyy-MM-dd`
      - `password_change_indicator` 'no_change' | 'this_transaction' | 'less_than_30_days' | 'from_30_to_60_days' | 'more_than_60_days': Indicates the length of time since the cardholder’s account had a password change or account reset. One off: `no_change` - No change, `this_transaction` - Changed during this transaction, `less_than_30_days` - Less than 30 days, `from_30_to_60_days` - 30−60 days, `more_than_60_days` - More than 60 days
      - `purchase_count` integer: Number of purchases with this cardholder account during the previous six months.
      - `add_card_attempts` integer: Number of Add Card attempts in the last 24 hours.
      - `transactions_day` integer: Number of transactions (successful and abandoned) for this cardholder account (across payment methods) in the previous 24 hours
      - `transactions_year` integer: Number of transactions (successful and abandoned) for this cardholder account (across payment methods) in the previous year
      - `card_age` string: For customer initiated card-on-file session, the date that the used card was added. Provided by Reepay but can be overridden. Format: `yyyy-MM-dd`.
      - `card_age_indicator` 'this_transaction' | 'less_than_30_days' | 'from_30_to_60_days' | 'more_than_60_days': For customer initiated card-on-file session, indicates the length of time that the card was enrolled in the cardholder’s account. Provided by Reepay but can be overridden. One off: `this_transaction` - Changed during this transaction, `less_than_30_days` - Less than 30 days, `from_30_to_60_days` - 30−60 days, `more_than_60_days` - More than 60 days
      - `shipping_address_usage` string: Date when the shipping address used for this transaction was first used. Format: `yyyy-MM-dd`.
      - `shipping_address_usage_indicator` 'this_transaction' | 'less_than_30_days' | 'from_30_to_60_days' | 'more_than_60_days': Indicates when the shipping address used for this transaction was first used. One off: `this_transaction` - During this transaction, `less_than_30_days` - Less than 30 days, `from_30_to_60_days` - 30−60 days, `more_than_60_days` - More than 60 days
      - `shipping_name_indicator` boolean: Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.
      - `suspicious_activity` boolean: Indicates if there has been experienced suspicious activity (including previous fraud) on the cardholder account.
  - `payment_method_reference` string
  - `account_funding` boolean
  - `allowed_ip` string
  - `require_cardholder_name` boolean

## Other responses

- `400`: Invalid request, see error codes at https://api.frisbii.com/v1/error_codes
- `401`: None or invalid credentials provided in access to secured resource
- `403`: Not authorized to perform resource operation
- `404`: Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes
- `500`: Internal service error, error is reported automatically to Frisbii

---

[API](https://skmtc.dev/frisbii/apis/frisbii-checkout-api.md) - [All operations](https://skmtc.dev/frisbii/apis/frisbii-checkout-api/llms.txt) - [OpenAPI document](https://skmtc.dev/frisbii/apis/frisbii-checkout-api/revisions/43015ffd9dbb?raw)