Normalized request and response fields

Request Fields

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validationgateway_type
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_idA string of up to 20 characters in length.authorize_net
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_idGateway does not specify.cyber_source_rest
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_idA string with no length specified.nmi
customer_datamerchant_customer_idThe merchant's internal reference for the customer.custom_idA string of up to 255 characters in length.paypal_commerce_platform
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_referenceAn alphanumeric string of up to 17 characters in length.stripe_payment_intents
customer_datamerchant_customer_idThe merchant's internal reference for the customer.authenticatedShopperIDA 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 (_).worldpay
merchant_metadatastatement_descriptorStatement description data.
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.descriptor_nameLess than or equal to 15 characters and can only contain letters and numbers.braintree
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.descriptorA string with no length specified.nmi
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.soft_descriptorA string between 1 and 22 characters that supports alphanumeric characters, dashes, asterisks, periods (.) and spaces.paypal_commerce_platform
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.statement_descriptorMust contain at least one letter and be 1–22 characters long.stripe_payment_intents
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.statement_narrativeCan generally be up to 50 characters long. Note: Different APMs will have different validation requirements - to learn more see gateway docs.worldpay
merchant_metadatastatement_descriptorphone_numberThe phone number that appears on the customer's credit card statement.descriptor_phoneMust be 10 - 14 characters and can only contain numbers, dashes, parentheses and periods.braintree
merchant_metadatastatement_descriptorphone_numberThe phone number that appears on the customer's credit card statement.descriptor_phoneA string with no length specified.nmi
merchant_metadatastatement_descriptorsuffixAn 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_suffixA maximum 22 characters.stripe_payment_intents
merchant_metadatastatement_descriptorurlThe url that appears on the customer's credit card statement.descriptor_urlMust be less than or equal to 13 characters.braintree
merchant_metadatastatement_descriptorurlThe url that appears on the customer's credit card statement.descriptor_urlA string with no length specified.nmi
merchant_metadatatransacting_account_idA unique identifier for each merchant account within a gateway.merchant_accountA string.adyen
merchant_metadatatransacting_account_idA unique identifier for each merchant account within a gateway.merchant_account_idGateway does not specify.braintree
merchant_metadatatransacting_account_idA unique identifier for each merchant account within a gateway.stripe_accountGateway does not specify.stripe_payment_intents
order_datagateway_idempotency_keyA unique identifier for idempotent transactions to help prevent duplicate transactions.idempotency_keyA string with a max length of 64 characters.adyen
order_datagateway_idempotency_keyA unique identifier for idempotent transactions to help prevent duplicate transactions.idempotency_keyA string of up to 255 characters in length.checkout_v2
order_datagateway_idempotency_keyA unique identifier for idempotent transactions to help prevent duplicate transactions.idempotency_keyGateway does not specify.stripe_payment_intents
order_datagateway_idempotency_keyA unique identifier for idempotent transactions to help prevent duplicate transactions.idempotency_keyGateway does not specify.worldpay
order_datanetwork_transaction_id_overrideThe Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.network_transaction_idGateway does not specify.adyen
order_datanetwork_transaction_id_overrideThe Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.network_transaction_idnmi
order_datanetwork_transaction_id_overrideThe Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.network_transaction_idGateway does not specify.stripe_payment_intents
order_datanetwork_transaction_id_overrideThe Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.schemeTransactionIdentifierGateway does not specify.worldpay
order_datanetwork_transaction_id_overrideThe Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.previous_network_transaction_idString.braintree
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.po_numberInteger with a max of 25 characters in length.authorize.net
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.invoiceDetails ; purchaseOrderNumberGateway does not specify.cyber_source_rest
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.ponumberA string with no length specified.nmi
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.invoice_idA string of up to 127 characters in length.paypal_commerce_platform
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.merchant_referenceAn alphanumeric string of up to 25 characters in length.stripe_payment_intents
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.purchase_order_numberA string of up to 12 ASCII characters for AIB and 17 ASCII characters for all other processors.braintree
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.invoiceReferenceNumberA string between 1 and 15 characters.worldpay
order_datashipping_amountThe cost associated with shipping a product or order to a customer.

*L2/L3 data field
freight_amountA string with a max length of 12 characters.adyen
order_datashipping_amountThe cost associated with shipping a product or order to a customer.

*L2/L3 data field
amountA positive integer with a max of 15 characters for transactions of type CREDIT.authorize_net
order_datashipping_amountThe cost associated with shipping a product or order to a customer.

*L2/L3 data field
shipping_amountA positive integer greater than 0, with a maximum of 9 digits.braintree
order_datashipping_amountThe cost associated with shipping a product or order to a customer.

*L2/L3 data field
shippingnmi
order_datashipping_amountThe cost associated with shipping a product or order to a customer.

*L2/L3 data field
shippingGateway does not specify.paypal_commerce_platform
order_datashipping_amountThe cost associated with shipping a product or order to a customer.

*L2/L3 data field
shipping_amountIn cents, as a non-negative integer.stripe_payment_intents
order_datashipping_amountThe cost associated with shipping a product or order to a customer.

*L2/L3 data field
shipping_amountAn integer with a max of 12 digits.worldpay
order_datadiscount_amountThe reduction or discount price applied to a product or order.

*L2/L3 data field
discount_amountA positive integer greater than 0, with a maximum of 9 digits.braintree
order_datadiscount_amountThe reduction or discount price applied to a product or order.

*L2/L3 data field
discount_amountAn integer with a max of 12 digits.worldpay
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction.

*L2/L3 data field
total_tax_amountA string with a max length of 12 characters. Must not be all zeros.adyen
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction.

*L2/L3 data field
amountA positive integer with a max of 15 characters for transactions of type CREDIT.authorize.net
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction.

*L2/L3 data field
tax_amountA 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.braintree
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction.

*L2/L3 data field
taxnmi
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction.

*L2/L3 data field
tax_totalThe value can not be negative, and in most cases, it must be greater than zero.paypal_commerce_platform
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction.

*L2/L3 data field
total_tax_amountAn integer in the amount of cents. stripe_payment_intents
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction.

*L2/L3 data field
tax_amountAn integer with a max of 12 digits.worldpay
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating.

*L2/L3 data field
ship_from_postal_codeA string with a max length of 10 characters. Must not start with a space or be all spaces/zeros.adyen
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating.

*L2/L3 data field
zipInteger with a max length of 20 characters. Can be 5 or 9 digits long.authorize.net
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating.

*L2/L3 data field
ships_from_postal_codeMay contain no more than 9 letter or number characters.braintree
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating.

*L2/L3 data field
shipping_from_zipGateway does not specify.stripe_payment_intents
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating.

*L2/L3 data field
ships_from_postal_codeGateway does not specifycyber_source_rest
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating.

*L2/L3 data field
ships_from_postal_codeA string up to 20 characters of lengthworldpay
order_dataline_itemsAn array that includes a detailed breakdown of the items included within the transaction, such as quantity and price per unit.

*L2/L3 data field
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant.

*L2/L3 data field
product_codeA string with a max length of 12 characters. Must not start with a space or be all spaces/zeros.adyen
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant.

*L2/L3 data field
product_codeGateway does not specify.authorize.net
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant.product_codeA maximum of 127 characters.braintree
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant.skuA string of up to 127 characters in length.paypal_commerce_platform
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant.product_codeA maximum of 12 characters.stripe_payment_intents
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant.productCodeA string with a max of 255 characters.cybersource_rest
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant.product_codeA string with a min length of 1 character and a max of 12 characters.worldpay
order_dataline_itemsdescriptionA description of the item or product sold.

*L2/L3 data field
descriptionA string with a max length of 26 characters. Must not start with a space or be all spaces/zeros.adyen
order_dataline_itemsdescriptionA description of the item or product sold.

*L2/L3 data field
descriptionA string of up to 255 characters in length.authorize.net
order_dataline_itemsdescriptionA description of the item or product sold.descriptionA maximum 127 characters.braintree
order_dataline_itemsdescriptionA description of the item or product sold.product_descriptionAn alphanumeric string of up to 26 characters in length.stripe_payment_intents
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction.

*L2/L3 data field
quantityA string with a max length of 12 characters. Must not start with a space or be all spaces.adyen
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction.

*L2/L3 data field
quantityUp to 4 digits max length with up to two decimal places.authorize.net
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction.quantityThe value must be a whole number and can’t be negative or zero.braintree
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction.quantityA string of up to 10 characters in length. Must be a whole number.paypal_commerce_platform
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction.quantityA positive integer greater than 0.stripe_payment_intents
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction.quantityA nonnegative integer with a max of 10 characters. cyber_source_rest
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction.quantityA decimal with a max of 12 digits.worldpay
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service.

*L2/L3 data field
unit_priceA string with a max length of 12 characters. Must not be all zeros.adyen
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service.

*L2/L3 data field
unit_price4 digit maximum in length with a decimal point (no dollar symbol).authorize.net
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service.unit_amountUp to 2 decimal places. The value can’t be negative or zero.braintree
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service.unit_amountCan not be a negative number.paypal_commerce_platform
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service.unit_costIn cents, as a positive integer greater than 0.stripe_payment_intents
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service.unitPriceGateway does not specify.cyber_source_rest
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service.unit_amountA decimal with a max of 12 digits. worldpay
order_dataline_itemstax_amountThe monetary value representing the amount of tax applied to a product or transaction.

*L2/L3 data field
unit_tax_amountUp to 2 decimal places. This value can’t be negative or zero.braintree
order_dataline_itemstax_amountThe monetary value representing the amount of tax applied to a product or transaction.

*L2/L3 data field
tax_amountIn cents, as a non-negative integer.stripe_payment_intents
order_dataline_itemstax_amountThe monetary value representing the amount of tax applied to a product or transaction.

*L2/L3 data field
taxAmountA decimal with a max of 15 digits.cyber_source_rest
order_dataline_itemstax_amountThe monetary value representing the amount of tax applied to a product or transaction.

*L2/L3 data field
unit_tax_amountAn integer with a max of 12 digits.worldpay
order_dataline_itemsdiscount_amountThe reduction or discount price applied to a product or order.

*L2/L3 data field
discount_amountA string with a max length of 12 characters.adyen
order_dataline_itemsdiscount_amountThe reduction or discount price applied to a product or order.

*L2/L3 data field
discount_amountA decimal. Master card should have a max length of 10 digits. Visa should have a max length of 13 digits.cyber_source_rest
order_dataline_itemsdiscount_amountThe reduction or discount price applied to a product or order.

*L2/L3 data field
discountCannot be a negative number.paypal_commerce_platform
order_dataline_itemsdiscount_amountThe reduction or discount price applied to a product or order.

*L2/L3 data field
discount_amountA non-negative integer.stripe_payment_intents
order_dataline_itemssale_kindIndicates whether the line item is a debit (sale) or credit (refund) to the customer. Accepted values: debit or creditkindAccepted values: debit, creditbraintree
order_dataline_itemssale_kindIndicates whether the line item is a debit (sale) or credit (refund) to the customer. Accepted values: debit or creditkindGateway does not specify.cyber_source_rest
order_dataline_itemssale_kindIndicates whether the line item is a debit (sale) or credit (refund) to the customer. Accepted values: debit or creditkindGateway does not specify.worldpay
order_dataline_itemsitem_nameItem namenameA string with a maximum of 31 characters in length.authorize.net
order_dataline_itemsitem_nameItem namenameA maximum of 127 characters.braintree
order_dataline_itemsitem_nameItem nameproductNameA string with a max of 255 characters.cyber_source_rest
order_dataline_itemsitem_nameItem namenameA string in between 2 and 300 characters.paypal_commerce_platform
order_dataline_itemsitem_nameItem namenameA string with a max of 100 characters.worldpay
order_dataline_itemstotal_amounttotal_amountA string with a max length of 12 characters. Must not start with a space or be all spaces/zeros.adyen
order_dataline_itemstotal_amounttotal_amount4 digit maximum in length after the decimal point (no dollar symbol).authorize.net
order_dataline_itemstotal_amounttotal_amountCan include up to 2 decimal places.braintree
order_dataline_itemstotal_amountitem_totalCan not be a negative number.paypal_commerce_platform
order_datazero_dollar_authallow_card_verificationGateway does not specify.braintree
order_datazero_dollar_authzero_dollar_authGateway does not specify.worldpay
order_datafulfillment_datefulfillment_dateGateway does not specify.stripe_payment_intents
order_dataorder_contentorder_contentGateway does not specify.worldpay
order_datainstallment_countinstallmentsA string.adyen
order_datainstallment_countinstalmentsGateway does not specify.worldpay
order_datametadatametadataGateway does not specify.adyen
order_datametadatacustom_fieldsCan be formatted as a string or integer with a max of 255 characters.braintree
order_datametadatametadataValues up to 500 characters in length.checkout_v2
order_datametadatametadataA string, with key names up to 40 characters long and values up to 500 characters long.stripe_payment_intents
risk_dataignore_avsskip_avsBooleanbraintree
risk_dataignore_avsignore_avsA string with a max of 3 characters.cyber_source_rest
risk_dataignore_cvvskip_cvvBooleanbraintree
risk_dataignore_cvvignore_cvvGateway does not specify.cyber_source_rest
risk_dataignore_fraud_rulesskip_advanced_fraud_checkingBooleanbraintree
risk_dataignore_fraud_rulesskip_radar_rulesGateway does not specify.stripe_payment_intents
risk_datauser_agentuser_agentA string.adyen
risk_datauser_agentuserAgentHeaderGateway does not specify.worldpay

Response Fields

group_namespreedly_field_namedescription gateway_field_namegateway_type
card_metadatacard_typeThe type of card that is issued by the issuing bank.additionalData.fundingSource
debit
source.card_type
accountType
payment_source.card.type
funding
amount_debit_credit_indicator
adyen
braintree
checkout_v2
cyber_source_rest
paypal_commerce_platform
stripe_payment_intents
worldpay
card_metadataissuer_countryCountry in the address of the issuing bank.additionalData.issuerCountry
country_of_issuance
source.issuer_country
country
card.bin_details.bin_country_code
country
issuer_country_code
adyen
braintree
checkout_v2
cyber_source_rest
paypal_commerce_platform
stripe_payment_intents
worldpay
merchant_datacustomer_idThe gateway's unique identifier for the customer's card and billing information.customer_vault_id
customer.id
customerId
id
customer
braintree
checkout_v2
cyber_source_rest
stripe_payment_intents
worldpay
merchant_datafraud_resultThe result of the risk assessment completed by the gateway.additionalData.fraudResultType
decision
risk.score
result
risk_level
risk_score_value
adyen
braintree
checkout_v2
cyber_source_rest
stripe_payment_intents
worldpay
payment_outcome_datafailure_reasonSpreedly's normalized field that reflects the normalized value derived from the processor's error code.refusalReason
errors.error.errorCode
braintree_transaction.processor_response_code
response_code
errorInformation.reason
response_code
details.issue
error.decline_code
iso8583_return_code_code
adyen
authorize_net
braintree
checkout_v2
cyber_source_rest
nmi
paypal_commerce_platform
stripe_payment_intents
worldpay
payment_outcome_datanetwork_advice_codeSpreedly's normalized field that reflects the normalized value derived from the network's error code.additionalData.merchantAdviceCode
braintree_transaction.merchant_advice_code
processing.partner_merchant_advice_code
processorInformation.merchantAdvice.code
mac
adyen
braintree
checkout_v2
cyber_source_rest
worldpay
raw_payment_outcome_dataauthorization_codeThe code generated by the processor that provides details on decline or approval.additionalData.authCode
authCode
processor_authorization_code
auth_code
code
authcode
id
authorization_code
authorization_id
adyen
authorize_net
braintree
checkout_v2
cyber_source_rest
nmi
paypal_commerce_platform
stripe_payment_intents
worldpay
raw_payment_outcome_datagateway_messageThe description of the outcome type and reason by the gateway.additionalData.resultCode
errors.error.errorText
message
response_summary
responseDetails
responsetext
intent
seller_message
iso8583_return_code_description
adyen
authorize_net
braintree
checkout_v2
cyber_source_rest
nmi
paypal_commerce_platform
stripe_payment_intents
worldpay
raw_payment_outcome_datanetwork_transaction_idThe network transaction identifier provided by the payment network for subsequent transactions.additionalData.networkTxReference
networkTransId
network_transaction_id
scheme_id
networkTransactionId
transactionid
authorizations.0.id
network_transaction_id
transaction_identifier
adyen
authorize_net
braintree
checkout_v2
cyber_source_rest
nmi
paypal_commerce_platform
stripe_payment_intents
worldpay
raw_payment_outcome_dataprocessor_decline_codeThe error code sent by the issuing bank.refusalReason
messages.message.code
additional_processor_response
responseCode
network_decline_code
iso8583_return_code_code
adyen
authorize_net
braintree
cyber_source_rest
stripe_payment_intents
worldpay
raw_payment_outcome_dataraw_avs_resultThe processor's response to the address verification system value.additionalData.avsResult
avsResultCode
transaction.avs_error_response_code
source.avs_check
code
avsresponse
checks.address_line1_check
avs_result_code_description
adyen
authorize_net
braintree
checkout_v2
cyber_source_rest
nmi
stripe_payment_intents
worldpay
raw_payment_outcome_dataraw_cvc_resultThe processor's response to the card verification value.additionalData.cvvResult
cvvResultCode
cvv_response_code
source.cvv_check
resultCode
cvvresponse
cvc_check
cvc_result_code_description
adyen
authorize_net
braintree
checkout_v2
cyber_source_rest
nmi
stripe_payment_intents
worldpay