13. Get Payment Methods

The Get Payment Methods API returns a list of payment methods with which a customer is eligible to pay. Their eligibility is based on the Curated Payment Business Rule that is applicable to the transaction.

13.1 Request

The following is an example of a request for the Get Payment Methods API:

?xml version="1.0" encoding="UTF-8"?>
<payment_method_search_criteria>
	<event_id>5754676</event_id>
	<account_id>101118</account_id>
	<transaction>
		<type_id>1</type_id>
		<order_no>MLW761</order_no>
		<product_type>100</product_type>
		<fees>
			<fee>
				<value>2300</value>
				<type>1</type>
			</fee>
		</fees>
		<amount>
			<value>10000</value>
			<country_id>407</country_id>
			<currency_id>840</currency_id>
			<decimal>2</decimal>
		</amount>
		<orders>
			<line_item>
				<product>
					<name>RETURN</name>
					<sku>3HHQM6</sku>
					<description>return</description>
					<airline_data>
						<flight_details>
							<flight_detail>
								<tag>1</tag>
								<trip_count>1</trip_count>
								<service_level>10</service_level>
								<service_class>E</service_class>
								<departure_date>2022-12-15T05:14:00Z</departure_date>
								<arrival_date>2022-12-15T06:10:00Z</arrival_date>
								<departure_country>405</departure_country>
								<arrival_country>405</arrival_country>
								<departure_airport>
									<iata>MDE</iata>
								</departure_airport>
								<arrival_airport>
									<iata>BOG</iata>
								</arrival_airport>
								<time_zone>-5:00</time_zone>
							</flight_detail>
							<flight_detail>
								<tag>1</tag>
								<trip_count>2</trip_count>
								<service_level>10</service_level>
								<service_class>E</service_class>
								<departure_date>2022-12-15T07:10:00Z</departure_date>
								<arrival_date>2022-12-15T08:15:00Z</arrival_date>
								<departure_country>405</departure_country>
								<arrival_country>405</arrival_country>
								<departure_airport>
									<iata>BOG</iata>
								</departure_airport>
								<arrival_airport>
									<iata>AXM</iata>
								</arrival_airport>
								<time_zone>-5:00</time_zone>
							</flight_detail>
						</flight_details>
						<billing_summary>
							<fare_detail>
								<fare>
									<profile_seq>1</profile_seq>
									<description>Base Fare</description>
									<currency>COP</currency>
									<amount>35710000</amount>
									<product_code>BASE</product_code>
									<product_category>FARE</product_category>
									<product_item>Base Fare</product_item>
								</fare>								
								<fare>
									<profile_seq>1</profile_seq>
									<description>Localization Key - Sales Tax Colombia</description>
									<currency>COP</currency>
									<amount>2226000</amount>
									<product_code>YSTR</product_code>
									<product_category>TAX</product_category>
									<product_item>Sales Tax Colombia</product_item>
								</fare>
							</fare_detail>
							<add_ons>
								<add_on>
									<profile_seq>1</profile_seq>
									<trip_tag>1</trip_tag>
									<trip_seq>1</trip_seq>
									<description>Localization Key - SEAT PRICE</description>
									<currency>COP</currency>
									<amount>2999000</amount>
									<product_code>SEAT</product_code>
									<product_category>SERVICE</product_category>
									<product_item>10E</product_item>
								</add_on>								
								<add_on>
									<profile_seq>2</profile_seq>
									<trip_tag>2</trip_tag>
									<trip_seq>1</trip_seq>
									<description>Localization Key - CBAG</description>
									<currency>COP</currency>
									<amount>18000000</amount>
									<product_code>CBAG</product_code>
									<product_category>Service</product_category>
									<product_item>3RD CHECKED BAG OR MORE 23KG</product_item>
								</add_on>
							</add_ons>
						</billing_summary>
					</airline_data>
				</product>
			</line_item>
			<amount>
				<country_id>407</country_id>
				<value>273891000</value>
			</amount>
		</orders>
	</transaction>
	<client_info>
		<platform>HTML5</platform>
		<language>en</language>
		<version>2.00</version>
		<sdk-version>2.0.0</sdk-version>
		<mobile>
			<mobile>9990521077</mobile>
			<mobile_type>MobileEnriched</mobile_type>
			<country_id>407</country_id>
			<validated>true</validated>
		</mobile>
		<email>
			<email>[email protected]</email>
			<email_type>EmailEnriched</email_type>
			<validated>true</validated>
		</email>
		<device_id>2E8667F78B23402BBFF6176313BD58D314566333</device_id>
		<ip>10.36.1.15</ip>
		<client_id>10101</client_id>
	</client_info>
</payment_method_search_criteria>

13.2 Response

The following is an example of a response for the Get Payment Methods API:

<payment_method_search_response>
    <payment_methods>
        <payment_method>
            <id>8</id>
            <psp_type/>
            <preference>1</preference>
            <state_id>1</state_id>
        </payment_method>
        <payment_method>
            <id>7</id>
            <psp_type/>
            <preference>2</preference>
            <state_id>1</state_id>
        </payment_method>
       
    </payment_methods>
</payment_method_search_response>

The parameters are listed and defined in the table below.