Culqi Gateway Guide

close

Services and Compatibility

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

Authentication and Security

Specific names for credentials:
Merchant, Terminal, Secret Key

Onboarding Merchants in:

Additional Notes

Culqi merchant accounts are configured for either purchase or auth/capture modes. This is configured by Culqi when setting up a merchant account and largely depends on the transaction acquiring bank. Be sure to understand how your account was configured prior to using this gateway.

Adding

To add a Culqi gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>culqi</gateway_type>
        <merchant_id>Your merchant id</merchant_id>
        <terminal_id>Your terminal id</terminal_id>
        <secret_key>Your secret key</secret_key>
      </gateway>'

<gateway>
  <token>GgCPlHGOKCu1AZvqRKU0q9hnduV</token>
  <gateway_type>culqi</gateway_type>
  <name>Culqi</name>
  <description nil="true"/>
  <merchant_id>Your merchant id</merchant_id>
  <terminal_id>Your terminal id</terminal_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_verify type="boolean">true</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">true</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>merchant_id</name>
      <value>Your merchant id</value>
    </credential>
    <credential>
      <name>terminal_id</name>
      <value>Your terminal id</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>cvv</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>
  <created_at type="dateTime">2016-12-23T16:58:19Z</created_at>
  <updated_at type="dateTime">2016-12-23T16:58:19Z</updated_at>
</gateway>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.add_gateway(:culqi, merchant_id: "Your merchant id", terminal_id: "Your terminal id", secret_key: "Your secret key")


#<Spreedly::Gateway:0x007ff76c2b8638
 @created_at="2016-12-23T16:58:21Z",
 @credentials=
  {"merchant_id"=>"Your merchant id", "terminal_id"=>"Your terminal id"},
 @gateway_type="culqi",
 @name="Culqi",
 @state="retained",
 @token="RLbUtqIjOGpd8kmw6OKG5uMrQxE",
 @updated_at="2016-12-23T16:58:21Z">

Gateway specific request fields

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

  • cvv (useful when payment method is not a credit card)
  • partner_id (useful when invoking store)

CVV


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>1000</amount>
  <currency_code>PEN</currency_code>
  <gateway_specific_fields>
    <culqi>
      <cvv>123</cvv>
    </culqi>
  </gateway_specific_fields>
</transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2016-12-23T17:57:07Z</created_at>
  <updated_at type="dateTime">2016-12-23T17:57:07Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>XRUtzcELSrtkhsjFjnuCJtJVVuD</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>
    <culqi>
      <cvv>123</cvv>
    </culqi>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>67</gateway_transaction_id>
  <amount type="integer">1000</amount>
  <currency_code>PEN</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>DAoIl7Tgm42p2TXwxYMSNNpKvFQ</gateway_token>
  <shipping_address>
    <name>Lempi Thompson</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">2016-12-23T17:57:07Z</created_at>
    <updated_at type="dateTime">2016-12-23T17:57:07Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>VugBz5uZRjCXIMrFA4YDexyD9bN</token>
    <created_at type="dateTime">2016-12-05T18:16:51Z</created_at>
    <updated_at type="dateTime">2016-12-23T17:47:11Z</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>Lempi</first_name>
    <last_name>Thompson</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>Lempi Thompson</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>

Partner Id


curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/store.xml \
-u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
-H 'Content-Type: application/xml' \
-d '<transaction>
  <payment_method_token>56wyNnSmuA6CWYP7w0MiYCVIbW6</payment_method_token>
  <gateway_specific_fields>
    <culqi>
      <partner_id>828</partner_id>
    </culqi>
  </gateway_specific_fields>
</transaction>'

<transaction>
  <created_at type="dateTime">2016-12-23T17:57:07Z</created_at>
  <updated_at type="dateTime">2016-12-23T17:57:07Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <token>Oq6PaQCgWkmkrZAYz5PSadCkdVh</token>
  <state>succeeded</state>
  <gateway_specific_fields>
    <culqi>
      <partner_id>828</partner_id>
    </culqi>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <transaction_type>Store</transaction_type>
  <third_party_token nil="true"/>
  <gateway_transaction_id>63</gateway_transaction_id>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>DAoIl7Tgm42p2TXwxYMSNNpKvFQ</gateway_token>
  <payment_method>
    <token>JIYih1tcxUur9MjUITQmCRuLOlM</token>
    <created_at type="dateTime">2016-12-23T17:57:07Z</created_at>
    <updated_at type="dateTime">2016-12-23T17:57:07Z</updated_at>
    <gateway_type>test</gateway_type>
    <storage_state>retained</storage_state>
    <third_party_token>test_vault:4111111111111111</third_party_token>
    <payment_method_type>third_party_token</payment_method_type>
    <errors>
    </errors>
  </payment_method>
  <basis_payment_method>
    <token>VugBz5uZRjCXIMrFA4YDexyD9bN</token>
    <created_at type="dateTime">2016-12-05T18:16:51Z</created_at>
    <updated_at type="dateTime">2016-12-23T17:57:07Z</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>Lempi</first_name>
    <last_name>Thompson</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>Lempi Thompson</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"/>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint nil="true"/>
  </basis_payment_method>
  <response>
    <success type="boolean">true</success>
    <message>Successful store</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">2016-12-23T17:57:07Z</created_at>
    <updated_at type="dateTime">2016-12-23T17:57:07Z</updated_at>
  </response>
</transaction>