Set Up a JSON Web Token Message

Setting up your JSON web token message requires you to complete these tasks:

Figure:

How to Set Up JSON Web Token Messaging
  1. Sign up and register a
    Barclays
    Smartpay Fuse Portal
    sandbox account. See Sign Up for a Sandbox Account.
  2. Create a P12 certificate. See Create a P12 Certificate.
  3. Construct a message using a JSON web token. See Construct Messages Using JSON Web Tokens.
  4. (Optional) Enable the optional message-level encryption (MLE) feature. See Enable Message-Level Encryption.
  5. Go live. See Going Live.

Sign Up for a Sandbox Account

The first step to set up your account is to sign up for a sandbox account. From this account you can obtain your security keys and test your implementation.
Follow these steps to sign up for a sandbox account:
  1. Go to the
    Barclays
    Developer Center sandbox account sign up page:
  2. Enter your information into the sandbox account form and click
    Create Account
    .
  3. Go to your email and find a message titled:
    Merchant Registration Details
    . Click the
    Set up your username and password now
    link.
    Your browser opens the New User Sign Up wizard.
  4. Enter the Organization ID and Contact email you supplied previously. Follow the wizard pages to add your name, a username, and a password.
  5. Log in to the
    Smartpay Fuse Portal
    .
    When you log in for the first time, you will be asked to verify your identity through a system-generated email to your email account.
  6. Check your email for a message titled:
    Barclays
    Identification Code
    . A passcode is included in the message.
  7. Enter the passcode on the
    Verify your Identity
    page.
    You should be directed to the
    Smartpay Fuse Portal
    home page.
    You have successfully signed up for a sandbox account.
Set Up a JSON Web Token Message

Going Live

When you are ready to process payments in a live environment, you must transition your account to a live status with a valid configuration for your chosen payment processor. When live, your transaction data flows through the production
Barclays
gateway, to your processor, and on to the appropriate payment network.
To transition your account:
  1. Sign up for a merchant account.
  2. Contact Sales
    to establish a contract with
    Barclays
    that enables you to process real transactions and receive support.
  3. Submit a merchant ID (MID) activation request.
It may take up to three business days to complete a MID activation request.
Set Up a JSON Web Token Message

Sign Up for a Sandbox Account

The first step to set up your account is to sign up for a sandbox account. From this account you can obtain your security keys and test your implementation.
Follow these steps to sign up for a sandbox account:
  1. Go to the
    Barclays
    Developer Center sandbox account sign up page:
  2. Enter your information into the sandbox account form and click
    Create Account
    .
  3. Go to your email and find a message titled:
    Merchant Registration Details
    . Click the
    Set up your username and password now
    link.
    Your browser opens the New User Sign Up wizard.
  4. Enter the Organization ID and Contact email you supplied previously. Follow the wizard pages to add your name, a username, and a password.
  5. Log in to the
    Smartpay Fuse Portal
    .
    When you log in for the first time, you will be asked to verify your identity through a system-generated email to your email account.
  6. Check your email for a message titled:
    Barclays
    Identification Code
    . A passcode is included in the message.
  7. Enter the passcode on the
    Verify your Identity
    page.
    You should be directed to the
    Smartpay Fuse Portal
    home page.
    You have successfully signed up for a sandbox account.
Set Up a JSON Web Token Message

Create a P12 Certificate

A P12 certificate and its private key are used with JSON Web Token message security. To create a P12 certificate, you must download a .p12 file from the
Smartpay Fuse Portal
and extract its private key.
Set Up a JSON Web Token Message

Construct Messages Using JSON Web Tokens

Follow these steps to construct messages using JWTs:
  1. Generate a hash of the message body. See Generate a Hash of the Message Body.
  2. Populate the header values. See Generate the Token Header.
  3. Generate a hash of the claim set. See Generate a Hash of the Claim Set.
  4. Generate a hash of the token header. See Generate a Hash of the Token Header.
  5. Generate a token signature hash. See Generate a Token Signature.
  6. Populate the
    signature
    header field. See Update Header Fields.
Set Up a JSON Web Token Message

Enable Message-Level Encryption

IMPORTANT
This feature is in the pilot phase. To use message-level encryption, contact your sales representative.
There are additional tasks you must complete before you can enable message-level encryption. For more information, see Prerequisites for Message-Level Encryption.
Message-Level Encryption (MLE) enables you to store information or communicate with other parties while helping to prevent uninvolved parties from understanding the stored information. MLE is optional and supported only for payments services.
MLE provides enhanced security for message payload by using an asymmetric encryption technique (public-key cryptography). The message encryption is implemented with symmetric encryption using Advanced Encryption Standard (AES), Galois Counter Mode (GCM) with 256-bit key size. The encryption of keys is supported using RSA Optimal Asymmetric Encryption Padding (OAEP) with 2048-bit key size. The encryption service is based on JSON Web Encryption (JWE), works on top of SSL and requires separate key-pairs for request and response legs of the transaction.
MLE is required for APIs that primarily deal with sensitive transaction data, both financial and non-financial. These are the types of sensitive transaction data:
  • Personal identification information (PII)
  • Personal account number (PAN)
  • Personal account information (PAI)
MLE is supported when using JSON web tokens. For more information, see Message-Level Encryption Using JSON Web Tokens.
Each of these authentication schemes uses an encrypted payload, called the
JWE
. A JWE token has these five components, with each component separated by a period (.):
  • JOSE header containing four elements:
    "alg": "RSA-OAEP-256", //The algorithm used to encrypt the CEK "enc": "A256GCM", //The algorithm used to encrypt the message "iat": "1702493653" //The current timestamp in milliseconds "kid": "keyId" //The serial number of shared public cert for encryption of CEK
  • JWE encrypted key
  • JWE initialization vector
  • JWE additional authentication data (AAD)
  • JWE ciphertext and authentication tag
Set Up a JSON Web Token Message

Going Live

When you are ready to process payments in a live environment, you must transition your account to a live status with a valid configuration for your chosen payment processor. When live, your transaction data flows through the production
Barclays
gateway, to your processor, and on to the appropriate payment network.
To transition your account:
  1. Sign up for a merchant account.
  2. Contact Sales
    to establish a contract with
    Barclays
    that enables you to process real transactions and receive support.
  3. Submit a merchant ID (MID) activation request.
It may take up to three business days to complete a MID activation request.
Set Up a JSON Web Token Message