Simetrik Gateway Guide

Simetrik fact sheet

Additional notes
A Simetrik authorize or purchase transaction will require the following Spreedly Standard Fields to be successful: - `order_id` - `description`

Adding a Simetrik gateway

To add a Simetrik gateway:

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

<gateway>
  <token>C1pjiU4vpLsTxPklsGY0GeXvcH5</token>
  <gateway_type>simetrik</gateway_type>
  <name>Simetrik</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <client_id>Your login</client_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">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_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_populate_mit_fields type="boolean">false</supports_populate_mit_fields>
  </characteristics>
  <credentials>
    <credential>
      <name>client_id</name>
      <value>Your login</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>token_acquirer</gateway_specific_field>
    <gateway_specific_field>acquire_extra_options</gateway_specific_field>
    <gateway_specific_field>trace_id</gateway_specific_field>
    <gateway_specific_field>user</gateway_specific_field>
    <gateway_specific_field>order</gateway_specific_field>
    <gateway_specific_field>vat</gateway_specific_field>
    <gateway_specific_field>psp_extra_fields</gateway_specific_field>
    <gateway_specific_field>comment</gateway_specific_field>
    <gateway_specific_field>sub_merchant</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">false</sandbox>
  <mode>default</mode>
  <created_at type="dateTime">2022-05-12T21:04:14Z</created_at>
  <updated_at type="dateTime">2022-05-12T21:04:14Z</updated_at>
</gateway>

Gateway specific fields

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

token_acquirer - The acquirer token.
acquire_extra_options - The acquirer’s specific options. If none are passed, it will be an empty object.
trace_id - A Payment Service Provider or Payment Facilitator uuid for identifying the transaction. It cannot be reused in more than one endpoint call.
user - The user object contains the id and email sub fields.
order - The order object contains the installments and datetime_local_transaction sub fields.
vat - Value Added Tax is already included in the total amount, but is shown separately for visibility. The value cannot be negative. A decimal point can be used but no other special characters.
psp_extra_fields - For any extra fields the PSP/Payfac wishes to be able to visualize in reconciliation reports. If none are passed, it will be an empty object.
comment - A comment related to the transaction, should only be present in refund calls.
sub_merchant - The sub_merchant object contains the following sub fields: merchant_id, extra_params, mcc, name, address, postal_code, url, and phone_number. The values of these fields are all specific to the merchant. extra_params may be used to pass in merchant specific information, it may be an empty object. mcc is the four digit number the payment card industry uses to classify merchants into market segments.

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>
          <simetrik>
            <token_acquirer>abc123-def456-ghi789</token_acquirer>
            <acquire_extra_options>
              <extra_options>This is an example field</extra_options>
            </acquire_extra_options>
            <trace_id>123456789</trace_id>
            <user>
              <id>UserID123</id>
              <email>[email protected]</email>
            </user>
            <order>
              <installments>3</installments>
              <datetime_local_transaction>2020-07-31T01:06:05.750Z</datetime_local_transaction>
            </order>
            <vat>19</vat>
            <psp_extra_fields>
              <extra_field>This is an example field</extra_field>
            </psp_extra_fields>
            <comment>A comment</comment>
            <sub_merchant>
              <merchant_id>Merchant123</merchant_id>
              <extra_params>
                <param1>This is an example field</param1>
                <param2>Merchant Specific Info</param2>
              </extra_params>
              <mcc>1234</mcc>
              <name>Merchant Name</name>
              <address>Merchant Address</address>
              <postal_code>12345</postal_code>
            </sub_merchant>
          </simetrik>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2022-05-26T17:43:37Z</created_at>
  <updated_at type="dateTime">2022-05-26T17:43:37Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>PRCmNUMHVSNuO9dD3atLN9P5WzN</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>
    <simetrik>
      <token_acquirer>abc123-def456-ghi789</token_acquirer>
      <acquire_extra_options>
        <extra_options>This is an example field</extra_options>
      </acquire_extra_options>
      <trace_id>123456789</trace_id>
      <user>
        <id>UserID123</id>
        <email>[email protected]</email>
      </user>
      <order>
        <installments>3</installments>
        <datetime_local_transaction>2020-07-31T01:06:05.750Z</datetime_local_transaction>
      </order>
      <vat>19</vat>
      <psp_extra_fields>
        <extra_field>This is an example field</extra_field>
      </psp_extra_fields>
      <comment>A comment</comment>
      <sub_merchant>
        <merchant_id>Merchant123</merchant_id>
        <extra_params>
          <param1>This is an example field</param1>
          <param2>Merchant Specific Info</param2>
        </extra_params>
        <mcc>1234</mcc>
        <name>Merchant Name</name>
        <address>Merchant Address</address>
        <postal_code>12345</postal_code>
      </sub_merchant>
    </simetrik>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>59</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-05-26T17:43:37Z</created_at>
    <updated_at type="dateTime">2022-05-26T17:43:37Z</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-05-26T17:43:36Z</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>

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.