GET/card_purchase_supplements/{card_purchase_supplement_id}

Retrieve a Card Purchase Supplement

Retrieves a Card Purchase Supplement containing additional information about a card purchase, such as level 3 line-item data. Use the supplement identifier to look up its associated Account, transaction, and any available invoice, shipping, or line-item details.

1 parameter
card_purchase_supplement_idstringrequired
The identifier of the Card Purchase Supplement to retrieve.

3 status codes
200Returns a Card Purchase Supplement object with its Account and transaction identifiers and any available invoice, shipping, and line-item details.
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
4XXReturned when the request encounters a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

The card_purchase_supplement_id path parameter must identify the Card Purchase Supplement to retrieve.