Checkout decision report JWT structure

The <JWT> contains the encoded and signed content with the checkout decision report (whether the checkout was approved or declined). The content (after being decoded) should have the following JSON format:

{
  "iss": "<MERCHANT_ID>",
  "sub": 'Merchant',
  "iat": "<TIMESTAMP>",
  "data": {
    "reference": "<RAYLO_REFERENCE>",
    "merchantReference": "<MERCHANT_REFERENCE>",
    "outcome": "<OUTCOME>",
    "outcomeDecidedAt": "<OUTCOME_DECIDED_AT>"
  }
}

Field details

Field	Type	Description
iss	String	This contains the merchant ID, which is provided to the merchant ahead of time
iat	Integer	This contains the timestamp when the payload was generated following the UNIX epoc time format
data	Data type	Refer to the Data type for more info on its structure.

Data type

Field	Type	Description
reference	String	Raylo reference for the checkout
merchantReference	String	Merchant reference for the checkout
outcome	String	One of: "success" - checkout was approved "failure" - checkout was declined
outcomeDecidedAt	String	This contains the timestamp when the checkout outcome was decided following the ISO8601 format

Decode the payload content

To decode the payload content the following is required:

• Merchant ID

• Signing algorithm

• Signing key

This information is shared with the merchant ahead of time

Ruby

require 'jwt'

options = {
  iss: "<MERCHANT_ID>",
  verify_iss: true,
  algorithm: signing_algorithm
}

jwt = JWT.decode(payload, signing_key, true, options)

Please refer to the official JWT website for more information about signing/verification libraries.