Card Purchase Supplements

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

Events

Your application can listen to webhooks about this resource. All of the events about Card Purchase Supplements will have the category "card_purchase_supplement.created" .

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"
    }
  ],
  "shipping": {
    "customer_reference_number": null,
    "destination_address": null,
    "destination_country_code": "US",
    "destination_postal_code": "10045",
    "destination_receiver_name": null,
    "discount_amount": null,
    "net_amount": 500,
    "number_of_packages": 1,
    "origin_address": null,
    "origin_country_code": "US",
    "origin_postal_code": "10045",
    "origin_sender_name": null,
    "pick_up_date": "2023-07-20",
    "service_description": null,
    "service_level_code": null,
    "shipping_courier_name": "UPS",
    "tax_amount": null,
    "tracking_number": "1Z9999999999999999",
    "unit_of_measure": null,
    "weight": null
  },
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "card_purchase_supplement"
}

Attributes

card_payment_id

string

Nullable

The ID of the Card Payment this transaction belongs to.

More about Card Payments.

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.

shipping

dictionary

Nullable

Shipping information for the purchase.

transaction_id

string

The ID of the transaction.

More about Transactions.

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}"

Returns a list response :

{
  "data": [
    { /* Card Purchase Supplement object */ },
    { /* Card Purchase Supplement object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

card_payment_id

string

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

More about Card Payments.

cursor

string

limit

integer

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

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.

More about Card Purchase Supplements.

Sandbox: Create a Card Purchase Supplement

Simulates the creation of a Card Purchase Supplement (Level 3 data) for a card settlement. This happens asynchronously in production when Visa sends enhanced transaction data about a purchase.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/card_purchase_supplements" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "invoice": {
      "discount_amount": 100,
      "duty_tax_amount": 200,
      "order_date": "2023-07-20",
      "shipping_amount": 300,
      "shipping_destination_country_code": "US",
      "shipping_destination_postal_code": "10045",
      "shipping_source_postal_code": "10045",
      "shipping_tax_amount": 400,
      "shipping_tax_rate": "0.2",
      "unique_value_added_tax_invoice_reference": "12302"
    },
    "line_items": [
      {
        "item_commodity_code": "001",
        "item_descriptor": "Coffee",
        "item_quantity": "1",
        "product_code": "101",
        "total_amount": 500,
        "unit_cost": "5",
        "unit_of_measure_code": "NMB"
      }
    ],
    "transaction_id": "transaction_uyrp7fld2ium70oa7oi"
  }'

Parameters

invoice

dictionary

Invoice-level information about the payment.

line_items

array

Line item information, such as individual products purchased.

transaction_id

string

Required

The identifier of the Transaction to create a Card Purchase Supplement for. The Transaction must have a source of type card_settlement.

More about Transactions.