Normalized request and response fields

Request Fields

Adyen

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
merchant_metadata		transacting_account_id	A unique identifier for each merchant account within a gateway.	merchant_account	A string.
order_data		gateway_idempotency_key	A unique identifier for idempotent transactions to help prevent duplicate transactions.	idempotency_key	A string with a max length of 64 characters.
order_data		network_transaction_id_override	The Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.	network_transaction_id	Gateway does not specify.
order_data		shipping_amount	The cost associated with shipping a product or order to a customer. *L2/L3 data field	freight_amount	A string with a max length of 12 characters.
order_data		tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	total_tax_amount	A string with a max length of 12 characters. Must not be all zeros.
order_data		shipping_from_zip	The postal or zip code from which a shipment or order is originating. *L2/L3 data field	ship_from_postal_code	A string with a max length of 10 characters. Must not start with a space or be all spaces/zeros.
order_data	line_items	product_code	A unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data field	product_code	A string with a max length of 12 characters. Must not start with a space or be all spaces/zeros.
order_data	line_items	description	A description of the item or product sold. *L2/L3 data field	description	A string with a max length of 26 characters. Must not start with a space or be all spaces/zeros.
order_data	line_items	quantity	The value that represents the number of units purchased or sold in a transaction. *L2/L3 data field	quantity	A string with a max length of 12 characters. Must not start with a space or be all spaces.
order_data	line_items	unit_cost	The cost associated with a single unit of a product or service. *L2/L3 data field	unit_price	A string with a max length of 12 characters. Must not be all zeros.
order_data	line_items	discount_amount	The reduction or discount price applied to a product or order. *L2/L3 data field	discount_amount	A string with a max length of 12 characters.
order_data	line_items	total_amount	The total amount of the line item.	total_amount	A string with a max length of 12 characters. Must not start with a space or be all spaces/zeros.
order_data		installment_count		installments	A string.
order_data		metadata		metadata	Gateway does not specify.
risk_data		user_agent	A string of data trasmitted that identifies the type of web browser and other relevant details	user_agent	A string.

Airwallex

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
order_data	line_items	reference	A unique identifier assocaited with a transaction, invoice or order. *L2/L3 data field	merchant_order_id	Gateway does not specify.

Authorize.net

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
customer_data		merchant_customer_id	The merchant's internal reference for the customer.	customer_id	A string of up to 20 characters in length.
order_data		invoice_id	A unique identifier assigned to an invoice, typically used by merchants for referencing transactions.	po_number	Integer with a max of 25 characters in length.
order_data		shipping_amount	The cost associated with shipping a product or order to a customer. *L2/L3 data field	amount	A positive integer with a max of 15 characters for transactions of type CREDIT.
order_data		tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	amount	A positive integer with a max of 15 characters for transactions of type CREDIT.
order_data		shipping_from_zip	The postal or zip code from which a shipment or order is originating. *L2/L3 data field	zip	Integer with a max length of 20 characters. Can be 5 or 9 digits long.
order_data	line_items	product_code	A unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data field	product_code	Gateway does not specify.
order_data	line_items	description	A description of the item or product sold. *L2/L3 data field	description	A string of up to 255 characters in length.
order_data	line_items	quantity	The value that represents the number of units purchased or sold in a transaction. *L2/L3 data field	quantity	Up to 4 digits max length with up to two decimal places.
order_data	line_items	unit_cost	The cost associated with a single unit of a product or service. *L2/L3 data field	unit_price	4 digit maximum in length with a decimal point (no dollar symbol).
order_data	line_items	item_name	Item name	name	A string with a maximum of 31 characters in length.
order_data	line_items	total_amount	The total amount of the line item.	total_amount	4 digit maximum in length after the decimal point (no dollar symbol).
risk_data		ignore_avs	True/false indicator to inform the gateway to bypass the AVS check	skip_avs	Boolean

Braintree

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
merchant_metadata	statement_descriptor	description	A description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.	descriptor_name	Less than or equal to 15 characters and can only contain letters and numbers.
merchant_metadata	statement_descriptor	phone_number	The phone number that appears on the customer's credit card statement.	descriptor_phone	Must be 10 - 14 characters and can only contain numbers, dashes, parentheses and periods.
merchant_metadata	statement_descriptor	url	The url that appears on the customer's credit card statement.	descriptor_url	Must be less than or equal to 13 characters.
merchant_metadata		transacting_account_id	A unique identifier for each merchant account within a gateway.	merchant_account_id	Gateway does not specify.
order_data		network_transaction_id_override	The Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.	previous_network_transaction_id	String.
order_data		invoice_id	A unique identifier assigned to an invoice, typically used by merchants for referencing transactions.	purchase_order_number	A string of up to 12 ASCII characters for AIB and 17 ASCII characters for all other processors.
order_data		shipping_amount	The cost associated with shipping a product or order to a customer. *L2/L3 data field	shipping_amount	A positive integer greater than 0, with a maximum of 9 digits.
order_data		discount_amount	The reduction or discount price applied to a product or order. *L2/L3 data field	discount_amount	A positive integer greater than 0, with a maximum of 9 digits.
order_data		tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	tax_amount	A positive integer greater than 0, with a maximum of 9 digits. Tax amount must be formatted like '10' or '10.00'. If the currency does not use decimal places, the tax amount can't include decimal places.
order_data		shipping_from_zip	The postal or zip code from which a shipment or order is originating. *L2/L3 data field	ships_from_postal_code	May contain no more than 9 letter or number characters.
order_data	line_items	product_code	A unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data field	product_code	A maximum of 127 characters.
order_data	line_items	description	A description of the item or product sold. *L2/L3 data field	description	A maximum 127 characters.
order_data	line_items	quantity	The value that represents the number of units purchased or sold in a transaction. *L2/L3 data field	quantity	The value must be a whole number and can’t be negative or zero.
order_data	line_items	unit_cost	The cost associated with a single unit of a product or service. *L2/L3 data field	unit_amount	Up to 2 decimal places. The value can’t be negative or zero.
order_data	line_items	tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	unit_tax_amount	Up to 2 decimal places. This value can’t be negative or zero.
order_data	line_items	sale_kind	Indicates whether the line item is a debit (sale) or credit (refund) to the customer. Accepted values: debit or credit	kind	Accepted values: `debit`, `credit`
order_data	line_items	item_name	Item name	name	A maximum of 127 characters.
order_data	line_items	total_amount	The total amount of the line item.	total_amount	Can include up to 2 decimal places.
order_data		zero_dollar_auth		allow_card_verification	Gateway does not specify.
order_data		metadata		custom_fields	Can be formatted as a string or integer with a max of 255 characters.
risk_data		ignore_cvv	True/false indicator to inform the gateway to bypass the CVV requirement	skip_cvv	Boolean
risk_data		ignore_fraud_rules	True/false indicator to inform the gateway to bypass certain fraud detection rules during a transaction	skip_advanced_fraud_checking	Boolean

Checkout.com

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
order_data		gateway_idempotency_key	A unique identifier for idempotent transactions to help prevent duplicate transactions.	idempotency_key	A string of up to 255 characters in length.
order_data		metadata		metadata	Values up to 500 characters in length.

CommerceHub

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
merchant_metadata	statement_descriptor	description	A description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.	service_entitlement	Gateway does not specify.
merchant_metadata	statement_descriptor	phone_number	The phone number that appears on the customer's credit card statement.	customer_service_number	Gateway does not specify.
order_data		network_transaction_id_override	The Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.	scheme_reference_transaction_id	Gateway does not specify.

Cybersource

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
customer_data		merchant_customer_id	The merchant's internal reference for the customer.	customer_id	A string of up to 26 characters in length.
merchant_metadata	statement_descriptor	description	A description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.	merchant_descriptor	A string of up to 23 characters in length.
order_data		invoice_id	A unique identifier assigned to an invoice, typically used by merchants for referencing transactions.	invoice_number	A string of up to 23 characters in length. Visa platform connect has a max of 15 characters.
order_data	line_items	product_code	A unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data field	sku	A string. Length is not specified.
order_data	line_items	description	A description of the item or product sold. *L2/L3 data field	description	A string of up to 32 characters in length.
order_data	line_items	quantity	The value that represents the number of units purchased or sold in a transaction. *L2/L3 data field	quantity	An integer with a max of 10 characters in length.
order_data	line_items	unit_cost	The cost associated with a single unit of a product or service. *L2/L3 data field	declared_value	Gateway does not specify.
order_data	line_items	tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	tax_amount	A string with a max length of 9 characters.
order_data		installment_count		installment_total_count	An integer with a max length of 2.
risk_data		ignore_avs	True/false indicator to inform the gateway to bypass the AVS check	ignore_avs	A string with a max length of 5 characters.
risk_data		ignore_cvv	True/false indicator to inform the gateway to bypass the CVV requirement	ignore_cvv	Boolean

Cybersource REST

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
customer_data		merchant_customer_id	The merchant's internal reference for the customer.	customer_id	Gateway does not specify.
order_data		invoice_id	A unique identifier assigned to an invoice, typically used by merchants for referencing transactions.	invoiceDetails ; purchaseOrderNumber	Gateway does not specify.
order_data		shipping_from_zip	The postal or zip code from which a shipment or order is originating. *L2/L3 data field	ships_from_postal_code	Gateway does not specify
order_data	line_items	product_code	A unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data field	productCode	A string with a max of 255 characters.
order_data	line_items	quantity	The value that represents the number of units purchased or sold in a transaction. *L2/L3 data field	quantity	A nonnegative integer with a max of 10 characters.
order_data	line_items	unit_cost	The cost associated with a single unit of a product or service. *L2/L3 data field	unitPrice	Gateway does not specify.
order_data	line_items	tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	taxAmount	A decimal with a max of 15 digits.
order_data	line_items	discount_amount	The reduction or discount price applied to a product or order. *L2/L3 data field	discount_amount	A decimal. Master card should have a max length of 10 digits. Visa should have a max length of 13 digits.
order_data	line_items	sale_kind	Indicates whether the line item is a debit (sale) or credit (refund) to the customer. Accepted values: debit or credit	kind	Gateway does not specify.
order_data	line_items	item_name	Item name	productName	A string with a max of 255 characters.
risk_data		ignore_avs	True/false indicator to inform the gateway to bypass the AVS check	ignore_avs	A string with a max of 3 characters.
risk_data		ignore_cvv	True/false indicator to inform the gateway to bypass the CVV requirement	ignore_cvv	Gateway does not specify.

Decidir

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
customer_data		merchant_customer_id	The merchant's internal reference for the customer.	customer_id	Gateway does not specify.
merchant_metadata	statement_descriptor	phone_number	The phone number that appears on the customer's credit card statement.	merchant_phone	Gateway does not specify.
merchant_metadata		transacting_account_id	A unique identifier for each merchant account within a gateway.	merchant_id	Gateway does not specify.
order_data		installment_count		installments	Gateway does not specify.

dLocal

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation	gateway_type
customer_data		merchant_customer_id	The merchant's internal reference for the customer.	user_reference	A string. Data length not specified.	d_local
customer_data		customer_tax_number	The merchant's internal reference for the customer's tax number.	document	A string. Data length not specified.	d_local
merchant_metadata	statement_descriptor	description	A description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.	dynamic_descriptor	A string. Data length not specified.	d_local
order_data		gateway_idempotency_key	A unique identifier for idempotent transactions to help prevent duplicate transactions.	idempotency_key	A string. Data length not specified.	d_local
order_data		invoice_id	A unique identifier assigned to an invoice, typically used by merchants for referencing transactions.	original_order_id	A string. Data length not specified.	d_local
order_data		installment_count		installments	Gateway does not specify.	d_local

Ebanx

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
customer_data		customer_tax_number	The merchant's internal reference for the customer's tax number.	document	Gateway does not specify.
merchant_metadata	statement_descriptor	description	A description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.	soft_descriptor	Gateway does not specify.
order_data		installment_count		instalments	Gateway does not specify.

NMI

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
customer_data		merchant_customer_id	The merchant's internal reference for the customer.	customer_id	A string with no length specified.
merchant_metadata	statement_descriptor	description	A description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.	descriptor	A string with no length specified.
merchant_metadata	statement_descriptor	phone_number	The phone number that appears on the customer's credit card statement.	descriptor_phone	A string with no length specified.
merchant_metadata	statement_descriptor	url	The url that appears on the customer's credit card statement.	descriptor_url	A string with no length specified.
order_data		network_transaction_id_override	The Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.	network_transaction_id	A string. Gateway does not specify max characters in length.
order_data		invoice_id	A unique identifier assigned to an invoice, typically used by merchants for referencing transactions.	ponumber	A string with no length specified.
order_data		shipping_amount	The cost associated with shipping a product or order to a customer. *L2/L3 data field	shipping	Gateway does not specify.
order_data		tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	tax	Gateway does not specify.

Nuvei

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
customer_data		merchant_customer_id	The merchant's internal reference for the customer.	userTokenId	Gateway does not specify.

Orbital

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
merchant_metadata	statement_descriptor	description	A description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.	product_description	A string with a max length of 18 characters.
merchant_metadata	statement_descriptor	phone_number	The phone number that appears on the customer's credit card statement.	merchant_phone	A string with a max length of 12 characters.
merchant_metadata	statement_descriptor	url	The url that appears on the customer's credit card statement.	merchant_url	A string with a max of 13 characters.
order_data		invoice_id	A unique identifier assigned to an invoice, typically used by merchants for referencing transactions.	purchase_order	Gateway does not specify.
order_data		shipping_amount	The cost associated with shipping a product or order to a customer. *L2/L3 data field	freight_amount	A max of 12 characters in length.
order_data		tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	total_tax_amount	A max of 12 characters in length.
order_data		shipping_from_zip	The postal or zip code from which a shipment or order is originating. *L2/L3 data field	zip; ship_from_zip	A string with a max length of 10 characters. It can not be all zeros or nines.
order_data	line_items	product_code	A unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data field	prod_cd	A string with a max of 12 characters of length. It can not be all zeros.
order_data	line_items	quantity	The value that represents the number of units purchased or sold in a transaction. *L2/L3 data field	qty	A string with a max of 13 characters in length. It can not be all zeros. Implied decimal of 4.
order_data	line_items	unit_cost	The cost associated with a single unit of a product or service. *L2/L3 data field	unit_cost	A decimal with a max of 13 characters in length. Implied decimal of 4
order_data	line_items	tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	tax_amt	An integer with a max of 12 characters in length.
order_data	line_items	discount_amount	The reduction or discount price applied to a product or order. *L2/L3 data field	disc	A decimal with a max of 12 characters in length. Implied decimal.
order_data	line_items	item_name	Item name	desc	A string with a max of 18 characters in length.
order_data	line_items	total_amount	The total amount of the line item.	line_tot	Gateway does not specify.

PayPal Commerce Platform (PPCP)

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
customer_data		merchant_customer_id	The merchant's internal reference for the customer.	custom_id	A string of up to 255 characters in length.
merchant_metadata	statement_descriptor	description	A description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.	soft_descriptor	A string between 1 and 22 characters that supports alphanumeric characters, dashes, asterisks, periods (.) and spaces.
order_data		invoice_id	A unique identifier assigned to an invoice, typically used by merchants for referencing transactions.	invoice_id	A string of up to 127 characters in length.
order_data		shipping_amount	The cost associated with shipping a product or order to a customer. *L2/L3 data field	shipping	Gateway does not specify.
order_data		tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	tax_total	The value can not be negative, and in most cases, it must be greater than zero.
order_data	line_items	product_code	A unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data field	sku	A string of up to 127 characters in length.
order_data	line_items	quantity	The value that represents the number of units purchased or sold in a transaction. *L2/L3 data field	quantity	A string of up to 10 characters in length. Must be a whole number.
order_data	line_items	unit_cost	The cost associated with a single unit of a product or service. *L2/L3 data field	unit_amount	Can not be a negative number.
order_data	line_items	discount_amount	The reduction or discount price applied to a product or order. *L2/L3 data field	discount	Cannot be a negative number.
order_data	line_items	item_name	Item name	name	A string in between 2 and 300 characters.
order_data	line_items	total_amount	The total amount of the line item.	item_total	Can not be a negative number.

Stripe

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
customer_data		merchant_customer_id	The merchant's internal reference for the customer.	customer_reference	A string.
merchant_metadata	statement_descriptor	description	A description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.	statement_description	A string.
merchant_metadata	statement_descriptor	suffix	An additional identifier or code appended to the description of the customer's credit card statement, typically used to differentiate between types of transactions.	statement_descriptor_suffix	A string.
order_data		gateway_idempotency_key	A unique identifier for idempotent transactions to help prevent duplicate transactions.	idempotency_key	A nullable string.
order_data		invoice_id	A unique identifier assigned to an invoice, typically used by merchants for referencing transactions.	merchant_reference	Gateway does not specify.
order_data		shipping_amount	The cost associated with shipping a product or order to a customer. *L2/L3 data field	shipping_amount	A non-negative integer in cents.
order_data		shipping_from_zip	The postal or zip code from which a shipment or order is originating. *L2/L3 data field	shipping_from_zip	A string.
order_data	line_items	product_code	A unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data field	product_code	A nullable string.
order_data	line_items	description	A description of the item or product sold. *L2/L3 data field	product_description	Gateway does not specify.
order_data	line_items	quantity	The value that represents the number of units purchased or sold in a transaction. *L2/L3 data field	quantity	An integer.
order_data	line_items	unit_cost	The cost associated with a single unit of a product or service. *L2/L3 data field	unit_cost	A nullable integer.
order_data	line_items	tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	tax_amount	An integer.
order_data	line_items	discount_amount	The reduction or discount price applied to a product or order. *L2/L3 data field	discount_amount	An integer.
order_data		metadata		metadata	Can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Keys and values are stored as strings and can contain any characters except square brackets ([ and ]) in keys.
risk_data		ignore_fraud_rules	True/false indicator to inform the gateway to bypass certain fraud detection rules during a transaction	skip_radar_rules	Gateway does not specify.

Stripe Payment Intents

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
customer_data		merchant_customer_id	The merchant's internal reference for the customer.	customer_reference	An alphanumeric string of up to 17 characters in length.
merchant_metadata	statement_descriptor	description	A description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.	statement_descriptor	Must contain at least one letter and be 1–22 characters long.
merchant_metadata	statement_descriptor	suffix	An additional identifier or code appended to the description of the customer's credit card statement, typically used to differentiate between types of transactions.	statement_descriptor_suffix	A maximum 22 characters.
merchant_metadata		transacting_account_id	A unique identifier for each merchant account within a gateway.	stripe_account	Gateway does not specify.
order_data		gateway_idempotency_key	A unique identifier for idempotent transactions to help prevent duplicate transactions.	idempotency_key	Gateway does not specify.
order_data		network_transaction_id_override	The Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.	network_transaction_id	Gateway does not specify.
order_data		invoice_id	A unique identifier assigned to an invoice, typically used by merchants for referencing transactions.	merchant_reference	An alphanumeric string of up to 25 characters in length.
order_data		shipping_amount	The cost associated with shipping a product or order to a customer. *L2/L3 data field	shipping_amount	In cents, as a non-negative integer.
order_data		tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	total_tax_amount	An integer in the amount of cents.
order_data		shipping_from_zip	The postal or zip code from which a shipment or order is originating. *L2/L3 data field	shipping_from_zip	Gateway does not specify.
order_data	line_items	product_code	A unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data field	product_code	A maximum of 12 characters.
order_data	line_items	description	A description of the item or product sold. *L2/L3 data field	product_description	An alphanumeric string of up to 26 characters in length.
order_data	line_items	quantity	The value that represents the number of units purchased or sold in a transaction. *L2/L3 data field	quantity	A positive integer greater than 0.
order_data	line_items	unit_cost	The cost associated with a single unit of a product or service. *L2/L3 data field	unit_cost	In cents, as a positive integer greater than 0.
order_data	line_items	tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	tax_amount	In cents, as a non-negative integer.
order_data	line_items	discount_amount	The reduction or discount price applied to a product or order. *L2/L3 data field	discount_amount	A non-negative integer.
order_data		fulfillment_date		fulfillment_date	Gateway does not specify.
order_data		metadata		metadata	A string, with key names up to 40 characters long and values up to 500 characters long.
risk_data		ignore_fraud_rules	True/false indicator to inform the gateway to bypass certain fraud detection rules during a transaction	skip_radar_rules	Gateway does not specify.

Vantiv eCommerce

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
customer_data		merchant_customer_id	The merchant's internal reference for the customer.	customer_id	Gateway does not specify.
merchant_metadata	statement_descriptor	description	A description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.	descriptor_name	Gateway does not specify.
merchant_metadata	statement_descriptor	phone_number	The phone number that appears on the customer's credit card statement.	descriptor_phone	Gateway does not specify.
order_data		network_transaction_id_override	The Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.	stored_credential_transaction_id	Gateway does not specify.
order_data		shipping_amount	The cost associated with shipping a product or order to a customer. *L2/L3 data field	shipping_amount	Gateway does not specify.
order_data		tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	tax_amount	Gateway does not specify.
order_data	line_items	product_code	A unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data field	product_code	Gateway does not specify.
order_data	line_items	description	A description of the item or product sold. *L2/L3 data field	item_description	A string with a maximum character count of 20,000.
order_data	line_items	quantity	The value that represents the number of units purchased or sold in a transaction. *L2/L3 data field	quantity	Gateway does not specify.
order_data	line_items	unit_cost	The cost associated with a single unit of a product or service. *L2/L3 data field	unit_cost	Gateway does not specify.
order_data	line_items	discount_amount	The reduction or discount price applied to a product or order. *L2/L3 data field	discount_amount	Gateway does not specify.

Worldpay

group_name	parent_field_name	spreedly_field_name	description	gateway_field_name	gateway field validation
customer_data		merchant_customer_id	The merchant's internal reference for the customer.	authenticatedShopperID	A maximum length is 64 characters, it must contain only the ISO-latin1 subset of the UTF-8 characters, there must be no white space and it cannot start with an underscore (_).
merchant_metadata	statement_descriptor	description	A description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.	statement_narrative	Can generally be up to 50 characters long. Note: Different APMs will have different validation requirements - to learn more see gateway docs.
order_data		gateway_idempotency_key	A unique identifier for idempotent transactions to help prevent duplicate transactions.	idempotency_key	Gateway does not specify.
order_data		network_transaction_id_override	The Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.	schemeTransactionIdentifier	Gateway does not specify.
order_data		invoice_id	A unique identifier assigned to an invoice, typically used by merchants for referencing transactions.	invoiceReferenceNumber	A string between 1 and 15 characters.
order_data		shipping_amount	The cost associated with shipping a product or order to a customer. *L2/L3 data field	shipping_amount	An integer with a max of 12 digits.
order_data		discount_amount	The reduction or discount price applied to a product or order. *L2/L3 data field	discount_amount	An integer with a max of 12 digits.
order_data		tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	tax_amount	An integer with a max of 12 digits.
order_data		shipping_from_zip	The postal or zip code from which a shipment or order is originating. *L2/L3 data field	ships_from_postal_code	A string up to 20 characters of length
order_data	line_items	product_code	A unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data field	product_code	A string with a min length of 1 character and a max of 12 characters.
order_data	line_items	quantity	The value that represents the number of units purchased or sold in a transaction. *L2/L3 data field	quantity	A decimal with a max of 12 digits.
order_data	line_items	unit_cost	The cost associated with a single unit of a product or service. *L2/L3 data field	unit_amount	A decimal with a max of 12 digits.
order_data	line_items	tax_amount	The monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data field	unit_tax_amount	An integer with a max of 12 digits.
order_data	line_items	sale_kind	Indicates whether the line item is a debit (sale) or credit (refund) to the customer. Accepted values: debit or credit	kind	Gateway does not specify.
order_data	line_items	item_name	Item name	name	A string with a max of 100 characters.
order_data		zero_dollar_auth		zero_dollar_auth	Gateway does not specify.
order_data		order_content		order_content	Gateway does not specify.
order_data		installment_count		instalments	Gateway does not specify.
risk_data		user_agent	A string of data transmitted that identifies the type of web browser and other relevant details	userAgentHeader	Gateway does not specify.

Response Fields

group_name	spreedly_field_name	description	gateway_field_name	gateway_type
card_metadata	card_type	The type of card that is issued by the issuing bank.	additionalData.fundingSource details.card_type debit source.card_type cardDetails.accountFoundSource accountType paymentOption.card.cardType payment_source.card.type payment_method_details.card.type funding enhancedAuthResponse_fundingSource_type amount_debit_credit_indicator	adyen airwallex braintree checkout_v2 commerce_hub cyber_source_rest nuvei paypal_commerce_platform stripe stripe_payment_intents vantiv_ecommerce worldpay
card_metadata	issuer_country	Country in the address of the issuing bank.	additionalData.issuerCountry issuer_country_code country_of_issuance source.issuer_country cardDetails.countryCode country country issuerCountry card.bin_details.bin_country_code payment_method_details.card.country country issuer_country_code	adyen airwallex braintree checkout_v2 commerce_hub cyber_source_rest d_local nuvei paypal_commerce_platform stripe stripe_payment_intents worldpay
merchant_data	customer_id	The gateway's unique identifier for the customer's card and billing information.	customer_id customer_vault_id customer.id customerId userTokenId customer id customer	airwallex braintree checkout_v2 cyber_source_rest nuvei stripe stripe_payment_intents worldpay
merchant_data	fraud_result	The result of the risk assessment completed by the gateway.	additionalData.fraudResultType fraud_data.action fraudScreeningResult.responseCode decision risk.score result fraud_detection fraudDetails.finalDecision outcome.risk_level risk_level fraudResult_authenticationResult risk_score_value	adyen airwallex bpoint braintree checkout_v2 cyber_source_rest decidir nuvei stripe stripe_payment_intents vantiv_ecommerce worldpay
payment_outcome_data	failure_reason	Spreedly's normalized field that reflects the normalized value derived from the processor's error code.	refusalReason provider_original_response_code errors.error.errorCode AcquirerResponseCode braintree_transaction.processor_response_code response_code paymentReceipt.processorResponseDetails.responseCode reasonCode errorInformation.reason status_details.error.type status_code payment.transaction_status.description gwErrorReason resp_code details.issue error.decline_code error.decline_code response iso8583_return_code_code	adyen airwallex authorize_net bpoint braintree checkout_v2 commerce_hub cyber_source cyber_source_rest decidir d_local ebanx nmi nuvei orbital paypal_commerce_platform stripe stripe_payment_intents vantiv_ecommerce worldpay
payment_outcome_data	network_advice_code	Spreedly's normalized field that reflects the normalized value derived from the network's error code.	additionalData.merchantAdviceCode details.merchant_advice_code braintree_transaction.merchant_advice_code processing.partner_merchant_advice_code merchantAdviceCode outcome.network_advice_code mac	adyen airwallex braintree checkout_v2 cyber_source_rest nuvei stripe worldpay
raw_payment_outcome_data	authorization_code	The code generated by the processor that provides details on decline or approval.	additionalData.authCode authorization_code authCode authoriseId processor_authorization_code auth_code paymentReceipt.processorResponseDetails.approvalCode ccAuthReply.authorizationCode code status_details.card_authorization_code acquirer.authorization_code payment.transaction_status.authcode authCode auth_code id payment_method_details.card.authorization_code authorization_code authCode authorization_id	adyen airwallex authorize_net bpoint braintree checkout_v2 commerce_hub cyber_source cyber_source_rest decidir d_local ebanx nmi nuvei orbital paypal_commerce_platform stripe stripe_payment_intents vantiv_ecommerce worldpay
raw_payment_outcome_data	gateway_message	The description of the outcome type and reason by the gateway.	additionalData.resultCode status errors.error.errorText responseText message response_summary paymentReceipt.processorResponseDetails.responseMessage ccAuthReply.paymentInsightsInformation.responseInsightsCategory responseDetails status status_detail payment.transaction_status.description responsetext status status_msg intent outcome.seller_message seller_message message iso8583_return_code_description	adyen airwallex authorize_net bpoint braintree checkout_v2 commerce_hub cyber_source cyber_source_rest decidir d_local ebanx nmi nuvei orbital paypal_commerce_platform stripe stripe_payment_intents vantiv_ecommerce worldpay
raw_payment_outcome_data	network_transaction_id	The network transaction identifier provided by the payment network for subsequent transactions.	additionalData.networkTxReference networkTransId network_transaction_id scheme_id networkDetails.transactionIdentifier paymentNetworkTransactionID networkTransactionId payment.cof_info.mandate_id transactionid mit_received_transaction_id transactionId authorizations.0.id payment_method_details.card.network_transaction_id network_transaction_id networkTransactionId transaction_identifier	adyen authorize_net braintree checkout_v2 commerce_hub cyber_source cyber_source_rest d_local ebanx nmi nuvei orbital paypal_commerce_platform stripe stripe_payment_intents vantiv_ecommerce worldpay
raw_payment_outcome_data	processor_decline_code	The error code sent by the issuing bank.	refusalReason provider_original_response_code messages.message.code bankResponseCode additional_processor_response paymentReceipt.processorResponseDetails.responseCode ccCreditReply.processorResponse responseCode status_code payment.transaction_status.code gwExtendedErrorCode outcome.network_decline_code network_decline_code response iso8583_return_code_code	adyen airwallex authorize_net bpoint braintree commerce_hub cyber_source cyber_source_rest d_local ebanx nuvei stripe stripe_payment_intents vantiv_ecommerce worldpay
raw_payment_outcome_data	raw_avs_result	The processor's response to the address verification system value.	additionalData.avsResult fraud_data.avs_result avsResultCode transaction.avs_error_response_code source.avs_check paymentReceipt.processorResponseDetails.bankAssociationDetails.avsSecurityCodeResponse.association.avs avsCode code avsresponse paymentOption.card.avsCode avs_resp_code checks.address_line1_check fraudResult_avsResult avs_result_code_description	adyen airwallex authorize_net braintree checkout_v2 commerce_hub cyber_source cyber_source_rest nmi nuvei orbital stripe_payment_intents vantiv_ecommerce worldpay
raw_payment_outcome_data	raw_cvc_result	The processor's response to the card verification value.	additionalData.cvvResult fraud_data.cvc_result cvvResultCode cvv_response_code source.cvv_check paymentReceipt.processorResponseDetails.bankAssociationDetails.avsSecurityCodeResponse.association.securityCodeResponse cvCode resultCode cvvresponse paymentOption.card.cvv2Reply cvv2_resp_code payment_method_details.card.checks.cvc_check cvc_check fraudResult_cardValidationResult cvc_result_code_description	adyen airwallex authorize_net braintree checkout_v2 commerce_hub cyber_source cyber_source_rest nmi nuvei orbital stripe stripe_payment_intents vantiv_ecommerce worldpay