BookingFlow

Processes a payment for a reserved booking (only available for public API clients using widgets with our supported payment providers).

Changed on Oct 26, 2026

post/pay/{orderId}/{orderKey}

Request

Base URL
https://api.travelify.io
URL
https://api.travelify.io/pay/{orderId}/{orderKey}
Auth
none declared

Path parameters

orderIdinteger required

Numeric order Id.

orderKeystring required

36-character order security key.

Query parameters

interactSessionstring

Optional but recommended customer interaction session. Keep the same session valid for the whole customer interaction journey.

Request body

sendConfirmationEmailboolean

Send confirmation email to customer (default=true)

customerIPstring nullable

Customer IP address (may be used for fraud prevention)

customReferencestring nullable

Optional reference field for the booking (eg. company cost code)

customDataobject nullable

Optional custom data (only for specific use cases)

provider0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 188 | 189 | 190 | 191 required

Enumerator defining supplier types:<br>0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom, 186=Eurosite, 187=Revolut, 188=Karpaten, 189=Love2Shop, 190=LunaCRM, 191=UTalk

paymentType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 required

Enumerator defining payment types card,ideal,alipay,bancontact,eps,giropay,multibanco,sepa_debit,p24,sofort,wechat:<br>0=None, 1=Card, 2=iDEAL, 3=Alipay, 4=Bancontact, 5=EPS, 6=Giropay, 7=Multibanco, 8=SepaDebit, 9=Przelewy24, 10=Sofort, 11=WeChat, 12=GooglePay, 13=ApplePay, 14=DirectDebit, 15=PayPal, 16=BankTransfer, 17=Cash, 18=Account, 19=CreditLimit, 20=Link, 21=Klarna, 22=ClearpayAfterpay, 23=Crypto, 24=PayLater, 25=GiftCard

tokenstring nullable

Payment token from the provider

additionalDataobject nullable

Additional payment data

paymentAmountnumber double nullable

Optional payment amount (for manual payments only)

paymentNotesstring nullable

Optional payment notes (for manual payments only)

Example request

{
  "contactInfo": {
    "internalRef": "CUST-123",
    "emailAddress": "joe.bloggs@email.com",
    "telephone": {
      "countryPrefix": "44",
      "number": "0123456789"
    },
    "firstname": "Joe",
    "surname": "Bloggs",
    "company": "ACME Travel",
    "address1": "123 Any Road",
    "city": "Bournemouth",
    "state": "Dorset",
    "postalCode": "BH1 1AB",
    "countryCode": "GB"
  }
}

Response

successboolean

Indicator as to whether API request was successful.

versioninteger nullable

API method version (for information only)

errorsstring[] nullable

Returns a list of errors if success is returned as false.

infostring nullable

Generic information (should not be dislayed to end user or used - informational purposes only).

interactSessionstring nullable

Customer interaction session. This should be cookied for 365-days for an individual customerand is used for personalisation features.

searchSessionstring nullable

Search session identifier which is used throughout a booking journey (e.g. id/guid).

humanReadableSearchRefstring nullable

A human-readable search identifier and can be shown to the end user for telephone enquiries about the current search (can be used by agents to look up the search in admin console)

shareUrlstring nullable

A sharing URL for this search

deeplinkUrlstring nullable

A deeplink URL for this search normally used for abandoned basket email tracking

orderRefDisplaystring nullable

Order reference for displaying to customer.

orderRefstring nullable

Order reference for maintaining a basket (e.g. id/guid).

orderCanAmendboolean nullable

Defines if an order can be amended

hasPreConfirmUrlboolean nullable

Defines if an order has a pre-confirmation URL (eg. Ryanair)

dedupeboolean nullable

Flag to inform front end that it needs to deduplicate results

totalinteger nullable

Total number of suppliers/threads initiated on the booking flow step.

completedinteger nullable

Number of completed suppliers/threads initiated on the booking flow step.

dataunknown

trackingCodestring nullable

Tracking code (if present)

specialRequestsstring nullable

Special requests

isSessionTimeoutboolean

Flag to inform front end of session timeout

sessionExpirystring date-time nullable

Session expiry date time

Changes

Oct 26, 202688ff4bb3b649 Revision changes
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
Oct 19, 2026e39d3af141ec Revision changes
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status

Operation history (10 revisions)