דלגו לתוכן
Academy

אינטגרציה עם TripPay

מאמר זה מכיל דוגמה מקצה לקצה כיצד להתממשק עם TripPay.

מומלץ שקראת כבר:

הנה השלבים לשימוש מוצלח ב-TripPay לתשלום עבור הזמנה:

  1. ודא שהמוטבים שהזכרת בחוזה ההזמנה ממופים.
  2. אפשר למטייל לבחור את המלאי שהוא רוצה להזמין ולהתכונן לתשלום.
  3. צור חוזה לתשלום עם TripPay שמכיל את הפריטים להזמנה.
  4. אפשר למטייל לשלם באמצעות רכיב ה-Web של TripPay.

אנו מניחים שכבר השלמת את שלב 1 ו-שלב 2 ואתה מוכן ליידע את TripPay על ההזמנה.

יצירת חוזה לתשלום

Section titled “יצירת חוזה לתשלום”

בקשה

Section titled “בקשה”

להלן דוגמת בקשת JSON הכוללת את כל מה שצריך כדי ליצור את חוזה התשלום הראשון שלך.

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

הסבר:

לא נסביר כל נקודת נתונים כאן כי הן כבר מכוסות בתיעוד ה-API.

  • שורות: 2 - 7 הן המשתמש האחראי על ההזמנה. ישנם שני סוגי מזמינים:
    • מטייל.
    • סוכן נסיעות.
  • שורות: 8 - 9 הן חשבון TripPay שמתווך את ההזמנה. זה יכול להיות:
    • חשבון האינטגרטור שלך ב-TripPay.
    • אם אתה מפעיל רשת שותפים, זה יכול להיות השותף שלך.
  • השתמש ב-traceId כדי לקבץ הזמנות מרובות מספקים שונים. כך תוכל לבטל הזמנה קבוצתית.
  • redirectUrl מודיע ל-TripPay לאיזו עמוד להפנות לאחר השלמת התשלום.
  • sourceUrl הוא האתר/האפליקציה שבהם בוצעה ההזמנה.

מערך contractList מכיל את הפריט(ים) שהמטייל רוצה לרכוש מספקים שונים. כל פריט מכיל:

  • ה-identifier הוא UUID תקין שאתה מייצר.
  • הספק שממנו אתה רוצה להזמין מלאי.
  • המלאי שאתה רוצה להזמין מהספק הזה. כל אלה מפורטים במערך המקונן contractItemList.
  • כל רשומה תחת contractItemList מכילה:
    • משתמש אורח זה המשתמש שיגיע למקום.
    • שם באנגלית שם המלאי בשפה האנגלית.
    • תיאור באנגלית תיאור ארוך יותר של המלאי בשפה האנגלית.
    • מחיר מחיר הפריט.
    • מסלול מתי יש להזמין את הפריט.
    • סוג תמחור כיצד המחיר חושב.
    • סוג מלאי איזה סוג מלאי זה.
    • לתשלום מתי המטייל צריך להיות מחויב. כעת אנו תומכים רק באפשרויות תשלום מיידיות.
    • מדיניות כללי מדיניות ביטול.
    • רשימת תעריפים יומית אם הפריט שמוזמן הוא חדר, ניתן לכלול כמה עלה החדר לכל לילה שהאורח שוהה.
    • מוטבים כלול אילו חשבונות TripPay יקבלו איזה סכום(ים) ממחיר הפריט. נתמכים סכומים קבועים ואחוזים.

תגובה

Section titled “תגובה”

כאשר TripPay מגיב לבקשתך, זה ייראה כך:

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

שמור את ה-id בשורה 3. תשתמש בו להזרקה לתוך רכיב ה-Web של TripPay.

הטמעת TripPay

Section titled “הטמעת TripPay”

כעת, אתה מוכן להטמיע את ה-Payment Web Component באתר שלך ולהציגו למשתמש.

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

לגבי האינטגרציה, זה כל מה שצריך לעשות. כל העבודה הכבדה נעשית על ידי TripPay מהשלב הזה ואילך.