Log in to the Enterprise Business Centre

1. Log in to the EBC (at https://admin.smartpayfuse-test.barclaycard/ebc2) using the credentials created in Getting Started Step 1:

   

2. Use the username and password you created in Getting Started Step 1 when requesting your sandbox account. Note: you will be asked to set a new password when you first log on to the Enterprise Business Centre.

3. Once logged in to the Enterprise Business Centre, proceed to Getting Started Step 3 to configure your Flex Microform service and retrieve credentials for the implementation.

Create your REST API key

An API Key is required to authenticate REST based requests on Smartpay Fuse. Once logged to the Smartpay Fuse EBC portal, head to the sidebar menu and select the Payment Configuration > Key Management menu item, which will display the main key management page. The initial view displays any keys already created on the account and allows you to search for keys by type and created date range.

To create a new key, you will need to select the ‘Generate Key’ button on the top right-hand side of the page:

A “Create Key” window will be displayed, offering a range of different key types. For REST API integration you will need to select a key type from the “REST APIs” section at the head of this page:

There are two options for REST key creation:

• Shared Secret: creates a key id and shared secret keypair used to sign HTTP requests

• Certificate: creates a PKCS12 certificate used for digitally signing API requests

For this guide select REST – Shared Secret.

When you’ve chosen your preferred key type, scroll to the bottom of the page and select ‘Generate Key’. Your new keys will be generated and displayed, ready to copy and download:

You now have the two parameters required for Flex Microform authentication:

• A key id used to identify your new REST key in API requests

• A shared secret used to digitally sign API requests

Important: these REST keys must be stored securely within your back-end service. They allow API access to your service and must be treated as highly sensitive information. Research and implement appropriate API key management best practices when considering how to store and manage these keys.

Note: clicking “Generate another key” at this stage will return you to the “Create Key” screen in readiness to create a fresh set of keys. Your keys have already been generated if this window is displayed, so it is safe to click “Cancel” or visit other screens via the menu at this stage.

If you would rather use certificates to sign your API requests then select the “REST – Certificate” option on the “Create Key” screen. This option generates a PKCS12 file that can be used to digitally sign your API request before transmitting the message to Smartpay Fuse. No data is displayed on the gateway in this case, so you must download the key ahead of future use.

You have now created your REST API, go to Getting Started Step 4 to test your integration. 

Testing your new REST API (using our developer hub request builder)

The REST API configuration is now ready to use. You will need to note the API Key, Secret (or Certificate) generated in Getting Started Step 3 to authenticate calls you make.

You can now start to run transactions, either making calls from our developer hub Live Console or directly through your own code. We will start by using the request builder as it provides a simple graphical representation of API REQ/RESP messages, will construct messages automatically for you and is accompanied by detailed field level documentation.

An introduction to the request builder is available here.

To demonstrate use of this tool we will perform a simple sale transaction using the POST method on the /payments endpoint.

1. Open the Process a Payment page in the request builder, you should see the following screen:

   

2. Configure the type of operation you would like to perform by clicking on the “Configuration” tab that is placed at the top of the “Request Builder” window. This pane allows you to configure key transaction parameters including:
     — The target API URL; destination endpoint of any API requests generated by the request builder
     — The request type; triggers the request builder to populate the request with appropriate fields
     — The payment processor; select Barclays Merchant Services
   
   See the example below for the simple authentication transaction we will run in this example:

   

   Try changing the “Simple Request” transaction type and notice how the JSON body content of the request message updates in the “Live Console” window:

   

3. Once you have selected the type of operation to perform, continue on to configure API credentials by scrolling further down in the “Configuration” tab to the Authentication section:

   

   Here you can enter the credentials generated in Getting Started Step 3:
     — HTTP Signature: uses a Merchant ID, Key and Shared secret to authenticate requests
     — JSON Web Token: uses a Merchant ID and P12 certificate to authenticate requests
   

4. Test the transaction.
   Having selected your transaction type and entered your credentials, return to the main “Request Builder” tab to execute your request. Click on the “Submit” button at the bottom of the Live Console and your request will be sent, with response displayed in the console at the bottom of the page.

Try experimenting by selecting different transaction types in the request builder “Configuration” tab and by selecting new objects and fields in the graphical request builder frame.

Note: each field in the request builder has a clickable tooltip that will provide further information on the field.

Congratulations, you should now have processed a transaction using our REST API using our online request builder. Proceed to Getting Started Step 5 to test execute transactions using sample code.

Testing your new REST API (using sample application code)

Having already run a transaction using our on-line request builder, you know that your credentials are valid and that your service configuration is correct. You will have been able to experiment with the request builder to send differing requests and tested a range of field values to evaluate the request types and parameters required to achieve your specific use case.

You will now probably want to start coding some simple transaction flows. To support this, we provide sample integrations in a number of languages to get a basic integration up and running. The links below are provided by our payment partner and are hosted within their GitHub account:

Note: Smartpay Fuse has been created in partnership with VISA Cybersource. You may notice some resources feature the Cybersource brand – these are still part of connecting to Barclaycard Payments.

Java      C#        PHP      NodeJS     Ruby    Python

These sample applications demonstrate a wide range of operations used in typical payment processing flows. The code will require modifying to work with your specific journey but serve to demonstrate the key steps required to interact with our REST API.

We will use the PHP example to demonstrate the necessary steps:

1. Prepare your environment:
     — Ensure you are using PHP version 5.6 or greater.
     — Install the cURL, JSON, and APCU extensions.
     — Created your test account (see Getting Started Step 1).
     — Generate your API keys (see Getting Started Step 3).
   


2. Clone the sample application code from GitHub.
   > git clone https://github.com/cybersource/cybersource-rest-samples-php
> cd cybersource-rest-samples-php
   
   
3. Run composer to update dependencies.
   > composer update


4. Execute a simple test scenario.
     — The sample application has a wide range of example scenarios, each of which can be used as a template for your own code or executed standalone from the command line.
     — The code samples work out of the box with test credentials, but you may wish to amend the sample application configuration to use the credentials you created in Getting Started Step 3. Note: Using your own credentials will execute transactions against your account and will allow you to search for and manage those transactions in the Enterprise Business Centre.
     — Start by executing a simple auth and capture operation.
   > php ./Samples/Payments/Payments/AuthorizationWithCaptureSale.php

The code will execute the request and log the result of the operation to the console. You can also log in to the EBC back-office portal and view the transaction details there.

Congratulations, you should now have processed a transaction using the REST API.

Continue to explore the various operations in the sample applications and use these alongside the full REST API guide and Live Console to building out capabilities in your own code.