📘
/PaymentRequest/include

Request Body

Field	Type	Description	Required
IdPaymentRequest	Integer(10)	Id Number to payment request	No
OrderID	String (255)	Partner-generated order number (We recommend using numbers only)	Yes
Currency	String (3)	Type of currency used	Yes
TotalPrice	Decimal (9.2)	Total Order Amount	Yes
DiscountPercent	Decimal (9.2)	percent discount on the total order value.	No
DiscountValue	Decimal (9.2)	Fixed discount on the total order value.	No
Proposal	String (254)	Proposal number	No
IncreasePercent	Decimal (9.2)	Percent addition to the total order amount.	No
IncreaseValue	Decimal (9.2)	Fixed addition to the total order amount.
ProductType	Array[String]	Type of product being sold (ex: ProductType:["Airline", "Lodging","CarRentClass"])	Yes
Buyer.Name	String (100)	Payer Name	Yes
Buyer.BirthDate	Date (10) yyyy-MM-dd	Payer birth date	No
Buyer.Email	String (300)	Payer's Email	Yes
Buyer.Status	Integer(2)	Payer's Status	No
Buyer.Documents.Type	String (14)	Buyer Document Type	Yes
Buyer.Documents.Number	String (14)	Buyer Document Number	Yes
Buyer.Phones.AreaCode	Integer (2)	Payer contact phone area code	Yes
Buyer.Phones.Number	String (10)	Payer contact phone number	Yes
Buyer.Address.ZipCode	String (10)	payer address zip code	Yes
Buyer.Address.Street	String (100)	Payer's address street	Yes
Buyer.Address.Number	String (10)	Payer address number	Yes
Buyer.Address.Complement	String (300)	Payer address supplement	Yes
Buyer.Address.District	String (100)	Payer's address district	Yes
Buyer.Address.City	String (100)	City of payer's address	Yes
Buyer.Address.State	String (2)	Payer address status	Yes
Buyer.Address.Country	String (100)	Country of payer's address	Yes
Buyer.Address.Type	Integer (1)	Payer address type: 1 = Residential / 2 = Commercial	Yes
Shipping.UseDate	Date (10) yyyy-MM-dd	Date of use of the service	Yes
Shipping.Price	Decimal (9.2)	Shipping Value	Yes
Shipping.Address.ZipCode	String (9)	Zip of delivery address	Yes
Shipping.Address.Street	String (100)	Delivery Address Street	Yes
Shipping.Address.Number	String (10)	Delivery address number	Yes
Shipping.Address.Complement	String (300)	Delivery address supplement	Yes
Shipping.Address.District	String (100)	Delivery Address Neighborhood	Yes
Shipping.Address.City	String (100)	Delivery Address City	Yes
Shipping.Address.State	String(2)	Status of delivery address	Yes
Shipping.Address.Country	String (100)	Country of delivery address	Yes
Shipping.Address.Type	Integer (1)	Type of delivery address: 1 = Residential / 2 = Commercial	Yes
Items.Reference	String (500)	Item SKU	Yes
Items.Description	String (500)	Item Description	Yes
Items.Category	String (500)	Item Category	Yes
Items.Quantity	Integer (3)	Acquired quantity of this item	Yes
Items.Price	Decimal (9.2)	Item Unit Value	Yes
AdditionalParameters.OrderOriginData	Object	Store source data	Yes
AdditionalParameters.OrderOriginData.OrderOriginDocuments.Type	String(50)	Type of document	Yes
AdditionalParameters.OrderOriginData.OrderOriginDocuments.Number	String(50)	Document number	Yes
AdditionalParameters.OrderOriginData.OrderOriginName	String (300)	Name of person of origin	No
AdditionalParameters.OrderOriginIsDifferent	String (1) Y = Yes / N = No	Flag to send OrderOrigin node	No
AdditionalParameters.OrderOriginCompanyName	String (300)	Company Name	Yes
AdditionalParameters.OrderOriginData.OrderOriginEmail	String (300)	Email of origin person	No
AdditionalParameters.OrderOriginData.OrderOriginPhone	String (15)	Phone of origin person	No
AdditionalParameters.ExpirationDate	Datetime (19)	Date and time of offer expiration for KOIN. yyyy-MM-dd HH:mm:ss	Yes
AdditionalParameters.UserExpirationDate	Datetime (19)	Date and time of offer expiration for KOIN. yyyy-MM-dd HH:mm:ss	No
AdditionalParameters.IntermediateId	String(50)	Intermediary code	Yes
AdditionalParameters.MaxInstallments	Integer (2)	Maximum installments to be offered	No
AdditionalParameters.IntermediateId	String(50)	Intermediary Code	No
AdditionalParameters.FixInstallments	Integer (2)	Fix parcel to be offered	No
AdditionalParameters.SoftDescription	String(50)	Additional description	No
AdditionalParameters.UserCreate	String (300)	Email of origin person	No
AdditionalParameters.CallbackUrl	String (300)	Callback URL for payment notification/order activation	No
AdditionalParameters.SalesChannelId	Integer (2)	Sales Channel Code: 1 = Physical Store / 2 = Telesales / 3 = Checkout	Yes

AirlineData

Field	Type	Description	Required
AdditionalData.AirlineData.Legs.LegNumber	Integer (2)	Sequential Leg Identification	Yes
AdditionalData.AirlineData.Legs.Origin	String (3)	Airport Origin Flight Acronym	Yes
AdditionalData.AirlineData.Legs.Destination	String (3)	Airport Flight Destination Acronym	Yes
AdditionalData.AirlineData.Legs.FlightNumber	String (10)	Flight Number	Yes
AdditionalData.AirlineData.Legs.DepartureTime	DateTime (yyyy-MM-dd HH:mm:ss)	Date and time of flight departure	Yes
AdditionalData.AirlineData.Legs.IdClass	String (1) - F / J / Y / W	Trip Class Id	Yes
AdditionalData.AirlineData.Legs.StopOverAllowed	String (1) - Y = Yes / N = No	Stop Over allowed?	Yes
AdditionalData.AirlineData.Legs.AirlineRefund	String (1) - Y = Yes / N = No	Indicates if ticket is refundable	No
AdditionalData.AirlineData.Passengers.PassengerName	String (100)	Passenger Name	Yes
AdditionalData.AirlineData.Passengers.PassengerEmail	String (300)	Passenger Email	Yes
AdditionalData.AirlineData.Passengers.PassengerPhone	String (15)	Passenger Phone	Yes
AdditionalData.AirlineData.Passengers.PassengerBirthDate	DateTime (10)	Passenger Birth Date	Yes
AdditionalData.AirlineData.Passengers.PassengerRating	String (10)	Passenger Classification	No
AdditionalData.AirlineData.Passengers.PassengerStatus	String (10)	Classification of the Airline Passenger	No
AdditionalData.AirlineData.Passengers.PassengerNationality	String(50)	Passenger Nationality	No
AdditionalData.AirlineData.Passengers.PassengerDocuments.Type	String (14)	Passenger Doc Type	Yes
AdditionalData.AirlineData.Passengers.PassengerDocuments.Number	String(50)	In a Passenger Doc	Yes

Car Rental

Field	Type	Description	Required
AdditionalData.CarRentalData.CarRentalCompany	String (300)	Lessor Name	Yes
AdditionalData.CarRentalData.CarDescription	String (300)	Vehicle Description	Yes
AdditionalData.CarRentalData.CarCategory	String (50)	Vehicle category	Yes
AdditionalData.CarRentalData.PickUpDateTime	DateTime (yyyy-MM-dd HH:mm:ss)	Date and time of vehicle pickup	Yes
AdditionalData.CarRentalData.ReturnDateTime	DateTime (yyyy-MM-dd HH:mm:ss)	Date and time of vehicle return	Yes
AdditionalData.CarRentalData.PickUpLocation.ZipCode	String (10)	Pickup address zip code	No
AdditionalData.CarRentalData.PickUpLocation.Street	String (100)	Retreat address street	Yes
AdditionalData.CarRentalData.PickUpLocation.Number	String (10)	Pickup address number	No
AdditionalData.CarRentalData.PickUpLocation.Complement	String (300)	Pickup address supplement	No
AdditionalData.CarRentalData.PickUpLocation.District	String (100)	Pickup Address Neighborhood	No
AdditionalData.CarRentalData.PickUpLocation.City	String (100)	City of pickup address	Yes
AdditionalData.CarRentalData.PickUpLocation.State	String (2)	Status of pickup address	Yes
AdditionalData.CarRentalData.PickUpLocation.Country	String (100)	Country of pickup address	Yes
AdditionalData.CarRentalData.ReturnLocation.ZipCode	String (10)	Return address zip code	No
AdditionalData.CarRentalData.ReturnLocation.Street	String (100)	Return Address Street	Yes
AdditionalData.CarRentalData.ReturnLocation.Number	String (10)	Return Address Number	No
AdditionalData.CarRentalData.ReturnLocation.Complement	String (300)	Return Address Supplement	No
AdditionalData.CarRentalData.ReturnLocation.District	String (100)	Return Address Neighborhood	No
AdditionalData.CarRentalData.ReturnLocation.City	String (100)	City of return address	Yes
AdditionalData.CarRentalData.ReturnLocation.State	String (2)	Return Address Status	Yes
AdditionalData.CarRentalData.ReturnLocation.Country	String (100)	Country of return address	Yes
AdditionalData.CarRentalData.Drivers.DriverName	String (100)	Driver's Name	Yes
AdditionalData.CarRentalData.Drivers.DriverEmail	String (300)	Driver's Email	Yes
AdditionalData.CarRentalData.Drivers.DriverBirthDate	Date (yyyy-MM-dd)	Date of Birth of Driver	Yes
AdditionalData.CarRentalData.Drivers.DriverPhone	String (15)	Driver's Phone	No
AdditionalData.CarRentalData.Drivers.DriverGender	Integer (1)	Gender of Driver (1= Female / 2= Male)	No
AdditionalData.CarRentalData.Drivers.DriverDocuments.Type	String (14)	Driver's Document Type	Yes
AdditionalData.CarRentalData.Drivers.DriverDocuments.Number	String (14)	Driver's Document Number	Yes

DestinationServiceData

Field	Type	Description	Required
AdditionalData.DestinationServiceData.DSDetails.DSId	Integer (1)	Service ID (1- Transfer, 2- Insurance, 3- Circuit, 4- Tickets, 5- Tours, 6- Road Tickets, 7- Rail Tickets)	No
AdditionalData.DestinationServiceData.DSDetails.DSType	String(50)	Type of Service	Yes
AdditionalData.DestinationServiceData.DSDetails.DSName	String (1200)	Service Name	Yes
AdditionalData.DestinationServiceData.DSDetails.DSDescription	String (1200)	Service Description	No
AdditionalData.DestinationServiceData.DSDetails.DSDateStart	Date (yyyy-MM-dd)	Start Date	No
AdditionalData.DestinationServiceData.DSDetails.DSDateEnd	Date (yyyy-MM-dd)	End Date	No
AdditionalData.DestinationServiceData.DSDetails.DSDuration	Integer (5)	Duration of Service	No
AdditionalData.DestinationServiceData.DSDetails.DSOrigin	String(50)	Source of Service	No
AdditionalData.DestinationServiceData.DSDetails.DSDestination	String(50)	Service Destination	Yes
AdditionalData.DestinationServiceData.DSDetails.DSPenaltyDate	Date (yyyy-MM-dd)	Penalty Date	No
AdditionalData.DestinationServiceData.DSDetails.DSQtPax	Integer (2)	Number of Passengers	No
AdditionalData.DestinationServiceData.PaxDetails.PaxName	String (100)	Passenger Name	Yes
AdditionalData.DestinationServiceData.PaxDetails.PaxBirthDate	Date (yyyy-MM-dd)	Date of Birth of the Passenger	Yes
AdditionalData.DestinationServiceData.PaxDetails.PaxEmail	String (300)	Passenger Email	No
AdditionalData.DestinationServiceData.PaxDetails.PaxPhone	String (15)	Passenger Phone	Yes
AdditionalData.DestinationServiceData.PaxDetails.PaxDocuments.Type	String (14)	Type of Passenger Document	Yes
AdditionalData.DestinationServiceData.PaxDetails.PaxDocuments.Number	String (15)	Guest Phone	No
AdditionalData.DestinationServiceData.PaxDetails.PaxAddress.ZipCode	String (10)	Passenger Zip Code	No
AdditionalData.DestinationServiceData.PaxDetails.PaxAddress.Country	String(50)	Country of Passenger	No
AdditionalData.DestinationServiceData.PaxDetails.PaxAddress.State	String (2)	Passenger Status	No
AdditionalData.DestinationServiceData.PaxDetails.PaxAddress.City	String(50)	City of the Passenger	No
AdditionalData.DestinationServiceData.PaxDetails.PaxAddress.District	String(50)	Passenger Quarter	No
AdditionalData.DestinationServiceData.PaxDetails.PaxAdress.Street	String(50)	Passenger Street	No
AdditionalData.DestinationServiceData.PaxDetails.PaxAddress.Number	String (10)	Passenger Number	No
AdditionalData.DestinationServiceData.PaxDetails.PaxAddress.Complement	String (100)	Passenger Supplement	No

Education

Field	Type	Description	Required
AdditionalData.ClassData.ClassDetails.ClassName	String (100)	Course Name	Yes
AdditionalData.ClassData.ClassDetails.ClassFinanceType	Integer (1)	AdditionalData.ClassData.ClassDetails.ClassFinanceType	Yes
AdditionalData.ClassData.ClassDetails.ClassSchoolName	String (100)	Education Institution	Yes
AdditionalData.ClassData.ClassDetails.ClassCourseLoad	Integer (20)	Course Credit Hours (in hours)	Yes
AdditionalData.ClassData.ClassDetails.ClassSchoolCampus	String (100)	Campus Name/Course Location	No
AdditionalData.ClassData.ClassDetails.ClassSchoolCampusCity	String (100)	Campus City/Course Location	No
AdditionalData.ClassData.ClassDetails.ClassStartDate	Date yyyy-MM-dd	Course Start Date	Yes
AdditionalData.ClassData.ClassDetails.ClassEndDate	Date yyyy-MM-dd	Expected Date for Course Completion	Yes
AdditionalData.ClassData.ClassDetails.ClassIsPresential	String (Y)	Classes are in person	Yes
AdditionalData.ClassData.ClassDetails.ClassPeriod	Integer (1)	Course Period	No
AdditionalData.ClassData.ClassDetails.ClassType.Category	Integer (10)	Course Category	Yes
AdditionalData.ClassData.ClassDetails.ClassType.SubCategory	Integer (10)	Course Sub Category	Yes
AdditionalData.ClassData.ClassDetails.ClassType.Segment	Integer (100)	Course Segment	No
AdditionalData.ClassData.ClassDetails.ClassMonthlyFee	Decimal (0000.00)	Course Fee	No
AdditionalData.ClassData.ClassDetails.ClassScholarship	Integer (10)	Scholarship Percentage	No
AdditionalData.ClassData.Students.StudentName	String (100)	Student Name	Yes
AdditionalData.ClassData.Students.StudentId	String(50)	MEC Student ID	No
AdditionalData.ClassData.Students.StudentRegistration	String (100)	Student RA (registration at the institution)	Yes
AdditionalData.ClassData.Students.StudentBondPayer	Integer (1)	Student Link with Payer	Yes
AdditionalData.ClassData.Students.StudentEmail	String (255)	Student Email	Yes
AdditionalData.ClassData.Students.StudentPhone	String (15)	Student Phone	Yes
AdditionalData.ClassData.Students.StudentBirthDate	Date yyyy-MM-dd	MEC Student ID	Yes
AdditionalData.ClassData.Students.StudentDocuments.Type	String (14)	Student Document Type	Yes
AdditionalData.ClassData.Students.StudentDocuments.Number	String (14)	Student document number	Yes
AdditionalData.ClassData.Students.StudentRegisterDate	Date yyyy-MM-dd	Student Enrollment Date	No
AdditionalData.ClassData.Students.ZipCode	String (20)	student address zip code	Yes
AdditionalData.ClassData.Students.Country	String (20)	Country of Student Address	Yes
AdditionalData.ClassData.Students.State	String (20)	Student address status	Yes
AdditionalData.ClassData.Students.City	String (20)	Student address city	Yes
AdditionalData.ClassData.Students.District	String (20)	Student address district	Yes
AdditionalData.ClassData.Students.Street	String (20)	Student address street	Yes
AdditionalData.ClassData.Students.Number	String (10)	Student House Number	Yes
AdditionalData.ClassData.Students.Complement	String (200)	Student Address Supplement	No

Lodging

Field	Type	Description	Required
AdditionalData.LodgingData.LodgingName	String (100)	Name of the Hotel/Inn	Yes
AdditionalData.LodgingData.CheckInDate	Date(yyyy-MM-dd)	Data CheckIn	Yes
AdditionalData.LodgingData.CheckOutDate	Date(yyyy-MM-dd)	Date CheckOut	Yes
AdditionalData.LodgingData.Duration	String (5)	Duration of accommodation (nights)	No
AdditionalData.LodgingData.LodgingRefund	String (1) - Y = Yes / N = No	Indicates if hosting is refundable	Yes
AdditionalData.LodgingData.Address.ZipCode	String (10)	Hotel/Pousada Zip Code	Yes
AdditionalData.LodgingData.Address.Street	String (100)	Rua do Hotel/Pousada	Yes
AdditionalData.LodgingData.Address.Number	String (10)	Hotel/Inn Number	Yes
AdditionalData.LodgingData.Address.Complement	String (100)	Hotel/Inn Complement	Yes
AdditionalData.LodgingData.Address.District	String (100)	Hotel/Inn Neighborhood	Yes
AdditionalData.LodgingData.Address.City	String (100)	Hotel/Inn City	Yes
AdditionalData.LodgingData.Address.State	String (2)	Hotel/Inn Status	Yes
AdditionalData.LodgingData.Address.Country	String (100)	Country of Hotel/Inn	Yes
AdditionalData.LodgingData.Lodger.LodgerName	String (100)	Host Name	Yes
AdditionalData.LodgingData.Lodger.LodgerEmail	String (300)	Host Email	No
AdditionalData.LodgingData.Lodger.LodgerPhone	String (15)	Guest Phone	No
AdditionalData.LodgingData.Lodger.LodgerDocument.Type	String (14)	Type Doc Host	Yes
AdditionalData.LodgingData.Lodger.LodgerDocument.Number	String (14)	In a Host Document	Yes