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>
  </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_field>cruiseline_travel_details</gateway_specific_field>
    <gateway_specific_field>lodging_details</gateway_specific_field>
    <gateway_specific_field>level2_level3</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.

To add a card to a existing profile customers can pass profile_idduring a Store transaction. Other available gateway specific fields for this flow are account_id, nickname, default_card_indicatorand billing_address_id. Please see the gateway documentation for additional information related to these fields.

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 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.

Airline Travel Details

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

When adding airline_travel_details, pass an object with:

passenger_name_record
passenger_name
departure_date
origin
computerized_reservation_system
ticket — an object with:
- ticket_number
- is_restricted_ticket
- city_of_ticket_issuing
- ticket_delivery_method
- ticket_issue_date
- number_of_pax
customer_reference_number
travel_agency — an object with:
- name
- code
trip_legs — an object where each key (leg1, leg2, etc.) maps to a leg object with::
- flight — an object with:
  - carrier_code
  - flight_number
  - airline_name
- service_class
- is_stop_over_allowed
- destination
- fare_basis
- fare
- departure_date
- departure_airport

Cruiseline Travel Details

The cruiseline_travel_details gateway specific field is an object that contains many additional fields specific to Cruise Line merchants. For more information on what can be included within the cruiseline_travel_details object, please reference Paysafe's API documentation and the example gateway specific field format shown below.

When adding cruiseline_travel_details, pass an object with:

cruise_ship_name
passenger_name
departure_date
return_date
country
state
origin_city
room_rate
travel_package_application
ticket — an object with:
- ticket_number
- is_restricted_ticket
passengers — an object where each key (passenger1, passenger2, etc.) maps to a passenger object with:
- ticket_number
- first_name
- last_name
- phone_number
- passenger_code
- gender
trip_legs — an object where each key (leg1, leg2, etc.) maps to a leg object with:
- service_class
- departure_city
- destination_city
- fare
- departure_date

Lodging Details

The lodging_details gateway specific field is an object that contains many additional fields specific to Lodging merchants. For more information on what can be included within the lodging_details object, please reference Paysafe’s API documentation and the example gateway specific field format shown below.

When adding lodging_details pass an object with:

hotel_folio_number
check_in_date
check_out_date
customer_service_phone
property_local_phone
room_rate
program_code
number_of_nights
is_fire_safety_act_compliant
extra_charges which is an array of strings. Possible values include:
- RESTAURANT
- GIFT_SHOP
- MINI_BAR
- TELEPHONE
- LAUNDRY
- OTHER

Level 2/Level 3 Data

The level2_level3 gateway specific field is an object that contains many additional fields specific to Level 2 and Level 3 data. For more information on what can be included within the level2_level3 object, please reference Paysafe’s API documentation and the example gateway specific field format shown below.

When adding level2_level3 pass an object with:

exempt_local_tax (if unspecified, the default is false)
local_tax_amount
national_tax_amount
freight_amount
duty_amount
destination_zip
destination_country
ship_from_zip
line_items which is an array of objects, each containing:
- description
- quantity
- unit_amount
- tax_amount
- tax_rate
- total_amount
- product_code

Funding Transactions

The funding_transaction field can be used by merchants registered with MCC 4829, 6012, 6051, or 6540 as directed by Paysafe. To identify the Purchase or Authorization request as a funding transaction, send the Funding Transaction Type text value as defined by Paysafe in the API documentation, along with a customer_id. Transaction requests that include these fields must also include the cardholder’s full name and complete billing address information. If name and billing information is already present on a Spreedly payment method, these fields will be automatically be applied to the transaction. For other information about Funding Transactions at Spreedly see the AFT Guide.

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>
            <merchant_descriptor>
              <dynamic_descriptor>Store Purchase</dynamic_descriptor>
              <phone>800-828-8828</phone>
            </merchant_descriptor>
            <external_initial_transaction_id>ABCDEF123456</external_initial_transaction_id>
            <split_pay>
              <linked_account>100100100</linked_account>
              <percent>50</percent>              
            </split_pay>
            <airline_travel_details>
              <passenger_name>John Doe</passenger_name>
              <passenger_name_record>12345abcde</passenger_name_record>
              <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>
                <city_of_ticket_issuing>Porto</city_of_ticket_issuing>
                <ticket_delivery_method>E_TICKET</ticket_delivery_method>
                <ticket_issue_date>2026-01-26</ticket_issue_date>
                <number_of_pax>4</number_of_pax>
              </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>
                    <airline_name>DEL</airline_name>
                  </flight>
                  <service_class>F</service_class>
                  <is_stop_over_allowed>true</is_stop_over_allowed>
                  <destination>ISL</destination>
                  <fare_basis>VMAY</fare_basis>
                  <fare>10</fare>
                  <departure_date>2021-11-30</departure_date>
                  <departure_airport>SEA</departure_airport>
                </leg1>
                <leg2>
                  <flight>
                    <carrier_code>LH</carrier_code>
                    <flight_number>344</flight_number>
                    <airline_name>DEL</airline_name>
                  </flight>
                  <service_class>F</service_class>
                  <is_stop_over_allowed>true</is_stop_over_allowed>
                  <destination>ISL</destination>
                  <fare_basis>VMAY</fare_basis>
                  <fare>10</fare>
                  <departure_date>2021-11-30</departure_date>
                  <departure_airport>SEA</departure_airport>
                </leg2>
              </trip_legs>
            </airline_travel_details>
            <cruiseline_travel_details>
              <cruise_ship_name>Cruise Ship</cruise_ship_name>
              <passenger_name>John Doe</passenger_name>
              <departure_date>2026-11-30</departure_date>
              <return_date>2026-12-30</return_date>
              <country>US</country>
              <state>CA</state>
              <room_rate>1200</room_rate>
              <origin_city>SFX</origin_city>
              <travel_package_application>CAR_RENTAL_RESERVATION</travel_package_application>
              <ticket>
              	<ticket_number>9876789</ticket_number>
              	<is_restricted_ticket>false</is_restricted_ticket>
              </ticket>
              <customer_reference_number>107854099</customer_reference_number>
              <passengers>
                <passenger1>
                  <ticket_number>12J13J1</ticket_number>
                  <first_name>Joe</first_name>
                  <last_name>Smith</last_name>
                  <phone_number>8888994222</phone_number>
                  <passenger_code>INF</passenger_code>
                  <gender>M</gender>
                </passenger1>
                <passenger2>
                  <ticket_number>12J12J1</ticket_number>
                  <first_name>Jane</first_name>
                  <last_name>Smith</last_name>
                  <phone_number>8888994223</phone_number>
                  <passenger_code>INF</passenger_code>
                  <gender>M</gender>
                </passenger2>
              </passengers>
              <trip_legs>
                <leg1>
                  <service_class>F</service_class>
                  <departure_city>DOM</departure_city>
                  <destination_city>BDS</destination_city>
                  <fare>10</fare>
                  <departure_date>2026-11-30</departure_date>
                </leg1>
                <leg2>
                  <service_class>F</service_class>
                  <departure_city>DOM</departure_city>
                  <destination_city>BDS</destination_city>
                  <fare>10</fare>
                  <departure_date>2026-11-30</departure_date>
                </leg2>
              </trip_legs>
            </cruiseline_travel_details>
            <lodging_details>
              <hotel_folio_number>Customer Folio Number</hotel_folio_number>
              <check_in_date>2026-11-30</check_in_date>
              <check_out_date>2026-12-01</check_out_date>
              <customer_service_phone>9998887777</customer_service_phone>
              <property_local_phone>9998887777</property_local_phone>
              <room_rate>1200</room_rate>
              <extra_charges type="array">
              	<charge>RESTAURANT</charge>
                <charge>GIFT_SHOP</charge>
                <charge>MINI_BAR</charge>
                <charge>TELEPHONE</charge>
                <charge>LAUNDRY</charge>
                <charge>OTHER</charge>
              </extra_charges>
              <room_rate>100</room_rate>
              <program_code>LODGING</program_code>
              <number_of_nights>1</number_of_nights>
              <is_fire_safety_act_compliant>true</is_fire_safety_act_compliant>
            </lodging_details>
            <level2_level3>
              <exempt_local_tax>true</exempt_local_tax>
              <local_tax_amount>100</local_tax_amount>
              <national_tax_amount>200</national_tax_amount>
              <freight_amount>300</freight_amount>
              <duty_amount>400</duty_amount>
              <destination_zip>27701</destination_zip>
              <destination_country>US</destination_country>
              <ship_from_zip>27701</ship_from_zip>
              <line_items type="array">
                <line_item>
                  <description>Widget</description>
                  <quantity>1</quantity>
                  <unit_amount>100</unit_amount>
                  <tax_amount>10</tax_amount>
                  <tax_rate>0.1</tax_rate>
                  <total_amount>110</total_amount>
                  <product_code>WIDGET123</product_code>
                </line_item>
              </line_items>
            </level2_level3>
            <funding_transaction>SDW_WALLET_TRANSFER</funding_transaction>
            <customer_id>cust-987654321</customer_id>
          </paysafe>
        </gateway_specific_fields>
      </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.