Formatting

transactionReference format

• The transactionReference must be a uniquely generated identifier
• Our Try (https://try.access.worldpay.com/) environment returns a bad request error if a duplicate transactionReference is supplied
• 64 characters max. We recommend your transactionReference contains between 9-20 characters for ease of onward processing
• This safeguards you against acquirers who truncate the transactionReference

Supported format, structure and limits for transactionReference:

Valid characters:

• A-Z
• a-z
• 0-9
• Hyphen -
• Underscore _
• Forward Slash /
• Exclamation mark !
• At @
• Pound, number sign, sharp or hash #
• Dollar $
• Percent %
• Parenthesis ()
• Asterisk *
• Equal =
• Full stop .
• Colon :
• Semi-colon ;
• Question mark ?
• Brackets []
• Braces or Curly braces {}
• Tilde ~
• Plus +

reference format

• This format applies for the reference parameter in partial settlement and partial refund requests
• reference must be between 1-128 characters

Valid characters:

• A-Z
• a-z
• 0-9
• Hyphen -

Narrative format

The narrative object helps your customers to better identify you on their statement.

Narrative line1

line1 is used to provide basic details about the merchant.

Supported format, structure and limits for line1:

• This has to be a consistent identifier
• There is a limit of 24 characters (25 characters for Payouts v1)
• It is not guaranteed that the bank will show this on the customer's statement
• Valid characters:
  • A-Z
  • a-z (these may appear as upper case in the statement)
  • 0-9
  • Hyphen -
  • Full stop .
  • Commas ,
  • Space

Narrative line2

line2 is used for additional context about the payment or merchant. eg Order number or Merchant phone number.

Supported format, structure and limits for line2:

• Free form
• There is a limit of 24 characters
• Valid characters:
  • A-Z
  • a-z (these may appear as upper case in the statement)
  • 0-9
  • Hyphen -
  • Full stop .
  • Commas ,
  • Space

Payment facilitator format

• pfId - Your payment facilitator ID received from Mastercard, Visa and Amex.

• isoId - Independent Sales Organization (ISO) ID provided by Mastercard. If an ISO is involved in the transaction, you must send this information.

• subMerchant - Your sub-merchant's details which includes: