This is an overview of the important resources and what they do.
Understand what resources to use
Please read Acquiring a Card to understand which resources to call
| API Call | Summary | Details |
|---|---|---|
| Get Supported Product Lines | Summary | Provides which brands can be acquired through channel. Can be polled at each transaction or periodically |
| Required | Contract ID | |
| Optional | First, Limit, sort order, sort key | |
| Response | ProductLineID, Name, Min accepted value, Max accepted value, discount | |
| Get Quote | Summary | Based on the card information provided, confirms whether GiftDeals will acquire this card and at what price (but not whether we will acquire it from a specific consumer) |
| Required | Merchant (ProductLineID), GC # | |
| Optional | PIN (conditional) | |
| Response | Error Code OR face value, Offer, TranID, isCompleted | |
| Fraud Check | Summary | Based on the card and consumer information, BHN determines if the consumer passes fraud check and that BHN is willing to acquire that card from that customer |
| Required | RequestID, ContractID, Location, Card (ProductLineID, GC #, PIN (conditional)), CardHolder/Seller (Name, Email, ID# OR CC# hash), Payout (eGift, Open Loop, Closed Loop, Cash) | |
| Optional | "PIN (conditional), Cardholder/Seller: {Phone, CC data encrypted (CC CVV, CC Exp MO, CC Exp YR, CC Zip (required if card collected)}, ID {ID#, ID Type (required if collected), Issue date, expire date, issuer city, issuer state, issuer country}" | |
| Response | cansell?, isCompleted, Transaction ID, Reason Code | |
| Acquire Card | Summary | Confirms acquisition of the card |
| Required | Transaction ID | |
| Optional | Location | |
| Response | Transaction ID, Face Value, Offer, isCompleted | |