Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Card Purchase Supplements

Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data.

The Card Purchase Supplement object
{
  "card_payment_id": "card_payment_nd3k2kacrqjli8482ave",
  "id": "card_purchase_supplement_ijuc45iym4jchnh2sfk3",
  "invoice": {
    "discount_amount": 100,
    "discount_currency": "USD",
    "discount_treatment_code": null,
    "duty_tax_amount": 200,
    "duty_tax_currency": "USD",
    "order_date": "2023-07-20",
    "shipping_amount": 300,
    "shipping_currency": "USD",
    "shipping_destination_country_code": "US",
    "shipping_destination_postal_code": "10045",
    "shipping_source_postal_code": "10045",
    "shipping_tax_amount": 400,
    "shipping_tax_currency": "USD",
    "shipping_tax_rate": "0.2",
    "tax_treatments": null,
    "unique_value_added_tax_invoice_reference": "12302"
  },
  "line_items": [
    {
      "detail_indicator": "normal",
      "discount_amount": null,
      "discount_currency": null,
      "discount_treatment_code": null,
      "id": "card_purchase_supplement_invoice_line_item_nf9760lz0apqy5retmqh",
      "item_commodity_code": "001",
      "item_descriptor": "Coffee",
      "item_quantity": "1.0",
      "product_code": "101",
      "sales_tax_amount": null,
      "sales_tax_currency": null,
      "sales_tax_rate": null,
      "total_amount": 500,
      "total_amount_currency": "USD",
      "unit_cost": "5.0",
      "unit_cost_currency": "USD",
      "unit_of_measure_code": "NMB"
    }
  ],
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "card_purchase_supplement"
}
Attributes
card_payment_id
string
Nullable

The ID of the Card Payment this transaction belongs to.

id
string

The Card Purchase Supplement identifier.

invoice
dictionary
Nullable

Invoice-level information about the payment.

line_items
array
Nullable

Line item information, such as individual products purchased.

transaction_id
string

The ID of the transaction.

type
string

A constant representing the object's type. For this resource it will always be card_purchase_supplement.

List Card Purchase Supplements
curl \
  --url "${INCREASE_URL}/card_purchase_supplements?card_payment_id=card_payment_nd3k2kacrqjli8482ave" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

card_payment_id
string

Filter Card Purchase Supplements to ones belonging to the specified Card Payment.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Retrieve a Card Purchase Supplement
curl \
  --url "${INCREASE_URL}/card_purchase_supplements/card_purchase_supplement_ijuc45iym4jchnh2sfk3" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
card_purchase_supplement_id
string
Required

The identifier of the Card Purchase Supplement.