Normalized request and response fields
Request Fields
| 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. | customer_id | A string of up to 20 characters in length. | authorize_net | |
| customer_data | merchant_customer_id | The merchant's internal reference for the customer. | customer_id | Gateway does not specify. | cyber_source_rest | |
| customer_data | merchant_customer_id | The merchant's internal reference for the customer. | custom_id | A string of up to 255 characters in length. | paypal_commerce_platform | |
| 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. | stripe_payment_intents | |
| 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 (_). | worldpay | |
| merchant_metadata | statement_descriptor | Statement description data. | ||||
| 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. | braintree |
| 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. | paypal_commerce_platform |
| 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. | stripe_payment_intents |
| 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. | worldpay |
| 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. | braintree |
| 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. | stripe_payment_intents |
| 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. | braintree |
| merchant_metadata | transacting_account_id | A unique identifier for each merchant account within a gateway. | merchant_account | A string. | adyen | |
| merchant_metadata | transacting_account_id | A unique identifier for each merchant account within a gateway. | merchant_account_id | Gateway does not specify. | braintree | |
| merchant_metadata | transacting_account_id | A unique identifier for each merchant account within a gateway. | stripe_account | Gateway does not specify. | stripe_payment_intents | |
| 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. | adyen | |
| 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. | checkout_v2 | |
| order_data | gateway_idempotency_key | A unique identifier for idempotent transactions to help prevent duplicate transactions. | idempotency_key | Gateway does not specify. | stripe_payment_intents | |
| order_data | gateway_idempotency_key | A unique identifier for idempotent transactions to help prevent duplicate transactions. | idempotency_key | Gateway does not specify. | worldpay | |
| 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. | adyen | |
| 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. | stripe_payment_intents | |
| 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. | worldpay | |
| 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. | braintree | |
| 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. | authorize.net | |
| order_data | invoice_id | A unique identifier assigned to an invoice, typically used by merchants for referencing transactions. | invoiceDetails ; purchaseOrderNumber | Gateway does not specify. | cyber_source_rest | |
| 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. | paypal_commerce_platform | |
| 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. | stripe_payment_intents | |
| 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. | braintree | |
| 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. | worldpay | |
| 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. | adyen | |
| 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. | authorize_net | |
| 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. | braintree | |
| 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. | paypal_commerce_platform | |
| 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. | stripe_payment_intents | |
| 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. | worldpay | |
| 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. | braintree | |
| 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. | worldpay | |
| 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. | adyen | |
| 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. | authorize.net | |
| 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. | braintree | |
| 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. | paypal_commerce_platform | |
| 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. | stripe_payment_intents | |
| 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. | worldpay | |
| 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. | adyen | |
| 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. | authorize.net | |
| 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. | braintree | |
| 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. | stripe_payment_intents | |
| 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 | cyber_source_rest | |
| 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 | worldpay | |
| order_data | line_items | An 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_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. | adyen |
| 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. | authorize.net |
| order_data | line_items | product_code | A unique identifier assigned to reference a specific product or item by the merchant. | product_code | A maximum of 127 characters. | braintree |
| order_data | line_items | product_code | A unique identifier assigned to reference a specific product or item by the merchant. | sku | A string of up to 127 characters in length. | paypal_commerce_platform |
| order_data | line_items | product_code | A unique identifier assigned to reference a specific product or item by the merchant. | product_code | A maximum of 12 characters. | stripe_payment_intents |
| order_data | line_items | product_code | A unique identifier assigned to reference a specific product or item by the merchant. | productCode | A string with a max of 255 characters. | cybersource_rest |
| order_data | line_items | product_code | A unique identifier assigned to reference a specific product or item by the merchant. | product_code | A string with a min length of 1 character and a max of 12 characters. | worldpay |
| 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. | adyen |
| 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. | authorize.net |
| order_data | line_items | description | A description of the item or product sold. | description | A maximum 127 characters. | braintree |
| order_data | line_items | description | A description of the item or product sold. | product_description | An alphanumeric string of up to 26 characters in length. | stripe_payment_intents |
| 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. | adyen |
| 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. | authorize.net |
| order_data | line_items | quantity | The value that represents the number of units purchased or sold in a transaction. | quantity | The value must be a whole number and can’t be negative or zero. | braintree |
| order_data | line_items | quantity | The value that represents the number of units purchased or sold in a transaction. | quantity | A string of up to 10 characters in length. Must be a whole number. | paypal_commerce_platform |
| order_data | line_items | quantity | The value that represents the number of units purchased or sold in a transaction. | quantity | A positive integer greater than 0. | stripe_payment_intents |
| order_data | line_items | quantity | The value that represents the number of units purchased or sold in a transaction. | quantity | A nonnegative integer with a max of 10 characters. | cyber_source_rest |
| order_data | line_items | quantity | The value that represents the number of units purchased or sold in a transaction. | quantity | A decimal with a max of 12 digits. | worldpay |
| 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. | adyen |
| 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). | authorize.net |
| order_data | line_items | unit_cost | The cost associated with a single unit of a product or service. | unit_amount | Up to 2 decimal places. The value can’t be negative or zero. | braintree |
| order_data | line_items | unit_cost | The cost associated with a single unit of a product or service. | unit_amount | Can not be a negative number. | paypal_commerce_platform |
| order_data | line_items | unit_cost | The cost associated with a single unit of a product or service. | unit_cost | In cents, as a positive integer greater than 0. | stripe_payment_intents |
| order_data | line_items | unit_cost | The cost associated with a single unit of a product or service. | unitPrice | Gateway does not specify. | cyber_source_rest |
| order_data | line_items | unit_cost | The cost associated with a single unit of a product or service. | unit_amount | A decimal with a max of 12 digits. | worldpay |
| 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. | braintree |
| 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. | stripe_payment_intents |
| 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. | cyber_source_rest |
| 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. | worldpay |
| 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. | adyen |
| 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. | cyber_source_rest |
| 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. | paypal_commerce_platform |
| 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. | stripe_payment_intents |
| 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 | braintree |
| 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. | cyber_source_rest |
| 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. | worldpay |
| order_data | line_items | item_name | Item name | name | A string with a maximum of 31 characters in length. | authorize.net |
| order_data | line_items | item_name | Item name | name | A maximum of 127 characters. | braintree |
| order_data | line_items | item_name | Item name | productName | A string with a max of 255 characters. | cyber_source_rest |
| order_data | line_items | item_name | Item name | name | A string in between 2 and 300 characters. | paypal_commerce_platform |
| order_data | line_items | item_name | Item name | name | A string with a max of 100 characters. | worldpay |
| order_data | line_items | total_amount | total_amount | A string with a max length of 12 characters. Must not start with a space or be all spaces/zeros. | adyen | |
| order_data | line_items | total_amount | total_amount | 4 digit maximum in length after the decimal point (no dollar symbol). | authorize.net | |
| order_data | line_items | total_amount | total_amount | Can include up to 2 decimal places. | braintree | |
| order_data | line_items | total_amount | item_total | Can not be a negative number. | paypal_commerce_platform | |
| order_data | zero_dollar_auth | allow_card_verification | Gateway does not specify. | braintree | ||
| order_data | zero_dollar_auth | zero_dollar_auth | Gateway does not specify. | worldpay | ||
| order_data | fulfillment_date | fulfillment_date | Gateway does not specify. | stripe_payment_intents | ||
| order_data | order_content | order_content | Gateway does not specify. | worldpay | ||
| order_data | installment_count | installments | A string. | adyen | ||
| order_data | installment_count | instalments | Gateway does not specify. | worldpay | ||
| order_data | metadata | metadata | Gateway does not specify. | adyen | ||
| order_data | metadata | custom_fields | Can be formatted as a string or integer with a max of 255 characters. | braintree | ||
| order_data | metadata | metadata | Values up to 500 characters in length. | checkout_v2 | ||
| order_data | metadata | metadata | A string, with key names up to 40 characters long and values up to 500 characters long. | stripe_payment_intents | ||
| risk_data | ignore_avs | skip_avs | Boolean | braintree | ||
| risk_data | ignore_avs | ignore_avs | A string with a max of 3 characters. | cyber_source_rest | ||
| risk_data | ignore_cvv | skip_cvv | Boolean | braintree | ||
| risk_data | ignore_cvv | ignore_cvv | Gateway does not specify. | cyber_source_rest | ||
| risk_data | ignore_fraud_rules | skip_advanced_fraud_checking | Boolean | braintree | ||
| risk_data | ignore_fraud_rules | skip_radar_rules | Gateway does not specify. | stripe_payment_intents | ||
| risk_data | user_agent | user_agent | A string. | adyen | ||
| risk_data | user_agent | userAgentHeader | Gateway does not specify. | worldpay |
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 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_metadata | issuer_country | Country 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_data | customer_id | The 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_data | fraud_result | The 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_data | failure_reason | Spreedly'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 details.issue error.decline_code iso8583_return_code_code | adyen authorize_net braintree checkout_v2 cyber_source_rest paypal_commerce_platform stripe_payment_intents 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 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_data | authorization_code | The code generated by the processor that provides details on decline or approval. | additionalData.authCode authCode processor_authorization_code auth_code code id authorization_code authorization_id | adyen authorize_net braintree checkout_v2 cyber_source_rest paypal_commerce_platform stripe_payment_intents worldpay |
| raw_payment_outcome_data | gateway_message | The description of the outcome type and reason by the gateway. | additionalData.resultCode errors.error.errorText message response_summary responseDetails intent seller_message iso8583_return_code_description | adyen authorize_net braintree checkout_v2 cyber_source_rest paypal_commerce_platform stripe_payment_intents 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 networkTransactionId authorizations.0.id network_transaction_id transaction_identifier | adyen authorize_net braintree checkout_v2 cyber_source_rest paypal_commerce_platform stripe_payment_intents worldpay |
| raw_payment_outcome_data | processor_decline_code | The 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_data | raw_avs_result | The processor's response to the address verification system value. | additionalData.avsResult avsResultCode transaction.avs_error_response_code source.avs_check code checks.address_line1_check avs_result_code_description | adyen authorize_net braintree checkout_v2 cyber_source_rest stripe_payment_intents worldpay |
| raw_payment_outcome_data | raw_cvc_result | The processor's response to the card verification value. | additionalData.cvvResult cvvResultCode cvv_response_code source.cvv_check resultCode cvc_check cvc_result_code_description | adyen authorize_net braintree raw_cvc_result cyber_source_rest stripe_payment_intents worldpay |
Updated 6 days ago