TravelPay B2B Guide
This can be a complex integration to build due to the need to send a customer in and out of our portal. Please contact us prior to building any TravelPay B2B integrations.
Overview
This integration is designed for Customers (Travel Agents) to make payments to a Merchant(Travel Supplier) via Travel supplier's application/website.
Customer(Travel Agent) Setup
-
Travel agent logs into Travel Supplier platform, they add a bank account to wallet
-
When wallet is setup within Travel supplier's platform, the platform makes a POST call to api.travelpay.com.au/v2/customers to create a new customer.
-
Bank account details are provided in the payload.
-
Customer Reference should be a value that uniquely identifies the customer (Travel Agent) to the Travel Supplier
Email address parameter
Within the TravelPay B2B platform, a customer profile can be linked to multiple merchants. TravelPay B2B platform allows the customers (Travel Agents) to have multiple email addresses associated with a customer profile with different access user rights. However, there can only be one customer profile owner. Customer profile owner email address is the key that links customer profiles between Travel supplier's platform and TravelPay B2B platform.
If same email address is used during the setup process with both the Travel supplier's platform and TravelPay B2B platform, then passing this email address will link profiles together.
During the customer creation process
-
If the supplied value for the email address parameter has a match in the TravelPay B2B platform, then the API will create new merchant customer link. New merchant customer link will be visible on the customer portal under my supplier's section.
-
If the supplied value for the email address parameter does not have a match in the TravelPay B2B platform, then the API will create a new customer profile. This will trigger a welcome email address to the email address so that the user can setup their TravelPay B2B customer portal.
Initial Payment
-
Travel Agent clicks a pay button within Travel supplier's platform.
-
Travel supplier's platform makes a POST call to api.travelpay.com.au/v2/payments
-
Customer Reference is used within the payload to match payment with the customer
-
Additional Reference is used for Booking information
After Payment is submitted
A routine has to be written to check the status of payment. As bank payments are not instant, at first paymentStatus of the payment will be Pending. This will change as the payment progresses.
Alternatively, there are webhooks available which will be sent out once the payment is completed.
How to update bank account details
If Travel supplier needs to make an update to an existing customers bank account. Following process can be used.
GET api.travelpay.com.au/v2/customers/\{customerReference\}/account to retrieve existing bank account details.
PUT api.travelpay.com.au/v2/customers/\{customerReference\}/account to update existing bank account details.