How To: Implement Chargeback Protection

1
{
2
  /**
3
   * The name of the product
4
   */
5
  productName: string;
6
  /**
7
   * The product type. Possible values include: inGameProduct, gameOfSkill, dataStorage, computingResources, sportsTicket, eSportsTicket, musicTicket, conferenceTicket, virtualSportsTicket, virtualESportsTicket, virtualMusicTicket, virtualConferenceTicket, alcohol, DLC, subscription, fundACause, realEstate, computingContract, digitalArt, topUp
8
   * Contact Coinflow for the productType value.
9
   */
10
  productType: 'inGameProduct' |
11
    'gameOfSkill' |
12
    'dataStorage' |
13
    'computingResources' |
14
    'sportsTicket' |
15
    'eSportsTicket' |
16
    'musicTicket' |
17
    'conferenceTicket' |
18
    'virtualSportsTicket' |
19
    'virtualESportsTicket' |
20
    'virtualMusicTicket' |
21
    'virtualConferenceTicket' |
22
    'alcohol' |
23
    'DLC' |
24
    'subscription' |
25
    'fundACause' |
26
    'realEstate' |
27
    'computingContract' |
28
    'digitalArt' |
29
    'topUp';
30
  /**
31
   * The number of units sold
32
   */
33
  quantity: number;
34
  /**
35
   * Any additional data that the store can provide on the product, e.g. description, link to image, etc.
36
   */
37
  rawProductData?: { [key: string]: any };
38
}

1
{
2
  /**
3
   * Identifies this cart item as a travel booking
4
   */
5
  itemClass: 'travel';
6
  /**
7
   * The cart item's unique ID
8
   */
9
  id?: string;
10
  /**
11
   * The item's selling price
12
   */
13
  sellingPrice: {
14
    valueInCurrency: number; // e.g. 1250.00
15
    currency: string;        // ISO 4217, e.g. 'USD'
16
  };
17
  /**
18
   * The item's list price
19
   */
20
  listPrice?: {
21
    valueInCurrency: number;
22
    currency: string;
23
  };
24
  /**
25
   * The lodging details of the booking
26
   */
27
  lodging: {
28
    reservationId: string;      // Hotel reservation ID, e.g. 'X36Q9C'
29
    nights: number;             // Number of nights booked (min 1)
30
    checkInDate: string;        // Check-in date, e.g. '2026-09-02'
31
    checkInHour: string;        // Hour of day of check-in, '00'-'23'
32
    hotel: {
33
      name: string;             // e.g. 'The Plaza Hotel'
34
      country: string;          // Two-letter ISO 3166 code, e.g. 'US'
35
      city: string;             // e.g. 'New York'
36
    };
37
    wereExtrasPurchased: boolean; // Whether extras were purchased
38
    isRefundable: boolean;        // Whether the reservation is refundable
39
    highestRoomType: string;      // Most luxurious room booked, e.g. 'Presidential Suite'
40
    numberOfRooms: number;        // Rooms booked (min 1)
41
    numberOfGuests: number;       // Guests in the reservation (min 1)
42
    numberOfKids: number;         // Kids out of the number of guests (min 0)
43
  };
44
  /**
45
   * The flight ticket's PNR code
46
   */
47
  pnr: string; // e.g. 'X36Q9C'
48
  /**
49
   * The trip details
50
   */
51
  trip: {
52
    numberOfFlights: number;      // Flights in the trip (min 1)
53
    numberOfCheckedBags: number;  // Checked bags (min 0)
54
    firstWayDestination: string;  // Three-letter IATA airport code, e.g. 'JFK'
55
    isRoundTrip: boolean;         // true if the trip is a round-trip
56
    highestClass: 'economy' | 'luxurious'; // 'luxurious' if the highest travel class is business/first
57
    isFlexibleTicket: boolean;    // true if the ticket is flexible
58
    wereExtrasPurchased: boolean; // true if extras were included
59
  };
60
  /**
61
   * The first flight of the trip
62
   */
63
  firstFlight: {
64
    numberOfTravelers: number; // Travelers on the first flight (min 1)
65
    departureTime: number;     // Departure timestamp in *milliseconds* since the unix epoch
66
    departureAirport: string;  // Three-letter IATA code, e.g. 'JFK'
67
    duration: number;          // Flight duration in hours, e.g. 3.5
68
    flightNumber: string;      // Alphanumeric flight code, e.g. 'BA2491A'
69
  };
70
  /**
71
   * Any additional data that the store can provide on the booking
72
   */
73
  rawProductData?: { [key: string]: any };
74
}

1
{
2
  itemClass: 'flightTicket';
3
  id?: string;
4
  sellingPrice: {valueInCurrency: number, currency: string};
5
  listPrice?: {valueInCurrency: number, currency: string};
6
  pnr: string;        // The flight ticket's PNR code
7
  trip: {/* same shape as travel */};
8
  firstFlight: {/* same shape as travel */};
9
  rawProductData?: { [key: string]: any };
10
}

1
{
2
  itemClass: 'flightUpgrade';
3
  id?: string;
4
  sellingPrice: {valueInCurrency: number, currency: string};
5
  listPrice?: {valueInCurrency: number, currency: string};
6
  /**
7
   * The PNR code of the booking being upgraded
8
   */
9
  pnr?: string;
10
  /**
11
   * The type of upgrade
12
   */
13
  upgradeType: 'changes' | 'fareIncrease' | 'baggage' | 'seats' | 'insurance' | 'other';
14
  /**
15
   * The upgrade description — required when upgradeType is 'other'
16
   */
17
  description?: string;
18
  rawProductData?: { [key: string]: any };
19
}

1
{
2
  itemClass: 'lodging';
3
  id?: string;
4
  sellingPrice: {valueInCurrency: number, currency: string};
5
  listPrice?: {valueInCurrency: number, currency: string};
6
  reservationId: string;        // e.g. 'X36Q9C'
7
  nights: number;               // min 1
8
  checkInDate: string;          // e.g. '2026-09-02'
9
  checkInHour: string;          // '00'-'23'
10
  hotel: {
11
    name: string;
12
    country: string;            // Two-letter ISO 3166 code
13
    city: string;
14
  };
15
  wereExtrasPurchased: boolean;
16
  isRefundable: boolean;
17
  highestRoomType: string;
18
  numberOfRooms: number;        // min 1
19
  numberOfGuests: number;       // min 1
20
  numberOfKids: number;         // min 0
21
  rawProductData?: { [key: string]: any };
22
}

1
{
2
  "itemClass": "travel",
3
  "id": "5de33332-546a-4171-8988-2a43d2bfe9c6",
4
  "sellingPrice": {
5
    "valueInCurrency": 1250.00,
6
    "currency": "USD"
7
  },
8
  "lodging": {
9
    "reservationId": "X36Q9C",
10
    "nights": 3,
11
    "checkInDate": "2026-09-02",
12
    "checkInHour": "15",
13
    "hotel": {
14
      "name": "The Plaza Hotel",
15
      "country": "US",
16
      "city": "New York"
17
    },
18
    "wereExtrasPurchased": false,
19
    "isRefundable": true,
20
    "highestRoomType": "Deluxe King",
21
    "numberOfRooms": 1,
22
    "numberOfGuests": 2,
23
    "numberOfKids": 0
24
  },
25
  "pnr": "X36Q9C",
26
  "trip": {
27
    "numberOfFlights": 2,
28
    "numberOfCheckedBags": 1,
29
    "firstWayDestination": "JFK",
30
    "isRoundTrip": true,
31
    "highestClass": "economy",
32
    "isFlexibleTicket": false,
33
    "wereExtrasPurchased": false
34
  },
35
  "firstFlight": {
36
    "numberOfTravelers": 2,
37
    "departureTime": 1788373800000,
38
    "departureAirport": "SFO",
39
    "duration": 5.5,
40
    "flightNumber": "AA1234"
41
  },
42
  "rawProductData": {
43
    "packageName": "NYC Getaway — Flight + Hotel",
44
    "bookingChannel": "web"
45
  }
46
}

1
<CoinflowPurchase
2
  wallet={wallet}
3
  merchantId={process.env.REACT_APP_MERCHANT_ID as string}
4
  transaction={transaction}
5
  amount={amount}
6
  chargebackProtectionData={[{
7
    "productName": "Sword", // Name of Product
8
    "productType": "inGameProduct", // Get the value from Coinflow
9
    "quantity": 1,
10
    "rawProductData": { // Adjust based on the available product data
11
      "productID": "sword12345",
12
      "productDescription": "A legendary sword with magical powers.",
13
      "productCategory": "Weapon",
14
      "weight": "15 lbs",
15
      "dimensions": "40 in x 5 in",
16
      "origin": "Ancient Kingdom",
17
      "craftedBy": "Master Blacksmith",
18
      "craftingDate": "2024-06-19"
19
    }
20
  },]}
21
/>