IPG Gateway Guide

IPG fact sheet

Adding an IPG gateway

To add an IPG Gateway you will need to obtain the user, password, certificate password, and certificates from the “API Soap” section of your IPG dashboard account.

The user field is mapped to user_id, password is mapped to password, and certificate password is mapped to pem_password when making an AddGateway request. To populate the pem field you must concatenate the certificate and private key fields from the IPG dashboard. One way to concatenate the certificate and private key is with the following command awk -v ORS='\\n' '1' {private_key_file_name}.key {public_certificate_file_name}.pem and copy the output into the pem field. Note: Be sure to check and not include any trailing whitespace or % characters.

User ID: The userid that you will send when creating the gateway should be the full User string from IPG (i.e. WS00000000000..1)

Store ID: If you only have one store_id you can pass it in when you create the gateway, but if you are a merchant aggregator and/or have multiple store_id values from IPG, you will want to use the gateway_specific_fields to pass in a store_id when transacting.

To add a IPG gateway:

curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>ipg</gateway_type>
        <user_id>Your User Id</user_id>
        <password>Your Password</password>
        <pem>Your Pem Certificate with Private Key</pem>
        <pem_password>Your Pem Password</pem_password>
      </gateway>'

<gateway>
  <token>ZOsUb8WXgy1N6WCPkaSZEvn7b7</token>
  <gateway_type>ipg</gateway_type>
  <name>IPG</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <store_id nil="true"/>
  <user_id>Your User Id</user_id>
  <pem_password>Your Pem Password</pem_password>
  <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">true</supports_store>
    <supports_remove type="boolean">true</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">false</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>
    <supports_stored_credentials type="boolean">true</supports_stored_credentials>
  </characteristics>
  <credentials>
    <credential>
      <name>store_id</name>
      <value nil="true"/>
    </credential>
    <credential>
      <name>user_id</name>
      <value>Your User Id</value>
    </credential>
    <credential>
      <name>pem_password</name>
      <value>Your Pem Password</value>
    </credential>
  </credentials>
  <gateway_settings>
    <store_id nil="true"/>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>hosted_data_id</gateway_specific_field>
    <gateway_specific_field>number_of_installments</gateway_specific_field>
    <gateway_specific_field>submerchant</gateway_specific_field>
    <gateway_specific_field>recurring_type</gateway_specific_field>
    <gateway_specific_field>store_id</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>third_party_token</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-10-26T21:03:28Z</created_at>
  <updated_at type="dateTime">2023-10-26T21:03:28Z</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 IPG. For more information about how to use this feature, see the 3DS2 Third-party Authentication Guide. Spreedly fields map to the relevant Paysafe fields as described in the following table.

SPREEDLY FIELD	IPG FIELD
`three_ds_version`	`Secure3DProtocolVersion`
`authentication_value`	`AuthenticationValue`
`directory_server_transaction_id`	`DirectoryServerTransactionId`
`xid`	`XID`

Gateway specific fields

Spreedly supports the following gateway specific fields when transacting with a IPG gateway:

number_of_installments
submerchant
recurring_type
hosted_data_id
store_id

hosted_data_id is passed for Third-Party Vaulting via the store action and it should be unique per cardholder. Passing this option allows the gateway to store payment source against the provided id otherwise gateway sends a unique hosted_data_id in response to be used for vaulting.

recurring_type is used as an alternative to passing the stored credentials object. See IPG’s documentation to learn more about how to use IPG API.

store_id is used as an alternative to the store_id passed when creating the gateway if the GSF is present. Note: if the gateway setting for store_id is nil and no store_id GSF is passed in, IPG gateway will return an unauthorized transaction response.

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>500</amount>
        <currency_code>ARS</currency_code>
        <gateway_specific_fields>
          <ipg>
            <number_of_installments>4</number_of_installments>
            <hosted_data_id>123456abc</hosted_data_id>
            <recurring_type>FIRST</recurring_type>
            <store_id>1234</store_id>
            <submerchant>
              <mcc>6513</mcc>
              <legal_name>KINDERLAND</legal_name>
              <address>
                <address1>ALVARADO 494</address1>
                <address2>Street 2</address2>
                <zip>1704</zip>
                <city>BUENOS AIRES</city>
                <state>BUENOS AIRES</state>
                <country>ARG</country>
              </address>
              <document>
                <type>SINGLE_CODE_OF_LABOR_IDENTIFICATION</type>
                <number>30710655479</number>
              </document>
              <merchant_id>12345678</merchant_id>
            </submerchant>
          </ipg>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2021-12-08T07:03:13Z</created_at>
  <updated_at type="dateTime">2021-12-08T07:03:13Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>WbD4M5ZoYXR9WzQNhPkIG7m6dSm</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>
    <ipg>
      <number_of_installments>4</number_of_installments>
      <hosted_data_id>123456abc</hosted_data_id>
      <recurring_type>FIRST</recurring_type>
      <store_id>1234</store_id>
      <submerchant>
        <mcc>6513</mcc>
        <legal_name>KINDERLAND</legal_name>
        <address>
          <address1>ALVARADO 494</address1>
          <address2>Street 2</address2>
          <zip>1704</zip>
          <city>BUENOS AIRES</city>
          <state>BUENOS AIRES</state>
          <country>ARG</country>
        </address>
        <document>
          <type>SINGLE_CODE_OF_LABOR_IDENTIFICATION</type>
          <number>30710655479</number>
        </document>
        <merchant_id>12345678</merchant_id>
      </submerchant>
    </ipg>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>46</gateway_transaction_id>
  <gateway_latency_ms type="integer">1</gateway_latency_ms>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <populate_mit_fields type="boolean">false</populate_mit_fields>
  <warning nil="true"/>
  <application_id nil="true"/>
  <amount type="integer">500</amount>
  <currency_code>ARS</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>
  <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">2021-12-08T07:03:13Z</created_at>
    <updated_at type="dateTime">2021-12-08T07:03:13Z</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">2021-12-06T23:37:28Z</updated_at>
    <email>[email protected]</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"/>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>

Gateway specific response fields

Responses from IPG gateway may contain approval_code, processor_response_message, processor_response_code, processor_association_response_code, processor_approval_code, processor_receipt_number, external_merchant_id, terminal_id, brand, processor_trace_number, processor_batch_number, processor_reference_number, country, commercial_service_provider, and payment_type.

For example, a purchase transaction could have something like this:

<transaction>
  <token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
  <transaction_type>Purchase</transaction_type>
  <gateway_specific_response_fields>
    <ipg>
      <approval_code>ABC123</approval_code>
      <processor_response_message>Function performed error free</processor_response_message>
      <processor_response_code>00</processor_response_code>
      <processor_association_response_code>AABBCC</processor_association_response_code>
      <processor_approval_code>12345</processor_approval_code>
      <processor_receipt_number>12345</processor_receipt_number>
      <external_merchant_id>8675309</external_merchant_id>
      <terminal_id>1010101</terminal_id>
      <brand>MASTERCARD</brand>
      <processor_trace_number>98765</processor_trace_number>
      <processor_batch_number>72186</processor_batch_number>
      <processor_reference_number>1234567890</processor_reference_number>
      <country>ARG</country>
      <commercial_service_provider>FDCS</commercial_service_provider>
      <payment_type>CREDITCARD</payment_type>
    </ipg>
  </gateway_specific_response_fields>
</transaction>

If you'd like to request any gateway_specific_fields or gateway_specific_response_fields, please contact Support with your request and the gateway documentation for the fields of interest.