Integrace s TripPay

Tento článek obsahuje komplexní příklad integrace s TripPay.

Doporučuje se, abyste si již přečetli:

Platba > Mapování.
Platba > Integrace.
Webová komponenta pro platby.
Platební API.Přečtěte si sekci oCreate payable contracts

Zde jsou kroky k úspěšnému použití TripPay k úhradě rezervace:

Ujistěte se, že příjemci, které uvádíte ve smlouvě o rezervaci, byli zmapováni.
Nechte cestovatele vybrat si inventář, který chce rezervovat, a připravte se na platbu.
Vytvořte payable contract s TripPay, který obsahuje položky k rezervaci.
Nechte cestovatele platit pomocí webové komponenty TripPay.

Předpokládáme, že jste již dokončiliStep 1aStep 2a jsou připraveni informovat TripPay o rezervaci.

Vytvořit splatnou smlouvu

Další informace o požadavcích na vytvoření splatné smlouvy naleznete v rozhraní Platební API. :::

Žádost

Zde je ukázkový požadavek JSON, který obsahuje vše, co potřebujete k vytvoření vaší první splatné smlouvy.

{
  "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"
            }
          ]
        }
      ]
    }
  ]
}

Vysvětlení:

Nebudeme zde vysvětlovat každý datový bod, protože jsou již zahrnuty v dokumentaci k API.

Řádky:2 - 7je uživatel zodpovědný za rezervaci. Existují dva typy rezervujících:
- Cestovatel.
- Cestovní agent.
Řádky:8 - 9je účet TripPay, který umožňuje rezervaci. Může to být:
- Váš účet integrátora TripPay.
- Pokud provozujete partnerskou síť, může to být váš partner.
PoužijtetraceIdseskupit více rezervací u více dodavatelů. Tímto způsobem můžete zrušit skupinovou rezervaci.
redirectUrldá TripPay vědět, na kterou stránku má po dokončení platby přesměrovat.
sourceUrlje web / aplikace, na které byla rezervace provedena.

Ten/Ta/TocontractListPole obsahuje položku (položky), které chce cestovatel zakoupit od více dodavatelů. Každá položka obsahuje:

Ten/Ta/Toidentifierje platný UUID, který vygenerujete.
Dodavatel, u kterého chcete rezervovat zásoby.
Zásoby, které chcete od daného dodavatele rezervovat. Všechny tyto položky jsou uvedeny ve vnořeném poli.contractItemList.
Každý záznam podcontractItemListobsahuje:
- Hostující uživatelToto je uživatel, který dorazí na místo.
- Jméno v angličtiněNázev inventáře v angličtině.
- Popis v angličtiněDelší popis inventáře v angličtině.
- CenaCena položky.
- ItinerářKdy by měla být tato položka rezervována.
- Typ cenyJak byla cena vypočítána.
- Typ inventářeO jaký typ inventáře se jedná.
- SplatnéKdy by měl být cestujícímu účtován poplatek.V současné době podporujeme pouze možnosti okamžité platby.
- PolitikaZahrňte pravidla pro zrušení rezervace.
- Denní sazbaPokud je rezervovanou položkou pokoj, můžete zvolit, zda chcete uvést cenu pokoje za každou noc, během níž se host ubytuje.
- PříjemciUveďte, na který účet TripPay by měla být přidělena jaká částka z ceny položky.Podporovány jsou fixní / procentuální částky.

Ve výše uvedeném příkladu JSON máme 3 příjemce:

1,5 % bylo přiděleno platformě, která rezervaci zprostředkovala.např. mrknutí
Partnerovi bylo přiděleno 9,85 % jako provize.např. Kim Kardashian
Dodavateli bylo přiděleno 88,65 % za rezervaci pokoje.např. Hilton

Když TripPay odpoví splatnou smlouvou, všimnete si, že vložil vlastního příjemce ve výši 4,0 %. :::

Odpověď

Když TripPay odpoví na váš požadavek, bude to vypadat nějak 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žitidna řádku 3. Toto použijete k vložení do webové komponenty TripPay.

Vložit TripPay

V tomto okamžiku jste připraveni vložitPayment Web Componentna váš web a ukázat ho uživateli.

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

Co se týče integrace, to je vše, co musíte udělat. Veškerou těžkou práci odteď vykonává TripPay.