SupportBlog
Guides
Start typing to search…

Normalized request and response fields

Available normalized request and response fields

"risk_data": {
            "ignore_cvv": true,
            "ignore_avs": false,
            "ignore_fraud_rules": "true",
            "user_agent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"
        },
"customer_data": {
  					"merchant_customer_id": "a_customer_id_1",
						"customer_tax_number": "123456789"

        },
"merchant_metadata": {
            "statement_descriptor": {
                "description": "TES",
                "phone_number": "123-456-7891",
                "url": "something.com",
                "suffix": "-EX"
            },
            	"transacting_account_id": "12345"
        },
"order_data": {
            "invoice_id": "INV_123",
            "shipping_amount": 10,
            "discount_amount": 20,
            "tax_amount": 10,
            "shipping_from_zip": "12345",
            "quantity": 2,
          	"description": "Vending Machine",
            "fulfillment_date": "07/29/2024",
          	"gateway_idempotency_key": "123",
          	"installment_count": "5",
          	"order_content": "vending",
          	"network_transaction_id_override": "1234567890",
          	"zero_dollar_auth": "false",
            "line_items": [
         {			"product_code": "SKU-123",
							  "description": "an item",
                "quantity": 1,
                "unit_cost": 40,
                "tax_amount": 5,
                "discount_amount": 10,
          			"total_amount": "20",
                "reference": "ORDER_123",
                "sale_kind": "debit",
                "item_name": "Water Bottle"
             },
          {
                "product_code": "SKU-321",
                "description": "two of the same",
                "quantity": 2,
                "unit_cost": 20,
                "tax_amount": 5,
                "discount_amount": 10,
            		"total_amount": "20",
                "reference": "ORDER_123",
                "sale_kind": "debit",
                "item_name": "Chips"
             }
            ]
        }
    }
}
"gateway_response": {
		"card_metadata": {
				"issuer_country": "N/A",
				"card_type": "credit"
            },
		"merchant_data": {
				"fraud_result": "21",
				"customer_id": "12345"
            },
		"raw_payment_outcome_data": {
				"raw_cvc_result": "C",
				"raw_avs_result": "E",
     		"network_transaction_id": "060720116005062",
				"processor_decline_code": "12",
      	"authorization_code": "1234",
				"gateway_message": "200002"
    				},
		"payment_outcome_data": {
				"network_advice_code": "cannot_aprove_at_this_time_try_again_later",
				"failure_reason": "contact_bank"
            }
        }

Request Fields by gateway

Adyen

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
merchant_metadatatransacting_account_idA unique identifier for each merchant account within a gateway.merchant_accountA string.
order_datagateway_idempotency_keyA unique identifier for idempotent transactions to help prevent duplicate transactions.idempotency_keyA string with a max length of 64 characters.
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.
order_datashipping_amountThe cost associated with shipping a product or order to a customer. *L2/L3 data fieldfreight_amountA string with a max length of 12 characters.
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldtotal_tax_amountA string with a max length of 12 characters. Must not be all zeros.
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating. *L2/L3 data fieldship_from_postal_codeA string with a max length of 10 characters. Must not start with a space or be all spaces/zeros.
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data fieldproduct_codeA string with a max length of 12 characters. Must not start with a space or be all spaces/zeros.
order_dataline_itemsdescriptionA description of the item or product sold. *L2/L3 data fielddescriptionA string with a max length of 26 characters. Must not start with a space or be all spaces/zeros.
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction. *L2/L3 data fieldquantityA string with a max length of 12 characters. Must not start with a space or be all spaces.
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service. *L2/L3 data fieldunit_priceA string with a max length of 12 characters. Must not be all zeros.
order_dataline_itemsdiscount_amountThe reduction or discount price applied to a product or order. *L2/L3 data fielddiscount_amountA string with a max length of 12 characters.
order_dataline_itemstotal_amountThe total amount of the line item.total_amountA string with a max length of 12 characters. Must not start with a space or be all spaces/zeros.
order_datainstallment_countinstallmentsA string.
order_datametadatametadataGateway does not specify.
risk_datauser_agentA string of data transmitted that identifies the type of web browser and other relevant detailsuser_agentA string.

Airwallex

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
order_dataline_itemsreferenceA unique identifier assocaited with a transaction, invoice or order. *L2/L3 data fieldmerchant_order_idGateway does not specify.

Authorize.net

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_idA string of up to 20 characters in length.
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.
order_datashipping_amountThe cost associated with shipping a product or order to a customer. *L2/L3 data fieldamountA positive integer with a max of 15 characters for transactions of type CREDIT.
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldamountA positive integer with a max of 15 characters for transactions of type CREDIT.
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating. *L2/L3 data fieldzipInteger with a max length of 20 characters. Can be 5 or 9 digits long.
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data fieldproduct_codeGateway does not specify.
order_dataline_itemsdescriptionA description of the item or product sold. *L2/L3 data fielddescriptionA string of up to 255 characters in length.
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction. *L2/L3 data fieldquantityUp to 4 digits max length with up to two decimal places.
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service. *L2/L3 data fieldunit_price4 digit maximum in length with a decimal point (no dollar symbol).
order_dataline_itemsitem_nameItem namenameA string with a maximum of 31 characters in length.
order_dataline_itemstotal_amountThe total amount of the line item.total_amount4 digit maximum in length after the decimal point (no dollar symbol).
risk_dataignore_avsTrue/false indicator to inform the gateway to bypass the AVS checkskip_avsBoolean

Braintree

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
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.
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.
merchant_metadatastatement_descriptorurlThe url that appears on the customer's credit card statement.descriptor_urlMust be less than or equal to 13 characters.
merchant_metadatatransacting_account_idA unique identifier for each merchant account within a gateway.merchant_account_idGateway does not specify.
order_datanetwork_transaction_id_overrideThe Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.previous_network_transaction_idString.
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.
order_datashipping_amountThe cost associated with shipping a product or order to a customer. *L2/L3 data fieldshipping_amountA positive integer greater than 0, with a maximum of 9 digits.
order_datadiscount_amountThe reduction or discount price applied to a product or order. *L2/L3 data fielddiscount_amountA positive integer greater than 0, with a maximum of 9 digits.
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldtax_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.
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating. *L2/L3 data fieldships_from_postal_codeMay contain no more than 9 letter or number characters.
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data fieldproduct_codeA maximum of 127 characters.
order_dataline_itemsdescriptionA description of the item or product sold. *L2/L3 data fielddescriptionA maximum 127 characters.
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction. *L2/L3 data fieldquantityThe value must be a whole number and can't be negative or zero.
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service. *L2/L3 data fieldunit_amountUp to 2 decimal places. The value can't be negative or zero.
order_dataline_itemstax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldunit_tax_amountUp to 2 decimal places. This value can't be negative or zero.
order_dataline_itemssale_kindIndicates whether the order was processed using a debit or credit network. Accepted values: debit or creditkindAccepted values: debit, credit
order_dataline_itemsitem_nameItem namenameA maximum of 127 characters.
order_dataline_itemstotal_amountThe total amount of the line item.total_amountCan include up to 2 decimal places.
order_datazero_dollar_authallow_card_verificationGateway does not specify.
order_datametadatacustom_fieldsCan be formatted as a string or integer with a max of 255 characters.
risk_dataignore_cvvTrue/false indicator to inform the gateway to bypass the CVV requirementskip_cvvBoolean
risk_dataignore_fraud_rulesTrue/false indicator to inform the gateway to bypass certain fraud detection rules during a transactionskip_advanced_fraud_checkingBoolean

CardConnect

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction.tax_amountGateway does not specify.
order_datafreight_amountThe cost associated with shipping a product or order to a customer.shipping_amountGateway does not specify.
order_dataship_from_zipThe postal or zip code from which a shipment or order is originating.shipping_from_zipGateway does not specify.

Checkout.com

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
order_datagateway_idempotency_keyA unique identifier for idempotent transactions to help prevent duplicate transactions.idempotency_keyA string of up to 255 characters in length.
order_datametadatametadataValues up to 500 characters in length.

CommerceHub

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.service_entitlementGateway does not specify.
merchant_metadatastatement_descriptorphone_numberThe phone number that appears on the customer's credit card statement.customer_service_numberGateway does not specify.
order_datanetwork_transaction_id_overrideThe Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.scheme_reference_transaction_idGateway does not specify.

Credorax

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.i2Upto 22 character long string

Cybersource

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_idA string of up to 26 characters in length.
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.merchant_descriptorA string of up to 23 characters in length.
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.invoice_numberA string of up to 23 characters in length. Visa platform connect has a max of 15 characters.
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data fieldskuA string. Length is not specified.
order_dataline_itemsdescriptionA description of the item or product sold. *L2/L3 data fielddescriptionA string of up to 32 characters in length.
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction. *L2/L3 data fieldquantityAn integer with a max of 10 characters in length.
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service. *L2/L3 data fielddeclared_valueGateway does not specify.
order_dataline_itemstax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldtax_amountA string with a max length of 9 characters.
order_datainstallment_countinstallment_total_countAn integer with a max length of 2.
risk_dataignore_avsTrue/false indicator to inform the gateway to bypass the AVS checkignore_avsA string with a max length of 5 characters.
risk_dataignore_cvvTrue/false indicator to inform the gateway to bypass the CVV requirementignore_cvvBoolean

Cybersource REST

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_idGateway does not specify.
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.invoiceDetails ; purchaseOrderNumberGateway does not specify.
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating. *L2/L3 data fieldships_from_postal_codeGateway does not specify
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data fieldproductCodeA string with a max of 255 characters.
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction. *L2/L3 data fieldquantityA nonnegative integer with a max of 10 characters.
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service. *L2/L3 data fieldunitPriceGateway does not specify.
order_dataline_itemstax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldtaxAmountA decimal with a max of 15 digits.
order_dataline_itemsdiscount_amountThe reduction or discount price applied to a product or order. *L2/L3 data fielddiscount_amountA decimal. Master card should have a max length of 10 digits. Visa should have a max length of 13 digits.
order_dataline_itemssale_kindIndicates whether the order was processed using a debit or credit network. Accepted values: debit or creditkindGateway does not specify.
order_dataline_itemsitem_nameItem nameproductNameA string with a max of 255 characters.
risk_dataignore_avsTrue/false indicator to inform the gateway to bypass the AVS checkignore_avsA string with a max of 3 characters.
risk_dataignore_cvvTrue/false indicator to inform the gateway to bypass the CVV requirementignore_cvvGateway does not specify.

Decidir

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_idGateway does not specify.
merchant_metadatastatement_descriptorphone_numberThe phone number that appears on the customer's credit card statement.merchant_phoneGateway does not specify.
merchant_metadatatransacting_account_idA unique identifier for each merchant account within a gateway.merchant_idGateway does not specify.
order_datainstallment_countinstallmentsGateway does not specify.

dLocal

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validationgateway_type
customer_datamerchant_customer_idThe merchant's internal reference for the customer.user_referenceA string. Data length not specified.d_local
customer_datacustomer_tax_numberThe merchant's internal reference for the customer's tax number.documentA string. Data length not specified.d_local
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.dynamic_descriptorA string. Data length not specified.d_local
order_datagateway_idempotency_keyA unique identifier for idempotent transactions to help prevent duplicate transactions.idempotency_keyA string. Data length not specified.d_local
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.original_order_idA string. Data length not specified.d_local
order_datainstallment_countinstallmentsGateway does not specify.d_local

Ebanx

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
customer_datacustomer_tax_numberThe merchant's internal reference for the customer's tax number.documentGateway does not specify.
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.soft_descriptorGateway does not specify.
order_datainstallment_countinstalmentsGateway does not specify.

Forte

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
order_datametadataxdatastring value with keys xdata_1, xdata_2, ... xdata_9

Heartland Payment Systems

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
merchant_metadatastatement_descriptormetadataA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.descriptionA string

NMI

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_idA string with no length specified.
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.
merchant_metadatastatement_descriptorphone_numberThe phone number that appears on the customer's credit card statement.descriptor_phoneA string with no length specified.
merchant_metadatastatement_descriptorurlThe url that appears on the customer's credit card statement.descriptor_urlA string with no length specified.
order_datanetwork_transaction_id_overrideThe Network Transaction ID (NTID) used to override the default NTID Spreedly sends to the gateway.network_transaction_idA string. Gateway does not specify max characters in length.
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.ponumberA string with no length specified.
order_datashipping_amountThe cost associated with shipping a product or order to a customer. *L2/L3 data fieldshippingGateway does not specify.
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldtaxGateway does not specify.

Nuvei

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
customer_datamerchant_customer_idThe merchant's internal reference for the customer.userTokenIdGateway does not specify.

Orbital

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.product_descriptionA string with a max length of 18 characters.
merchant_metadatastatement_descriptorphone_numberThe phone number that appears on the customer's credit card statement.merchant_phoneA string with a max length of 12 characters.
merchant_metadatastatement_descriptorurlThe url that appears on the customer's credit card statement.merchant_urlA string with a max of 13 characters.
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.purchase_orderGateway does not specify.
order_datashipping_amountThe cost associated with shipping a product or order to a customer. *L2/L3 data fieldfreight_amountA max of 12 characters in length.
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldtotal_tax_amountA max of 12 characters in length.
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating. *L2/L3 data fieldzip; ship_from_zipA string with a max length of 10 characters. It can not be all zeros or nines.
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data fieldprod_cdA string with a max of 12 characters of length. It can not be all zeros.
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction. *L2/L3 data fieldqtyA string with a max of 13 characters in length. It can not be all zeros. Implied decimal of 4.
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service. *L2/L3 data fieldunit_costA decimal with a max of 13 characters in length. Implied decimal of 4
order_dataline_itemstax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldtax_amtAn integer with a max of 12 characters in length.
order_dataline_itemsdiscount_amountThe reduction or discount price applied to a product or order. *L2/L3 data fielddiscA decimal with a max of 12 characters in length. Implied decimal.
order_dataline_itemsitem_nameItem namedescA string with a max of 18 characters in length.
order_dataline_itemstotal_amountThe total amount of the line item.line_totGateway does not specify.

PayPal Commerce Platform (PPCP)

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
customer_datamerchant_customer_idThe merchant's internal reference for the customer.custom_idA string of up to 255 characters in length.
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.
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.
order_datashipping_amountThe cost associated with shipping a product or order to a customer. *L2/L3 data fieldshippingGateway does not specify.
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldtax_totalThe value can not be negative, and in most cases, it must be greater than zero.
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data fieldskuA string of up to 127 characters in length.
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction. *L2/L3 data fieldquantityA string of up to 10 characters in length. Must be a whole number.
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service. *L2/L3 data fieldunit_amountCan not be a negative number.
order_dataline_itemsdiscount_amountThe reduction or discount price applied to a product or order. *L2/L3 data fielddiscountCannot be a negative number.
order_dataline_itemsitem_nameItem namenameA string in between 2 and 300 characters.
order_dataline_itemstotal_amountThe total amount of the line item.item_totalCan not be a negative number.

PayU Latam

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchanttransaction.order.descriptionGateway does not specify.
order_datashipping_from_zipThe postal or zip code from which a shipment or order is orginatingtransaction.order.shippingAddress.postalCodeGateway does not specify.
risk_datauser_agentA string of data transmitted that identifies the type of web browser and other relevant detailsuserAgentGateway does not specify.

Shift4_v2

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_id

Stripe

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_referenceA string.
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.statement_descriptionA string.
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 string.
order_datagateway_idempotency_keyA unique identifier for idempotent transactions to help prevent duplicate transactions.idempotency_keyA nullable string.
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.merchant_referenceGateway does not specify.
order_datashipping_amountThe cost associated with shipping a product or order to a customer. *L2/L3 data fieldshipping_amountA non-negative integer in cents.
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating. *L2/L3 data fieldshipping_from_zipA string.
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data fieldproduct_codeA nullable string.
order_dataline_itemsdescriptionA description of the item or product sold. *L2/L3 data fieldproduct_descriptionGateway does not specify.
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction. *L2/L3 data fieldquantityAn integer.
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service. *L2/L3 data fieldunit_costA nullable integer.
order_dataline_itemstax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldtax_amountAn integer.
order_dataline_itemsdiscount_amountThe reduction or discount price applied to a product or order. *L2/L3 data fielddiscount_amountAn integer.
order_datametadatametadataCan 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_dataignore_fraud_rulesTrue/false indicator to inform the gateway to bypass certain fraud detection rules during a transactionskip_radar_rulesGateway does not specify.

Stripe Payment Intents

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_referenceAn alphanumeric string of up to 17 characters in length.
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.
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.
merchant_metadatatransacting_account_idA unique identifier for each merchant account within a gateway.stripe_accountGateway does not specify.
order_datagateway_idempotency_keyA unique identifier for idempotent transactions to help prevent duplicate transactions.idempotency_keyGateway does not specify.
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.
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.
order_datashipping_amountThe cost associated with shipping a product or order to a customer. *L2/L3 data fieldshipping_amountIn cents, as a non-negative integer.
order_datatax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldtotal_tax_amountAn integer in the amount of cents.
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating. *L2/L3 data fieldshipping_from_zipGateway does not specify.
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data fieldproduct_codeA maximum of 12 characters.
order_dataline_itemsdescriptionA description of the item or product sold. *L2/L3 data fieldproduct_descriptionAn alphanumeric string of up to 26 characters in length.
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction. *L2/L3 data fieldquantityA positive integer greater than 0.
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service. *L2/L3 data fieldunit_costIn cents, as a positive integer greater than 0.
order_dataline_itemstax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldtax_amountIn cents, as a non-negative integer.
order_dataline_itemsdiscount_amountThe reduction or discount price applied to a product or order. *L2/L3 data fielddiscount_amountA non-negative integer.
order_datafulfillment_datefulfillment_dateGateway does not specify.
order_datametadatametadataA string, with key names up to 40 characters long and values up to 500 characters long.
risk_dataignore_fraud_rulesTrue/false indicator to inform the gateway to bypass certain fraud detection rules during a transactionskip_radar_rulesGateway does not specify.

Vantiv eCommerce

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_idGateway does not specify.
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.order_sourceGateway does not specify.
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.order_sourceGateway does not specify.
merchant_metadatatransacting_account_idA unique identifier for each merchant account within a gateway.merchant_accountGateway does not specify.
order_datagateway_idempotency_keyA unique identifier for idempotent transactions to help prevent duplicate transactions.idempotency_keyGateway does not specify.
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.order_idGateway does not specify.
order_datashipping_amountThe cost associated with shipping a product or order to a customer. *L2/L3 data fieldshipping_amountGateway does not specify.
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating. *L2/L3 data fieldshipping_from_zipGateway does not specify.
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data fieldproduct_codeGateway does not specify.
order_dataline_itemsdescriptionA description of the item or product sold. *L2/L3 data fieldproduct_descriptionGateway does not specify.
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction. *L2/L3 data fieldquantityGateway does not specify.
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service. *L2/L3 data fieldunit_costGateway does not specify.
order_dataline_itemstax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldtax_amountGateway does not specify.
order_dataline_itemsdiscount_amountThe reduction or discount price applied to a product or order. *L2/L3 data fielddiscount_amountGateway does not specify.
order_datametadatametadataGateway does not specify.
risk_dataignore_fraud_rulesTrue/false indicator to inform the gateway to bypass certain fraud detection rules during a transactionbypass_avsGateway does not specify.

Worldpay

group_nameparent_field_namespreedly_field_namedescriptiongateway_field_namegateway field validation
customer_datamerchant_customer_idThe merchant's internal reference for the customer.customer_idGateway does not specify.
merchant_metadatastatement_descriptordescriptionA description that appears on the customer's credit card statement, typically used to identify a specific transaction or merchant.order_sourceGateway does not specify.
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.order_sourceGateway does not specify.
merchant_metadatatransacting_account_idA unique identifier for each merchant account within a gateway.merchant_accountGateway does not specify.
order_datagateway_idempotency_keyA unique identifier for idempotent transactions to help prevent duplicate transactions.idempotency_keyGateway does not specify.
order_datainvoice_idA unique identifier assigned to an invoice, typically used by merchants for referencing transactions.order_idGateway does not specify.
order_datashipping_amountThe cost associated with shipping a product or order to a customer. *L2/L3 data fieldshipping_amountGateway does not specify.
order_datashipping_from_zipThe postal or zip code from which a shipment or order is originating. *L2/L3 data fieldshipping_from_zipGateway does not specify.
order_dataline_itemsproduct_codeA unique identifier assigned to reference a specific product or item by the merchant. *L2/L3 data fieldproduct_codeGateway does not specify.
order_dataline_itemsdescriptionA description of the item or product sold. *L2/L3 data fieldproduct_descriptionGateway does not specify.
order_dataline_itemsquantityThe value that represents the number of units purchased or sold in a transaction. *L2/L3 data fieldquantityGateway does not specify.
order_dataline_itemsunit_costThe cost associated with a single unit of a product or service. *L2/L3 data fieldunit_costGateway does not specify.
order_dataline_itemstax_amountThe monetary value representing the amount of tax applied to a product or transaction. *L2/L3 data fieldtax_amountGateway does not specify.
order_dataline_itemsdiscount_amountThe reduction or discount price applied to a product or order. *L2/L3 data fielddiscount_amountGateway does not specify.
order_datametadatametadataGateway does not specify.
risk_dataignore_fraud_rulesTrue/false indicator to inform the gateway to bypass certain fraud detection rules during a transactionbypass_avsGateway does not specify.

Response fields

group_namespreedly_field_namedescriptiongateway_field_namegateway_type
card_metadatacard_typeThe type of card that is issued by the issuing bank.additionalData.fundingSource, details.card_type, debit, source.card_type, cardDetails.accountFoundSource, accountType, point_of_interaction.type, paymentOption.card.cardType, payment_source.card.type, payment_method_details.card.type, funding, enhancedAuthResponse_fundingSource_type, amount_debit_credit_indicator, AccountFundingSourceadyen, airwallex, braintree, checkout_v2, commerce_hub, cyber_source_rest, mercado_pago, nuvei, paypal_commerce_platform, stripe, stripe_payment_intents, vantiv_ecommerce, worldpay, Shift4_v2, Heartland PaymentSystems
card_metadataissuer_countryCountry 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_codeadyen, airwallex, braintree, CardConnect, checkout_v2, commerce_hub, cyber_source_rest, d_local, nuvei, paypal_commerce_platform, Shift4_v2, stripe, stripe_payment_intents, worldpay
merchant_datacustomer_idThe gateway's unique identifier for the customer's card and billing information.customer_id, customer_vault_id, customer.id, customerId, cardholder.identification.number, userTokenId, customer, id, customer, customer_idairwallex, braintree, CardConnect, checkout_v2, cyber_source_rest, mercado_pago, nuvei, Shift4_v2, stripe, stripe_payment_intents, worldpay, Forte
merchant_datafraud_resultThe 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, Z21adyen, airwallex, bpoint, braintree, checkout_v2, cyber_source_rest, decidir, nuvei, stripe, stripe_payment_intents, vantiv_ecommerce, worldpay, Shift4 (Formerly Credorax)
payment_outcome_datafailure_reasonSpreedly'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, status_detail, gwErrorReason, resp_code, details.issue, error.decline_code, transactionResponse.responseCode, error.decline_code, response, iso8583_return_code_code, Z6, RspCode, response.response_codeadyen, airwallex, authorize_net, bpoint, braintree, CardConnect, checkout_v2, commerce_hub, cyber_source, cyber_source_rest, decidir, d_local, ebanx, mercado_pago, nmi, nuvei, orbital, paypal_commerce_platform, payu_latam, Shift4_v2, stripe, stripe_payment_intents, vantiv_ecommerce, worldpay, Shift4 (Formerly Credorax), Heartland PaymentSystem, Forte
payment_outcome_datanetwork_advice_codeSpreedly'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, Z44, CardBrandTxnId, RspCode, response.response_codeadyen, airwallex, braintree, checkout_v2, CardConnect, cyber_source_rest, nuvei, Shift4_v2, stripe, worldpay, Shift4 (Formerly Credorax), Heartland PaymentSystems, Forte
raw_payment_outcome_dataauthorization_codeThe 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, authorization_code, authCode, auth_code, id, payment_method_details.card.authorization_code, transactionResponse.authorizationCode, authorization_code, authCode, authorization_id, Z4, AuthCode, response.authorization_codeadyen, airwallex, authorize_net, bpoint, braintree, CardConnect, checkout_v2, commerce_hub, cyber_source, cyber_source_rest, decidir, d_local, ebanx, mercado_pago, nmi, nuvei, orbital, paypal_commerce_platform, payu_latam, stripe, stripe_payment_intents, vantiv_ecommerce, worldpay, Shift4 (Formerly Credorax), Heartland PaymentSystems, Forte
raw_payment_outcome_datagateway_messageThe 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, status, responsetext, status, status_msg, transactionResponse.state, outcome.seller_message, seller_message, message, iso8583_return_code_description, Z3, GatewayRspMsg, response.response_descadyen, airwallex, authorize_net, bpoint, braintree, braintree, CardConnect, checkout_v2, commerce_hub, cyber_source, cyber_source_rest, decidir, d_local, ebanx, mercado_pago, nmi, nuvei, orbital, paypal_commerce_platform, payu_latam, stripe, stripe_payment_intents, vantiv_ecommerce, worldpay, Shift4_v2, Shift4 (Formerly Credorax), Heartland PaymentSystems, Forte
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, 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, Z1, transaction_idadyen, authorize_net, braintree, checkout_v2, braintree, CardConnect, commerce_hub, cyber_source, cyber_source_rest, d_local, ebanx, nmi, nuvei, orbital, paypal_commerce_platform, stripe, stripe_payment_intents, vantiv_ecommerce, worldpay, Shift4_v2, Shift4 (Formerly Credorax), Forte
raw_payment_outcome_dataprocessor_decline_codeThe 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, Z6, RspCode, response.response_codeadyen, airwallex, authorize_net, bpoint, braintree, CardConnect, commerce_hub, cyber_source, cyber_source_rest, d_local, ebanx, nuvei, stripe, stripe_payment_intents, vantiv_ecommerce, worldpay, Shift4_v2, Shift4 (Formerly Credorax), Heartland PaymentSystems, Forte
raw_payment_outcome_dataraw_avs_resultThe 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, Z9, AVSRsltCode, response.avs_resultadyen, airwallex, authorize_net, braintree, CardConnect, checkout_v2, commerce_hub, cyber_source, cyber_source_rest, nmi, nuvei, orbital, stripe_payment_intents, vantiv_ecommerce, worldpay, Shift4_v2, Shift4 (Formerly Credorax), Heartland PaymentSystems, Forte
raw_payment_outcome_dataraw_cvc_resultThe 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, Z14, CVVRsltCode, response.cvv_codeadyen, airwallex, authorize_net, braintree, CardConnect, checkout_v2, commerce_hub, cyber_source, cyber_source_rest, nmi, nuvei, orbital, stripe, stripe_payment_intents, vantiv_ecommerce, worldpay, Shift4_v2, Shift4 (Formerly Credorax), Heartland PaymentSystems, Forte

Updated 6 days ago