Paysafe Gateway Guide

Paysafe fact sheet

Adding a Paysafe gateway

To add a Paysafe gateway:

curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>paysafe</gateway_type>
        <username>Your username</username>
        <password>Your password</password>
        <account_id>Your account ID</account_id>
      </gateway>'

<gateway>
  <token>IH1VHZppZxt4x5XKrV644h5PVCB</token>
  <gateway_type>paysafe</gateway_type>
  <name>Paysafe</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <username>Your username</username>
  <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">true</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>
  </characteristics>
  <credentials>
    <credential>
      <name>username</name>
      <value>Your username</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>email</gateway_specific_field>
    <gateway_specific_field>phone</gateway_specific_field>
    <gateway_specific_field>ip</gateway_specific_field>
    <gateway_specific_field>merchant_ref_num</gateway_specific_field>
    <gateway_specific_field>date_of_birth</gateway_specific_field>
    <gateway_specific_field>locale</gateway_specific_field>
    <gateway_specific_field>customer_id</gateway_specific_field>
    <gateway_specific_field>merchant_descriptor</gateway_specific_field>
    <gateway_specific_field>airline_travel_details</gateway_specific_field>
    <gateway_specific_field>split_pay</gateway_specific_field>
    <gateway_specific_field>funding_transaction</gateway_specific_field>
    <gateway_specific_field>external_initial_transaction_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">2022-09-01T12:50:50Z</created_at>
  <updated_at type="dateTime">2022-09-01T12:50:50Z</updated_at>
</gateway>

To learn more about creating and managing gateways in our Marketplace, review the Gateway user guide. For gateways not included in the Marketplace, review the steps below.

Create a gateway

Visit your Connections area to review all gateways and add new ones. When creating your gateways, select the gateway name and authentication mode (if prompted) before completing required fields. Select ☑️Sandbox to create a gateway in Sandbox mode, for processing test card data and transactions in your Spreedly environment.

Enter your Paysafe username, password and account ID into the respective fields in the Spreedly UI to create a new Paysafe gateway.

Stored credential regulations

For Paysafe, sending stored credential fields can be done using Spreedly’s first class support. Sending stored credential data is simple. For any Authorize or Purchase request, you need to include two fields which tell Spreedly a little bit more about the nature of the transaction:

stored_credential_initiator
stored_credential_reason_type

Third-party 3DS2 auth data

Spreedly will automatically handle the field mapping for sending third-party 3DS2 authentication data to Paysafe. 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. Please see Paysafe’s authentication object documentation for detailed descriptions of each of these fields and when to use them.

Spreedly field	Paysafe field
`three_ds_version`	`threeDSecureVersion`
`ecommerce_indicator`	`eci`
`authentication_value`	`cavv`
`directory_server_transaction_id`	`directoryServerTransactionId`
`xid`	`xid`

Gateway specific fields

When interacting with a Paysafe gateway to run transactions, there are a number of gateway specific fields you can specify.

The airline_travel_details gateway specific field is an object specific to Airline Merchants only and contains many additional fields. For more information on what can be included within the airline_travel_details object, please reference Paysafe’s API documentation.

The date_of_birth and locale fields are required only when utilizing the store method. For date_of_birth, the year should be 4 digits in length, the month and day fields should both be 2 digits in length. The locale field indicates the language of the profile being created by the store method. Possible values are en_US, fr_CA, or en_GB.

The funding_transaction field can be used by merchants registered with MCC 4829, 6012, 6051, or 6540. Transaction requests that include this field must also include the cardholder’s full name, complete billing address information, and a customer_id. Please reference Paysafe’s API documentation for additional requirements related to this field.

The external_initial_transaction_id field is used to pass in the Card Scheme Transaction Id of the initial payment transaction in the recurring plan when it was processed through external service provider. Please see the gateway documentation for the appropriate circumstances to use this field.

Fields such as split_pay and airline_travel_details must be authorized/enabled at an account level by Paysafe. Please contact your Paysafe Account Manager for assistance configuring your account for these fields.

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>
          <paysafe>
            <email>[email protected]</email>
            <phone>999-999-9999</phone>
            <ip>127.0.0.1</ip>
            <merchant_ref_num>123456789</merchant_ref_num>
            <date_of_birth>
              <year>1999</year>
              <month>1</month>
              <day>1</day>
            </date_of_birth>
            <locale>en_US</locale>
            <customer_id>cust-987654321</customer_id>
            <merchant_descriptor>
              <dynamic_descriptor>Store Purchase</dynamic_descriptor>
              <phone>800-828-8828</phone>
            </merchant_descriptor>
            <airline_travel_details>
              <passenger_name>John Doe</passenger_name>
              <departure_date>2021-11-30</departure_date>
              <origin>SXF</origin>
              <computerized_reservation_system>DATS</computerized_reservation_system>
              <ticket>
                <ticket_number>9876789</ticket_number>
                <is_restricted_ticket>false</is_restricted_ticket>
              </ticket>
              <customer_reference_number>107854099</customer_reference_number>
              <travel_agency>
                <name>Sally Travel</name>
                <code>AGENTS</code>
              </travel_agency>
              <trip_legs>
                <leg1>
                  <flight>
                    <carrier_code>LH</carrier_code>
                    <flight_number>344</flight_number>
                  </flight>
                  <service_class>F</service_class>
                  <is_stop_over_allowed>true</is_stop_over_allowed>
                  <destination>ISL</destination>
                  <fare_basis>VMAY</fare_basis>
                  <departure_date>2021-11-30</departure_date>
                </leg1>
                <leg2>
                  <flight>
                    <carrier_code>LH</carrier_code>
                    <flight_number>344</flight_number>
                  </flight>
                  <service_class>F</service_class>
                  <is_stop_over_allowed>true</is_stop_over_allowed>
                  <destination>ISL</destination>
                  <fare_basis>VMAY</fare_basis>
                  <departure_date>2021-11-30</departure_date>
                </leg2>
              </trip_legs>
            </airline_travel_details>
            <split_pay>
              <linked_account>100100100</linked_account>
              <percent>50</percent>              
            </split_pay>
            <funding_transaction>SDW_WALLET_TRANSFER</funding_transaction>
            <external_initial_transaction_id>ABCDEF123456</external_initial_transaction_id>
          </paysafe>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2022-09-01T12:50:49Z</created_at>
  <updated_at type="dateTime">2022-09-01T12:50:50Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>8zK7hWeDEKG8x6H9ynwbPn2FoPZ</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>
    <paysafe>
      <email>[email protected]</email>
      <phone>999-999-9999</phone>
      <ip>127.0.0.1</ip>
      <merchant_ref_num>123456789</merchant_ref_num>
      <date_of_birth>
        <year>1999</year>
        <month>1</month>
        <day>1</day>
      </date_of_birth>
      <locale>en_US</locale>
      <customer_id>cust-987654321</customer_id>
      <merchant_descriptor>
        <dynamic_descriptor>Store Purchase</dynamic_descriptor>
        <phone>800-828-8828</phone>
      </merchant_descriptor>
      <airline_travel_details>
        <passenger_name>John Doe</passenger_name>
        <departure_date>2021-11-30</departure_date>
        <origin>SXF</origin>
        <computerized_reservation_system>DATS</computerized_reservation_system>
        <ticket>
          <ticket_number>9876789</ticket_number>
          <is_restricted_ticket>false</is_restricted_ticket>
        </ticket>
        <customer_reference_number>107854099</customer_reference_number>
        <travel_agency>
          <name>Sally Travel</name>
          <code>AGENTS</code>
        </travel_agency>
        <trip_legs>
          <leg1>
            <flight>
              <carrier_code>LH</carrier_code>
              <flight_number>344</flight_number>
            </flight>
            <service_class>F</service_class>
            <is_stop_over_allowed>true</is_stop_over_allowed>
            <destination>ISL</destination>
            <fare_basis>VMAY</fare_basis>
            <departure_date>2021-11-30</departure_date>
          </leg1>
          <leg2>
            <flight>
              <carrier_code>LH</carrier_code>
              <flight_number>344</flight_number>
            </flight>
            <service_class>F</service_class>
            <is_stop_over_allowed>true</is_stop_over_allowed>
            <destination>ISL</destination>
            <fare_basis>VMAY</fare_basis>
            <departure_date>2021-11-30</departure_date>
          </leg2>
        </trip_legs>
      </airline_travel_details>
      <split_pay>
        <linked_account>100100100</linked_account>
        <percent>50</percent>
      </split_pay>
      <funding_transaction>SDW_WALLET_TRANSFER</funding_transaction>
      <external_initial_transaction_id>ABCDEF123456</external_initial_transaction_id>
    </paysafe>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>57</gateway_transaction_id>
  <sub_merchant_key nil="true"/>
  <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">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>
  <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">2022-09-01T12:50:49Z</created_at>
    <updated_at type="dateTime">2022-09-01T12:50:50Z</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">2022-08-31T19:53:35Z</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"/>
    <issuer_identification_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>
    <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>

Gateway specific response fields

A response from Paysafe may contain the following gateway specific response fields:

The field_errors object may be returned and will identify certain fields and a description of associated errors.

account_currency_code reflects the currency code returned in the transaction response from Paysafe.

<transaction>
  <token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
  <transaction_type>Purchase</transaction_type>
  <gateway_specific_response_fields>
     <paysafe>
       <auth_code>976900</auth_code>
       <field_errors>
         <field>Email</field>
         <error>Unexpected Characters</error>
       </field_errors>
       <account_currency_code>USD</account_currency_code>
     </paysafe>
  </gateway_specific_response_fields>
</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.