---
title: "Gets a checkout by ID"
method: GET
path: "/checkouts/{id}"
tags: ["Checkouts"]
---

# Gets a checkout by ID

`GET /checkouts/{id}`

Retrieves the details of a checkout. Supply the unique identifier of the checkout.

## Path parameters

- `id` string, required

## Response `200`

OK.

- Checkout
  - `id` string — The checkout's unique identifier
  - `createdTime` string, date-time — Time at which the checkout was created.
  - `updatedTime` string, date-time — Time at which the checkout was last updated.
  - `customerId` string — The identifier of the Customer associated with the Checkout.
  - `currency` string — A three-letter ISO currency code.
  - `email` string, email — The customer's email address.
  - `language` 'ar' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'en-us' | 'en-gb' | 'es' | 'es-419' | 'fi' | 'fr' | 'fr-ca' | 'hu' | 'it' | 'ja' | 'ko' | 'nl' | 'false' | 'pl' | 'pt' | 'pt-br' | 'ru' | 'sk' | 'sv' | 'th' | 'tr' | 'zh' | 'zh-hk' | 'zh-tw' — The language assigned to the checkout.
  - `locale` string — A designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.
  - `browserIp` string — The IP address of the browser used by the customer when placing the order.
  - `applicationId` string — An arbitrary string identifier that can be used to track the application type.
  - `shipFrom` ShipFrom — The address from which a physical product is shipped.
    - `address` Address — Represents basic address information.
      - `line1` string, nullable — The first line of the address.
      - `line2` string — The second line of the address.
      - `city` string, nullable — The city of the address.
      - `postalCode` string, nullable — The postal code of the address.
      - `state` string, nullable — The state, county, province, or region.
      - `country` string, required — A [two-letter Alpha-2 country code](https://www.iban.com/country-codes) as described in the [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) international standard.
    - `additionalAddressInfo` AdditionalAddressInfo — Captures any information that's not included in the basic address.
      - `neighborhood` string, nullable — The neighborhood of the address.
      - `division` string, nullable — A division within an organization.
      - `phoneticName` string, nullable — The phonetic spelling of a name.
  - `shipTo` Shipping
    - `address` Address — Represents basic address information.
      - `line1` string, nullable — The first line of the address.
      - `line2` string — The second line of the address.
      - `city` string, nullable — The city of the address.
      - `postalCode` string, nullable — The postal code of the address.
      - `state` string, nullable — The state, county, province, or region.
      - `country` string, required — A [two-letter Alpha-2 country code](https://www.iban.com/country-codes) as described in the [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) international standard.
    - `name` string, nullable — The recipient’s name.
    - `phone` string, nullable — The recipient’s phone number.
    - `email` string, email, nullable — The recipient’s email address.
    - `organization` string, nullable — The recipient’s organization.
    - `additionalAddressInfo` AdditionalAddressInfo — Captures any information that's not included in the basic address.
      - `neighborhood` string, nullable — The neighborhood of the address.
      - `division` string, nullable — A division within an organization.
      - `phoneticName` string, nullable — The phonetic spelling of a name.
  - `billTo` Billing — Customer billing information.
    - `address` Address, required — Represents basic address information.
      - `line1` string, nullable — The first line of the address.
      - `line2` string — The second line of the address.
      - `city` string, nullable — The city of the address.
      - `postalCode` string, nullable — The postal code of the address.
      - `state` string, nullable — The state, county, province, or region.
      - `country` string, required — A [two-letter Alpha-2 country code](https://www.iban.com/country-codes) as described in the [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) international standard.
    - `name` string, nullable
    - `phone` string, nullable
    - `email` string, email, nullable
    - `organization` string, nullable
    - `additionalAddressInfo` AdditionalBillingAddressInfo — Captures any information that's not included in the basic address.
      - `neighborhood` string, nullable — The neighborhood of the address.
      - `division` string, nullable — A division within an organization.
      - `phoneticName` string, nullable — The phonetic spelling of a name.
      - `title` 'M' | 'Mme' | 'Mlle', nullable
  - `organization` Organization — Allows for the identification of a specific organization within a B2B transaction.
    - `id` string — The unique identifier of the organization.
  - `subtotal` number, double — Represents the total order amount exclusive of tax.
  - `totalTax` number, double — Represents the total tax amount.
  - `totalImporterTax` number, double — Represents the total tax amount from the importer of record.
  - `importerOfRecordTax` boolean, nullable — If <code>true</code>, indicates that the tax amount is paid by the importer of record.
  - `totalFees` number, double — Represents the total fee amount.
  - `totalDuty` number, double — Represents the total duty amount.
  - `totalDiscount` number, double — Represents the total discount amount.
  - `totalShipping` number, double — Represents the total shipping amount.
  - `totalAmount` number, double — Represents the total charge amount.
  - `discount` Discount — The applied discount.
    - `amountOff` number, double — The discount expressed as an amount.
    - `percentOff` number, double — The discount expressed as a percentage.
  - `taxIdentifiers` TaxIdentifier[]
    - `id` string — The identifier of the tax identifier.
    - `createdTime` string, date-time — The time when the tax identifier was created.
    - `customerId` string, nullable — The identifier of an existing customer.
    - `type` string — Type of tax identifier.
    - `value` string — The tax identifier.
    - `state` 'pending' | 'not_valid' | 'verified' — The verification state.
    - `stateTransitions` TaxIdentifierStateTransitions, nullable — A timestamp of when the state was updated.
      - `pending` string, date-time, nullable
      - `verified` string, date-time, nullable
      - `not_valid` string, date-time, nullable
    - `verifiedName` string, nullable — The registered name of the customer with this tax identifier.
    - `verifiedAddress` string, nullable — The registered address of the customer with this tax identifier.
    - `updatedTime` string, date-time — The time when the tax identifier was updated.
  - `invoiceAttributes` InvoiceAttributes
    - `id` string — The ID of the invoice
    - `type` 'cn_individual_general' | 'cn_business_general' | 'cn_business_special' | 'tw_individual_mobile_barcode' | 'tw_individual_member_carrier' | 'tw_individual_citizen_cert' | 'tw_individual_donate' — The type of invoice.
    - `customerId` string — The ID of the customer.
    - `atttributes` Attributes[]
      - `invoiceTitle` string — The title of the invoice.
      - `regAccount` string — The identifier for the account.
      - `regAddress` string — The address associated to the invoice.
      - `regBank` string — The name of the bank.
      - `regPhone` string — The phone number associated to the invoice
    - `createdTime` string, date-time — The time when the invoice attribute was created.
    - `updatedTime` string, date-time — The time when the invoice attribute was updated.
    - `liveMode` boolean — Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
  - `purchaseLocation` PurchaseLocation — Used to create a tax estimate for the customer.
    - `country` string, required — The ISO 3166-1 alpha-2 country code.
    - `state` string — The state,county,province, or region.
    - `postalCode` string — The ZIP or postal code.
  - `customerType` 'business' | 'individual' — The type of customer.
  - `chargeType` 'customer_initiated' | 'merchant_initiated' | 'moto' — Represents the charge type.
  - `sellingEntity` SellingEntity — Represents the local selling entity.
    - `id` string — The identifier of the selling entity.
    - `name` string — The name of the selling entity.
  - `items` SkuItem[]
    - `id` string — The identifier of the item.
    - `skuId` string — The identifier of the [stock keeping unit (SKU)](https://docs.digitalriver.com/digital-river-api/checkouts-and-orders/skus).
    - `productDetails` ProductDetails
      - `id` string — The identifier of the product in the upstream system.
      - `skuGroupId` string — The identifier of the SKU group.
      - `name` string — The name of the product.
      - `description` string — The description of the product.
      - `itemBreadcrumb` string — The full path to the category where item is included. Categories should be separated by “ > “.
      - `url` string — The product url.
      - `countryOfOrigin` string — The country of origin of the product.
      - `image` string — The image of the product.
      - `weight` number, double — The weight of the product measured in the unit specified by weightUnit.
      - `weightUnit` 'oz' | 'lb' | 'g' | 'kg' — The unit of measurement applied to the weight.
      - `partNumber` string — The manufacturer's part number.
      - `partnerAccountId` string — The unique, Digital River identifier (account Id) of the partner associated with the sku.
    - `logisticsOptions` ItemLogisticsOptions — In the [Global Logistics](https://docs.digitalriver.com/digital-river-api/using-our-services/global-logistics) solution, <code>logisticsOptions</code> allows you to define a list of services that you want the carrier to provide. If you select any of these options, the appropriate fees are added to the shipping quotes that customers select from during the checkout process and the necessary information is added to shipping labels during the fulfillment process.<br><br>There are two ways to provide these <code>logisticsOptions</code>. You can either (1) store them in the product's [SKU Group](https://docs.digitalriver.com/digital-river-api/product-management/setting-up-sku-groups) or (2) pass them in checkout and shipping quotes requests at run-time. If you take the second approach, and <code>logisticsOptions</code> exist in a request, then you’re required to define a list of <code>deliveryOptions</code> and/or <code>dangerousGoods</code>.<br><br>In either case, we pass your selected options to the [Global Logistics Provider](https://docs.digitalriver.com/digital-river-api/using-our-services/global-logistics#global-logistics-providers) so that the carrier is made aware that these services need to be provided.
      - `deliveryOptions` string[] — <br>A set of value-added services offered by the [Global Logistics Provider](https://docs.digitalriver.com/digital-river-api/using-our-services/global-logistics#global-logistics-providers). They provide additional assurances that packages are delivered successfully and that shipping rates are appropriately calculated.<br><br> <code>signature_required</code> - Requires that an individual signs for the package at the time of delivery.<br><br><code>adult_signature_required</code> - Requires that an individual who is at least 21 years of age signs for the package at the time of delivery. It’s useful for high-value, dangerous, and age-sensitive items, or as a prevention against theft. After an adult signs for the delivery, the purchaser receives a notification that contains an image of that signature, along with other delivery details.<br><br><code>direct_delivery_only</code> - Ensures that the package is only delivered to the address provided by the customer at the time of purchase. In other words, the package can't be redirected to another address. No signature is required with this option, so if that's something you'd like to collect, you'll need to add <code>signature_required</code> or <code>adult_signature_required</code> to <code>deliveryOptions</code>.<br><br><code>additional_handling</code> - Indicates that a product requires special handling because it's heavy and/or shipped in a large package. If you select this option, then a surcharge is automatically added to each shipping quote that customers select from, regardless of the package’s weight or dimensions.<br><br> However, if <code>additional_handling</code> doesn’t exist, but the weight and dimensional values in the request exceed thresholds established by the carrier, that same surcharge is still applied.<br><br> Using <code>additional_handling</code> can help minimize your financial risk. This is because if a package’s dimensions and weight are omitted or incorrectly defined in a request and the actual scale weight of the package at the time of shipment exceeds the carrier defined thresholds, thereby incurring a surcharge, then the customer will have underpaid for shipping at checkout, leaving you to make up the difference.<br><br>
      - `dangerousGoods` string[] — Indicates that the product poses unreasonable health, safety, or property risks when shipped and therefore requires special packaging, handling, and modes of transportation. For example, some products, such as lithium batteries and (in)flammable perfumes, are susceptible to static electricity as well as temperature and pressure variations. These forces can cause them to leak, emit toxic fumes, ignite, or even explode.<br><br> If a product is considered hazardous, and you opt not to store this information in its [SKU Group](https://docs.digitalriver.com/digital-river-api/product-management/setting-up-sku-groups), then <code>dangerousGoods</code> must list the category it falls into.
    - `subscriptionInfo` SubscriptionInfo — The subscription information of the item.
      - `freeTrial` boolean — If <code>true</code>, indicates that this is a free trial.
      - `autoRenewal` boolean — If <code>true</code>, indicates that renewals for this subscription are automatic rather than manual.
      - `terms` string — For auto renewal subscriptions, the terms displayed to the customer at acquisition.
      - `planId` string — The unique identifier of the plan
      - `subscriptionId` string — The subscription identifier.
      - `billingAgreementId` string — The Digital River billing agreement identifier.
      - `startTime` string, date-time — The start date and time of the subscription.
      - `endTime` string, date-time — The <code>startTime</code> plus the subscription duration.
    - `fees` Fees
      - `details` FeeDetails[]
        - `type` 'battery' | 'weee' | 'copyright' | 'e_waste' | 'packaging'
        - `amount` number, double — The <code>details[].perUnitAmount</code> multiplied by the <code>quantity</code> of the line item.
        - `perUnitAmount` number, double — The fee amount per unit.
        - `id` string — The Fee's unique identifier.
      - `amount` number, double — Total fee amount.
      - `taxAmount` number, double — Total fee tax amount
    - `quantity` integer — The number of items.
    - `amount` number, double — The cost of the items.
    - `sellerTaxIdentifier` string — The tax identifier of the seller.
    - `tax` Tax
      - `rate` number, double — The tax rate percentage.
      - `amount` number, double — The tax amount.
    - `importerTax` ImporterTax
      - `amount` number, double — The tax amount from the importer of record.
    - `duties` Duties
      - `amount` number, double — The duty amount for the item.
    - `discount` SkuDiscount
      - `amountOff` number, double — The discount expressed as an amount.
      - `percentOff` number, double — The discount expressed as a percentage.
      - `quantity` number — The quantity of the item to which the discount applies.
    - `shipFrom` ShipFrom — The address from which a physical product is shipped.
      - `address` Address — Represents basic address information.
        - `line1` string, nullable — The first line of the address.
        - `line2` string — The second line of the address.
        - `city` string, nullable — The city of the address.
        - `postalCode` string, nullable — The postal code of the address.
        - `state` string, nullable — The state, county, province, or region.
        - `country` string, required — A [two-letter Alpha-2 country code](https://www.iban.com/country-codes) as described in the [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) international standard.
      - `additionalAddressInfo` AdditionalAddressInfo — Captures any information that's not included in the basic address.
        - `neighborhood` string, nullable — The neighborhood of the address.
        - `division` string, nullable — A division within an organization.
        - `phoneticName` string, nullable — The phonetic spelling of a name.
    - `shipping` ItemShipping
      - `amount` number, double — The shipping amount for the item.
      - `taxAmount` number, double — The tax amount associated to the item level shipping cost.
    - `metadata` Metadata — Key-value pairs used to store additional data. Value can be string, boolean or integer types.
  - `billingOptimization` BillingOptimization
    - `subscriptionId` string — The unique identifier of the subscription.
    - `segmentId` string — The unique identifier of the segment.
    - `renewalAttemptNumber` number — The number of renewal attempts.
    - `trackingId` string — The unique identifier of the tracking.
  - `shippingChoice` ShippingChoice, nullable — Represents the shipping amount, description, taxes, and service level.
    - `id` string — The unique identifier of the shipment.
    - `amount` number, double — The shipping amount.
    - `taxAmount` number, double — The shipping taxable amount.
    - `description` string — A description of the shipping choice.
    - `serviceLevel` string — A shipping code that represents the service level.
    - `shippingTerms` 'DDP' | 'DAP' — The terms of shipping.
  - `payment` Payments
    - `sources` Source[]
      - `id` string — Unique identifier for the source.
      - `clientSecret` string — Used for client-side retrieval using a public key.
      - `createdTime` string, date-time — Time when the source was created.
      - `type` 'creditCard' | 'directDebit' | 'googlePay' | 'applePay' | 'payPal' | 'payPalBilling' | 'payPalCredit' | 'wireTransfer' | 'customerCredit' | 'alipay' | 'bPay' | 'onlineBanking' | 'codJapan' | 'klarnaCredit' | 'klarnaCreditRecurring' | 'konbini' | 'bankTransfer' | 'msts' | 'bancontact' | 'giftCard' | 'ideal' | 'amazonPay' | 'afterPay' | 'ccAvenue' — The payment type of the source. The payment type will correspond to another element in the source response that contains detailed information specific to the type. For example, a type of creditCard indicates that there is an object in the response named creditCard.
      - `currency` string — Three-letter ISO currency code.
      - `amount` number, double — Amount associated with the source. Once ready, the source will be charged this amount. Required for single_use sources.
      - `reusable` boolean — If true, you can reuse this source, if false, only once.
      - `owner` Owner — The owner of the payment source.
        - `firstName` string
        - `lastName` string
        - `email` string
        - `organization` string, nullable — The organization of the payment source owner.
        - `upstreamId` string
        - `address` Address, required — Represents basic address information.
          - `line1` string, nullable — The first line of the address.
          - `line2` string — The second line of the address.
          - `city` string, nullable — The city of the address.
          - `postalCode` string, nullable — The postal code of the address.
          - `state` string, nullable — The state, county, province, or region.
          - `country` string, required — A [two-letter Alpha-2 country code](https://www.iban.com/country-codes) as described in the [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) international standard.
        - `additionalAddressInfo` AdditionalAddressInfo — Captures any information that's not included in the basic address.
          - `neighborhood` string, nullable — The neighborhood of the address.
          - `division` string, nullable — A division within an organization.
          - `phoneticName` string, nullable — The phonetic spelling of a name.
      - `creditCard` CreditCard
        - `lastFourDigits` string — The last four digits of the card number.
        - `expirationMonth` number — One to two digits representing the expiration month.
        - `expirationYear` number — Four digits representing the expiration year.
        - `brand` string — The card brand.
      - `googlePay` GooglePay
        - `lastFourDigits` string — The last four digits of the card number.
        - `expirationMonth` number — One to two digits representing the expiration month.
        - `expirationYear` number — Four digits representing the expiration year.
        - `brand` string — The card brand.
      - `payPal` PayPal
        - `redirect` Redirect
          - `redirectUrl` string
          - `returnUrl` string
          - `cancelUrl` string
        - `directDebit` PayPalToken
          - `token` string
      - `payPalBilling` PayPal
        - `redirect` Redirect
          - `redirectUrl` string
          - `returnUrl` string
          - `cancelUrl` string
        - `directDebit` PayPalToken
          - `token` string
      - `payPalCredit` PayPal
        - `redirect` Redirect
          - `redirectUrl` string
          - `returnUrl` string
          - `cancelUrl` string
        - `directDebit` PayPalToken
          - `token` string
      - `directDebit` DirectDebit
        - `redirect` DirectDebitRedirect
          - `redirectUrl` string
          - `returnUrl` string
      - `wireTransfer` WireTransfer
        - `accountHolder` string — .
        - `bankName` string — .
        - `city` string — .
        - `country` string — .
        - `referenceId` string — .
        - `accountNumber` string — .
        - `additionalBankInformation` string — .
        - `iban` string — .
        - `swiftCode` string — .
      - `payCo` PaycoResponse
        - `redirectUrl` string
        - `returnUrl` string
        - `payCo` Payco
      - `alipay` Alipay
      - `applePay` ApplePay
      - `bPay` BPay
        - `accountHolder` string
        - `bankName` string
        - `city` string
        - `country` string
        - `referenceId` string
        - `accountNumber` string
        - `billId` string
        - `customerPaymentReference` string
        - `swiftCode` string
      - `onlineBanking` InternetBankPayment
        - `bankCode` string
      - `codJapan` JapanCOD
      - `klarnaCredit` Klarna
        - `shipping` KlarnaShipping
          - `recipient` string
          - `phoneNumber` string
          - `address` KlarnaAddress
            - `line1` string
            - `city` string
            - `state` string
            - `country` string
            - `postalCode` string
          - `email` string
        - `token` string
      - `klarnaCreditRecurring` KlarnaRecurring
        - `returnUrl` string
        - `cancelUrl` string
      - `konbini` Konbini
        - `storeId` string
        - `receiptNumber` string
        - `printableInvoiceUrl` string
        - `storeName` string
        - `localizedStoreName` string
        - `storeLogoUrl` string
      - `bankTransfer` BankTransfer
      - `msts` MSTS
      - `bancontact` Bancontact
      - `ideal` Ideal
      - `giftCard` GiftCard
        - `cardCurrency` string — The currency used by the card.
        - `conversionRate` number — The conversion rate of the currency.
        - `lastFourDigits` integer — The last four digits of the card.
      - `amazonPay` AmazonPay
      - `afterPay` AfterPay
      - `ccAvenue` CCAvenue
      - `flow` 'standard' | 'redirect' | 'receiver' — The authentication flow of the source.
      - `state` 'pending_funds' | 'pending_redirect' | 'requires_action' | 'chargeable' | 'consumed' | 'cancelled' | 'failed' — The status of the source, one of pending_funds, pending_redirect, requires_action, cancelled, chargeable, consumed or failed. You can only use chargeable sources to create a charge.
      - `metadata` Metadata — Key-value pairs used to store additional data. Value can be string, boolean or integer types.
      - `customerId` string — Unique identifier of a customer.
      - `paymentSessionId` string — Tracks the process of collecting a payment.
      - `liveMode` boolean — Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    - `charges` Charge[]
      - `id` string — The unique identifier of the charge.
      - `createdTime` string, date-time — The time when the charge was created.
      - `currency` string — A three-letter ISO 4217 currency code.
      - `amount` number, double — An amount representing how much is to be to charged.
      - `state` 'pending' | 'capturable' | 'processing' | 'complete' | 'cancelled' | 'failed' — The state of the charge.
      - `orderId` string — The identifier of the associated order.
      - `sourceId` string — The identifier of the source.
      - `failureCode` string — Error code identifying reason for charge failure.
      - `failureMessage` string — Error message describing reason for charge failure.
      - `paymentSessionId` string — Tracks the process of collecting a payment.
      - `cancels` Cancel[]
        - `id` string — The unique identifier of the cancel.
        - `createdTime` string, date-time — The time when the cancel was created.
        - `updatedTime` string, date-time — The time when the cancel was updated.
        - `amount` number, double — An amount representing how much was cancelled.
        - `state` 'pending' | 'pending_information' | 'complete' | 'failed' — The state of the cancel.
        - `failureCode` string — An error code that identifies the reason for the cancel failure.
        - `failureMessage` string — An error message that describes the reason for the cancel failure.
      - `captures` Capture[]
        - `id` string — The unique identifier of the capture.
        - `createdTime` string, date-time — The time when the capture was created.
        - `updatedTime` string, date-time — The time when the capture was updated.
        - `amount` number, double — An amount representing how much was captured.
        - `state` 'pending' | 'complete' | 'failed' — The state of the capture.
        - `failureCode` string — An error code that identifies the reason for the capture failure.
        - `failureMessage` string — An error message that describes the reason for the capture failure.
      - `captured` boolean — Indicates if the charge has been captured.
      - `refunds` Refund[]
        - `id` string — The unique identifier of the refund.
        - `createdTime` string, date-time — The time when the refund was created.
        - `updatedTime` string, date-time — The time when the refund was updated.
        - `amount` number, double — An amount representing how much was refunded.
        - `state` 'pending' | 'complete' | 'failed' — The state of the refund.
        - `failureCode` string — An error code that identifies the reason for the refund failure.
        - `failureMessage` string — An error message that describes the reason for the refund failure.
      - `refunded` boolean — Indicates if the charge has been refunded.
      - `type` 'customer_initiated' | 'merchant_initiated' | 'moto' — The type of charge.
      - `liveMode` boolean — Has the value <code>true</code> if the object exists in live mode and the value <code>false</code> if the object exists in test mode.
    - `session` Session
      - `id` string — The unique identifier for the session
      - `amountContributed` number, double — Represents the amount contributed for the transaction
      - `amountRemainingToBeContributed` number, double — Represents the amount needed to fully fund the transaction
      - `clientSecret` string — The client secret to be used by DR.js
      - `state` 'requires_source' | 'requires_confirmation' | 'confirmed' | 'pending' | 'pending_funds' | 'pending_redirect' | 'chargeable' | 'complete' | 'cancelled' | 'processing' | 'failed' | 'requires_action' — The state of session.
      - `nextAction` object — If this object exists, it contains the next actions that must be taken to complete payment.
        - `action` 'redirect' | 'show_payment_instructions' | 'sca_required' — The specific action that must be taken.
        - `data` object
          - `redirectUrl` string — If <code>action</code> is <code>redirect</code> then redirect to this resource.
          - `sourceId` string — The identifier of the payment source. If <code>action</code> is <code>show_payment_instructions</code>, then use this identifier to configure the delayed payment instructions element.
          - `sourceClientSecret` string — The client secret of the payment source. If <code>action</code> is <code>show_payment_instructions</code>, then use this identifier to configure the delayed payment instructions element.
          - `sessionId` string — The identifier of the payment session
          - `fingerprintToken` string
          - `challengeToken` string
          - `originKey` string
  - `disclosures` DisclosureDetails[]
    - `type` 'termsOfSale' | 'privacyPolicy' | 'cookiePolicy' | 'legalNotice' | 'autoRenewalPlanTerms' | 'saveCardMandate' | 'idealRecurringAgreement' | 'businessEntity' | 'resellerDisclosure' | 'confirmDisclosure' | 'californiaPrivacyRights', required — The type of disclosure.
    - `entityName` string — The name related to the entity.
    - `entityId` string — The id associated to the entity.
    - `localizedText` string — The translated text of the disclosure.
    - `url` string — The url related to the disclosure.
  - `liveMode` boolean — Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
  - `metadata` Metadata — Key-value pairs used to store additional data. Value can be string, boolean or integer types.
  - `upstreamId` string — The upstream identifier.

## Other responses

- `400` — 400 Bad Request
- `401` — 401 Unauthorized
- `403` — 403 Forbidden
- `404` — 404 Not Found
- `405` — 405 Method Not Allowed
- `406` — 406 Not Acceptable
- `408` — 408 Request Timeout
- `429` — 429 Too Many Requests
- `500` — 500 Internal Server Error
- `502` — 502 Bad Gateway Error
- `503` — 503 Service Unavailable Error
- `504` — 504 Gateway Timeout Error

---

[API](https://skmtc.net/digitalriver/apis/digital-river-api-reference.md) · [All operations](https://skmtc.net/digitalriver/apis/digital-river-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalriver/digital-river-api-reference/revisions/f21981db32be/schema)