Nuvei (formerly SafeCharge) Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Nuvei
Services that work with Spreedly:
  • Nuvei (formerly SafeCharge)
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify, General Credit
Supported payment types:
Credit Card
Spreedly 3DS2 Global Supported
Yes
Gateway Specific 3DS2 Supported
No
Populate MIT GSF Support
No
Regions:
Europe, North America
API endpoint URL:
https://process.safecharge.com/service.asmx/Process

Authentication and Security

Specific names for credentials:
Client Login Id, Client Password

Onboarding Merchants in:

Adding a Nuvei Gateway

To add a Nuvei (formerly SafeCharge) gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>safe_charge</gateway_type>
        <client_login_id>Your login</client_login_id>
        <client_password>Your password</client_password>
      </gateway>'


<gateway>
  <token>R3WBT9usBm6nCITJKfwGkbWx9fw</token>
  <gateway_type>safe_charge</gateway_type>
  <name>SafeCharge</name>
  <description nil="true"/>
  <client_login_id>Your login</client_login_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">true</supports_general_credit>
    <supports_void type="boolean">true</supports_void>
    <supports_verify type="boolean">true</supports_verify>
    <supports_reference_purchase type="boolean">true</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">false</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>client_login_id</name>
      <value>Your login</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>user_id</gateway_specific_field>
    <gateway_specific_field>auth_type</gateway_specific_field>
    <gateway_specific_field>expected_fulfillment_count</gateway_specific_field>
    <gateway_specific_field>website_id</gateway_specific_field>
    <gateway_specific_field>vendor_id</gateway_specific_field>
    <gateway_specific_field>merchant_descriptor</gateway_specific_field>
    <gateway_specific_field>merchant_phone_number</gateway_specific_field>
    <gateway_specific_field>merchant_name</gateway_specific_field>
    <gateway_specific_field>stored_credential_mode</gateway_specific_field>
  </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">2018-06-19T17:07:35Z</created_at>
  <updated_at type="dateTime">2018-06-19T17:07:35Z</updated_at>
</gateway>



env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:safe_charge, client_login_id: "Your login", client_password: "Your password")



#<Spreedly::Gateway:0x007ffce4b56b00
@token="IFmcml8uRYlhKWwk6ZOxOHvJv9n",
@created_at="2017-09-29T07:15:00Z",
@updated_at="2017-09-29T07:15:00Z",
@gateway_type="safe_charge",
@state="retained",
@name="SafeCharge",
@credentials={"client_login_id"=>"Your login"}>

Gateway specific fields

When interacting with a Nuvei (formerly SafeCharge) gateway to run transactions, there are several gateway specific fields you can specify.

  • When making a transaction, you can specify user_id; this maps to the gateway’s UserID field.
  • When making an authorize call you can specify auth_type and expected_fulfillment_count; these parameters map to sg_AuthType (to trigger the pre-authorization transaction type) and sg_ExpectedFulfillmentCount respectively.
  • When making any call, you may specify website_id, vendor_id, and product_id which correspond to sg_WebsiteID, sg_VendorID, and sg_ProductID, respectively.
  • When making a purchase, authorize, or credit you can specify stored_credential_mode as true or false. When specified as true, the transaction will be flagged as completed using a previously tokenized and stored card data. Specify false when the card data was entered for the first time, which will be tokenized and stored for future transactions.
  • When making any call, you may specify merchant_descriptor, merchant_phone_number, and merchant_name. These fields are part of Nuvei’s Dynamic Descriptor service and may used to display information on a customer’s credit card statement.
  • When attempting a credit, you may specify unreferenced_refund field as a true value if you wish to have an unreferenced refund.

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>
          <safe_charge>
            <user_id>123</user_id>
            <auth_type>1</auth_type>
            <expected_fulfillment_count>12</expected_fulfillment_count>
            <merchant_descriptor>Descriptor</merchant_descriptor>
            <merchant_phone_number>(555)555-5555</merchant_phone_number>
            <merchant_name>Merchant</merchant_name>
            <stored_credential_mode>true</stored_credential_mode>
            <is_partial_approval>true</is_partial_approval>
            <product_id>Product</product_id>
            <not_use_cvv>true</not_use_cvv>
            <unreferenced_refund>true</unreferenced_refund>
          </safe_charge>
        </gateway_specific_fields>
      </transaction>'


<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2023-07-26T22:44:00Z</created_at>
  <updated_at type="dateTime">2023-07-26T22:44:00Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>YwpCljQ1t7NolQ5rp6fhtkvEXYH</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>
    <safe_charge>
      <user_id>123</user_id>
      <auth_type>1</auth_type>
      <expected_fulfillment_count>12</expected_fulfillment_count>
      <merchant_descriptor>Descriptor</merchant_descriptor>
      <merchant_phone_number>(555)555-5555</merchant_phone_number>
      <merchant_name>Merchant</merchant_name>
      <stored_credential_mode>true</stored_credential_mode>
      <is_partial_approval>true</is_partial_approval>
      <product_id>Product</product_id>
      <not_use_cvv>true</not_use_cvv>
      <unreferenced_refund>true</unreferenced_refund>
    </safe_charge>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>54</gateway_transaction_id>
  <sub_merchant_key nil="true"/>
  <gateway_latency_ms type="integer">1</gateway_latency_ms>
  <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>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <stored_credential_gateway_override nil="true"/>
  <populate_mit_fields type="boolean">false</populate_mit_fields>
  <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">2023-07-26T22:44:00Z</created_at>
    <updated_at type="dateTime">2023-07-26T22:44:00Z</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">2023-07-19T16:09:17Z</updated_at>
    <email>joey@example.com</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"/>
    <click_to_pay type="boolean">false</click_to_pay>
    <managed 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>

Please refer to using a payment method for more information on how to send GSFs

Third-party 3D Secure 2 auth data

Spreedly will automatically handle the field mapping for sending third-party 3DS2 authentication data to Nuvei. For more information about how to use this feature, see the 3DS2 Third-party Authentication Guide. Spreedly fields map to the relevant Nuvei fields as described in the following table. Note that the challenge_preference field is being set to NoPreference since exemptions are not supported.

Spreedly Field Nuvei Field
three_ds_version threeDSProtocolVersion
ecommerce_indicator eci
authentication_value cavv
directory_server_transaction_id dsTransID
xid xid
challenge_preference challengePreference

Gateway specific response fields

A response from Nuvei (Safe Charge) may contain the following gateway specific response fields:

  <transaction>
    <token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
    <transaction_type>Purchase</transaction_type>
    <gateway_specific_response_fields>
       <safe_charge>
        <card_type>Debit</card_type>
       </safe_charge>
    </gateway_specific_response_fields>
  </transaction>