Get a MOTO interface URL request

This method allows you to create instances of the MOTO web interface. From this interface, the operator will be able to create card tokens or send request links with an option to process initial payments (if processing capabilities are activated).

Note: In Hospitality business, this interface is named Phone Booking interface.

If a link is provided to the payment method holder, when the process is complete, the user will be sent back to the specified url payment_page_return_url which will contain a result parameter appended to it in order to verify that the request parameter/s has not been tampered with. See the Post process redirection documentation.

• URL syntax: /api/v2/merchant/moto-instance
• Method: POST

Request parameters

Name	Type	Details	Mandatory	Description
source	int		N	The ID reference for which this request is. This data is provided by SysPay.
language	string	en |fr |it	N	Sets the phone booking interface language. If not specified it will try to get the browser’s language, by default it will be automatically set to en if the detection fails or the browser language is not supported.
accept_until	unix timestamp		N	This unix timestamp determines the date and time the customer is allowed to complete the operation requested.
description	string	Max length 300	N	The service/product description message which will be displayed on the SysPay Hosted page.
phone_booking_return_url	string		N	The URL to redirect the operator to when the operation on the Phone Booking web interface is complete.
payment_page_return_url	string		N	The URL to redirect the customer/buyer to when the operation is complete. (If the ‘send request’ method was used).
extra	string	Max length 300	N	An extra parameter that is passed back to you when sending a redirect or event message.
customer	array	Customer	N	The customer’s details.
locked	boolean		N	Set to false allows the user to modify the customer/transaction data. Default to false.
locked_inputs	array		N	Partial form lock. Contains which inputs will be locked once the form is loaded. See section below.
allowed_tabs	array		N	Contains which action tabs will be locked once the form is loaded. See section below.
payment	array	Payment	N	The initial payment’s details.

Parameters relative to Hospitality business

Name	Type	Details	Mandatory	Description
booking_details	array	Booking details	Y	The booking details.
expiration_date	unix timestamp		N	This unix timestamp determines the token expiration date. After this date, the payment method details will not be anymore visible on SysPay interfaces. If no expiration_date is provided, the booking_details.check_out_date plus an interval amount will be used as the expiration date of the token. If set as null, the payment method details will not be visible at all.

locked_inputs parameter

Name	Type	Mandatory	Description
description	boolean	N	Lock the description input.
operation	boolean	N	Lock the transaction operation content. Locking an operation when there is a payment object will only allow the user to process a payment or a preauth while not passing a payment object will only allow the user to process a card verification.
payment_amount	boolean	N	Lock the amount input. Setting the amount as locked with no payment object will only allow the user to process a card verification.
reference	boolean	N	Lock the reference input.
booking_dates	boolean	N	Lock the check-in and check-out date inputs.
accept_until	boolean	N	Lock the option expiration input.
payment_currency	boolean	N	Lock the currency input.
payment_type	boolean	N	Lock the transaction type input (direct payment or pre-authorization).
customer_gender	boolean	N	Lock the Mr/Mrs input.
customer_lastname	boolean	N	Lock the lastname input.
customer_email	boolean	N	Lock the email input.
customer_language	boolean	N	Lock the language dropdown.

allowed_tabs parameter

Name	Type	Mandatory	Description
direct_processing	boolean	N	Lock or allow the payment method details form.
email_request	boolean	N	Lock or allow the email request tab.
secure_link	boolean	N	Lock or allow the secure link tab.

Example request

{
  "accept_until": 1712222640,
  "customer": {
    "email": "julien.eyraud+65e59330911c0@syspay.com",
    "firstname": "Julien",
    "lastname": "Eyraud",
    "language": "fr",
    "ip": "53.124.30.54"
  },
  "locked": false,
  "description": "Booking 65e59330940fd from 2024-03-27 to 2024-04-03.",
  "expiration_date": "1712136240",
  "booking_details": {
    "type": "HOTEL",
    "check_in_date": "2024-03-27",
    "check_out_date": "2024-04-03",
    "booking_id": "65e59330940fd",
    "total_booking_amount": 100000,
    "booking_currency": "EUR"
  }
}

Response parameters

The response in this case is a Moto Instance object.

Example response

{
  "class": "moto_instance",
  "id": "8",
  "action_url": "http://www.syspay.com/redirect/moto-instance/28",
}