Credorax Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Credorax
Services that work with Spreedly:
  • Credorax
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify, General Credit
Supported payment types:
Credit Card
3D Secure 1 Supported
Yes
3D Secure 2 Supported
Yes
Regions:
Europe
API endpoint URL:
https://xts.gate.credorax.net/crax_gate/service/gateway

Authentication and Security

Specific names for credentials:
Merchant, Mpi Merchant, Mpi Merchant Name, Cipher Key, Mpi Password

Onboarding Merchants in:

Adding a Credorax gateway

To add a Credorax gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>credorax</gateway_type>
        <merchant_id>Your merchant_id</merchant_id>
        <cipher_key>Your cipher_key</cipher_key>
        <mpi_merchant_id>Your MPI merchant ID</mpi_merchant_id>
        <mpi_merchant_name>Your MPI merchant name</mpi_merchant_name>
        <mpi_password>Your MPI password</mpi_password>
      </gateway>'

<gateway>
  <token>BdN4R4anImKOKedyiCaph1fthf0</token>
  <gateway_type>credorax</gateway_type>
  <name>Credorax</name>
  <description nil="true"/>
  <merchant_id>Your merchant_id</merchant_id>
  <mpi_merchant_id>Your MPI merchant ID</mpi_merchant_id>
  <mpi_merchant_name>Your MPI merchant name</mpi_merchant_name>
  <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">true</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">true</supports_3dsecure_purchase>
    <supports_3dsecure_authorize type="boolean">true</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>
  </characteristics>
  <credentials>
    <credential>
      <name>merchant_id</name>
      <value>Your merchant_id</value>
    </credential>
    <credential>
      <name>mpi_merchant_id</name>
      <value>Your MPI merchant ID</value>
    </credential>
    <credential>
      <name>mpi_merchant_name</name>
      <value>Your MPI merchant name</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>eci</gateway_specific_field>
    <gateway_specific_field>cavv</gateway_specific_field>
    <gateway_specific_field>xid</gateway_specific_field>
    <gateway_specific_field>billing_descriptor</gateway_specific_field>
    <gateway_specific_field>submerchant_id</gateway_specific_field>
    <gateway_specific_field>transaction_type</gateway_specific_field>
    <gateway_specific_field>mpi_purchase_desc</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">2018-11-21T17:02:47Z</created_at>
  <updated_at type="dateTime">2018-11-21T17:02:47Z</updated_at>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:credorax, merchant_id: "Your merchant_id", cipher_key: "Your cipher_key")


#<Spreedly::Gateway:0x007fe333af5000
@token="WlZZaXqs9ikipUXLbZjKsdIdL15",
@created_at="2017-07-27T17:48:28Z",
@updated_at="2017-07-27T17:48:28Z",
@gateway_type="credorax",
@state="retained",
@name="Credorax",
@credentials={"merchant_id"=>"Your merchant_id"}>

Note that you can leave the MPI fields blank if you are not using Spreedly-powered 3D Secure 1 support with Credorax. For more information, please see the Spreedly 3D Secure guide.

3DS 2.0

The gateway specific fields three_ds_challenge_window_size and three_ds_initiate will be passed when running 3DS 2.0 transactions on Credorax. three_ds_challenge_window_size determines the size of the challenge window and by default is set to ‘03’. However, any of the following values may be used:

three_ds_challenge_window_size Description
01 250x400
02 390x400
03 500x600
04 600x400
05 Full screen
three_ds_initiate determines when 3DS is initiated. By default this value is set to '01’ if execute_threed = true. However, any of the following values may be used:

three_ds_initiate Description
01 Initiate 3D Secure before completing the payment
02 Process payment without 3D Secure
03 Initiate 3D Secure according to the 3DS Adviser result

Credorax requires a value to be passed for 3DS transaction type. By default we pass the value '01’, however you may overide this value by passing a different value in the gateway specific field transaction_type. Acceptable values for 3DS transaction type are the following:

transaction_type Description
01 Goods/Service Purchase
03 Check Accpetance
10 Account Funding
11 Quasi-Cash Transaction
28 Prepaid Activation and Loan

Third-party 3D Secure 2 Auth Data

Spreedly will automatically handle the special CAVV formatting requirements specified by Credorax for Visa payment methods. You should pass this value as a 28 byte Base64-encoded string via the authentication_value field as documented in our 3DS2 Third-party Authentication Guide.

Optional gateway specific fields

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

The billing_descriptor field allows you to specify how the transaction should appear on the customer’s credit card statement, and corresponds to the i2 field in Credorax’s official documentation. Please see Credorax’s guide for more information.

3DS information can be sent with the cavv, xid, and eci fields, but be advised that cavv and xid must be present for the transaction to succeed.

Spreedly also provides a fully hosted implementation of 3DS for Credorax. For more information, please see the Spreedly 3D Secure guide. When using the Spreedly 3D Secure implementation, you may use the gateway specific field mpi_purchase_desc to control what purchase description is displayed at Credorax on their 3D Secure authentication page.

The submerchant_id field may be provided by payment facilitators to specify a sub-merchant.

The a9 field can be set using the transaction_type gateway specific field. If not set, the value will be sent as “9” for subsequent transactions on a payment method.

These gateway specific fields may be added like this:


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>
          <credorax>
            <cavv>CAVV</cavv>
            <xid>XID</xid>
            <eci>ECI</eci>
            <billing_descriptor>Your Name*Reno/12345</billing_descriptor>
            <submerchant_id>90210</submerchant_id>
            <transaction_type>2</transaction_type>
            <mpi_purchase_desc>Magic Beans</mpi_purchase_desc>
            <three_ds_challenge_window_size> Challenge Window Size </three_ds_challenge_window_size>
            <three_ds_initiate> Initiate Parameter </three_ds_initiate>
          </credorax>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2019-09-16T22:10:01Z</created_at>
  <updated_at type="dateTime">2019-09-16T22:10:01Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>6H8EAyhaS6GbqLlVLTgHAmaq6Se</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>
    <credorax>
      <cavv>CAVV</cavv>
      <xid>XID</xid>
      <eci>ECI</eci>
      <billing_descriptor>Your Name*Reno/12345</billing_descriptor>
      <submerchant_id>90210</submerchant_id>
      <transaction_type>2</transaction_type>
      <mpi_purchase_desc>Magic Beans</mpi_purchase_desc>
      <three_ds_challenge_window_size> Challenge Window Size </three_ds_challenge_window_size>
      <three_ds_initiate> Initiate Parameter </three_ds_initiate>
    </credorax>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>46</gateway_transaction_id>
  <gateway_latency_ms type="integer">19</gateway_latency_ms>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <amount type="integer">100</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 nil="true"/>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2019-09-16T22:10:01Z</created_at>
    <updated_at type="dateTime">2019-09-16T22:10:01Z</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">2019-09-16T21:59:25Z</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>
</transaction>