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

Certification manager: https://portal-cert.shieldconex.com

Production manager: https://portal.shieldconex.com

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

API Endpoints

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

• Certification environment URL: https://proxy-cert.shieldconex.com

• Production environment URL: https://proxy.shieldconex.com

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 (see API Examples Page )
• deviceSerial
• deviceType
• devicePayload

For the Quickstart process, follow one of the API examples detailed in the API Examples page. We recommend that you start with JSON tokenization.

Creation of ORCA Configuration

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

From here, give your configuration a name, and generate a reference value. Select the partner name and client. Then, in the box below, copy in the ORCA Configuration provided 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 in the list of available ORCA Configurations. The reference that was generated and now appears in the list is known in this document as the configReferenceID. This is required for the request configuration.

Creating a Template

You also need a template, which you also create 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 API examples provided 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%

There are further options for iframe customization. For the purposes of this Quickstart, we recommend that you leave this blank, and leave the template itself unpublished.

Once you click Save, your newly created template should appear in the list of available templates. The reference generated 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.

📘

See the References page for Configuration help, explanations and clarification.