Cecabank gateway guide

Adding a 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> <acquirer_bin>Acquirer Bin</acquirer_bin> <merchant_id>Merchant ID</merchant_id> <terminal_id>Terminal ID</terminal_id> <cypher_key>Cypher Key</cypher_key> </gateway>'
<gateway> <token>5QZ7cKcHqf3wjjNx2YTx22kDJW9</token> <gateway_type>cecabank</gateway_type> <name>Cecabank</name> <description nil="true"/> <merchant_profile_key nil="true"/> <sub_merchant_key nil="true"/> <merchant_id>Merchant ID</merchant_id> <acquirer_bin>Acquirer Bin</acquirer_bin> <terminal_id>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_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">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> <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> </characteristics> <credentials> <credential> <name>merchant_id</name> <value>Merchant ID</value> </credential> <credential> <name>acquirer_bin</name> <value>Acquirer Bin</value> </credential> <credential> <name>terminal_id</name> <value>Terminal ID</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_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">2023-10-26T16:39:37Z</created_at> <updated_at type="dateTime">2023-10-26T16:39:37Z</updated_at> </gateway>

Gateway specific fields

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

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> </cecabank> </gateway_specific_fields> </transaction>'
<transaction> <on_test_gateway type="boolean">true</on_test_gateway> <created_at type="dateTime">2023-10-26T16:39:37Z</created_at> <updated_at type="dateTime">2023-10-26T16:39:37Z</updated_at> <succeeded type="boolean">true</succeeded> <state>succeeded</state> <token>T9nLts436p0OhWGe9cSlFOkjhjr</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> </cecabank> </gateway_specific_fields> <gateway_specific_response_fields> </gateway_specific_response_fields> <gateway_transaction_id>50</gateway_transaction_id> <sub_merchant_key nil="true"/> <gateway_latency_ms type="integer">8</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>1xrmbBe664VwogceZfiHxfRHXjO</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">2023-10-26T16:39:37Z</created_at> <updated_at type="dateTime">2023-10-26T16:39:37Z</updated_at> </response> <api_urls> </api_urls> <payment_method> <token>2E7VJIrNbj6F5uWKA5bf6fxIyL8</token> <created_at type="dateTime">2023-10-25T23:07:12Z</created_at> <updated_at type="dateTime">2023-10-26T15:41:55Z</updated_at> <email nil="true"/> <data nil="true"/> <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">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>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"/> <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>cdb667950fd509729e70</network_transaction_id> </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>

Did this page help you?