---
title: "Retrieve a Card Purchase Supplement"
method: GET
path: "/card_purchase_supplements/{card_purchase_supplement_id}"
---

# Retrieve a Card Purchase Supplement

`GET /card_purchase_supplements/{card_purchase_supplement_id}`

## Path parameters

- `card_purchase_supplement_id` string, required — The identifier of the Card Purchase Supplement.

## Response `200`

Card Purchase Supplement

- CardPurchaseSupplement — Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data.
  - `card_payment_id` string, nullable, required — The ID of the Card Payment this transaction belongs to.
  - `id` string, required — The Card Purchase Supplement identifier.
  - `invoice` object, nullable, required — Invoice-level information about the payment.
    - `discount_amount` integer, nullable, required — Discount given to cardholder.
    - `discount_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount.
    - `discount_treatment_code` 'no_invoice_level_discount_provided' | 'tax_calculated_on_post_discount_invoice_total' | 'tax_calculated_on_pre_discount_invoice_total', nullable, required — Indicates how the merchant applied the discount.
    - `duty_tax_amount` integer, nullable, required — Amount of duty taxes.
    - `duty_tax_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the duty tax.
    - `order_date` string, date, nullable, required — Date the order was taken.
    - `shipping_amount` integer, nullable, required — The shipping cost.
    - `shipping_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping cost.
    - `shipping_destination_country_code` string, nullable, required — Country code of the shipping destination.
    - `shipping_destination_postal_code` string, nullable, required — Postal code of the shipping destination.
    - `shipping_source_postal_code` string, nullable, required — Postal code of the location being shipped from.
    - `shipping_tax_amount` integer, nullable, required — Taxes paid for freight and shipping.
    - `shipping_tax_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping tax.
    - `shipping_tax_rate` string, nullable, required — Tax rate for freight and shipping.
    - `tax_treatments` 'no_tax_applies' | 'net_price_line_item_level' | 'net_price_invoice_level' | 'gross_price_line_item_level' | 'gross_price_invoice_level', nullable, required — Indicates how the merchant applied taxes.
    - `unique_value_added_tax_invoice_reference` string, nullable, required — Value added tax invoice reference number.
  - `line_items` object[], nullable, required — Line item information, such as individual products purchased.
    - `detail_indicator` 'normal' | 'credit' | 'payment', nullable, required — Indicates the type of line item.
    - `discount_amount` integer, nullable, required — Discount amount for this specific line item.
    - `discount_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount.
    - `discount_treatment_code` 'no_line_item_level_discount_provided' | 'tax_calculated_on_post_discount_line_item_total' | 'tax_calculated_on_pre_discount_line_item_total', nullable, required — Indicates how the merchant applied the discount for this specific line item.
    - `id` string, required — The Card Purchase Supplement Line Item identifier.
    - `item_commodity_code` string, nullable, required — Code used to categorize the purchase item.
    - `item_descriptor` string, nullable, required — Description of the purchase item.
    - `item_quantity` string, nullable, required — The number of units of the product being purchased.
    - `product_code` string, nullable, required — Code used to categorize the product being purchased.
    - `sales_tax_amount` integer, nullable, required — Sales tax amount for this line item.
    - `sales_tax_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the sales tax assessed.
    - `sales_tax_rate` string, nullable, required — Sales tax rate for this line item.
    - `total_amount` integer, nullable, required — Total amount of all line items.
    - `total_amount_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total amount.
    - `unit_cost` string, nullable, required — Cost of line item per unit of measure, in major units.
    - `unit_cost_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the unit cost.
    - `unit_of_measure_code` string, nullable, required — Code indicating unit of measure (gallons, etc.).
  - `shipping` object, nullable, required — Shipping information for the purchase.
    - `customer_reference_number` string, nullable, required — The customer reference number.
    - `destination_address` string, nullable, required — Address of the destination.
    - `destination_country_code` string, nullable, required — Country code of the destination.
    - `destination_postal_code` string, nullable, required — Postal code of the destination.
    - `destination_receiver_name` string, nullable, required — Name of the receiver at the destination.
    - `discount_amount` integer, nullable, required — Discount amount for the shipment.
    - `net_amount` integer, nullable, required — Net shipping amount.
    - `number_of_packages` integer, nullable, required — Number of packages shipped.
    - `origin_address` string, nullable, required — Address of the origin.
    - `origin_country_code` string, nullable, required — Country code of the origin.
    - `origin_postal_code` string, nullable, required — Postal code of the origin.
    - `origin_sender_name` string, nullable, required — Name of the sender at the origin.
    - `pick_up_date` string, date, nullable, required — Date the shipment should be picked up.
    - `service_description` string, nullable, required — Description of the shipping service.
    - `service_level_code` string, nullable, required — Service level code for the shipment.
    - `shipping_courier_name` string, nullable, required — Name of the shipping courier.
    - `tax_amount` integer, nullable, required — Tax amount for the shipment.
    - `tracking_number` string, nullable, required — Tracking number for the shipment.
    - `unit_of_measure` string, nullable, required — Unit of measure for the shipment weight.
    - `weight` string, nullable, required — Weight of the shipment.
  - `transaction_id` string, required — The ID of the transaction.
  - `type` 'card_purchase_supplement', required — A constant representing the object's type. For this resource it will always be `card_purchase_supplement`.

## Other responses

- `4XX` — Error
- `5XX` — Error

---

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