Parameter definitions

Data Representation Notations

Notation	Description
a	alphabetic characters A-Z and a-z
n	numeric digits 0-9
s	spaces and special characters Note: See parameter description for character restrictions
an	alphabetic characters and numeric digits
ans	alphabetic characters, numeric digits, spaces and special characters
dx	hexadecimal

Message and sender information

Parameter	Description
MsgType Format:n 4 ISO: MTI	0100 - Authorization Request 0110 - Authorization Response 0400 - Authorization Reversal Request 0410 - Authorization Reversal Response 0800 - Network Management Request 0810 - Network Management Response 0120 - Authorization Advice 0130 - Authorization Advice Response
MsgSenderID Format: ISO:	typically "P" + Processor ID + Server No.
MsgSenderAP Format: ISO:	Senders password. Never store or log this value unless within proper data protection.
MsgUTC Format:n 10 ISO:7	Note! This parameter is obsolete and is no longer required. Transmission Date and Time expressed in (UTC) Coordinated Universal Time (GMT) format: MMDDhhmmss (hh values: 00-23)
MsgID Format:n 6 ISO:11	System Trace Audit Number (STAN), Request ID, generated by the sender. This parameter must not be all zeros.
MsgCode Format:n 3 ISO:70	Only used in 0800 messages 900 - Echo Test - Authorization system
MerchantGatewayID Format: MasterCard: n ..11 ISO: MasterCard: 48.37	Identifies the registered Merchant Payment Gateway used by the merchant and is provided by the acquirer when a registered MPG service provider is involved in a transaction. Mandatory for E-commerce transaction and transactions with Stored Credentials.
IsoID Format: Mastercard: n ..11, Visa: an 11 ISO: Mastercard: 48.37.2, Visa: 104.56.03	Mastercard:Contains the company id that will be assigned by Mastercard during the time of registration of a service provider as an Independent Sales Organization. Visa: Contains the Independent Sales Organization ID.
AmexAsAPaymentFacilitator Format:n 1 ISO:	Usage is dependent on authorization. Please contact your Rapyd implementation specialist for further information. Note: This parameter is only allowed when card scheme is Amex. If used with other card schemes (Visa, MasterCard, etc.), response code AX (Invalid parameter) will be returned.

Merchant information

Parameter	Description
MerchantXID Format:an 15 ISO:42	Card Acceptor Identification Code Merchant eXtended ID = Merchant ID (six digit agreement number) plus one of the following: "1" + Obsolete as of 6.0 release, please update at earliest convenience, "2" + sponsored merchant's ID (an 8), Payment Facilitators must use this option "3" + Terminal ID (an 8) ISO merchants should use this option
MerchantType Format:n 4 ISO:18	Also known as: Merchant Category Code (MCC) (as assigned to merchant by Rapyd)
TerminalID Format:n 8 ISO:41	Card Acceptor Terminal Identification (as assigned by Rapyd)
DeviceID Format:ans 8 ISO:	An ID of a physical POS device, unique per merchant.
TerminalType Format:n 2 ISO:	3 - unattended terminal 9 - mPOS device 10 - Off the shelf mobile device
TerminalCapability Format:n 1 ISO:	8 - contactless only
TerminalPinEntryCapability Format:n 1 ISO:	0 - Unknown 1 - PIN entry capability 2 - No PIN entry capability 3 - Software PIN entry capability 8 - PIN entry capability but PIN pad down
TerminalLocation Format:n 1 ISO:	1 - Off premises of card acceptor 2 - On premises of card acceptor
MerchantName Format: Visa: ans..25 MasterCard: ans..22 Amex: ans..38 ISO:43.1	Mandatory for sponsored merchants. As the acquirer Rapyd must ensure that a transaction conducted by a submerchant includes the names of both the payment facilitator and the submerchant in the MerchantName parameter. The payment facilitator name, in full or in abbreviated form must be three, seven or 12 characters in length filled with whitespaces if needed, followed by * and the submerchant name. Example: "CIPBilly shoes" If the payment facilitator name is CIP then the can be placed right after payment facilitator name, and the submerchant is Billy shoes. Example: "BASE Timmys toystore" If payment facilitator name is BASE three whitespaces must be placed right after the name and then the can be placed, and the submerchant is Timmys toystore. *Allowed characters: A-Z, a-z, 0-9 '().+,-**
MerchantCity Format:ans..13 ISO: Visa: 43.2 MasterCard: 43.2 Amex: 43.1	Mandatory for all Mastercard transactions. Optionally: merchant's phone number for Visa. For Mastercard use MerchantPhoneNumber *Allowed characters: A-Z, a-z, 0-9 '().+,-**
MerchantPostCode Format: MasterCard: ans ..10 Visa: ans ..08 Amex: ans ..10 ISO: MasterCard: 61.14 Visa: 59 Amex: 43.2	Mandatory for all Mastercard transactions if postal codes are available in the acquiring country. Is mandatory for merchants to send their postal code inn for Visa AFT transaction. Visa allows a postal code of length 8 characters and requires that the postal code contains no spaces. If a Visa transaction is longer than 8 characters only the first 8 will be used and empty spaces will be removed.
MerchantStreet Format: MasterCard: ans ..48 Visa: ans ..99 Amex: ans ..30 ISO: MasterCard: 122.01.01 Visa: 34.02.CO Amex: 43.1	Visa: Mandatory for merchants to send their street address for AFT transactions. Mastercard: Mandatory for all transactions. This is the street address of the acceptor, which should include the street number, street name, and other identifiers of the precise location, such as a building or unit number. For countries that do not use street names, the value "Unavailable" must be used. *Allowed characters: A-Z, a-z, 0-9 '().+,-**
MerchantStateOrProvince Format: MasterCard: ans ..3 Visa: ans ..6 ISO: MasterCard: 122.01.02 Visa: 59	Visa: Mandatory for merchants to send their state or province for Visa AFT transactions. Mastercard: For Mastercard this contains the ISO 3166-2 code identifying the state, province, or other country subdivision of the acceptor. Mastercard Example: Belgium-Antwerpen -> VAN List of all subdivison codes
MarketplaceID Format:an ..11 ISO: Visa: 104.56.83	Mandatory for Marketplaces to send their ID, provided by the acquirer upon registration.
MerchantCountryOfOrigin Format: n 3 ISO:	ISO numeric country code for the home country of the government that owns or controls the merchant that initiated the transaction. Applies to transactions using MCC's: 9211, 9222, 9311, 9399, 9402, 9405, 9406
MerchantUrlAddress Format: Mastercard: ans...255 ISO: Mastercard: 122.001.003	The Acceptor URL Address must be present for all electronic commerce transactions and contain a valid website address. Example: www.somemerchantwebsite.com
MerchantPhoneNumber Format: Mastercard: ans...16 ISO: Mastercard: 122.001.004	Contains the phone number of the merchant (card acceptor) that can be used for transaction inquiries. Acceptor Customer Service Phone Number must contain a valid value defined and formatted as per local telecom or the ITU Telecommunication Standardization Sector (ITU-T) standards. Examples: +1 202 555 0150 +442079460958 +354 123-4567 (202) 555-0150 Recommended for all Mastercard transactions.
AcceptorGeographicCoordinates Format: Mastercard: ns...20 ISO: Mastercard: 122.001.013	Contains the latitude and longitude of the acceptor´s location. Acceptor Geographic Coordinates can optionally be provided for all transactions and contain valid latitude and longitude values representing the acceptor location Example: 37.11000,-8.67880 Recommended for all Mastercard transactions.
ServiceLocationGeographicCoordinates Format: Mastercard: ns...20 ISO: Mastercard: 122.001.014	Contains the latitude and longitude of the where the cardholder received the service, if it is different from the acceptor´s location. The Service location geographic coordinates must be present for all transactions when different from the location identified in the Acceptor Geographic Coordinates. Example: 37.11000,-8.67880
SoftPosInformation Format:TLV ISO:	Contains information about the device and software used in SoftPos transactions. see list of supported tags here. Example: 0101102058.1.003081.0.0(2)04082.0.0(1)0519MyCompanySoftPOSApp
MerchantEmailAddress Format: ans 6..320 ISO: Amex: DF60.3	Contains the contact email of the merchant. If the address exceeds the length of a scheme format it will be substringed to fit. Mandatory for Amex. Optional for Visa and Mastercard.
MerchantAmexSEID Format: n 10 ISO: Amex: DF42	The 10-digit Amex SEID. Mandatory when AmexAsAPaymentFacilitator is enabled.
AmexSellerID Format: an ..20 ISO: Amex: DF60.2	If processing as AmexAsAPaymentFacilitator, Amex seller id (sub-merchant id) should be passed in using this parameter.
RampProviderID Format:an ..11 ISO: Visa: 104.56.86	Mandatory for Ramp Provider's to send their ID, provided by the acquirer upon registration.
ForeignRetailIndicator Format:n 1 ISO: Visa: 104.56.04	Indicates whether the retailer is located in a different country from the Ramp Provider or Marketplace. Valid values: 0 = Domestic retailer (same country) 1 = Foreign retailer (different country) Used in conjunction with RampProviderID and MarketplaceID to determine Visa field population.
MerchantTaxId Format: Mastercard: ans ..14 Visa: an ..20 ISO: Mastercard: 112.020 Visa: 104.63.05	Contains the merchant's VAT registration number or tax identification number. Mandatory for domestic transactions in France, Belgium, and Luxembourg where the merchant and cardholder are in the same country. Mastercard: In France this contains the SIRET number (14 characters). Note: The Payment Facilitator is responsible for verifying the country match condition before including this parameter.

Parameter	Description
CardType Format:a 1 ISO:	V = Visa, M = Mastercard, A = Amex
CardNumber Format:n 11..19 ISO:2	See PCI chapter on how to handle Card data.
CardSequenceNumber Format:n 3 ISO:23	Required in chip transaction Application PAN Sequence Number (tag 5F34).
CardExpDate Format:n 4 ISO:14	YYMM - required if the expiry date is known. This parameter is (formally speaking) optional in recurring transactions, but issuers are now allowed to (and more and more often) reject authorization requests without it. See PCI chapter on how to handle Card data.
CardVD Format: Visa: n3 MasterCard: n3 American Express: n4 ISO:	Visa = CVV2 (Field 126.10) Mastercard = CVC2 (DE 48.92) American Express = CID (Df 53) See PCI chapter on how to handle Card data.
CardVR Format:an..1 ISO:	Visa: Field 44.10 Mastercard: DE 48.87 Amex: Df 44 See possible CardVR responses here.
CAVD Format:ans 28, base64 ISO:	Cardholder Authentication Verification Data Required in 3D-secure and 3D-secure attempt transactions. Also, when using issuer approved exemptions. See 3-D Secure chapter. Visa: Field 126.9 (CAVV - Verified by Visa) Must be a 20-byte base64-encoded binary value. Example: ACIzRFVmd4iZAKq7zN3u/wAAAAA= For backward compatibility, the format of hex 40 is also supported for Visa. Example: 00223344556677889900AABBCCDDEEFF00000000 Mastercard: DE 48.43 (UCAF - SecureCode) Example: jE1Hja90rhaDCRECEKc0AEUAAAAA American Express: DF 61 (Safekey) Example: AAABBWcSNIdjeUZThmNHAAAAAAA=
CAVR Format:an 1 ISO:	Cardholder Authentication Verification Result Present in response if request included CAVD. Visa: Field 44.13 (CAVV ResultsCode) Mastercard: DE 48.71 Amex: DF 61 See possible response codes here
CRDAccountOwner Format:ans 2 ISO:56.81	Cardholder Related Data - Account Owner Type Has two possible values: 01 (Primary account owner) 02 (Secondary account owner) If CRDLastName is present and CRDAccountOwner not specified it will be default set to 01 Only applies for Visa
CRDLastName Format:ans..35 ISO: Visa: 56.85 Mastercard: 108.01.03 or 108.02.03	Cardholder Related Data - Last Name Visa: Account Owner Last Name - Identifies last name of account or entity Mastercard: Used with CRDNameValidationType for Name Validation Service.
CRDGivenName Format:ans..35 ISO: Visa: 56.83 Mastercard: 108.01.01 or 108.02.01	Cardholder Related Data - Given Name Visa: Account Owner Given Name - Identifies given name (first name) of account or entity Mastercard: Used with CRDNameValidationType for Name Validation Service.
CRDMiddleName Format: ans..35 ISO: Visa: 56.84 Mastercard: 108.01.02 or 108.02.02	Cardholder Related Data - Middle Name Visa: Account Owner Middle Name Mastercard: Used with CRDNameValidationType for Name Validation Service.
CRDNameValidationType Format:a 1 ISO:108.07	Mastercard Name Validation Service Type Requests name validation for the cardholder. Can only be used with zero-amount authorization requests (Account Status Inquiry). Valid values: R = Receiver/Recipient name validation S = Sender name validation When specified, at least one of CRDGivenName, CRDMiddleName, or CRDLastName must be provided. The validation result will be returned in CRDR. Only applies for Mastercard
CRDR Format:TLV ISO:	Cardholder Related Data Result Present in response if request included CRDNameValidationType. For Visa cardholder data verification, see possible response codes here Example:010200020201030201040201050201 For Mastercard name validation, returns validation code: A (Match), B (Partial Match), C (No Match), U (Unverified) Example: 0101A0201B
AVSPostalCode Format:ans..9 ISO:	Visa: Field 123, Mastercard: DE 120, Amex: Df 63
AVSStreetAddress Format: Visa: ans..40 Mastercard: ans..40 Amex: ans..20 ISO:	Visa: Field 123, Mastercard: DE 120, Amex: Df 63
AVSR Format:an 1 ISO:	Present in response if request included AVSStreetAddress and/or AVSPostalCode. Visa: Field 44.2 - Address Verification Result Mastercard: DE 48.83 - AVS Response Amex: Df 44 - Additional Response Data
Track2 Format:ans..37 ISO:35	Required in swipe, chip and contactless transactions. Excluding beginning and ending sentinels. If present in Mastercard advice messages (0120), it must be the same value as in the authorization request (0100). Allowed characters: 0-9 ^D= See PCI chapter on how to handle Card data.
ICCdata Format:dx..510 ISO:55	Required in chip transaction. Required in Dynamic Currency Conversion (DCC) transactions. TLV sets (sent as display hex), see list of supported tags here.
PinBlock Format:dx 16 ISO:52	Required in online PIN transactions. Encrypted PIN block hex format. Example: AB01CD23EF456789 If parameter "PinBlockKeyIndex" is passed in, this parameter becomes mandatory. See PCI chapter on how to handle Card data.
PinBlockKeyIndex Format:n 1..4 ISO:	Required in online PIN transactions. Partner key index as provided by Rapyd Range 1..9999 If parameter "PinBlock" is passed in, this parameter becomes mandatory.
SecondaryPinBlock Format:dx 16 ISO:152	For Pin change transactions originated in ATM's. See PCI chapter on how to handle Card data.
PinBlockKeySerial Format:dx 20 ISO:	Key serial number (KSN), supplied by pin pad. For use with base derived keys (BDK).
PanMapping Format:n 11..19 ISO:	Mastercard: DE 48.33 subfield 2 - Account Number. See PCI chapter on how to handle Card data.
PaymentAccountReference Format:an ..29 ISO: 56	Payment Account Reference (PAR) contains the assigned PAR value. A PAR is a unique value associated with a single PAN and attributed to all tokens associated with that PAN.
TokenData Format:ans 28, base64 ISO:	Token cryptogram for digital token transactions, a 20-byte base64-encoded binary value. TAVV for Visa, DSRP for Mastercard and Token Block A for Amex For Amex cryptograms use this parameter only for Token Block A. Use TransXID for Token Block B.
PhoneNumberVerification Format: Visa: ans ..16 Amex: ans ..16 ISO: Visa: 56.02.83 Amex: 47	For Visa: The phone number of the cardholder to match the phone number registered at the issuer of the card. PhoneNumberVerificationResult returns the outcome of the match. For Amex: ANI (Automatic Number Identification) specified 10-digit phone number that customer used to place order with Merchant. If longer phone number is sent in the last 10-digits will be used.
PhoneNumberType Format: Amex: ans 2 ISO: Amex: 47	The PhoneNumberType is the telephone company-provided ANI Information Identifier (II) digits associated with CUSTOMER ANI. PhoneNumberType (II digits) indicate call type. For example, cellular (61-63), payphone (27), toll free (24, 25), etc
EmailAddressVerification Format: Visa: ans ..99 Amex: ans ..60 ISO: Visa: 56.02.86 Amex: 60	The email address of the cardholder. For Visa: The email address of the cardholder to match the email address registered at the issuer of the card. EmailAddressVerificationResult returns the outcome of the match. For Amex: The customer email address send in when doing a Card Not Present transaction, can also be used to verify the email address of the customer.
PhoneNumberVerificationResult Format:n 1	Contains the result of phone number verification. 1 = Verified, 2 = Failed 3 = Not Performed Visa only.
EmailAddressVerificationResult Format:n 1	Contains the result of email address verification. 1 = Verified, 2 = Failed 3 = Not Performed Visa only.
BenefitProgramManagerID Format:an 2 ISO: 124.50	Contains the Benefit Program Manager ID. 01 = Edenred, 02 = Sodexo 11 = Monizze MasterCard only.
VoucherCode Format:ans 7..93 ISO: 124.50	Contains the Voucher codes. MasterCard only.
VoucherCodeFreeText Format:ans ..248 ISO: 124	Present in response if request included BenefitProgramManagerID and VoucherCode. Receive free-text and balance information from benefit card. MasterCard only.

Payment facilitator information

Parameter	Description
PaymentFacilitatorID Format: MasterCard: n ..11 Visa: an ..11 ISO: MasterCard: 48.37 Visa: 104.56	Mandatory for Payment Facilitators to send their ID, provided by the acquirer upon registration.
PaymentFacilitatorStreetAddress Format: Visa: ans ..99 ISO: 34.02.D1	Payment Facilitator street address needs to be provided to VISA when doing cross-border AFT's.
PaymentFacilitatorCityName Format: Visa: ans ..50 ISO: 34.02.D2	Payment Facilitator city name needs to be provided to VISA when doing cross-border AFT's.
PaymentFacilitatorStateProvinceCode Format: Visa: an ..3 ISO: 34.02.D3	Payment Facilitator state province code needs to be provided to VISA when doing cross-border AFT's.
PaymentFacilitatorPostalCode Format: Visa: ans ..10 ISO: 34.02.D4	Payment Facilitator postal code needs to be provided to VISA when doing cross-border AFT's.
PaymentFacilitatorCountryCode Format: Visa: a3 ISO: 34.02.D5	Payment Facilitator country code needs to be provided to VISA when doing cross-border AFT's.

Transaction and response information

Parameter	Description
TransType Format:an 2 ISO:	Transaction Type as defined by Rapyd - See Transaction types
TransAmount Format:n..12 ISO:4	With decimal point if necessary, e.g. 1234.56. Unnecessary decimal zeros will be removed from response. For PAN verification requests use 0 (zero), not 1 In reversals if partial amount was approved in authorization response, use the amount from the 0110 response when reversing. Examples: 0100 - TransAmount=1.00 -> 0110 TransAmount=1 0100 - TransAmount=1.50 -> 0110 TransAmount=1.5 0100 - TransAmount=10 -> 0110 TransAmount=5 -> 0400 TransAmount=5
TransCurrency Format:n 3 ISO:49	Numeric ISO code (e.g. 840 = US dollar)
TransFee Format:n.. 8 ISO:28	Required in ATM transactions if a service fee is being charged. For reversals the value needs to be the same as in the original authorization. Fee amount in the same currency as TransCurrency. With decimal point if necessary, e.g. 1234.56 The fee amount also must be included in the TransAmount.
TransID Format:n 12 ISO:37	0110 = transaction ID assigned by Rapyd (only in transactions with response codes from card issuers (or provided by Stand-In Processing - STIP)) 0120 = transaction ID from 0110 0400 = transaction ID from 0110
TransDate Format:n 4 ISO:13	Local date of the card acceptor location format: MMDD
TransTime Format:n 6 ISO:12	Local time of the card acceptor location format: hhmmss
TransXID Format:dx 40 ISO:	Visa: Field 126.8 - Transaction ID (XID). Used in Verified by Visa in conjunction with CAVV Format: display hex Amex: Datafield 61 - Token Data Block B
dsTransID Format:ans 36 ISO:	Directory server transaction id as defined by the EMV 3DS standard. Required in EMV 3DS transactions.
ThreeDSMessageVersion Format:ns 5..8 ISO:48.66.01	Message version defined by the EMV 3DS standard. Required in EMV 3DS transactions. Version information in Major.minor.patch format. Example: 99.99.99
TransStatus Format:an 1 ISO:	N = Normal request (final authorization) - default P = Preauthorized request D = Deferred authorization B - Balance Inquiry See Pre-Authorizations, Deferred authorization or ATM Balance Inquiry for details.
CashbackAmount Format:n..12 ISO:	With decimal point if necessary, e.g. 100.5 CashbackAmount must be less than Amount (and the same currency is implied).
AuthCode Format:an 6 ISO:38	Only in authorized transactions. Authorization Code, assigned by Issuer or Stand-In Processing (STIP)
TransLCID Format: Visa: n 15 Mastercard: an 13 Amex: n 15 ISO:	Identifier assigned by card schemes that links original authorization requests to subsequent transactions, reversals and advices. Visa: Field 62.2 (TID - Transaction Identifier). Format:: n 15 Mastercard: DE63 (pos.1-9) + DE15 (Settlement Date, sent by Mastercard in the 0110 response). Format:: an 13 (alpha characters are case-sensitive) Amex: Df 31 (Acquirer Reference Data)
TransitIndicator Format: Visa: n/a Mastercard: n 4 ISO:	Mastercard: DE 48.64, see details about Transit Program. Visa: n/a
PartialAuthSupported Format:n 1 ISO:	Partial authorization supported = 1 Partial authorization not supported = 0 Default value is 0 (partial authorization not supported) Indicates if the merchant terminal supports partial approvals. See details about Partial Authorizations
StoredCredential Format:n 1 ISO:	1 = StoredCredential See details about Stored Credentials
Initiator Format:a 1 ISO:	Required in Merchant Initiated and Stored Credential transactions. M = Merchant C = Cardholder See details about Stored Credentials
InitiationReason Format:an 3 ISO:	Required in Merchant Initiated and Stored Credential transactions. REC = Recurring INS = Installment CRE = CredentialOnFile INC = Incremental RES = Resubmission DEL = Delayed charges REA = Reauthorization NOS = No show See details about Stored Credentials and Merchant Initiated Transactions
ScaExemption Format:an 3 ISO:	LOW = Low Value Transaction TRA = Transaction Risk Analysis OUT = Authentication Outage SCP = Secure Corporate Payments AUT = Automatic See details about Exemptions
OriginalTransAmount Format:n..12 ISO:4	Required in Dynamic Currency Conversion (DCC) transactions. With decimal point if necessary, e.g. 1234.56.
OriginalTransCurrency Format:n 3 ISO:	Required in Dynamic Currency Conversion (DCC) transactions. Numeric ISO code (e.g. 840 = US dollar)
ReplacementAmount Format:n..12 ISO:4	Required in Partial Reversals. With decimal point if necessary, e.g. 1234.56.
Refund Format:n 1 ISO:	1 = Refund See details about Online Refund
SingleTapSupported Format:n 1 ISO:	0 = Not supported 1 = Supported Default value is 0 (single tap not supported)
SingleTapFollowUp Format:n 1 ISO:	0 = Not a follow up 1 = Follow up Default value is 0 (Not a follow-up)
BalanceAmount Format:n..13 ISO:54	With decimal point if necessary, e.g. 1234.56. Can contain a negative amount, e.g. -100
BalanceCurrency Format:n 3 ISO:54	The currency of the returned balance amount. Numeric ISO code (e.g. 840 = US dollar)
AuthorizationIdentifier Format: Guid ISO:	A unique identifier of an authorization, generated by the authorization host.
Eci Format: n 2 ISO: Visa 60.8 MasterCard 48.42.01	Electronic Commerce Indicator. See Electronic Commerce Indicator
SpecialConditionIndicator Format: n 1 ISO: Visa 60.4	1 = Central Bank Digital Currency (CBDC) or Tokenized Deposit 2 = Stablecoin (fiat-backed) 3 = Blockchain native token/coin 7 = Purchase of Cryptocurrency (For AFTs this also includes sale or conversion of crypto currency to fiat currency) 8 = Quasi-Cash
OriginalCredit Format: n 1 ISO:	0 = Not an Original Credit Transaction 1 = Original Credit Transaction Default value is 0 (Not an OCT)
TransactionLinkID Format: ans 22 ISO: MasterCard 105.001	Allowed characters: a-z, A-Z, - (hyphen) and _ (underscore) Example: aRyU-3Ti981f_6WvBaqM03 Only applies to Mastercard transactions. See further explanation here
GoodsSoldProductCode Format: an 4 ISO: Amex: 47	Goods product indicator code. Valid codes include: 1000 = Gift Card

Shipping information

Parameter	Description
ShippingPostalCode Format:ans..9 ISO: Amex: 63	Postal code for the shipping address where goods will be delivered. Required for certain transaction types where physical goods are shipped.
ShippingStreetAddress Format:ans..50 ISO: Amex: 63	Street address for shipping delivery location. Should include street number, street name, and other identifiers of the precise location such as building or unit number. *Allowed characters: A-Z, a-z, 0-9 '().+,-**
ShippingGivenName Format:ans..15 ISO: Amex: 63	Given name (first name) of the person receiving the shipment at the delivery address.
ShippingLastName Format:ans..30 ISO: Amex: 63	Last name (surname) of the person receiving the shipment at the delivery address.
ShippingPhoneNumber Format:ans..16 ISO: Amex: 63	Phone number for the shipping contact person. Should be formatted according to local telecom or ITU-T standards. Examples: +1 202 555 0150 +442079460958 +354 123-4567 (202) 555-0150
ShippingCountryCode Format:n3 ISO: Amex: 63	ISO 3166-1 numeric 3 digit country code for the shipping destination country. Examples: 840, 826, 352

Internet information

Parameter	Description
ShippingMethod Format: Amex: n 2 ISO: Amex: 47	The shipping method used to shipp the product Code for ShippingMethod: 01 = Same Day 02 = Overnight / Next Day 03 = Priority, 2-3 days 04 = Ground, 4 or more days 05 = Electronic Delivery 06 = Ship-to Store* 07-ZZ = Reserved for future use
MerchantProductSku Format: Amex: ans ..15 ISO: Amex: 47	Unique SKU (Stock Keeping Unit) inventory reference number of product associated with this authorization request. For multiple items, enter SKU for single, most expensive item.
CustomerHostName Format: Amex: ans ..60 ISO: Amex: 47	Name of server to which customer is connected.
HttpBrowserType Format: Amex: ans ..60 ISO: Amex: 47	Customer's HTTP browser type.
CustomerIp Format: Amex: ans 8-15 ISO: Amex: 47	Customer's Internet IP address.

Airline information

Parameter	Description
DepartureDate Format:n 8 ISO: Amex: 47	Departure Date in format CCYYMMDD (Century, Year, Month, Day). Example: 20030101
PassengerName Format:ans 23..40 ISO: Amex: 47	Passenger Name in format: SURNAME FIRSTNAME MIDDLEINITIAL TITLE Variable data must be a minimum length of 23 and a maximum length of 40. Example: FROST JANE M MRS
OriginAirport Format:ans ..5 ISO: Amex: 47	First segment travel origination Airport. Five-character length allows for anticipated expansion of present, three-character Airport Code. Example: ABC
Destination Format:ans ..5 ISO: Amex: 47	Destination Airport for first travel segment of trip; not necessarily the final destination. For example, if passenger flies from STL to MIA with layover at JFK, Destination Airport for first segment is JFK. Five-character length allows for anticipated expansion of present, three-character Airport Code. Example: XYZ
RoutingCities Format:ans 11..59 ISO: Amex: 47	Routing Airport or City Codes for each leg on ticket (including ORIGIN and DEST) in segments of length 5 with virgule (/) separator and space filled if needed. Example: ABC /DEF /GHI /JKL /MNO /PQR /STU /VMX /YZA
AirlineCarriers Format:ans 5..53 ISO: Amex: 47	Airline Carrier Code for each leg on ticket (including ORIGIN and DEST) in segments of length 5 with virgule (/) separator. Example: AB /XY /BC /CD /DE
NumberOfPassengers Format:n 3 ISO: Amex: 47	Number of passengers in party. Example: 001
FareBasisCode Format:ans..24 ISO: Amex: 47	Primary & secondary discount codes indicate class of service and fare level associated with ticket. Example: ABC123DEF456GHI789JKL012

General

Parameter	Description
AdditionalData Format:[A-Za-z0-9\s\*\.\=\_]	See Additional Data Details
ResponseCode Format:an 2 ISO:39	See response codes
ResponseSource Format:an 1 ISO:	A = Acquirer (Rapyd) I = Issuer (cardholder's issuing bank) S = Stand-In Processing (Visa or Mastercard center)
MerchantAdviceCode Format:an 2	See merchant advice codes
AuthorizationExpiryDate Format: ans 10	Returns the expiration date for the authorization. An authorization must be captured before it's expiration date. It will be returned in the date format "yyyy-MM-dd". This is only returned for approved authorizations.
ResponseCodeDescription Format:ans	An explanatory text of the response code For example, if ResponseCode is 00, "Approval and completed successfully" will be returned in ResponseCodeDescription

Additional Data Details

The parameter was added to increase flexibility in the ever-changing payment landscape. It is a TLV (Tag-Length-Value) parameter.

Tag is defined as alphanumerical, two characters long

Length three numerical characters, i.e. possible values 001-999

Value is defined as alphanumerical with a few additional special characters: space | * | . | , | - | _ | ' | + | = | \ | : | / |
Regex: [A-Za-zÀ-ȕ0-9\s\*\.\,-_\'\+\=\\:\/]{0,999}

Attention

Be aware that this parameter is open to changes (tags added or changed), so do not implement with additional data expecting a fixed set of tags and subelements."

The following TLV set has been specified and implemented:

Tag	Length	Value	Example	Applies to
01	004	The last four digits of the original PAN (for tokenized transactions) Format: n 4	010041234	Response
02	002	Electronic Commerce Indicator Format: n 2	0200205 or 0200207	Request
03	030	OBSOLETE
04	010	Merchant Verification Value Format: n 10 Only applies to VISA transactions, field: 62.20		Request
05	003	Wallet Identifier Format: an 3 Only applies to MasterCard transactions. 101 = Masterpass 103 = Apple Pay 216 = Google Pay 217 = Samsung Pay 327 = Merchant tokenization program See details about Token Transactions		Request
06	Varible, max 12	EstimatedAmount Format: n..12, with decimal point if necessary, e.g. 100.25 The estimated amount should be in the same currency as the parameter TransCurrency Only applies to MasterCard token transactions. See details about Token Transactions	06006100.25	Request
07	Variable, max 150	RemoteCommerceAcceptorIdentifier Format: base64 encoded, max 150 Only applies to MasterCard transactions.	07016dmFsaXRvci5pcw==	Request
08	Variable, max 99	BinData Format: an.. 99 Use TLV format: Tag is defined as alphanumerical, two characters long Length two numerical characters, i.e. possible values 01-99 Value is defined as alphanumerical (currently limited to 0-9, A-Z, a-z and spaces) Defined tags are: 01 = Product description 02 = Issuing country 03 = Billing currency 04 = Card usage 05 = Card category 06 = Card level	080850147Debit Mastercard Standard Prepaid General spend0202US0303USD0405Debit0508Consumer	Request
09	Variable, max 50	External Reference Data Format: ans...50	09013tr_UZwDMUwArX	Request
10	Variable, max 999	MasterCard MoneySend Format: ans...999 Use TLV format: Tag is defined as alphanumerical, two characters long Length two numerical characters, i.e. possible values 01-99 Value is defined as alphanumerical special. See in MasterCard MoneySend a more detailed breakdown on the values and format of the fields	100970105601003Jon03007Jonsson070033521101653514400000000001800203030310101905555558012153054010500208	Request
11	003	TTI (Transaction Type Identifier) Format: an 3	11003C55	Request
12	Variable, max 500	Visa Direct AFT Format: ans...500 Use TLV format: Tag is defined as alphanumerical, two characters long Length two numerical characters, i.e. possible values 01-99 Value is defined as alphanumerical special. See in Visa Direct a more detailed breakdown on the values and format of the fields	121230110902016411111111111111103011Jon Jonsson04013Laugarvegur 105009Reykjavik07003ISK0A019Gunna Gunnarsdottir021301002FD02001103006ISACCT	Request
13	Variable, max 125	Visa Direct Account Owner Data Format: ans...125 Use TLV format: Tag is defined as alphanumerical, two characters long Length two numerical characters, i.e. possible values 01-99 Value is defined as alphanumerical special. See in Visa Direct a more detailed breakdown on the values and format of the fields	8B009Reykjavik8E003ISL86013Laugarvegur 18A0031058D003STY	Request
14	Variable, max 46	Visa Direct Account Identifier Format: ans...46 Use TLV format: Tag is defined as alphanumerical, two characters long Length two numerical characters, i.e. possible values 01-99 Value is defined as alphanumerical special. See in Visa Direct a more detailed breakdown on the values and format of the fields	[email protected]	Request

Bin information

Notice

The new bin fields are informational only. Failure to locate bin information will not affect the authorization. Partners must take that into consideration in their implementation and be prepared to receive authorizations without the bin information parameters.

Parameter	Description
ProductId Format: a..3	The product id assigned to the bin series that the card belongs to. Provided by the issuer of the card. Visa and Mastercard only.
ProductIdDescription Format: ans..256	Text description of the product. Visa and Mastercard only.
IssuerIdentifier Format: n..11	ICA (MC) or CIB (Visa) of the Issuer. Visa and Mastercard only.
IssuingCountry Format: a3	Alpha Country Code of the Issuer.
IssuerRegion Format: n1	1 = United States A = Canada B = Latin America and the Caribbean C = Asia/Pacific D = Europe E = South Asia/Middle East/Africa Visa and Mastercard only.
CardholderBillingCurrency Format: a3	Alpha Currency Code of the cardholder currency. Available for Visa and Mastercard.
CardUsage Format: a1	C = Credit D = Debit P = Prepaid H = Charge R = Deferred Debit Visa and Mastercard only.
CardCategory Format: n1	1 = Consumer 2 = Commercial 3 = All 4 = Other Amex and Mastercard only.
FundsDisbursementEnabled Format: a1	Y = Enabled, Domestic and Cross Border D = Enabled Domestic only N = Not enabled U = Unknown Visa and Mastercard only.
FundsDisbursementOnlineGamblingEnabled Format: a1	N = Issuer not qualified for Gaming Participation Y = Issuer Gaming Participation Visa and Mastercard only.
FasterFunds Format: a1	N = Faster Funds is not supported D = Faster Funds is supported for Domestic but not Cross Border Y = Faster Funds is supported for Domestic and Cross Border C = Cross-Border Visa and Mastercard only.
MoneyTransfer Format: a1	N = Money transfer is not supported Y = Money transfer is supported Visa only.
AccountRangeLow Format: n20	Lower bound of the account number range that the card is a part of, right padded with zeros.
AccountRangeHigh Format: n20	Higher bound of the account number range that the card is a part of, right padded with zeros.

Parameter usages matrix

Codes: M=Mandatory, C=Conditional, O=Optional, E=Echo (copy from previous message)