SumUp Gateway Guide

SumUp fact sheet

Adding a SumUp gateway

To add a SumUp gateway:

curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>sum_up</gateway_type>
        <access_token>Your access_token</access_token>
        <pay_to_email>Your pay_to_email</pay_to_email>
        <sandbox>true</sandbox>
      </gateway>'

<gateway>
  <token>PnEbhBhEofJX7r3PWuUMbxGxZiy</token>
  <gateway_type>sum_up</gateway_type>
  <name>SumUp</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <access_token>Your access_token</access_token>
  <characteristics>
    <supports_purchase type="boolean">true</supports_purchase>
    <supports_authorize type="boolean">false</supports_authorize>
    <supports_capture type="boolean">false</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">false</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">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_inquire_by_gateway_transaction_id type="boolean">false</supports_inquire_by_gateway_transaction_id>
    <supports_inquire_by_order_id type="boolean">false</supports_inquire_by_order_id>
    <supports_transaction_retry type="boolean">false</supports_transaction_retry>
    <supports_stored_stored_credentials type="boolean">false</supports_stored_stored_credentials>
  </characteristics>
  <credentials>
    <credential>
      <name>access_token</name>
      <value>Your access_token</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>checkout_id</gateway_specific_field>
    <gateway_specific_field>return_url</gateway_specific_field>
    <gateway_specific_field>partner_id</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">true</sandbox>
  <mode>default</mode>
  <created_at type="dateTime">2023-09-25T01:05:19Z</created_at>
  <updated_at type="dateTime">2023-09-25T01:05:19Z</updated_at>
</gateway>

Gateway specific fields

Spreedly supports the following gateway specific fields when transacting with a SumUp gateway:

checkout_id: SumUp checkout id generated after create a checkout.

partner_id: This partner_id is prepended to the order_id field and passed in the the checkout_reference to SumUp. This is used to identify to SumUp if a particular transaction is originating from a partner organization.

The return_url is an optional field that will allow the SumUp platform to send the processing status of the payment checkout.

For more information about each field go to SumUp Rest API explorer.

Gateway specific fields usage example:

curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<transaction>
        <billing_address>
          <zip>31331</zip>
          <state>NJ</state>
          <phone_number>919.331.3313</phone_number>
          <name>Francisca Torphy</name>
          <country>US</country>
          <city>Wanaque</city>
          <address2>Apartment 4</address2>
          <address1>33 Lane Road</address1>
        </billing_address>
        <email>[email protected]</email>
        <credit_card>
            <first_name>Joe</first_name>
            <last_name>Smith</last_name>
            <number>4111111111111111</number>
            <verification_value>987</verification_value>
            <month>12</month>
            <year>2031</year>
        </credit_card>
        <amount>100</amount>
        <currency_code>USD</currency_code>
        <gateway_specific_fields>
            <sum_up>
              <checkout_id>Your checkout_id</checkout_id>
              <partner_id>Partner Id</partner_id>
              <return_url>www.test.com</return_url>
            </sum_up>
        </gateway_specific_fields>
    </transaction>'

<transaction>
  <on_test_gateway type="boolean">false</on_test_gateway>
  <created_at type="dateTime">2023-09-24T23:55:18Z</created_at>
  <updated_at type="dateTime">2023-09-24T23:55:19Z</updated_at>
  <succeeded type="boolean">false</succeeded>
  <state>gateway_processing_result_unknown</state>
  <token>KeuB0qg2njfKxUU7zfhcjpvw01o</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>
    <sum_up>
      <checkout_id type="integer">123</checkout_id>
    </sum_up>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id nil="true"/>
  <sub_merchant_key nil="true"/>
  <gateway_latency_ms nil="true"/>
  <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">true</payment_method_added>
  <smart_routed type="boolean">false</smart_routed>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <stored_credential_alternate_gateway nil="true"/>
  <message>An unexpected error occurred.</message>
  <gateway_token>1ocqheUhq2bXTnBeyrIKX1HTdox</gateway_token>
  <gateway_type>sum_up</gateway_type>
  <shipping_address>
    <name>{{Woodrow}} {{Daugherty}}</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">false</success>
    <message>An unexpected error occurred.</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">true</result_unknown>
    <error_code nil="true"/>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review type="boolean">false</fraud_review>
    <created_at type="dateTime">2023-09-24T23:55:19Z</created_at>
    <updated_at type="dateTime">2023-09-24T23:55:19Z</updated_at>
  </response>
  <api_urls>
</api_urls>
  <payment_method>
    <token>QhpNDJe3HM50uFfT37kq95ss586</token>
    <created_at type="dateTime">2023-09-24T23:55:18Z</created_at>
    <updated_at type="dateTime">2023-09-24T23:55:18Z</updated_at>
    <email nil="true"/>
    <data nil="true"/>
    <storage_state>cached</storage_state>
    <test type="boolean">true</test>
    <metadata nil="true"/>
    <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>{{Woodrow}}</first_name>
    <last_name>{{Daugherty}}</last_name>
    <month type="integer">12</month>
    <year type="integer">2029</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>{{Woodrow}} {{Daugherty}}</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>41111111</issuer_identification_number>
    <click_to_pay type="boolean">false</click_to_pay>
    <managed nil="true"/>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
  </errors>
    <verification_value>XXX</verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint nil="true"/>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>

Additional notes

To add a transaction to an existing checkout you can use checkout_id as a gateway specific field.
pay_to_email is the email address of the merchant to whom the payment is made.
access_token is the SumUp token listed in the API keys page.