Kushki Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Kushki
Services that work with Spreedly:
  • Kushki
Supported operations:
Purchase, Void
Unsupported operations:
Authorize, Capture, Refund
Regions:
Latin America

Authentication and Security

Specific names for credentials:
Public Merchant, Private Merchant

Onboarding Merchants in:

Adding

To add a Kushki gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>kushki</gateway_type>
        <public_merchant_id>Your Public Merchant Id</public_merchant_id>
        <private_merchant_id>Your Private Merchant Id</private_merchant_id>
      </gateway>'

<gateway>
  <token>FoJgrGIymTKiToFzk2Bq1rfYeX2</token>
  <gateway_type>kushki</gateway_type>
  <name>Kushki</name>
  <description nil="true"/>
  <public_merchant_id>Your Public Merchant Id</public_merchant_id>
  <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">false</supports_credit>
    <supports_general_credit type="boolean">false</supports_general_credit>
    <supports_void type="boolean">true</supports_void>
    <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_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>public_merchant_id</name>
      <value>Your Public Merchant Id</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>amount</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">2017-02-13T20:01:25Z</created_at>
  <updated_at type="dateTime">2017-02-13T20:01:25Z</updated_at>
</gateway>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.add_gateway(:kushki, public_merchant_id: "Your Public Merchant Id", private_merchant_id: "Your Private Merchant Id")


#<Spreedly::Gateway:0x007fe3392d8038
 @created_at="2017-02-13T20:01:29Z",
 @credentials={"public_merchant_id"=>"Your Public Merchant Id"},
 @gateway_type="kushki",
 @name="Kushki",
 @state="retained",
 @token="37VHgU2ElGnnaJc2stvsixpOQRk",
 @updated_at="2017-02-13T20:01:29Z">

Gateway specific request fields

When interacting with a Kushki gateway to run transactions, there are some gateway specific fields you can specify when making a call.

  • amount (detailed amount breakdown)

Amount

Use this gateway specific field to pass the detailed amount breakdown when making purchase and void transactions. The relevant sub fields are in snake case as illustrated in the example below.


curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
-u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
-H 'Content-Type: application/xml' \
-d '<transaction>
  <payment_method_token>56wyNnSmuA6CWYP7w0MiYCVIbW6</payment_method_token>
  <amount>1985</amount>
  <currency_code>USD</currency_code>
  <gateway_specific_fields>
    <kushki>
      <amount>
        <subtotal_iva>10</subtotal_iva>
        <subtotal_iva_0>4.95</subtotal_iva_0>
        <ice>3.5</ice>
        <iva>1.4</iva>
      </amount>
    </kushki>
  </gateway_specific_fields>
</transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2017-02-13T20:01:26Z</created_at>
  <updated_at type="dateTime">2017-02-13T20:01:26Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>XXJuHXvwqYszYKeKn7kYEt5QNp9</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"/>
  <gateway_specific_fields>
    <kushki>
      <amount>
        <subtotal_iva>10</subtotal_iva>
        <subtotal_iva_0>4.95</subtotal_iva_0>
        <ice>3.5</ice>
        <iva>1.4</iva>
      </amount>
    </kushki>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>45</gateway_transaction_id>
  <amount type="integer">1985</amount>
  <currency_code>USD</currency_code>
  <retain_on_success type="boolean">false</retain_on_success>
  <payment_method_added type="boolean">false</payment_method_added>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>GLURDjMpl2HfE5zaONEAWpLdcj</gateway_token>
  <shipping_address>
    <name>Trudie Murphy</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></error_code>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2017-02-13T20:01:26Z</created_at>
    <updated_at type="dateTime">2017-02-13T20:01:26Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>9yCiFh4dvr4RLk6lYOMDmqRUAoN</token>
    <created_at type="dateTime">2017-02-08T15:17:54Z</created_at>
    <updated_at type="dateTime">2017-02-08T15:17:54Z</updated_at>
    <email nil="true"/>
    <data nil="true"/>
    <storage_state>retained</storage_state>
    <test type="boolean">true</test>
    <last_four_digits>1111</last_four_digits>
    <first_six_digits>411111</first_six_digits>
    <card_type>visa</card_type>
    <first_name>Trudie</first_name>
    <last_name>Murphy</last_name>
    <month type="integer">4</month>
    <year type="integer">2020</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>Trudie Murphy</full_name>
    <eligible_for_card_updater nil="true"/>
    <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"/>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint nil="true"/>
  </payment_method>
</transaction>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.purchase_on_gateway("LlkjmEk0xNkcWrNixXa1fvNoTP4", "56wyNnSmuA6CWYP7w0MiYCVIbW6", 1985,
  gateway_specific_fields: {
    kushki: {
      amount: {
        subtotal_iva: "10",
        subtotal_iva_0: "4.95",
        ice: "3.5",
        iva: "1.4"
      }
    }
  }
)


#<Spreedly::Purchase:0x007fe06485d9b8
 @amount=
  "<subtotal_iva>10</subtotal_iva>\n        <subtotal_iva_0>4.95</subtotal_iva_0>\n        <ice>3.5</ice>\n        <iva>1.4</iva>",
 @created_at="2017-02-13T20:01:28Z",
 @currency_code="USD",
 @description="",
 @email="",
 @gateway_specific_fields=
  {:kushki=>
    {:amount=>"\n        10\n        4.95\n        3.5\n        1.4\n      "}},
 @gateway_token="GLURDjMpl2HfE5zaONEAWpLdcj",
 @gateway_transaction_id="59",
 @ip="",
 @merchant_location_descriptor="",
 @merchant_name_descriptor="",
 @message="Succeeded!",
 @on_test_gateway="true",
 @order_id="",
 @payment_method=
  #<Spreedly::CreditCard:0x007fe0633935a0
   @address1="",
   @address2="",
   @card_type="visa",
   @city="",
   @company="",
   @country="",
   @created_at="2017-02-08T15:17:54Z",
   @data="",
   @eligible_for_card_updater="",
   @email="",
   @errors=[],
   @fingerprint="",
   @first_name="Trudie",
   @first_six_digits="411111",
   @full_name="Trudie Murphy",
   @last_four_digits="1111",
   @last_name="Murphy",
   @month="4",
   @number="XXXX-XXXX-XXXX-1111",
   @phone_number="",
   @state="",
   @storage_state="retained",
   @token="9yCiFh4dvr4RLk6lYOMDmqRUAoN",
   @updated_at="2017-02-13T20:01:26Z",
   @verification_value="",
   @year="2020",
   @zip="">,
 @response=
  #<Spreedly::Response:0x007fe063a18088
   @avs_code="",
   @avs_message="",
   @cancelled="false",
   @created_at="2017-02-13T20:01:28Z",
   @cvv_code="",
   @cvv_message="",
   @error_code="",
   @error_detail="",
   @fraud_review="",
   @message="Successful purchase",
   @pending="false",
   @success="true",
   @updated_at="2017-02-13T20:01:28Z">,
 @shipping_address=
  #<Spreedly::ShippingAddress:0x007fe0639f0510
   @address1="",
   @address2="",
   @city="",
   @country="",
   @name="Trudie Murphy",
   @phone_number="",
   @state="",
   @zip="">,
 @state="succeeded",
 @succeeded="true",
 @token="WoPtZdMTwRfo6dBixyEYu1msp90",
 @updated_at="2017-02-13T20:01:28Z">