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 | Gateway does not specify. | cyber_source_rest | |
| 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 | 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_id | Gateway does not specify. | braintree | |
| merchant_metadata | transacting_account_id | 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 | 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. | 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 | braintree | ||
| 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 | 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 | braintree | ||
| order_data | invoice_id | A unique identifier assigned to an invoice, typically used by merchants for referencing transactions | invoiceReferenceNumber | worldpay | ||
| 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. 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 | 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 | 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. 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 | discount_amount | The reduction or discount price applied to a product or order. *L2/L3 data field | discount_amount | worldpay | ||
| 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 | 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 | worldpay | ||
| 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 | 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 | 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 | 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 | product_code | Up to 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 | cybersource_rest | |
| order_data | line_items | product_code | A unique identifier assigned to reference a specific product or item by the merchant | product_code | worldpay | |
| 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 | 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 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 | cyber_source_rest | |
| order_data | line_items | quantity | The value that represents the number of units purchased or sold in a transaction | quantity | worldpay | |
| 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. This 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_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 | cyber_source_rest | |
| order_data | line_items | unit_cost | The cost associated with a single unit of a product or service | unit_amount | 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 | 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 | 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 non-negative integer. | stripe_payment_intents |
| order_data | line_items | discount_amount | The reduction or discount price applied to a product or order *L2/L3 data field | discount_amount | 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 | 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 | 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 | worldpay | |
| order_data | line_items | item_name | Item name | name | A maximum of 127 characters. | braintree |
| order_data | line_items | item_name | Item name | productName | cyber_source_rest | |
| order_data | line_items | item_name | Item name | name | worldpay | |
| order_data | line_items | total_amount | total_amount | braintree | ||
| order_data | zero_dollar_auth | allow_card_verification | braintree | |||
| order_data | zero_dollar_auth | zero_dollar_auth | worldpay | |||
| order_data | fulfillment_date | fulfillment_date | stripe_payment_intents | |||
| order_data | order_content | order_content | worldpay | |||
| order_data | installment_count | instalments | worldpay | |||
| order_data | metadata | custom_fields | braintree | |||
| order_data | metadata | metadata | stripe_payment_intents | |||
| risk_data | ignore_avs | skip_avs | braintree | |||
| risk_data | ignore_avs | ignore_avs | cyber_source_rest | |||
| risk_data | ignore_cvv | skip_cvv | braintree | |||
| risk_data | ignore_cvv | ignore_cvv | cyber_source_rest | |||
| risk_data | ignore_fraud_rules | skip_advanced_fraud_checking | braintree | |||
| risk_data | ignore_fraud_rules | skip_radar_rules | stripe_payment_intents | |||
| risk_data | user_agent | userAgentHeader | 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 | debit accountType funding amount_debit_credit_indicator | braintree cyber_source_rest stripe_payment_intents worldpay |
| card_metadata | issuer_country | Country in the address of the issuing bank | country_of_issuance country country issuer_country_code | braintree cyber_source_rest stripe_payment_intents worldpay |
| merchant_data | customer_id | The gateway's unique identifier for the customer's card and billing information | customer_vault_id customerId id customer | braintree cyber_source_rest stripe_payment_intents worldpay |
| merchant_data | fraud_result | The result of the risk assessment completed by the gateway | decision result risk_level risk_score_value | braintree cyber_source_rest stripe_payment_intents worldpay |
| raw_payment_outcome_data | authorization_code | The code generated by the processor that provides details on decline or approval | processor_authorization_code code authorization_code authorization_id | braintree cyber_source_rest stripe_payment_intents worldpay |
| raw_payment_outcome_data | gateway_message | The description of the outcome type and reason by the gateway | message responseDetails seller_message iso8583_return_code_description | braintree cyber_source_rest stripe_payment_intents worldpay |
| raw_payment_outcome_data | network_transaction_id | The network transaction identifier provided by the payment network for subsequent transactions | network_transaction_id networkTransactionId network_transaction_id transaction_identifier | braintree cyber_source_rest stripe_payment_intents worldpay |
| raw_payment_outcome_data | processor_decline_code | The error code sent by the issuing bank | additional_processor_response responseCode network_decline_code iso8583_return_code_code | 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 | transaction.avs_error_response_code code checks.address_line1_check avs_result_code_description | braintree cyber_source_rest stripe_payment_intents worldpay |
| raw_payment_outcome_data | raw_cvc_result | The processor's response to the card verification value | cvv_response_code resultCode cvc_check cvc_result_code_description | braintree cyber_source_rest stripe_payment_intents worldpay |
Updated 21 days ago