Ingenico ePayments (formerly GlobalCollect) Gateway Guide
Services and Compatibility
- Payment Gateway Company Name:
- Ingenico ePayments (formerly GlobalCollect)
- Services that work with Spreedly:
-
- Ingenico ePayments (formerly GlobalCollect)
- Supported operations:
- Purchase, Authorize, Capture, Refund, Void, Verify
- Supported payment types:
- Credit Card, Apple Pay, Google Pay
- Spreedly 3DS2 Global Supported
- Yes
- Gateway Specific 3DS2 Supported
- No
- Populate MIT GSF Support
- No
- Regions:
- Asia Pacific, Europe, Latin America, Middle East, North America
- API endpoint URL:
-
https://world.api-ingenico.com
Authentication and Security
- Specific names for credentials:
- Api Key Id, Merchant Id, Secret Api Key
Onboarding Merchants in:
-
Andorra
-
United Arab Emirates
-
Antigua and Barbuda
-
Anguilla
-
Albania
-
Armenia
-
Angola
-
Argentina
-
American Samoa
-
Austria
-
Australia
-
Aruba
-
Åland Islands
-
Azerbaijan
-
Bosnia and Herzegovina
-
Barbados
-
Bangladesh
-
Belgium
-
Burkina Faso
-
Bulgaria
-
Bahrain
-
Burundi
-
Benin
-
Saint Barthélemy
-
Bermuda
-
Brunei Darussalam
-
Bolivia (Plurinational State of)
-
Bonaire, Sint Eustatius and Saba
-
Brazil
-
Bahamas
-
Bhutan
-
Botswana
-
Belarus
-
Belize
-
Canada
-
Cocos (Keeling) Islands
-
Congo (Democratic Republic of the)
-
Central African Republic
-
Switzerland
-
Côte d'Ivoire
-
Cook Islands
-
Chile
-
Cameroon
-
China
-
Colombia
-
Costa Rica
-
Cuba
-
Cabo Verde
-
Curaçao
-
Christmas Island
-
Cyprus
-
Czechia
-
Germany
-
Djibouti
-
Denmark
-
Dominica
-
Dominican Republic
-
Algeria
-
Ecuador
-
Estonia
-
Egypt
-
Eritrea
-
Spain
-
Ethiopia
-
Finland
-
Fiji
-
Falkland Islands (Malvinas)
-
Micronesia (Federated States of)
-
Faroe Islands
-
France
-
Gabon
-
United Kingdom
-
Grenada
-
Georgia
-
French Guiana
-
Ghana
-
Gibraltar
-
Greenland
-
Gambia
-
Guinea
-
Guadeloupe
-
Equatorial Guinea
-
Greece
-
South Georgia and the South Sandwich Islands
-
Guatemala
-
Guam
-
Guinea-Bissau
-
Guyana
-
Hong Kong
-
Honduras
-
Croatia
-
Haiti
-
Hungary
-
Indonesia
-
Ireland
-
Israel
-
Isle of Man
-
India
-
Iceland
-
Italy
-
Jamaica
-
Jordan
-
Japan
-
Kenya
-
Kyrgyzstan
-
Cambodia
-
Kiribati
-
Comoros
-
Saint Kitts and Nevis
-
Korea (Republic of)
-
Kuwait
-
Cayman Islands
-
Kazakhstan
-
Lao People’s Democratic Republic
-
Lebanon
-
Saint Lucia
-
Liechtenstein
-
Sri Lanka
-
Liberia
-
Lesotho
-
Lithuania
-
Luxembourg
-
Latvia
-
Morocco
-
Monaco
-
Moldova (Republic of)
-
Montenegro
-
Saint Martin (French part)
-
Madagascar
-
Marshall Islands
-
Macedonia (the former Yugoslav Republic of)
-
Myanmar
-
Mongolia
-
Macao
-
Northern Mariana Islands
-
Martinique
-
Mauritania
-
Montserrat
-
Malta
-
Mauritius
-
Maldives
-
Malawi
-
Mexico
-
Malaysia
-
Mozambique
-
Namibia
-
New Caledonia
-
Niger
-
Nigeria
-
Nicaragua
-
Netherlands
-
Norway
-
Nepal
-
Nauru
-
Niue
-
New Zealand
-
Oman
-
Panama
-
Peru
-
French Polynesia
-
Papua New Guinea
-
Philippines
-
Poland
-
Pitcairn
-
Palestine, State of
-
Portugal
-
Palau
-
Qatar
-
Réunion
-
Romania
-
Serbia
-
Russian Federation
-
Rwanda
-
Saudi Arabia
-
Solomon Islands
-
Seychelles
-
Sweden
-
Singapore
-
Saint Helena, Ascension and Tristan da Cunha
-
Slovenia
-
Svalbard and Jan Mayen
-
Slovakia
-
Sierra Leone
-
San Marino
-
Senegal
-
Suriname
-
Sao Tome and Principe
-
El Salvador
-
Swaziland
-
Turks and Caicos Islands
-
Chad
-
Togo
-
Thailand
-
Tajikistan
-
Timor-Leste
-
Turkmenistan
-
Tunisia
-
Tonga
-
Turkey
-
Trinidad and Tobago
-
Tuvalu
-
Taiwan
-
Tanzania, United Republic of
-
Ukraine
-
Uganda
-
United States
-
Uruguay
-
Uzbekistan
-
Saint Vincent and the Grenadines
-
Venezuela (Bolivarian Republic of)
-
Virgin Islands (British)
-
Virgin Islands (U.S.)
-
Vietnam
-
Wallis and Futuna
-
Samoa
-
South Africa
-
Zambia
-
Zimbabwe
Adding a Global Collect gateway
To add a Ingenico ePayments (formerly GlobalCollect) gateway:
curl https://core.spreedly.com/v1/gateways.xml \
-u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-H 'Content-Type: application/xml' \
-d '<gateway>
<gateway_type>global_collect</gateway_type>
<merchant_id>Your Merchant ID</merchant_id>
<api_key_id>Your API Key ID</api_key_id>
<secret_api_key>Your Secret API key</secret_api_key>
</gateway>'
<gateway>
<token>Zsys40JozrI8FrR2GpPJOhmiMIe</token>
<gateway_type>global_collect</gateway_type>
<name>Ingenico ePayments (formerly GlobalCollect)</name>
<description nil="true"/>
<merchant_profile_key nil="true"/>
<sub_merchant_key nil="true"/>
<merchant_id>Your Merchant ID</merchant_id>
<api_key_id>Your API Key ID</api_key_id>
<characteristics>
<supports_purchase type="boolean">true</supports_purchase>
<supports_authorize type="boolean">true</supports_authorize>
<supports_capture type="boolean">true</supports_capture>
<supports_credit type="boolean">true</supports_credit>
<supports_general_credit type="boolean">false</supports_general_credit>
<supports_void type="boolean">true</supports_void>
<supports_adjust type="boolean">false</supports_adjust>
<supports_verify type="boolean">true</supports_verify>
<supports_reference_purchase type="boolean">false</supports_reference_purchase>
<supports_purchase_via_preauthorization type="boolean">false</supports_purchase_via_preauthorization>
<supports_offsite_purchase type="boolean">false</supports_offsite_purchase>
<supports_offsite_authorize type="boolean">false</supports_offsite_authorize>
<supports_offsite_synchronous_purchase type="boolean">false</supports_offsite_synchronous_purchase>
<supports_offsite_synchronous_authorize type="boolean">false</supports_offsite_synchronous_authorize>
<supports_3dsecure_purchase type="boolean">false</supports_3dsecure_purchase>
<supports_3dsecure_authorize type="boolean">false</supports_3dsecure_authorize>
<supports_3dsecure_2_mpi_purchase type="boolean">true</supports_3dsecure_2_mpi_purchase>
<supports_3dsecure_2_mpi_authorize type="boolean">true</supports_3dsecure_2_mpi_authorize>
<supports_store type="boolean">false</supports_store>
<supports_remove type="boolean">false</supports_remove>
<supports_fraud_review type="boolean">false</supports_fraud_review>
<supports_network_tokenization type="boolean">false</supports_network_tokenization>
<supports_populate_mit_fields type="boolean">false</supports_populate_mit_fields>
</characteristics>
<credentials>
<credential>
<name>merchant_id</name>
<value>Your Merchant ID</value>
</credential>
<credential>
<name>api_key_id</name>
<value>Your API Key ID</value>
</credential>
</credentials>
<gateway_settings>
<url_override nil="true"/>
</gateway_settings>
<gateway_specific_fields>
<gateway_specific_field>airline_data</gateway_specific_field>
<gateway_specific_field>lodging_data</gateway_specific_field>
<gateway_specific_field>country_code</gateway_specific_field>
<gateway_specific_field>fraud_fields</gateway_specific_field>
<gateway_specific_field>pre_authorization</gateway_specific_field>
<gateway_specific_field>requires_approval</gateway_specific_field>
<gateway_specific_field>number_of_installments</gateway_specific_field>
<gateway_specific_field>idempotency_key</gateway_specific_field>
<gateway_specific_field>payment_product_id</gateway_specific_field>
</gateway_specific_fields>
<payment_methods>
<payment_method>credit_card</payment_method>
</payment_methods>
<state>retained</state>
<redacted type="boolean">false</redacted>
<sandbox type="boolean">false</sandbox>
<mode>default</mode>
<created_at type="dateTime">2022-08-10T20:10:14Z</created_at>
<updated_at type="dateTime">2022-08-10T20:10:14Z</updated_at>
</gateway>
env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:global_collect, merchant_id: "Your merchant_id", api_key_id: "Your secret",
secret_api_key: "Your refund_password")
#<Spreedly::Gateway:0x007fb8c9984480
@token="OcqqYa9hK4r3ofQOJnm4Edt41to",
@created_at="2017-11-17T14:48:37Z",
@updated_at="2017-11-17T14:48:37Z",
@gateway_type="global_collect",
@state="retained",
@name="Ingenico ePayments (formerly GlobalCollect)",
@credentials={"merchant_id"=>"Your merchant_id", "api_key_id"=>"Your secret"}>
Add Ogone Direct API through GlobalCollect
Additionally the Global Collect Gateway offers the capability to utilize the Ogone Direct API,
facilitated by the shared usage of the same Payment Service Provider (PSP) between the two gateways.
To integrate an Ogone Gateway within the Global Collect integration, the following parameters need
to be provided: merchant_id
, api_key_id
, and secret_api_key
, which can be obtained from your Ogone
Direct API credentials. Additionally, it is necessary to include the url_override
field when creating the gateway and have it set to ogone_direct
. Example below:
Add Ogone Direct API throught GlobalCollect
curl https://core.spreedly.com/v1/gateways.xml \
-u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-H 'Content-Type: application/xml' \
-d '<gateway>
<gateway_type>global_collect</gateway_type>
<merchant_id>PSPID</merchant_id>
<api_key_id>API KEY ID</api_key_id>
<secret_api_key>WORLDINE_SECRET</secret_api_key>
<url_override>ogone_direct</url_override>
</gateway>'
<gateway>
<token>Zzm080ICLOWUYhXKWilpARSHmsf</token>
<gateway_type>global_collect</gateway_type>
<name>Ingenico ePayments (formerly GlobalCollect)</name>
<description nil="true"/>
<merchant_profile_key nil="true"/>
<sub_merchant_key nil="true"/>
<merchant_id>PSPID</merchant_id>
<api_key_id>API KEY ID</api_key_id>
<characteristics>
<supports_purchase type="boolean">true</supports_purchase>
<supports_authorize type="boolean">true</supports_authorize>
<supports_capture type="boolean">true</supports_capture>
<supports_credit type="boolean">true</supports_credit>
<supports_general_credit type="boolean">false</supports_general_credit>
<supports_void type="boolean">true</supports_void>
<supports_adjust type="boolean">false</supports_adjust>
<supports_verify type="boolean">true</supports_verify>
<supports_reference_purchase type="boolean">false</supports_reference_purchase>
<supports_purchase_via_preauthorization type="boolean">false</supports_purchase_via_preauthorization>
<supports_offsite_purchase type="boolean">false</supports_offsite_purchase>
<supports_offsite_authorize type="boolean">false</supports_offsite_authorize>
<supports_offsite_synchronous_purchase type="boolean">false</supports_offsite_synchronous_purchase>
<supports_offsite_synchronous_authorize type="boolean">false</supports_offsite_synchronous_authorize>
<supports_3dsecure_purchase type="boolean">false</supports_3dsecure_purchase>
<supports_3dsecure_authorize type="boolean">false</supports_3dsecure_authorize>
<supports_3dsecure_2_mpi_purchase type="boolean">true</supports_3dsecure_2_mpi_purchase>
<supports_3dsecure_2_mpi_authorize type="boolean">true</supports_3dsecure_2_mpi_authorize>
<supports_store type="boolean">false</supports_store>
<supports_remove type="boolean">false</supports_remove>
<supports_fraud_review type="boolean">false</supports_fraud_review>
<supports_network_tokenization type="boolean">false</supports_network_tokenization>
<supports_populate_mit_fields type="boolean">false</supports_populate_mit_fields>
<supports_inquire_by_gateway_transaction_id type="boolean">true</supports_inquire_by_gateway_transaction_id>
<supports_inquire_by_order_id type="boolean">false</supports_inquire_by_order_id>
<supports_transaction_retry type="boolean">false</supports_transaction_retry>
<supports_stored_stored_credentials type="boolean">false</supports_stored_stored_credentials>
</characteristics>
<credentials>
<credential>
<name>merchant_id</name>
<value>PSPID</value>
</credential>
<credential>
<name>api_key_id</name>
<value>API KEY ID</value>
</credential>
</credentials>
<gateway_settings>
<url_override>ogone_direct</url_override>
</gateway_settings>
<gateway_specific_fields>
<gateway_specific_field>airline_data</gateway_specific_field>
<gateway_specific_field>lodging_data</gateway_specific_field>
<gateway_specific_field>country_code</gateway_specific_field>
<gateway_specific_field>fraud_fields</gateway_specific_field>
<gateway_specific_field>pre_authorization</gateway_specific_field>
<gateway_specific_field>requires_approval</gateway_specific_field>
<gateway_specific_field>number_of_installments</gateway_specific_field>
<gateway_specific_field>idempotency_key</gateway_specific_field>
<gateway_specific_field>payment_product_id</gateway_specific_field>
<gateway_specific_field>customer</gateway_specific_field>
</gateway_specific_fields>
<payment_methods>
<payment_method>credit_card</payment_method>
<payment_method>apple_pay</payment_method>
<payment_method>google_pay</payment_method>
</payment_methods>
<state>retained</state>
<redacted type="boolean">false</redacted>
<sandbox type="boolean">false</sandbox>
<mode>default</mode>
<created_at type="dateTime">2023-06-07T15:47:10Z</created_at>
<updated_at type="dateTime">2023-06-07T15:47:10Z</updated_at>
</gateway>
Third-party 3D Secure 2 auth data
Spreedly will automatically handle the field mapping for sending third-party 3DS2 authentication data to Ingenico. For more information about how to use this feature, see the 3DS2 Third-party Authentication Guide. Spreedly fields map to the relevant Ingenico fields as described in the following table. Please see Ingenico’s transaction variable documentation for detailed descriptions of each of these fields and when to use them.
Spreedly Field | Ingenico Field |
---|---|
three_ds_version |
threeDSecureVersion |
ecommerce_indicator |
eci |
authentication_value |
cavv |
authentication_value_algorithm |
cavvAlgorithm |
directory_server_transaction_id |
directoryServerTransactionId |
authentication_response_status |
validationResult |
acs_transaction_id |
acsTransactionId |
xid |
xid |
The above field mapping are the same if you are working with the Ogone Direct API
Gateway specific fields
When interacting with Ingenico ePayments (formerly GlobalCollect) gateway to run transactions, you can specify true
or false
for
the optional field pre_authorization
, approved for use by some acquirers.
When performing an authorization or purchase, the billing address associated with the payment method will be sent to Ingenico. The country_code
field allows developers to supply a country code for payment methods that do not have a billing address or to override the country code associated with the payment method being used for the transaction.
requires_approval
is an optional boolean field that can be sent on a purchase. If it is false
, then a purchase
request will capture funds via an auth
call (and not attempt a capture
call). If it is true
or not present, then a purchase
request will make an auth
call and, if necessary, a capture
call to capture the funds. For specific details, see requiresApproval
in the cardPaymentMethodSpecificInput
Group in Ingenico’s Create Payment Request documentation.
idempotency_key
is a field that supports idempotent requests. The value of the field will be sent as an idempotent request header value.
payment_product_id
is a field that allows you to pass in an integer that is associated with a payment product.
Fraud fields
You can specify certain fraud-related fields in a JSON blob supplied via the fraud_fields
field. For more information and which sub-fields are available, see the Ingenico ePayments developer documentation.
Lodging data fields
The lodging_data
field requires the inclusion of some specific subfields. For specific details, see order > additionalInput > lodging_data
in Ingenico’s Create Payment Request documentation. This data may also be supplied in a JSON blob similar to fraud_fields
. Only the fields specified below will be passed.
Airline data fields
The airline_data
field requires the inclusion of some specific subfields. For specific details, see order > additionalInput > airlineData
in Ingenico’s Create Payment Request documentation. This data may also be supplied in a JSON blob similar to fraud_fields
. Only the fields specified below will be passed.
curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
-u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-H 'Content-Type: application/xml' \
-d '<transaction>
<payment_method_token>56wyNnSmuA6CWYP7w0MiYCVIbW6</payment_method_token>
<amount>100</amount>
<currency_code>USD</currency_code>
<gateway_specific_fields>
<global_collect>
<pre_authorization>true</pre_authorization>
<fraud_fields><![CDATA[
{
"website": "www.example.com",
"giftMessage": "Happy Day!"
}
]]></fraud_fields>
<airline_data>
<code>111</code>
<name>Spreedly Airlines</name>
<flight_date>20190810</flight_date>
<passenger_name>Randi Smith</passenger_name>
<is_eticket>True</is_eticket>
<is_third_party>True</is_third_party>
<issue_date>20210901</issue_date>
<merchant_customer_id>AIR1234ID</merchant_customer_id>
<agent_numeric_code>12345</agent_numeric_code>
<passengers>
<first_name>Randi</first_name>
<surname>Smith</surname>
<surname_prefix>Smithy</surname_prefix>
<title>Mr</title>
</passengers>
<passengers>
<first_name></first_name>
<surname></surname>
<surname_prefix></surname_prefix>
<title></title>
</passengers>
<flight_legs>
<airline_class>ZZ</airline_class>
<arrival_airport>BDL</arrival_airport>
<arrival_time></arrival_time>
<carrier_code>SA</carrier_code>
<coupon_number>1</coupon_number>
<date>20190810</date>
<departure_time>1220</departure_time>
<endorsement_or_restriction>No</endorsement_or_restriction>
<exchange_ticket>No</exchange_ticket>
<fare>20000</fare>
<fare_basis>Fare Basis</fare_basis>
<fee>1</fee>
<flight_number>DA123</flight_number>
<number>596</number>
<origin_airport>RDU</origin_airport>
<passenger_class>Coach</passenger_class>
<stopover_code>permitted</stopover_code>
<taxes>700</taxes>
</flight_legs>
<flight_legs>
<arrival_airport>RDU</arrival_airport>
<origin_airport>BDL</origin_airport>
<date>20190817</date>
<carrier_code>SA</carrier_code>
<number>597</number>
<airline_class>ZZ</airline_class>
</flight_legs>
</airline_data>
<lodging_data>
<charges>
<charge_amount>1000</charge_amount>
<charge_amount_currency_code>USD</charge_amount_currency_code>
<charge_type>giftshop</charge_type>
</charges>
<check_in_date>20211223</check_in_date>
<check_out_date>20211227</check_out_date>
<folio_number>randAssortmentofChars</folio_number>
<is_confirmed_reservation>true</is_confirmed_reservation>
<is_facility_fire_safety_conform>true</is_facility_fire_safety_conform>
<is_no_show>false</is_no_show>
<is_preference_no_smoking_room>true</is_preference_no_smoking_room>
<number_of_adults>2</number_of_adults>
<number_of_nights>1</number_of_nights>
<number_of_rooms>1</number_of_rooms>
<program_code>advancedDeposit</program_code>
<property_customer_service_phone_number>5555555555</property_customer_service_phone_number>
<property_phone_number>5555555555</property_phone_number>
<renter_name>Person</renter_name>
<rooms>
<daily_room_rate>25000</daily_room_rate>
<daily_room_rate_currency_code>USD</daily_room_rate_currency_code>
<daily_room_tax_amount>5</daily_room_tax_amount>
<daily_room_tax_amount_currency_code>USD</daily_room_tax_amount_currency_code>
<number_of_nights_at_room_rate>1</number_of_nights_at_room_rate>
<room_location>Courtyard</room_location>
<type_of_bed>Queen</type_of_bed>
<type_of_room>Walled</type_of_room>
</rooms>
</lodging_data>
<number_of_installments>3</number_of_installments>
<country_code>US</country_code>
<requires_approval>true</requires_approval>
<idempotency_key>test123</idempotency_key>
<payment_product_id>1</payment_product_id>
</global_collect>
</gateway_specific_fields>
</transaction>'
<transaction>
<on_test_gateway type="boolean">true</on_test_gateway>
<created_at type="dateTime">2023-08-16T23:00:00Z</created_at>
<updated_at type="dateTime">2023-08-16T23:00:00Z</updated_at>
<succeeded type="boolean">true</succeeded>
<state>succeeded</state>
<token>Aa8NAmHau8kGQreYJgsCO514cDi</token>
<transaction_type>Purchase</transaction_type>
<order_id nil="true"/>
<ip nil="true"/>
<description nil="true"/>
<email nil="true"/>
<merchant_name_descriptor nil="true"/>
<merchant_location_descriptor nil="true"/>
<merchant_profile_key nil="true"/>
<gateway_specific_fields>
<global_collect>
<pre_authorization>true</pre_authorization>
<fraud_fields>
{
"website": "www.example.com",
"giftMessage": "Happy Day!"
}
</fraud_fields>
<airline_data>
<code>111</code>
<name>Spreedly Airlines</name>
<flight_date>20190810</flight_date>
<passenger_name>Randi Smith</passenger_name>
<is_eticket>True</is_eticket>
<is_third_party>True</is_third_party>
<issue_date>20210901</issue_date>
<merchant_customer_id>AIR1234ID</merchant_customer_id>
<agent_numeric_code>12345</agent_numeric_code>
<passengers type="array">
<passenger>
<first_name>Randi</first_name>
<surname>Smith</surname>
<surname_prefix>Smithy</surname_prefix>
<title>Mr</title>
</passenger>
<passenger>
<first_name nil="true"/>
<surname nil="true"/>
<surname_prefix nil="true"/>
<title nil="true"/>
</passenger>
</passengers>
<flight_legs type="array">
<flight_leg>
<airline_class>ZZ</airline_class>
<arrival_airport>BDL</arrival_airport>
<arrival_time nil="true"/>
<carrier_code>SA</carrier_code>
<coupon_number>1</coupon_number>
<date>20190810</date>
<departure_time>1220</departure_time>
<endorsement_or_restriction>No</endorsement_or_restriction>
<exchange_ticket>No</exchange_ticket>
<fare>20000</fare>
<fare_basis>Fare Basis</fare_basis>
<fee>1</fee>
<flight_number>DA123</flight_number>
<number>596</number>
<origin_airport>RDU</origin_airport>
<passenger_class>Coach</passenger_class>
<stopover_code>permitted</stopover_code>
<taxes>700</taxes>
</flight_leg>
<flight_leg>
<arrival_airport>RDU</arrival_airport>
<origin_airport>BDL</origin_airport>
<date>20190817</date>
<carrier_code>SA</carrier_code>
<number>597</number>
<airline_class>ZZ</airline_class>
</flight_leg>
</flight_legs>
</airline_data>
<lodging_data>
<charges>
<charge_amount>1000</charge_amount>
<charge_amount_currency_code>USD</charge_amount_currency_code>
<charge_type>giftshop</charge_type>
</charges>
<check_in_date>20211223</check_in_date>
<check_out_date>20211227</check_out_date>
<folio_number>randAssortmentofChars</folio_number>
<is_confirmed_reservation>true</is_confirmed_reservation>
<is_facility_fire_safety_conform>true</is_facility_fire_safety_conform>
<is_no_show>false</is_no_show>
<is_preference_no_smoking_room>true</is_preference_no_smoking_room>
<number_of_adults>2</number_of_adults>
<number_of_nights>1</number_of_nights>
<number_of_rooms>1</number_of_rooms>
<program_code>advancedDeposit</program_code>
<property_customer_service_phone_number>5555555555</property_customer_service_phone_number>
<property_phone_number>5555555555</property_phone_number>
<renter_name>Person</renter_name>
<rooms>
<daily_room_rate>25000</daily_room_rate>
<daily_room_rate_currency_code>USD</daily_room_rate_currency_code>
<daily_room_tax_amount>5</daily_room_tax_amount>
<daily_room_tax_amount_currency_code>USD</daily_room_tax_amount_currency_code>
<number_of_nights_at_room_rate>1</number_of_nights_at_room_rate>
<room_location>Courtyard</room_location>
<type_of_bed>Queen</type_of_bed>
<type_of_room>Walled</type_of_room>
</rooms>
</lodging_data>
<number_of_installments>3</number_of_installments>
<country_code>US</country_code>
<requires_approval>true</requires_approval>
<idempotency_key>test123</idempotency_key>
<payment_product_id>1</payment_product_id>
</global_collect>
</gateway_specific_fields>
<gateway_specific_response_fields>
</gateway_specific_response_fields>
<gateway_transaction_id>48</gateway_transaction_id>
<sub_merchant_key nil="true"/>
<gateway_latency_ms type="integer">0</gateway_latency_ms>
<warning nil="true"/>
<application_id nil="true"/>
<amount type="integer">100</amount>
<local_amount nil="true"/>
<currency_code>USD</currency_code>
<retain_on_success type="boolean">false</retain_on_success>
<payment_method_added type="boolean">false</payment_method_added>
<smart_routed type="boolean">false</smart_routed>
<stored_credential_initiator nil="true"/>
<stored_credential_reason_type nil="true"/>
<stored_credential_gateway_override nil="true"/>
<populate_mit_fields type="boolean">false</populate_mit_fields>
<message key="messages.transaction_succeeded">Succeeded!</message>
<gateway_token>T11bJAANtTWnxl36GYjKWvbNK0g</gateway_token>
<gateway_type>test</gateway_type>
<shipping_address>
<name>Newfirst Newlast</name>
<address1 nil="true"/>
<address2 nil="true"/>
<city nil="true"/>
<state nil="true"/>
<zip nil="true"/>
<country nil="true"/>
<phone_number nil="true"/>
</shipping_address>
<response>
<success type="boolean">true</success>
<message>Successful purchase</message>
<avs_code nil="true"/>
<avs_message nil="true"/>
<cvv_code nil="true"/>
<cvv_message nil="true"/>
<pending type="boolean">false</pending>
<result_unknown type="boolean">false</result_unknown>
<error_code nil="true"/>
<error_detail nil="true"/>
<cancelled type="boolean">false</cancelled>
<fraud_review nil="true"/>
<created_at type="dateTime">2023-08-16T23:00:00Z</created_at>
<updated_at type="dateTime">2023-08-16T23:00:00Z</updated_at>
</response>
<api_urls>
</api_urls>
<payment_method>
<token>1rpKvP8zOUhj4Y9EDrIoIYQzzD5</token>
<created_at type="dateTime">2017-06-26T17:04:38Z</created_at>
<updated_at type="dateTime">2023-07-26T22:44:00Z</updated_at>
<email>joey@example.com</email>
<data>
<my_payment_method_identifier>448</my_payment_method_identifier>
<extra_stuff>
<some_other_things>Can be anything really</some_other_things>
</extra_stuff>
</data>
<storage_state>retained</storage_state>
<test type="boolean">true</test>
<metadata>
<key>string value</key>
</metadata>
<callback_url nil="true"/>
<last_four_digits>1111</last_four_digits>
<first_six_digits>411111</first_six_digits>
<card_type>visa</card_type>
<first_name>Newfirst</first_name>
<last_name>Newlast</last_name>
<month type="integer">3</month>
<year type="integer">2032</year>
<address1 nil="true"/>
<address2 nil="true"/>
<city nil="true"/>
<state nil="true"/>
<zip nil="true"/>
<country nil="true"/>
<phone_number nil="true"/>
<company nil="true"/>
<full_name>Newfirst Newlast</full_name>
<eligible_for_card_updater type="boolean">true</eligible_for_card_updater>
<shipping_address1 nil="true"/>
<shipping_address2 nil="true"/>
<shipping_city nil="true"/>
<shipping_state nil="true"/>
<shipping_zip nil="true"/>
<shipping_country nil="true"/>
<shipping_phone_number nil="true"/>
<issuer_identification_number nil="true"/>
<click_to_pay type="boolean">false</click_to_pay>
<managed nil="true"/>
<payment_method_type>credit_card</payment_method_type>
<errors>
</errors>
<verification_value></verification_value>
<number>XXXX-XXXX-XXXX-1111</number>
<fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
<stored_credential_usage>
<test>
<original_network_transaction_id>37be5367d6dbe4a88c9d</original_network_transaction_id>
<network_transaction_id>37be5367d6dbe4a88c9d</network_transaction_id>
</test>
</stored_credential_usage>
</payment_method>
<attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>
Please refer to using a payment method for more information on how to send GSFs
Gateway specific response fields
A response from Ingenico ePayments (formerly GlobalCollect) gateway may contain a authorisation_code
, provider_id
, and status_output
field which you can find in the gateway_specific_response_fields
.
status_output
is an object which may contain some/all of these additional fields:statusCodeChangeDateTime
,statusCode
,statusCategory
,isRetriable
,isRefundable
,isCancellable
, andisAuthorized
.
For example, a transaction could have something like this:
<transaction>
<token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
<transaction_type>Purchase</transaction_type>
<gateway_specific_response_fields>
<global_collect>
<authorisation_code>12345678</authorisation_code>
<provider_id>provider123</provider_id>
<status_output>
<statusCodeChangeDateTime>20230704013312</statusCodeChangeDateTime>
<statusCode>000</statusCode>
<statusCategory>PENDING_CONNECT</statusCategory>
<isRetriable>true</isRetriable>
<isRefundable>true</isRefundable>
<isCancellable>true</isCancellable>
<isAuthorized>true</isAuthorized>
</status_output>
</global_collect>
</gateway_specific_response_fields>
</transaction>
If you’d like to request any additional gateway_specific_fields
or gateway_specific_response_fields
, please contact Support with your request and the gateway documentation for the fields of interest.
Syncing Transactions
Spreedly supports updating the status of transactions that have been initiated at the Ingenico gateway using the gateway_transaction_id
.
See our documentation for more information.