CyberSource REST Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
CyberSource REST
Services that work with Spreedly:
  • CyberSource REST
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify, General Credit
Supported payment types:
Credit Card, Apple Pay, Google Pay, Bank Account
Spreedly 3DS2 Global Supported
No
Gateway Specific 3DS2 Supported
No
Populate MIT GSF Support
No
Regions:
Asia Pacific, Europe, Latin America, North America
API endpoint URL:
https://api.cybersource.com

Authentication and Security

Specific names for credentials:
Merchant Id, Private Key, Public Key

Onboarding Merchants in:

Adding CyberSource gateway

To add a CyberSource REST gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>cyber_source_rest</gateway_type>
        <merchant_id>your merchant id</merchant_id>
        <public_key>your public key</public_key>
        <private_key>your secret key</private_key>
      </gateway>'

<gateway>
  <token>5HIXjPkH7NyV5AqYnaNBIyubQEN</token>
  <gateway_type>cyber_source_rest</gateway_type>
  <name>Cybersource REST</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <merchant_id>your merchant id</merchant_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">true</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_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>
  </characteristics>
  <credentials>
    <credential>
      <name>merchant_id</name>
      <value>your merchant id</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>customer_id</gateway_specific_field>
    <gateway_specific_field>ignore_avs</gateway_specific_field>
    <gateway_specific_field>ignore_cvv</gateway_specific_field>
    <gateway_specific_field>zero_amount_verify</gateway_specific_field>
    <gateway_specific_field>sec_code</gateway_specific_field>
    <gateway_specific_field>invoice_number</gateway_specific_field>
    <gateway_specific_field>reconciliation_id</gateway_specific_field>
    <gateway_specific_field>mdd_field_1</gateway_specific_field>
    <gateway_specific_field>mdd_field_2</gateway_specific_field>
    <gateway_specific_field>mdd_field_3</gateway_specific_field>
    <gateway_specific_field>mdd_field_4</gateway_specific_field>
    <gateway_specific_field>mdd_field_5</gateway_specific_field>
    <gateway_specific_field>mdd_field_6</gateway_specific_field>
    <gateway_specific_field>mdd_field_7</gateway_specific_field>
    <gateway_specific_field>mdd_field_8</gateway_specific_field>
    <gateway_specific_field>mdd_field_9</gateway_specific_field>
    <gateway_specific_field>mdd_field_10</gateway_specific_field>
    <gateway_specific_field>mdd_field_11</gateway_specific_field>
    <gateway_specific_field>mdd_field_12</gateway_specific_field>
    <gateway_specific_field>mdd_field_13</gateway_specific_field>
    <gateway_specific_field>mdd_field_14</gateway_specific_field>
    <gateway_specific_field>mdd_field_15</gateway_specific_field>
    <gateway_specific_field>mdd_field_16</gateway_specific_field>
    <gateway_specific_field>mdd_field_17</gateway_specific_field>
    <gateway_specific_field>mdd_field_18</gateway_specific_field>
    <gateway_specific_field>mdd_field_19</gateway_specific_field>
    <gateway_specific_field>mdd_field_20</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>apple_pay</payment_method>
    <payment_method>google_pay</payment_method>
    <payment_method>bank_account</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-04-12T17:03:37Z</created_at>
  <updated_at type="dateTime">2023-04-12T17:03:37Z</updated_at>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:cyber_source_rest, merchant_id: "your merchant id", public_key: "Your public key", private_key: "Your private key")


#<Spreedly::Gateway:0x00007fe54284c928
@token="KMQX3wzTHm3pIjhpcSUhSmUf63g",
@created_at="2023-04-12T17:03:38Z",
@updated_at="2023-04-12T17:03:38Z",
@gateway_type="cyber_source_rest",
@state="retained",
@name="Cybersource REST",
@credentials={"merchant_id"=>"your merchant id"}>

Gateway specific fields

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

merchant_id: This field can be used to specify a destination merchant_id different from the one used to create the CyberSource gateway. This enables portfolio merchants to utilize meta keys and direct funds to linked merchants.

ignore_avs: Flag for a sale request that indicates whether to allow the capture service to run even when the authorization.

ignore_cvv: Flag for a sale request that indicates whether to allow the capture service to run even when the authorization receives a CVN decline.

mdd_field_1 .. mdd_field_100: Fields available to store merchant defined values in the transaction.

reconciliation_id: Reference number for the transaction, the actual value used in the request to the processor is provided back to you by Cybersource in the response.

customer_id: CyberSource customer id.

zero_amount_verify: Flag to specify if the verify transaction should attempt a $0 auth verification.

sec_code: Specifies the authorization method for the transaction (ARC|CDD|POP|PPD|TEL|WEB).

invoice number: Field to support an invoice number for a transaction

For more information about each field go to CyberSource Rest API exlporer

Gateway specific fields usage example:


curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<transaction>
        <billing_address>
          <zip>31331</zip>
          <state>NJ</state>
          <phone_number>919.331.3313</phone_number>
          <name>Francisca Torphy</name>
          <country>US</country>
          <city>Wanaque</city>
          <address2>Apartment 4</address2>
          <address1>33 Lane Road</address1>
        </billing_address>
        <email>johndoe@gmail.com</email>
        <credit_card>
            <first_name>Joe</first_name>
            <last_name>Smith</last_name>
            <number>4111111111111111</number>
            <verification_value>987</verification_value>
            <month>12</month>
            <year>2031</year>
        </credit_card>
        <amount>100</amount>
        <currency_code>USD</currency_code>
        <gateway_specific_fields>
            <cyber_source_rest>
              <invoice_number>6568f352</invoice_number>
              <ignore_avs>true</ignore_avs>
              <ignore_cvv>true</ignore_cvv>
              <reconciliation_id>abc123</reconciliation_id>
            </cyber_source_rest>
        </gateway_specific_fields>
    </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2023-04-12T17:33:21Z</created_at>
  <updated_at type="dateTime">2023-04-12T17:33:25Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>BaqFSnLKKLoZ7EfcEkj540VkxFr</token>
  <transaction_type>Purchase</transaction_type>
  <order_id nil="true"/>
  <ip nil="true"/>
  <description nil="true"/>
  <email>johndoe@gmail.com</email>
  <merchant_name_descriptor nil="true"/>
  <merchant_location_descriptor nil="true"/>
  <merchant_profile_key nil="true"/>
  <gateway_specific_fields>
    <cyber_source_rest>
      <invoice_number>6568f352</invoice_number>
      <ignore_avs>true</ignore_avs>
      <ignore_cvv>true</ignore_cvv>
      <reconciliation_id>abc123</reconciliation_id>
    </cyber_source_rest>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
    <cyber_source_rest>
      <reconciliation_id>72492858TG3K5GB1</reconciliation_id>
      <processor_response>100</processor_response>
      <authorization_code>BaqFSnLKKLoZ7EfcEkj540VkxFr</authorization_code>
      <payment_network_transaction_id>123456789619999</payment_network_transaction_id>
    </cyber_source_rest>
  </gateway_specific_response_fields>
  <gateway_transaction_id>6813208017946158704951|100</gateway_transaction_id>
  <sub_merchant_key nil="true"/>
  <gateway_latency_ms type="integer">784</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">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">true</payment_method_added>
  <smart_routed type="boolean">false</smart_routed>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>C11FAQml9ACr6JNQCKgZ8e56K1w</gateway_token>
  <gateway_type>cyber_source_rest</gateway_type>
  <billing_address>
    <name>Francisca Torphy</name>
    <address1>33 Lane Road</address1>
    <address2>Apartment 4</address2>
    <city>Wanaque</city>
    <state>NJ</state>
    <zip>31331</zip>
    <country>US</country>
    <phone_number>919.331.3313</phone_number>
  </billing_address>
  <shipping_address>
    <name>Joe Smith</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>AUTHORIZED</message>
    <avs_code>X</avs_code>
    <avs_message>Street address and 9-digit postal code match.</avs_message>
    <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-04-12T17:33:21Z</created_at>
    <updated_at type="dateTime">2023-04-12T17:33:25Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>5wAI48A48MZd43g2WoCVxFzYe8D</token>
    <created_at type="dateTime">2023-04-12T17:33:21Z</created_at>
    <updated_at type="dateTime">2023-04-12T17:33:21Z</updated_at>
    <email nil="true"/>
    <data nil="true"/>
    <storage_state>cached</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>Joe</first_name>
    <last_name>Smith</last_name>
    <month type="integer">12</month>
    <year type="integer">2031</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>Joe Smith</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>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value>XXX</verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint nil="true"/>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>