Getting Started

Integration with the ShieldConex® Proxy involves a combination of both API calls and configuration via the ShieldConex® Manager. There is a different Manager for the certification and production environments:

Certification Manager:

Production Manager:

The Proxy Configuration is the key to the API, allowing you to customize settings, set additional options, and enhance your developer experience. The Proxy Configuration object is detailed under the Proxy Configuration JSON Schema Definitions section in the References page.

API Endpoints

Choose one of the following endpoints to access the ShieldConex® Proxy. If necessary, in the POST requests detailed in the API Examples section, replace {-*} with the chosen environment name.

Certification environment URL:

Production environment URL:

Quickstart Guide

You must have a number of authentication and environment variables to hand, as given to you by Bluefin:

  • partnerID
  • partnerKey
  • authKey
  • secret ( Base64 Encoded/Decoded Secret Key For HMAC)
  • HMAC_AUTH_HEADER ( refer to API Examples Page )
  • deviceSerial
  • deviceType
  • devicePayload

For the Quickstart process, follow one of the API examples detailed in the 'API Examples' page - we recommend starting with JSON Tokenization.

Creation of Proxy Configuration

First, create a Proxy Configuration via the ShieldConex® Manager. Under the Manage Proxy Configurations tab, select your partner name and client from the dropdown and click on 'Create Proxy Configuration'.

From here, give your Proxy Configuration a name, and generate a reference value. The chosen partner name and client must also be selected. Then, in the box below, copy in the Proxy Configuration given by the chosen API Example. Replace any {variables} with the corresponding environment variable or authentication token, and save the configuration.

Once the configuration has been saved, you should see it appear in the list of available Proxy Configurations. The reference that was generated and appears now in the list is known in this document as the configReferenceID - this is required for the request configuration.

Creation of Template

You also need a Template, also created via the ShieldConex® Manager. Similarly, under the Manage Templates tab, select your partner name and client from the dropdown and click on 'Create Template'.

Give your Template a name, select the partner and client, and generate a reference value. If required, you can change the Access Mode of your template.

The given API examples all use three field template types; Card Information, Bank Account Number, and Routing Number. If you wish, you can follow the sample template configurations below.

Card Information

  • Field Type: Card Information
    • Display name: Card Information
    • Data Protection Method: FPT
    • Use Non Idempotent Tokens: No
    • Cardholder Name: No
    • Expiration Date: Yes
    • Security Code: Yes
      • Card Number
        • System Name: scx_token_card_number
        • Data Masking: Tokenize all inputs in field
        • Label: Credit Card Number
        • Placeholder Text:
        • Luhn Check: None
      • Expiration Date
        • System Name: scx_token_card_expiration
        • Label: Credit Card Expiration
        • Placeholder Text:
      • Security Code
        • System name: scx_token_card_verification
        • Label: Credit Card Verification
        • Placeholder Text:

Bank Account Number

  • Field Type: Bank Account Number
    • Display name: Bank Account Number
    • Data Protection Method: FPT
    • System Name: scx_token_bank_account_number
    • Data Masking: Tokenize all inputs in field
    • Placeholder Text:
    • Width: 100%

Routing Number

  • Field Type: Routing Number
    • Display name: Routing Number
    • Data Protection Method: FPT
    • System Name: scx_token_bank_routing_number
    • Data Masking: Tokenize all inputs in field
    • Placeholder Text:
    • Width: 100%

If you wish, there are further options for iframe customization. For the purposes of this Quickstart, we recommend leaving this blank, and leaving the Template itself unpublished.

Once you click Save, your newly created Template should appear in the list of Templates available. The generated reference is required for the request configurations - it is known as the templateRef.

Once you have your configReferenceID and your templateRef, you can copy the Request Configuration from your chosen API Example into your application, again replacing any {variables} with the corresponding values, including your target URL (Payment Processor). You should receive a 200 response back.


Please refer to the References page for Configuration help, explanations, and clarification

What’s Next

Use one of the API Examples to follow the Quickstart Guide, then check out the Example Use Case - source code available at the bottom of that page.