Sign in

v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

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.

post/simulations/card_purchase_supplements

Request body

transaction_idstring required

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

Example request

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

Response

Card Purchase Supplement

card_payment_idstring nullable required

The ID of the Card Payment this transaction belongs to.

idstring required

The Card Purchase Supplement identifier.

transaction_idstring 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.

Example response

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