Moka Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Moka
Services that work with Spreedly:
  • Moka
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify
Supported payment types:
Credit Card
Spreedly 3DS2 Global Supported
No
Gateway Specific 3DS1 Supported
Yes
Gateway Specific 3DS2 Supported
No
Regions:
Europe, Middle East
API endpoint URL:
https://service.moka.com

Authentication and Security

Specific names for credentials:
Dealer Code, Username, Password

Onboarding Merchants in:

Adding a Moka gateway

To add a Moka gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>moka</gateway_type>
        <dealer_code>dealercode</dealer_code>
        <username>username</username>
        <password>password</password>
      </gateway>'


<gateway>
  <token>Zp9Ypnw1ay6hQdMsBexJsavWUep</token>
  <gateway_type>moka</gateway_type>
  <name>Moka</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <dealer_code>dealercode</dealer_code>
  <username>username</username>
  <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">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">true</supports_3dsecure_purchase>
    <supports_3dsecure_authorize type="boolean">true</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>dealer_code</name>
      <value>dealercode</value>
    </credential>
    <credential>
      <name>username</name>
      <value>username</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>sub_merchant_name</gateway_specific_field>
    <gateway_specific_field>basket_product</gateway_specific_field>
    <gateway_specific_field>is_pool_payment</gateway_specific_field>
    <gateway_specific_field>installment_number</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">2021-10-28T20:10:04Z</created_at>
  <updated_at type="dateTime">2021-10-28T20:10:04Z</updated_at>
</gateway>



env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:moka, dealer_code: 123, username: "username", password: "password")



#<Spreedly::Gateway:0x00007ffc740b0d88
@token="8ADHoR8CTzJz0bux5r3r2EiOFxq",
@created_at="2021-09-30T21:08:01Z",
@updated_at="2021-09-30T21:08:01Z",
@gateway_type="moka",
@state="retained",
@name="Moka",
@credentials={"dealer_code"=>"123", "username"=>"username"}>

3DS1 Support

Spreedly supports 3DS on Moka through a Gateway Specific 3DS1 integration. For instructions on how to implement Spreedly’s 3DS1 solution on the Moka gateway, please see our Gateway Specific 3DS1 Guide.

Please note that if the payment method used in a 3DS transaction is not 3DS-eligible, Moka will return a failure. Moka does not automatically fall back to a non-3DS transaction, so it will be your responsibility to handle the logic for retrying the transaction without 3DS.

Gateway specific fields

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

  • sub_merchant_name
  • basket_product
  • is_pool_payment
  • installment_number

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>200</amount>
        <currency_code>TRY</currency_code>
        <gateway_specific_fields>
          <moka>
            <sub_merchant_name>sub merchant name</sub_merchant_name>
            <basket_product>
              <product_id>123</product_id>
              <product_code>0123</product_code>
              <unit_price>100</unit_price>
              <quantity>1</quantity>
            </basket_product>
            <basket_product>
              <product_id>456</product_id>
              <product_code>0456</product_code>
              <unit_price>50</unit_price>
              <quantity>2</quantity>
            </basket_product>
            <is_pool_payment>0</is_pool_payment>
            <installment_number>1</installment_number>
          </moka>
        </gateway_specific_fields>
      </transaction>'


<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2021-10-28T20:10:03Z</created_at>
  <updated_at type="dateTime">2021-10-28T20:10:03Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>ZfBIQOh7QeN6fgDTlOI5Qcj4iQF</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>
    <moka>
      <sub_merchant_name>sub merchant name</sub_merchant_name>
      <basket_product type="array">
        <basket_product>
          <product_id>123</product_id>
          <product_code>0123</product_code>
          <unit_price>100</unit_price>
          <quantity>1</quantity>
        </basket_product>
        <basket_product>
          <product_id>456</product_id>
          <product_code>0456</product_code>
          <unit_price>50</unit_price>
          <quantity>2</quantity>
        </basket_product>
      </basket_product>
      <is_pool_payment>0</is_pool_payment>
      <installment_number>1</installment_number>
    </moka>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>62</gateway_transaction_id>
  <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">200</amount>
  <currency_code>TRY</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">2021-10-28T20:10:03Z</created_at>
    <updated_at type="dateTime">2021-10-28T20:10:03Z</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">2021-10-27T18:56: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>
    <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"/>
    <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>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>



env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.purchase_on_gateway("LlkjmEk0xNkcWrNixXa1fvNoTP4", "56wyNnSmuA6CWYP7w0MiYCVIbW6", 4432,
  gateway_specific_fields: {
    moka: {
      sub_merchant_name: "sub merchant name",
      basket_product: [
        {
          "product_id": 123,
          "product_code": "0123",
          "unit_price": 100,
          "quantity": 1
        }
      ],
      is_pool_payment: 0,
      installment_number: 1
    }
  }
)



#<Spreedly::Purchase:0x00007fde9b155c30
@token="Ef8lPS9crNthbBlX626flY9skLY",
@created_at="2021-10-28T20:10:04Z",
@updated_at="2021-10-28T20:10:04Z",
@state="succeeded",
@message="Succeeded!",
@succeeded="true",
@order_id="",
@ip="",
@description="",
@gateway_token="T11bJAANtTWnxl36GYjKWvbNK0g",
@gateway_transaction_id="49",
@email="",
@transaction_type="Purchase",
@merchant_name_descriptor="",
@merchant_location_descriptor="",
@on_test_gateway="true",
@currency_code="USD",
@callback_url="",
@stored_credential_initiator="",
@stored_credential_reason_type="",
@amount="4432",
@response,=
#<Spreedly::Response:0x00007fde9b167728
@success="true",
@pending="false",
@cancelled="false",
@fraud_review="",
@created_at="2021-10-28T20:10:04Z",
@updated_at="2021-10-28T20:10:04Z",
@message="Successful purchase",
@avs_code="",
@avs_message="",
@cvv_code="",
@cvv_message="",
@error_code="",
@error_detail="">,
@shipping_address,=
#<Spreedly::ShippingAddress:0x00007fde9b16e668
@name="Newfirst Newlast",
@address1="",
@address2="",
@city="",
@state="",
@zip="",
@country="",
@phone_number="">,
@gateway_specific_fields={:moka=>{:sub_merchant_name=>"sub merchant name", :basket_product=>"[{:product_id=>123, :product_code=>\"0123\", :unit_price=>100, :quantity=>1}]", :is_pool_payment=>"0", :installment_number=>"1"}},
@gateway_specific_response_fields={},
@payment_method,=
#<Spreedly::CreditCard:0x00007fde9b176ef8
@token="1rpKvP8zOUhj4Y9EDrIoIYQzzD5",
@created_at="2017-06-26T17:04:38Z",
@updated_at="2021-10-28T20:10:03Z",
@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>",
@payment_method_type="credit_card",
@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="true",
@errors=[]>>

Please refer to using a payment method for more information on how to send GSFs