Paysafe (formerly Optimal Payments) Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Optimal Payments
Services that work with Spreedly:
  • Paysafe (formerly Optimal Payments)
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify, Store
Supported payment types:
Credit Card
Spreedly 3DS2 Global Supported
No
Gateway Specific 3DS2 Supported
No
Populate MIT GSF Support
No
Regions:
Asia Pacific, Europe, North America
API endpoint URL:
https://webservices.optimalpayments.com/creditcardWS/CreditCardServlet/v1

Authentication and Security

Specific names for credentials:
Account Number, Store Id, Password

Onboarding Merchants in:

To add a Paysafe (formerly Optimal Payments) gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>optimal_payments</gateway_type>
        <account_number>12345678</account_number>
        <store_id>test</store_id>
        <password>Your password</password>
      </gateway>'


<gateway>
  <token>FiX8YWngI7CPK4iUjpDOWuT4ris</token>
  <gateway_type>optimal_payments</gateway_type>
  <name>Paysafe (formerly Optimal Payments)</name>
  <description nil="true"/>
  <account_number>12345678</account_number>
  <store_id>test</store_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_3dsecure_purchase type="boolean">false</supports_3dsecure_purchase>
    <supports_3dsecure_authorize type="boolean">false</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">true</supports_store>
    <supports_remove type="boolean">false</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
  </characteristics>
  <credentials>
    <credential>
      <name>account_number</name>
      <value>12345678</value>
    </credential>
    <credential>
      <name>store_id</name>
      <value>test</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
  </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>
  <created_at type="dateTime">2020-04-02T16:44:42Z</created_at>
  <updated_at type="dateTime">2020-04-02T16:44:42Z</updated_at>
</gateway>



env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:optimal_payments, account_number: "12345678", store_id: "test", password: "Your password")



#<Spreedly::Gateway:0x007fe332956b50
@token="2fKWnO5XWLu2G5vYBvS8kvEMXq",
@created_at="2017-07-27T17:49:46Z",
@updated_at="2017-07-27T17:49:46Z",
@gateway_type="optimal_payments",
@state="retained",
@name="Optimal Payments",
@credentials={"account_number"=>"12345678", "store_id"=>"test"}>

Gateway-specific response fields

A Purchase response from the Paysafe (formerly Optimal Payments) gateway should contain an auth_code field, which you can find in the gateway_specific_response_fields. For example, a transaction could have something like this:

<transaction>
  <token>PRBa8pzUwn81IbgLwJHqyi70jLV</token>
  <transaction_type>Purchase</transaction_type>
  <gateway_specific_response_fields>
    <optimal_payments>
      <auth_code>146967</auth_code>
    </optimal_payments>
  </gateway_specific_response_fields>
</transaction>