Cecabank Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Cecabank, SA
Services that work with Spreedly:
  • Cecabank
Supported operations:
Purchase, Authorize, Capture, Refund, Void
Supported payment types:
Credit Card
Spreedly 3DS2 Global Supported
Yes
Gateway Specific 3DS2 Supported
No
Populate MIT GSF Support
No
Regions:
Europe
API endpoint URL:
https://pgw.ceca.es/tpvweb/rest/procesos/

Authentication and Security

Specific names for credentials:
default mode:
Acquirer Bin, Merchant ID, Terminal ID, Cypher Key
encrypted mode:
Acquirer Bin, Merchant ID, Terminal ID, Cypher Key, Encryption Key, Initiator Vector

Onboarding Merchants in:

Adding Cecabank REST gateway

Cecabank offers an offsite hosted payment page and a direct API integration option. Spreedly only supports a direct API integration model. To add Cecabank to your Spreedly account you must ensure that your Cecabank account is set up to support a direct API model. If you’re not sure please check with your Cecabank account manager first. To add a Cecabank gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>cecabank</gateway_type>
        <merchant_id>YourMerchantID</merchant_id>
        <acquirer_bin>YourAcquirerBin</acquirer_bin>
        <terminal_id>YourTerminalID</terminal_id>
        <cypher_key>YourCypherKey</cypher_key>
      </gateway>'

<gateway>
  <token>2SY4D6QFXP8ZAVFEHY16HKQXWN</token>
  <gateway_type>cecabank</gateway_type>
  <name>Cecabank</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <merchant_id>YourMerchantID</merchant_id>
  <acquirer_bin>YourAcquirerBin</acquirer_bin>
  <terminal_id>YourTerminalID</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_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_offsite_synchronous_purchase type="boolean">false</supports_offsite_synchronous_purchase>
    <supports_offsite_synchronous_authorize type="boolean">false</supports_offsite_synchronous_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">true</supports_3dsecure_2_mpi_purchase>
    <supports_3dsecure_2_mpi_authorize type="boolean">true</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>
    <supports_inquire_by_gateway_transaction_id type="boolean">false</supports_inquire_by_gateway_transaction_id>
    <supports_inquire_by_order_id type="boolean">false</supports_inquire_by_order_id>
    <supports_transaction_retry type="boolean">false</supports_transaction_retry>
    <supports_stored_stored_credentials type="boolean">false</supports_stored_stored_credentials>
    <supports_stored_credentials type="boolean">true</supports_stored_credentials>
    <supports_card_scheme_ntid type="boolean">true</supports_card_scheme_ntid>
  </characteristics>
  <credentials>
    <credential>
      <name>merchant_id</name>
      <value>YourMerchantID</value>
    </credential>
    <credential>
      <name>acquirer_bin</name>
      <value>YourAcquirerBin</value>
    </credential>
    <credential>
      <name>terminal_id</name>
      <value>YourTerminalID</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>recurring_frequency</gateway_specific_field>
    <gateway_specific_field>recurring_end_date</gateway_specific_field>
    <gateway_specific_field>network_transaction_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>
  <sandbox type="boolean">false</sandbox>
  <mode>default</mode>
  <created_at type="dateTime">2024-02-06T22:35:56Z</created_at>
  <updated_at type="dateTime">2024-02-06T22:35:56Z</updated_at>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:cecabank, merchant_id: 'YourMerchantId',
                acquirer_bin: 'YourAcquirerBin', terminal_id: 'YourTerminalId',
                cypher_key: 'YourCypherKey')


#<Spreedly::Gateway:0x00007fca508c4d68
@token="5ZYZ31G6219MGBT389BC80V83K",
@created_at="2024-02-06T22:35:59Z",
@updated_at="2024-02-06T22:35:59Z",
@gateway_type="cecabank",
@state="retained",
@name="Cecabank",
@credentials={"merchant_id"=>"YourMerchantId", "acquirer_bin"=>"YourAcquirerBin", "terminal_id"=>"YourTerminalId"}>

Adding encrypted Cecabank REST gateway

Some Cecabank accounts may require or use a encryption for sensitive credit card and CAVV fields; for these you can specify the encrypted mode:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>cecabank</gateway_type>
        <mode>encrypted</mode>
        <merchant_id>YourMerchantID</merchant_id>
        <acquirer_bin>YourAcquirerBin</acquirer_bin>
        <terminal_id>YourTerminalID</terminal_id>
        <cypher_key>YourCypherKey</cypher_key>
        <encryption_key>YourEncryptionKey</encryption_key>
        <initiator_vector>YourInitiatorVector</initiator_vector>
      </gateway>'

<gateway>
  <token>687GM2TNSS9M4BSDJ0DE92AZWZ</token>
  <gateway_type>cecabank</gateway_type>
  <name>Cecabank</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <merchant_id>YourMerchantID</merchant_id>
  <acquirer_bin>YourAcquirerBin</acquirer_bin>
  <terminal_id>YourTerminalID</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_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_offsite_synchronous_purchase type="boolean">false</supports_offsite_synchronous_purchase>
    <supports_offsite_synchronous_authorize type="boolean">false</supports_offsite_synchronous_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">true</supports_3dsecure_2_mpi_purchase>
    <supports_3dsecure_2_mpi_authorize type="boolean">true</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>
    <supports_inquire_by_gateway_transaction_id type="boolean">false</supports_inquire_by_gateway_transaction_id>
    <supports_inquire_by_order_id type="boolean">false</supports_inquire_by_order_id>
    <supports_transaction_retry type="boolean">false</supports_transaction_retry>
    <supports_stored_stored_credentials type="boolean">false</supports_stored_stored_credentials>
    <supports_stored_credentials type="boolean">true</supports_stored_credentials>
    <supports_card_scheme_ntid type="boolean">true</supports_card_scheme_ntid>
  </characteristics>
  <credentials>
    <credential>
      <name>merchant_id</name>
      <value>YourMerchantID</value>
    </credential>
    <credential>
      <name>acquirer_bin</name>
      <value>YourAcquirerBin</value>
    </credential>
    <credential>
      <name>terminal_id</name>
      <value>YourTerminalID</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>recurring_frequency</gateway_specific_field>
    <gateway_specific_field>recurring_end_date</gateway_specific_field>
    <gateway_specific_field>network_transaction_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>
  <sandbox type="boolean">false</sandbox>
  <mode>encrypted</mode>
  <created_at type="dateTime">2024-02-06T22:44:26Z</created_at>
  <updated_at type="dateTime">2024-02-06T22:44:26Z</updated_at>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:cecabank, mode: 'encrypted', merchant_id: 'YourMerchantId',
                acquirer_bin: 'YourAcquirerBin', terminal_id: 'YourTerminalId',
                cypher_key: 'YourCypherKey', encryption_key: 'YourEncryptionKey', initiator_vector: 'YourInitiatorVector')


#<Spreedly::Gateway:0x000000013e9af710
@token="75JKZ1GPFV96HTXSM4ZWN2R37Y",
@created_at="2024-01-26T03:43:37Z",
@updated_at="2024-01-26T03:43:37Z",
@gateway_type="cecabank",
@state="retained",
@name="Cecabank",
@credentials={"merchant_id"=>"YourMerchantId", "acquirer_bin"=>"YourAcquirerBin", "terminal_id"=>"YourTerminalId"}>

Gateway specific fields

When interacting with a Cecabank gateway to run transactions, there are a few gateway specific fields you can specify when making a call:

  • recurring_frequency
  • recurring_end_date
  • network_transaction_id

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>
          <cecabank>
            <recurring_frequency>1</recurring_frequency>
            <recurring_end_date>20231231</recurring_end_date>
            <network-transaction-id>12345678</network-transaction-id>
          </cecabank>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2024-02-06T22:44:24Z</created_at>
  <updated_at type="dateTime">2024-02-06T22:44:25Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>ARfIdQX8fJtfbpbQcETOP9zAuA3</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>
    <cecabank>
      <recurring_frequency>1</recurring_frequency>
      <recurring_end_date>20231231</recurring_end_date>
      <network_transaction_id>12345678</network_transaction_id>
    </cecabank>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>62</gateway_transaction_id>
  <sub_merchant_key nil="true"/>
  <gateway_latency_ms type="integer">14</gateway_latency_ms>
  <warning nil="true"/>
  <application_id nil="true"/>
  <amount type="integer">100</amount>
  <local_amount nil="true"/>
  <currency_code>USD</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>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <stored_credential_alternate_gateway nil="true"/>
  <populate_mit_fields type="boolean">false</populate_mit_fields>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>PKFXjn0If07shHZJyDobhTnKVl</gateway_token>
  <gateway_type>test</gateway_type>
  <shipping_address>
    <name>Karolyn Kertzmann</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">2024-02-06T22:44:24Z</created_at>
    <updated_at type="dateTime">2024-02-06T22:44:25Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>4tXxHs23fmw92reA5CV7OXiH8xa</token>
    <created_at type="dateTime">2024-02-06T21:49:26Z</created_at>
    <updated_at type="dateTime">2024-02-06T22:42:54Z</updated_at>
    <email nil="true"/>
    <data nil="true"/>
    <storage_state>retained</storage_state>
    <test type="boolean">true</test>
    <metadata nil="true"/>
    <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>Karolyn</first_name>
    <last_name>Kertzmann</last_name>
    <month type="integer">4</month>
    <year type="integer">2027</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>Karolyn Kertzmann</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"/>
    <issuer_identification_number>41111111</issuer_identification_number>
    <click_to_pay type="boolean">false</click_to_pay>
    <managed nil="true"/>
    <payment_method_type>credit_card</payment_method_type>
    <stored_credential_usage>
      <test>
        <original_network_transaction_id nil="true"/>
        <network_transaction_id nil="true"/>
      </test>
    </stored_credential_usage>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint nil="true"/>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>

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

Stored credentials

For Cecabank,Sending stored credential data is simple. For any Authorize or Purchase request, you need to include two fields which tell Spreedly a little bit more about the nature of the transaction:

  • stored_credential_initiator
  • stored_credential_reason_type

Learn more about how Spreedly enables seamless use of stored credentials by reviewing our Stored Credentials Guide.