Ruby Client SDK for the CyberSource REST APIs

The CyberSource Ruby client provides convenient access to the CyberSource REST API from your Ruby application.

Requirements

• Ruby 2.5.0 or higher
• CyberSource Account
• CyberSource API Keys

Dependencies

• activesupport >= 6.0.3.2, < 8.0
• interface 1.0.4
• json 2.1.0
• jwt 2.1.0
• typhoeus 1.3.1

Installation

Bundler

Be sure to always use HTTPS rubygems source in your gemfile and include the cybersource_rest_client.

	source 'https://rubygems.org' do
	  gem 'cybersource_rest_client'
	end

Registration & Configuration

Use of this SDK and the CyberSource APIs requires having an account on our system. You can find details of getting a test account and creating your keys here

Once you have your keys, simply load them into the appropriate variables in your code, as per the below sample code dealing with the authentication part of the API request.

Remember this SDK is for use in server-side Ruby applications that access the CyberSource REST API and credentials should always be securely stored and accessed appropriately.

SDK Usage Examples and Sample Code

To get started using this SDK, it's highly recommended to download our sample code repository:

• CyberSource Ruby Sample Code Repository (on GitHub)

In that respository, we have comprehensive sample code for all common uses of our API:

Additionally, you can find details and examples of how our API is structured in our API Reference Guide:

• Developer Center API Reference

The API Reference Guide provides examples of what information is needed for a particular request and how that information would be formatted. Using those examples, you can easily determine what methods would be necessary to include that information in a request using this SDK.

MetaKey Support

A Meta Key is a single key that can be used by one, some, or all merchants (or accounts, if created by a Portfolio user) in the portfolio.

The Portfolio or Parent Account owns the key and is considered the transaction submitter when a Meta Key is used, while the merchant owns the transaction.

MIDs continue to be able to create keys for themselves, even if a Meta Key is generated.

Further information on MetaKey can be found in New Business Center User Guide.

Switching between the sandbox environment and the production environment

CyberSource maintains a complete sandbox environment for testing and development purposes. This sandbox environment is an exact duplicate of our production environment with the transaction authorization and settlement process simulated. By default, this SDK is configured to communicate with the sandbox environment. To switch to the production environment, set the runEnvironment property in the SDK Configuration. See our sample at https://github.com/CyberSource/cybersource-rest-samples-ruby/blob/master/data/Configuration.rb

   # For TESTING use
     runEnvironment='apitest.cybersource.com'
   # For PRODUCTION use
   # runEnvironment='api.cybersource.com'

API credentials are different for each environment, so be sure to switch to the appropriate credentials when switching environments.

License

This repository is distributed under a proprietary license. See the provided LICENSE.txt file.