Worldline (formerly Ogone) Gateway Guide

Worldline (formerly Ogone) fact sheet

Adding a Worldline gateway

Default Mode

To add an Worldline (formerly Ogone) gateway:

 <https://core.spreedly.com/v1/gateways.xml>  
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ'  
  -H 'Content-Type: application/xml'  
  -d '<gateway>  
        \<gateway_type>ogone\</gateway_type>  
        <pspid>psp</pspid>  
        <userid>user</userid>  
        <password>password</password>  
        <signature>sig</signature>  
        \<signature_strength>sha512\</signature_strength>  
      </gateway>'

The signature_strength can be either sha256 or sha512, and will have to match the strength set in the Ogone backend.

<gateway>
  <token>Oj05SGmzLNlnjSLDUNa7vhdoWku</token>
  <gateway_type>ogone</gateway_type>
  <name>Ingenico ePayments (formerly Ogone)</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <pspid>psp</pspid>
  <userid>user</userid>
  <signature_strength>sha512</signature_strength>
  <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_3dsecure_purchase type="boolean">true</supports_3dsecure_purchase>
    <supports_3dsecure_authorize type="boolean">true</supports_3dsecure_authorize>
    <supports_3dsecure_2_mpi_purchase type="boolean">false</supports_3dsecure_2_mpi_purchase>
    <supports_3dsecure_2_mpi_authorize type="boolean">false</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>pspid</name>
      <value>psp</value>
    </credential>
    <credential>
      <name>userid</name>
      <value>user</value>
    </credential>
    <credential>
      <name>signature_strength</name>
      <value>sha512</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>eci</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>
  <created_at type="dateTime">2021-11-23T21:58:43Z</created_at>
  <updated_at type="dateTime">2021-11-23T21:58:43Z</updated_at>
  <mode>default</mode>
</gateway>

No Signature Mode

Legacy Ogone accounts may not require or use a signature; for these you can specify the no_signature mode:

<https://core.spreedly.com/v1/gateways.xml>  
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ'  
  -H 'Content-Type: application/xml'  
  -d '<gateway>  
        \<gateway_type>ogone\</gateway_type>  
        <mode>no_signature</mode>  
        <pspid>psp</pspid>  
        <userid>user</userid>  
        <password>password</password>  
      </gateway>'

<gateway>
  <token>Y9E63HuYQpRqLvJq5FOAtz7U5Sx</token>
  <gateway_type>ogone</gateway_type>
  <name>Ingenico ePayments (formerly Ogone)</name>
  <description nil="true"/>
  <pspid>psp</pspid>
  <userid>user</userid>
  <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_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_3dsecure_purchase type="boolean">true</supports_3dsecure_purchase>
    <supports_3dsecure_authorize type="boolean">true</supports_3dsecure_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_disburse type="boolean">false</supports_disburse>
  </characteristics>
  <credentials>
    <credential>
      <name>pspid</name>
      <value>psp</value>
    </credential>
    <credential>
      <name>userid</name>
      <value>user</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2017-07-27T17:49:42Z</created_at>
  <updated_at type="dateTime">2017-07-27T17:49:42Z</updated_at>
  <mode>no_signature</mode>
</gateway>

Configure for 3D-Secure

If you’re going to be using 3D-secure, there are extra configuration steps that must be completed. First, note that 3D-secure is incompatible with no_signature mode.

Second, it’s important to note that if this isn’t configured correctly, you aren’t guaranteed to get final/complete status for all transactions, so customers could be charged without your system getting updated with that fact. To verify, you need to do a production 3D-secure transaction and ensure you get a redirect and callback from Spreedly indicating the transaction has completed.

Third, you need to make 4 configuration changes in the Ogone backend under “Configuration” > “Technical information” > “Transaction feedback”:

“I would like to receive transaction feedback parameters on the redirection URLs” needs to be checked.
“Direct HTTP server-to-server request” needs to be set to “Online but switch to a deferred request when the online requests fail”.
Under “Direct HTTP server-to-server request” both of the fields under “URL of the merchant’s post-payment page” need to be set to <https://core.spreedly.com/transaction/><PARAMVAR>/callback.
Under “Direct HTTP server-to-server request” the “Request method” needs to be set to “POST”.

The defaults for the rest of the fields should be fine. The above changes are highlighted on this image:

Gateway specific fields

Spreedly supports the following gateway specific fields when transacting with a Worldline (formerly Ogone) gateway:

eci

The eci field can be used to pass in a specific ECI value to accompany a card during tokenization, to override the default value.

<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>  
          <ogone>  
            <eci>9</eci>  
          </ogone>  
        \</gateway_specific_fields>  
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2021-11-23T21:58:43Z</created_at>
  <updated_at type="dateTime">2021-11-23T21:58:43Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>LTS5vQ9OK2Nr0i3UvqNuioZ3vO0</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>
    <ogone>
      <eci>9</eci>
    </ogone>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>60</gateway_transaction_id>
  <gateway_latency_ms type="integer">0</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">100</amount>
  <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>
  <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-11-23T21:58:43Z</created_at>
    <updated_at type="dateTime">2021-11-23T21:58:43Z</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-11-23T20:30:48Z</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

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.

Ogone Direct

If you are looking to use the Ogone Direct gateway, this integration is available via our Global Collect gateway adapter.