Kushki Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Kushki
Services that work with Spreedly:
  • Kushki
Supported operations:
Purchase, Authorize, Capture, Refund, Void
Supported payment types:
Credit Card
Spreedly 3DS2 Global Supported
No
Gateway Specific 3DS1 Supported
No
Gateway Specific 3D2 Supported
No
Regions:
Latin America
API endpoint URL:
https://api.kushkipagos.com/

Authentication and Security

Specific names for credentials:
Public Merchant, Private Merchant

Onboarding Merchants in:

Adding a Kushki gateway

To add a Kushki gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -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>JeKuqb3e9LbuuIDyWW7A16M8FCF</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">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>
  </characteristics>
  <credentials>
    <credential>
      <name>public_merchant_id</name>
      <value>Your Public Merchant Id</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <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>
  <sandbox type="boolean">false</sandbox>
  <created_at type="dateTime">2020-04-08T14:19:17Z</created_at>
  <updated_at type="dateTime">2020-04-08T14:19:17Z</updated_at>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:kushki, public_merchant_id: "Your Public Merchant Id", private_merchant_id: "Your Private Merchant Id")


#<Spreedly::Gateway:0x007fe332acddd0
@token="QcVMY6vVnaIoJ2YoNGv7rPyhLT9",
@created_at="2017-07-27T17:49:12Z",
@updated_at="2017-07-27T17:49:12Z",
@gateway_type="kushki",
@state="retained",
@name="Kushki",
@credentials={"public_merchant_id"=>"Your Public Merchant Id"}>

Authorize and capture

Kushki supports authorize and capture only in Chile and Peru, and only for PEN, CLP, and UF currencies. For further details, see Kushki’s documentation.

Gateway specific 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, including information such as extra_taxes that are required for certain currencies (e.g. COP). 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 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-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>
        <extra_taxes>
          <propina>2000</propina>
          <tasa_aeroportuaria>2000</tasa_aeroportuaria>
          <agencia_de_viaje>2000</agencia_de_viaje>
          <iac>2000</iac>
        </extra_taxes>
      </amount>
    </kushki>
  </gateway_specific_fields>
</transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2018-06-14T14:23:17Z</created_at>
  <updated_at type="dateTime">2018-06-14T14:23:17Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>BBHF92Ci2KYeM9icNULXOejGYJ6</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>
        <extra_taxes>
          <propina>2000</propina>
          <tasa_aeroportuaria>2000</tasa_aeroportuaria>
          <agencia_de_viaje>2000</agencia_de_viaje>
          <iac>2000</iac>
        </extra_taxes>
      </amount>
    </kushki>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>44</gateway_transaction_id>
  <gateway_latency_ms type="integer">23</gateway_latency_ms>
  <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>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></error_code>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2018-06-14T14:23:17Z</created_at>
    <updated_at type="dateTime">2018-06-14T14:23:17Z</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">2018-06-12T21:13:55Z</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>
    <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 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>e3cef43464fc832f6e04f187df25af497994</fingerprint>
  </payment_method>
</transaction>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
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:0x007fe3329e8cf8
@token="9RSIBz7cJPPIIkg0S5iCRjHsqnK",
@created_at="2017-07-27T17:49:11Z",
@updated_at="2017-07-27T17:49:11Z",
@state="succeeded",
@message="Succeeded!",
@succeeded="true",
@order_id="",
@ip="",
@description="",
@gateway_token="T11bJAANtTWnxl36GYjKWvbNK0g",
@gateway_transaction_id="55",
@email="",
@merchant_name_descriptor="",
@merchant_location_descriptor="",
@on_test_gateway="true",
@currency_code="USD",
@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>",
@response,=
#<Spreedly::Response:0x007fe33299e6a8
@success="true",
@pending="false",
@cancelled="false",
@fraud_review="",
@created_at="2017-07-27T17:49:11Z",
@updated_at="2017-07-27T17:49:11Z",
@message="Successful purchase",
@avs_code="",
@avs_message="",
@cvv_code="",
@cvv_message="",
@error_code="",
@error_detail="">,
@shipping_address,=
#<Spreedly::ShippingAddress:0x007fe332a20e50
@name="Newfirst Newlast",
@address1="",
@address2="",
@city="",
@state="",
@zip="",
@country="",
@phone_number="">,
@gateway_specific_fields={:kushki=>{:amount=>"\n        10\n        4.95\n        3.5\n        1.4\n      "}},
@payment_method,=
#<Spreedly::CreditCard:0x007fe3329c4a88
@token="1rpKvP8zOUhj4Y9EDrIoIYQzzD5",
@created_at="2017-06-26T17:04:38Z",
@updated_at="2017-07-27T17:49:11Z",
@email="joey@example.com",
@storage_state="retained",
@data="<my_payment_method_identifier>448</my_payment_method_identifier>\n      <extra_stuff>\n        <some_other_things>Can be anything really</some_other_things>\n      </extra_stuff>",
@first_name="Newfirst",
@last_name="Newlast",
@full_name="Newfirst Newlast",
@month="3",
@year="2032",
@number="XXXX-XXXX-XXXX-1111",
@last_four_digits="1111",
@first_six_digits="411111",
@card_type="visa",
@verification_value="",
@address1="",
@address2="",
@city="",
@state="",
@zip="",
@country="",
@phone_number="",
@company="",
@fingerprint="e3cef43464fc832f6e04f187df25af497994",
@eligible_for_card_updater="",
@errors=[]>>