Integrácia s TripPay

Tento článok obsahuje komplexný príklad integrácie s TripPay.

Odporúča sa, aby ste si už prečítali:

• Platba > Mapovanie.
• Platba > Integrácia.
• Webový komponent platby.
• Platobné rozhranie API.Prečítajte si časť oCreate payable contracts

Tu sú kroky na úspešné použitie TripPay na úhradu rezervácie:

1. Uistite sa, že príjemcovia, ktorých uvediete v zmluve o rezervácii, boli zmapovaní.
2. Nechajte cestujúceho vybrať si inventár, ktorý si chce rezervovať, a nech sa pripraví na platbu.
3. Vytvoriť payable contract s TripPay, ktorý obsahuje položky, ktoré sa majú rezervovať.
4. Nechajte cestujúceho platiť pomocou webového komponentu TripPay.

Predpokladáme, že ste už dokončiliStep 1aStep 2a sú pripravení informovať TripPay o rezervácii.

Vytvoriť platobnú zmluvu

Poznámka

Viac informácií o požiadavkách na vytvorenie platobnej zmluvy nájdete v rozhraní API. :::

Žiadosť

Tu je vzorová požiadavka JSON, ktorá obsahuje všetko, čo potrebujete na vytvorenie vašej prvej splatnej zmluvy.

{
  "user": {
    "userIdentifier": "191d5729-0b90-4000-85df-1bea7a6e9a01",
    "firstName": "John",
    "lastName": "Smith",
    "email": "[email protected]"
  },
  "affiliateAccountIdentifier": "291d5729-0b91-4001-95df-2bec7a6e9a01",
  "affiliateAccountIdentifierType": "INTERNAL",
  "displayCurrency": "USD",
  "traceId": "trace-1",
  "redirectUrl": "/thank-you",
  "sourceUrl": "https://www.travel.com",
  "contractList": [
    {
      "identifier": "191d5729-0b90-4000-8298-72431beb1701",
      "supplierIdentifier": "191d5729-0b90-4000-8b72-58186a642401",
      "supplierIdentifierType": "EXTERNAL",
      "contractItemList": [
        {
          "user": {
            "userIdentifier": "191d5729-0b90-4000-8596-ed18f9876801",
            "firstName": "John",
            "lastName": "Smith",
            "email": "[email protected]",
            "telephone": "+1 212 555 1212",
          },
          "nameInEnglish": "Deluxe King",
          "descriptionInEnglish": "This is the best deluxe king that money can buy.",
          "price": {
            "amount": 100,
            "currency": "USD"
          },
          "itinerary": {
            "startDate": "2024-12-24T00:00:00.000Z",
            "endDate": "2024-12-25T00:00:00.000Z",
            "adults": 2
          },
          "pricingType": "PER_STAY",
          "type": "LODGING",
          "payable": "PREPAY",
          "policy": {
            "refundable": true
          },
          "externalIdentifier": "room-type-1",
          "dailyRateList": [
            {
              "date": "2024-12-24",
              "price": {
                "amount": 100,
                "currency": "USD"
              }
            }
          ],
          "beneficiaryList": [
            {
              "identifier": "account-0",
              "identifierType": "INTERNAL",
              "amountDue": {
                "type": "PERCENTAGE",
                "percent": 0.015
              },
              "type": "PLATFORM_FEE"
            },
            {
              "identifier": "account-1",
              "identifierType": "INTERNAL",
              "amountDue": {
                "type": "PERCENTAGE",
                "percent": 0.0985
              },
              "type": "COMMISSION"
            },
            {
              "identifier": "account-2",
              "identifierType": "INTERNAL",
              "amountDue": {
                "type": "PERCENTAGE",
                "percent": 0.8865
              },
              "type": "SALE"
            }
          ]
        }
      ]
    }
  ]
}

Vysvetlenie:

Nebudeme tu vysvetľovať každý dátový bod, pretože sú už uvedené v dokumentácii k API.

• Riadky:2 – 7je používateľ zodpovedný za rezerváciu. Existujú dva typy rezervujúcich:
  • Cestovateľ.
  • Cestovný agent.
• Riadky:8 - 9je účet TripPay, ktorý umožňuje rezerváciu. Môže to byť:
  • Váš integračný účet TripPay.
  • Ak prevádzkujete partnerskú sieť, môže to byť váš partner.
• PoužitetraceIdzoskupiť viacero rezervácií od viacerých dodávateľov. Týmto spôsobom môžete zrušiť skupinovú rezerváciu.
• redirectUrlumožňuje TripPay vedieť, na ktorú stránku má po dokončení platby presmerovať.
• sourceUrlje stránka/aplikácia, na ktorej sa rezervácia uskutočnila.

Ten/Tá/TocontractListPole obsahuje položku (položky), ktoré chce cestovateľ kúpiť od viacerých dodávateľov. Každá položka obsahuje:

• Ten/Tá/Toidentifierje platný UUID, ktorý vygenerujete.
• Dodávateľ, od ktorého chcete rezervovať zásoby.
• Zásoby, ktoré chcete rezervovať od daného dodávateľa. Všetky sú uvedené vo vnorenom poli.contractItemList.
• Každý záznam podcontractItemListobsahuje:
  • Hosťovský používateľToto je používateľ, ktorý príde na miesto konania.
  • Názov v angličtineNázov inventára v anglickom jazyku.
  • Popis v angličtineDlhší popis inventára v anglickom jazyku.
  • CenaCena položky.
  • ItinerárKedy by sa mala táto položka rezervovať.
  • Typ cenyAko bola cena vypočítaná.
  • Typ inventáraAký typ inventára je toto.
  • SplatnéKedy by mal byť cestujúci poplatok účtovaný.Momentálne podporujeme iba možnosti okamžitej platby.
  • PravidláZahrňte pravidlá storna.
  • Denný cenníkAk je rezervovanou položkou izba, môžete si vybrať, či chcete zahrnúť cenu izby za každú noc pobytu hosťa.
  • PríjemcoviaUveďte, ktorému účtu (účtom) TripPay má byť pridelená aká suma (sumy) z ceny položky.Podporované sú fixné/percentuálne sumy.

Poznámka

Vo vyššie uvedenom príklade JSON máme 3 príjemcov:

• 1,5 % bolo pridelených platforme, ktorá uľahčila rezerváciu.napr. žmurknutie
• Partnerovi bolo pridelených 9,85 % ako provízia.napr. Kim Kardashian
• Dodávateľovi bolo pridelených 88,65 % na rezerváciu izby.napr. Hilton

Keď TripPay odpovie s platenou zmluvou, všimnete si, že vložil vlastného beneficienta vo výške 4,0 %. :::

Odpoveď

Keď TripPay odpovie na vašu žiadosť, bude to vyzerať asi takto:

[
  {
    "id": "contract-1",
    "traceId": "trace-1",
    "supplierContractIdentifier": "191d5729-0b90-4000-8298-72431beb1701",
    "supplierIdentifier": "191d5729-0b90-4000-8b72-58186a642401",
    "supplierName": "Hilton",
    "totalPrice": {
      "amount": 100,
      "currency": "USD"
    },
    "totalDisplayPrice": {
      "amount": 100,
      "currency": "USD"
    },
    "totalSupplierPrice": {
      "amount": 100,
      "currency": "USD"
    },
    "totalInternalPrice": {
      "amount": 100,
      "currency": "USD"
    },
    "totalCapturePrice": {
      "amount": 100,
      "currency": "USD"
    }
  }
]

Uložiťidna riadku 3. Toto použijete na vloženie do webového komponentu TripPay.

Vložiť TripPay

Poznámka

Uistite sa, že ste si vopred načítali naše štýly a Javascript.

V tomto bode ste pripravení vložiťPayment Web Componentna vašu webovú stránku a ukážte ju používateľovi.

<trip-pay id="contract-1"></trip-pay>

Čo sa týka integrácie, to je všetko, čo musíte urobiť. Všetku ťažkú ​​prácu odteraz vykoná TripPay.