Paygate

This page provides an overview of the payments methods provided by the Paygate adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating Paygate within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.

Payment methods

Payment Method	Transaction Flows	Transaction Types
SID_EFT	Full-Page Redirect	Debit, Refund
DPO Pay mobile	Full-Page Redirect	Debit, Refund
USSD	Full-Page Redirect	Debit, Refund

Mandatory Parameters

Name	Type	Required	Description
amount (Transaction)	string	true	Total amount in the selected currency. No more than 2 digits after the comma
currency (Transaction)	string	true	3 letter currency code
description (Transaction)	string	true	The description of the payment made

Data Levels

Name	Required	Description
Transaction	true	Contains all the basic transaction information
Allocations	false	Contains all the information regarding the allocation of money received from transaction to be paid to other providers in Direct Pay Online system. If this level is not sent, the system will allocate all the money from this transaction to the provider
Additional	false	Contains an option to block specific payment options in the transaction (for example, on an application which needs fast payment, block off Direct Pay Online bank payment)
Travelers	false	Contains information regarding travelers (passengers / guests) which will a process in Direct Pay Online system to verify that one of the payers name matches the name of one of the travelers

ExtraData Parameters

ExtraData fields for different levels. If level is not mandatory then fields are also not required until you specify it.

If extraData value has [i] - it means that multiply object could be mapped. [i] - should always start with 1. It should be used even if you are mapping only one object.

Name	Type	Required	Description	Level
extraData.companyRefUnique	string	false	Company reference number, i.e also referred to as Booking ref	Transaction
extraData.demandPaymentByTraveler	Boolean(1/0)	false	If marked as 1, the system will require one of the travelers which are included in the travelers tag to be the payer	Transaction
extraData.emailTransaction	string	false	If marked as 1, the system will send the customer an e-mail about the transaction with a link to pay	Transaction
extraData.companyAccRef	string	false	Internal accounting reference number	Transaction
extraData.userToken	string	false	To define who created the transaction	Transaction
extraData.defaultPayment	string	false	The code of the default payment option (the one to be displayed first in the payment page), options: CC - Credit card, MO - Mobile, PP - PayPal, BT - Bank transfer, XP - xPay	Transaction
extraData.defaultPaymentCountry	string	false	Should be used only for Mobile default payment. Name of the default country for the payment option (DefaultPayment will work without this option too)	Transaction
extraData.default_PaymentMNO	string	false	Should be used only for Mobile default payment. Name of the default MNO (mobile network operator) for the payment option (DefaultPayment will work without this option too)	Transaction
extraData.transactionToPrep	Boolean(1/0)	false	Will mark the transaction as Marketplace Prep	Transaction
extraData.voidable	Boolean(1/0)	false	If this tag sent, transaction will be checked in scoring process, if 0 and scoring above high risk/very high risk then will be blocked, if 1 then will go to a check by DPO support team	Transaction
extraData.TRANSblockCountries	Boolean(1/0)	false	transaction block countries	Transaction
extraData.allocationCode[i]	string	true	The code of the other provider to allocate money to	Allocations
extraData.allocationAmount[i]	string	true	The allocated amount	Allocations
extraData.allocationServiceType[i]	number	true	Allocation service type from list of services	Allocations
extraData.allocationServiceDescription[i]	string	false	Allocation description	Allocations
extraData.allocationInvoice[i]	string	false	Invoice of the allocation	Allocations
extraData.allocationPnr[i]	string	false	Pnr of the allocation	Allocations
extraData.blockPayment[i]	string	false	The code of the payment options to be blocked, options: CC - Credit card, MO - Mobile, PP - PayPal, BT - Bank transfer, XP - xPay	Additional
extraData.travelerFirstName[i]	string	true	Traveler first name	Travelers
extraData.travelerLastName[i]	string	true	Traveler last name	Travelers
extraData.travelerPhone[i]	string	false	Traveler phone number	Travelers
extraData.travelerPhonePrefix[i]	string	false	Traveler number prefix (without +)	Travelers
extraData.aafTicketType	string	false	Ticket Type	AdditionalAirlineFields
extraData.aafDocumentType	string	false	Document Type	AdditionalAirlineFields
extraData.aafDateIssued	DateTime	true	Date Issued	AdditionalAirlineFields
extraData.aafIATACarrierCode	IATA	true	IATA Carrier Code	AdditionalAirlineFields
extraData.aafIATATravelAgencyNbr	IATA	false	IATA Travel Agency Number	AdditionalAirlineFields
extraData.aafTicketCarrierName	string	false	Ticket Carrier Name	AdditionalAirlineFields
extraData.aafTicketIssuerCityName	string	false	Ticket Issuer City Name	AdditionalAirlineFields
extraData.aafPassengerCount	number	false	Number of Passengers	AdditionalAirlineFields
extraData.aafConjTicketIndicator	string	false	Conjunction Ticket Indicator	AdditionalAirlineFields
extraData.aafElecTicketIndicator	string	false	Electronic Ticket Indicator	AdditionalAirlineFields
extraData.aafTicketNumber	string	true	Exchanged/Original Ticket No or PNR	AdditionalAirlineFields
extraData.flightDescription[i]	string	true	The description of the payment made	AdditionalAirlineFields.FlightLeg
extraData.flightType[i]	string	true	Service type number according to the options accepted from DPO	AdditionalAirlineFields.FlightLeg
extraData.flightDate[i]	DateTime	true	Service date of the booked service Format: YYYY/MM/DD HH:MM	AdditionalAirlineFields.FlightLeg
extraData.flightFrom[i]	IATA	true	3 letters departure airport code	AdditionalAirlineFields.FlightLeg
extraData.flightTo[i]	IATA	true	3 letters destination airport code	AdditionalAirlineFields.FlightLeg
extraData.flightRef[i]	string	false	Service Reference	AdditionalAirlineFields.FlightLeg
extraData.carrierCode[i]	IATA	true	IATA carrier code	AdditionalAirlineFields.FlightLeg
extraData.serviceClass[i]	string	true	Service Class	AdditionalAirlineFields.FlightLeg
extraData.flightNumber[i]	string	true	Flight Number	AdditionalAirlineFields.FlightLeg
extraData.fareBasisCode[i]	string	true	Fare Basis Code	AdditionalAirlineFields.FlightLeg
extraData.stopOverCode[i]	string	true	Stop Over Code	AdditionalAirlineFields.FlightLeg
extraData.aafTravelerFirstName[i]	string	true	First name	AdditionalAirlineFields.Traveler
extraData.aafTravelerLastName[i]	string	true	Last name	AdditionalAirlineFields.Traveler
extraData.aafTravelerPhone[i]	string	false	Phone number	AdditionalAirlineFields.Traveler
extraData.aafTravelerPhonePrefix[i]	number	false	Phone number prefix (without +)	AdditionalAirlineFields.Traveler
extraData.aafTravelerDateOfBirth[i]	DateTime	false	Traveler Date Of Birth	AdditionalAirlineFields.Traveler
extraData.aafTravelerCountryCode[i]	string	false	Traveler Country Code	AdditionalAirlineFields.Traveler