POST/simulations/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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields
invoiceobjectoptional
Invoice-level information about the payment.
line_itemsarray<object>optional
Line item information, such as individual products purchased.
transaction_idstringrequired
The identifier of the Transaction to create a Card Purchase Supplement for. The Transaction must have a source of type `card_settlement`.

3 status codes
200Card Purchase Supplement
account_idstringrequired
The identifier for the Account the Card Purchase Supplement belongs to.
card_payment_idstringrequired
The ID of the Card Payment this transaction belongs to.
idstringrequired
The Card Purchase Supplement identifier.
invoiceobjectrequired
Invoice-level information about the payment.
line_itemsarray<CardPurchaseSupplementLineItemsElement>required
Line item information, such as individual products purchased.
shippingobjectrequired
Shipping information for the purchase.
transaction_idstringrequired
The ID of the transaction.
typestringrequired
A constant representing the object's type. For this resource it will always be `card_purchase_supplement`.
Allowed:card_purchase_supplement
4XXError
5XXError