On This Page

{#jumplink-list}  
[Markdown](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-wm-api-fields/sa-response-fields.md)  
Filter  
FILTER BY TAG

Response Fields {#sa-response-fields}
=====================================

Response fields are sent using these notification methods:

* Merchant POST URL. See [Merchant Notifications](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-configuration/sa-merchant-notifications.md "").
* Merchant POST Email. See [Merchant Notifications](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-configuration/sa-merchant-notifications.md "").
* POST to the URL specified in the Transaction or Custom Cancel Response page. See [Customer Response Page](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-configuration/sa-customer-response-pg.md "").

Notification methods are enabled on the Notifications and Customer Response pages of your `Secure Acceptance` profile.  
To ensure the integrity of the response fields, a signature is included in the response. This signature is generated using the same secret_key value that was used to generate the request signature.  
To verify that the response fields have not been tampered with, create a signature using the fields listed in the signed_field_names response field. This signature must be the same value that is included in the signature response field. Refer to the receipt page that is included in the sample scripts. See [Scripting Language Samples](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-samples-scripting-languages.md "").

> Because response fields and reason codes can be added at any time, proceed as follows:
>
> * Parse the response data according to the names of the fields instead of their order in the response. For more information on parsing response fields, see the documentation for your scripting language.
> * The signature that you generate must be the same value that is included in the signature response field.
> * Your error handler should use the decision field to determine the transaction result if it receives a reason code that it does not recognize.
>   {#sa-response-fields_ul_uxy_hb3_15b}  
>   If configured, these response fields are sent back to your Merchant POST URL or email. See [Merchant Notifications](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-configuration/sa-merchant-notifications.md ""). Your error handler should use the decision field to obtain the transaction result if it receives a reason code that it does not recognize.  
>   The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to Cybersource. `Visa Platform Connect` creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.

auth_affluence_indicator
:
**Chase Paymentech Solutions:** Indicates whether a customer has high credit limits. This information enables you to market high-cost items to these customers and to understand the kinds of cards that high-income customers are using.
:
This field is available for Visa, Mastercard, Discover, and Diners Club. Possible values:

    * `Y`: Yes
    * `N`: No
    * `X`: Does not apply/unknown

    {#sa-response-fields_ul_gns_mvg_kgc} **Worldpay VAP:** Flag that indicates that a Visa cardholder or Mastercard cardholder is in one of the affluent categories. Possible values:

    * `AFFLUENT`: High income customer with high spending pattern (\>100k USD annual income and \>40k USD annual card usage).
    * `MASS AFFLUENT`: High income customer (\>100k USD annual income).

    {#sa-response-fields_ul_hns_mvg_kgc} **Data Type \& Length:**

:
* Chase Paymentech Solution: String (1)
* Worldpay VAP: String (13)
{#sa-response-fields_ul_b1m_3kp_nfc}

auth_amount
:
Amount that was authorized.
:
**Data Type \& Length:** String (15)

auth_avs_code
:
AVS result code. See [AVS Codes](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-avs-codes.md "").
:
**Data Type \& Length:** String (1)

auth_avs_code_raw
:
AVS result code sent directly from the processor. Returned only if a value is returned by the processor.
:
**Data Type \& Length:** String (10)

auth_card_commercial
:
Indicates whether the card is a commercial card, which enables you to include Level II data in your transaction requests. Possible values:

    * `Y`: Yes
    * `N`: No
    * `X`: Does not apply/unknown
    This field is available for Visa and Mastercard on Chase Paymentech Solutions.

:
**Data Type \& Length:** String (1)

auth_card_healthcare
:
Indicates whether the card is a healthcare card. Possible values:

    * `Y`: Yes
    * `N`: No
    * `X`: Does not apply/unknown
    This field is available for Visa and Mastercard on Chase Paymentech Solutions.

:
**Data Type \& Length:** String (1)

auth_card_issuer_country
:
Country in which the card was issued. This information enables you to determine whether the card was issued domestically or internationally.
:
This field is available for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase Paymentech Solutions.
:
**Data Type \& Length:** String (3)

auth_card_level_3_eligible
:
Indicates whether the card is eligible for Level III interchange fees, which enables you to include Level III data in your transaction requests. Possible values:

    * `Y`: Yes
    * `N`: No
    * `X`: Does not apply/unknown
    This field is available for Visa and Mastercard on Chase Paymentech Solutions.

:
**Data Type \& Length:** String (1)

auth_card_payroll
:
Indicates whether the card is a payroll card. Possible values:

    * `Y`: Yes
    * `N`: No
    * `X`: Does not apply/unknown
    This field is available for Visa, Discover, Diners Club, and JCB on Chase Paymentech Solutions.

:
**Data Type \& Length:** String (1)

auth_card_prepaid
:
Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or prepaid card is presented for use when establishing a new recurring billing or installment billing relationship. Possible values:

    * `Y`: Yes
    * `N`: No
    * `X`: Does not apply/unknown
    This field is available for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions.

:
**Data Type \& Length:** String (1)

auth_card_regulated
:
Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card issuer is subject to price caps and interchange rules. Possible values:

    * `Y`: Yes (assets greater than $10B)
    * `N`: No (assets less than $10B)
    * `X`: Does not apply/unknown
    This field is available for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions.

:
**Data Type \& Length:** String (1)

auth_card_signature_debit
:
Indicates whether the card is a signature debit card. This information enables you to alter the way an order is processed. Possible values:

    * `Y`: Yes
    * `N`: No
    * `X`: Does not apply/unknown
    This field is available for Visa, Mastercard, and Maestro (International) on Chase Paymentech Solutions.

:
**Data Type \& Length:** String (1)

auth_cavv_result
:
Mapped response code for the Visa Secure and American Express SafeKey:

    * See [Visa Secure Response Codes](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-visa-secure-response-codes.md "").
    * See [American Express SafeKey Response Codes](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-amex-safekey-resp-codes.md "").

    **Data Type \& Length:** String (3)

auth_cavv_result_raw
:
Raw response code sent directly from the processor for Visa Secure and American Express SafeKey.
:
**Data Type \& Length:** String (3)

auth_code
:
Authorization code. Returned only if a value is returned by the processor.
:
**Data Type \& Length:** String (7)

auth_cv_result
:
CVN result code. See [CVN Codes](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-cvn-codes.md "").
:
**Data Type \& Length:** String (1)

auth_cv_result_raw
:
CVN result code sent directly from the processor. Returned only if a value is returned by the processor.
:
**Data Type \& Length:** String (10)

auth_reconciliation_reference_number
:
Unique number that `Cybersource` generates to identify the transaction.
:
**Data Type \& Length:** String (20)

auth_response
:
For most processors, this is the error message sent directly from the bank. Returned only if a value is returned by the processor.
:
**Data Type \& Length:** String (10)

auth_time
:
Time of authorization in UTC.
:
**Data Type \& Length:** String (20)

auth_trans_ref_no
:
Reference number that you use to reconcile your transaction reports with your processor reports.  
For authorization requests, the transaction reference number is returned only for these processors:

    * American Express Direct
    * Asia, Middle East, and Africa Gateway
    * BML Direct
    * Chase Paymentech Solutions
    * China UnionPay
    * Cielo
    * FDC Compass
    * FDC Nashville Global
    * Moneris
    * `Visa Platform Connect`
    * Worldpay VAP
    **Data Type \& Length:**  
    `China UnionPay`: AlphaNumeric (12)

    All other processors: AlphaNumeric (60)

bill_trans_ref_no
:
Reference number that you use to reconcile your transaction reports with your processor reports.  
This field is not available on `Visa Platform Connect`.
:
**Data Type \& Length:** AlphaNumeric (60)

card_type_name
:
Name of the card type.
:
For security reasons, this field is returned only in the merchant POST URL and email notifications (not in the receipt POST through the browser).
:
**Data Type \& Length:** String (50)

decision
:
The result of your request. Possible values:

    * `ACCEPT`
    * `DECLINE`
    * `REVIEW`
    * `ERROR`
    * `CANCEL`

:
**Data Type \& Length:** String (7)

echeck_debit_ref_no
:
Reference number for the transaction.
:
**Data Type \& Length:** AlphaNumeric (60)

echeck_debit_submit_time
:
Time when the debit was requested in UTC.
:
**Data Type \& Length:** Date and Time (20)

invalid_fields
:
Indicates which request fields were invalid.
:
**Data Type \& Length:** Variable

message
:
Response message from the payment gateway.
:
**Data Type \& Length:** String (255)

payer_authentication_acs_transaction_id
:
Unique transaction identifier assigned by the ACS to identify a single transaction.
:
**Data Type \& Length:** String (36)

payer_authentication_cavv
:
Cardholder authentication verification value (CAVV). Transaction identifier generated by the issuing bank. This field is used by the payer authentication validation service.
:
**Data Type \& Length:** String (50)

payer_authentication_challenge_type
:
The type of 3-D Secure transaction flow that occurred. Possible values:

    * `CH`: Challenge
    * `FR`: Frictionless
    * `FD`: Frictionless with delegation (challenge not generated by the issuer but by the scheme on behalf of the issuer).
    Used for Cartes Bancaires transactions.

:
**Data Type \& Length:** String (2)

payer_authentication_eci
:
Electronic commerce indicator (ECI). This field is used by payer authentication validation and enrollment services. Possible values for Visa, American Express, `China UnionPay` and JCB:

    * `05`: Successful authentication.
    * `06`: Authentication attempted.
    * `07`: Failed authentication.

    Possible values for Mastercard:



    * `00`: Failed authentication.
    * `01`: Authentication attempted.
    * `02`: Successful authentication.

    **Data Type \& Length:** String (15)

payer_authentication_enroll_e_commerce_indicator
:
Commerce indicator for cards not enrolled. Possible values:

    * `internet`: Card not enrolled or card type not supported by Payer Authentication. No liability shift.
    * `js_attempted`: JCB card not enrolled, but attempt to authenticate is recorded. Liability shift.
    * `js_failure`: J/Secure directory service is not available. No liability shift.
    * `spa`: Mastercard card not enrolled in the Identity Check program. No liability shift.
    * `up3ds`: China UnionPay card authentication verified successfully.
    * `up3ds_attempted`: China UnionPay card not enrolled, but the attempt to authenticate is recorded.
    * `up3ds_failure:` China UnionPay card authentication unavailable.
    * `vbv_attempted`: Visa card not enrolled, but attempt to authenticate is recorded. Liability shift.
    * `vbv_failure`: For payment processor Barclays, Streamline, or AIBMS, you receive this result if Visa's directory service is not available. No liability shift.

    **Data Type \& Length:** String (255)

payer_authentication_enroll_veres_enrolled
:
Result of the enrollment check. Possible values:

    * `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift.
    * `N`: Card not enrolled; proceed with authorization. Liability shift.
    * `U`: Unable to authenticate regardless of the reason. No liability shift.
    {#sa-response-fields_ul_o1f_vwg_kgc} This field applies only to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request.

:
This value can be returned if you are using rules-based payer authentication:

    * `B`: Indicates that authentication was bypassed.

    {#sa-response-fields_ul_p1f_vwg_kgc} For rules-based payer authentication information, see the [Payer Authentication Guides](https://developer.cybersource.com/docs.md#PayerAuthentication "").

:
**Data Type \& Length:** String (255)

payer_authentication_network_score
:
The global score calculated by the Cartes Bancaires scoring platform and returned to the merchant.
:
**Data Type \& Length:** Integer (2)

payer_authentication_pares_status
:
Raw result of the authentication check. Possible values:

    * `A`: Proof of authentication attempt was generated.
    * `N`: Customer failed or cancelled authentication. Transaction denied.
    * `U`: Authentication not completed regardless of the reason.
    * `Y`: Customer was successfully authenticated.

:
**Data Type \& Length:** String (255)

payer_authentication_pares_status_reason
:
Provides additional information about the PARes status value.
:
**Data Type \& Length:** Integer (2)

payer_authentication_proof_xml
:
XML element containing proof of enrollment verification.
:
For cards not issued in the U.S. or Canada, your bank can require this data as proof of enrollment verification for any payer authentication transaction that you re-submit because of a chargeback.
:
For cards issued in the U.S. or Canada, Visa can require this data for specific merchant category codes.
:
This field is HTML encoded.
:
This field is not returned for 3-D Secure 2.0 transactions.
:
**Data Type \& Length:** String (1024)

payer_authentication_reason_code
:
Numeric value corresponding to the result of the payer authentication request. See [Reason Codes](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-reason-codes.md "").
:
**Data Type \& Length:** String (5)

payer_authentication_specification_version
:
This field contains the 3-D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0.
:
**Data Type \& Length:** String (20)

payer_authentication_transaction_id
:
Payer authentication transaction identifier used by `Secure Acceptance` to link the enrollment check and validate authentication messages.
:
**Data Type \& Length:** String (20)

payer_authentication_type
:
Indicates the type of authentication that is used to challenge the cardholder. Possible values:

    * `01`: Static
    * `02`: Dynamic
    * `03`: OOB (Out of Band)

    **Data Type \& Length:** Integer (2)

payer_authentication_uad
:
Mastercard Identity Check UCAF authentication data. Returned only for Mastercard Identity Check transactions.
:
**Data Type \& Length:** String (32)

payer_authentication_uci
:
Mastercard Identity Check UCAF collection indicator. This field indicates whether authentication data is collected at your website. Possible values:

    * `0`: Authentication data was not collected and customer authentication not completed.
    * `1`: Authentication data was not collected because customer authentication not completed.
    * `2`: Authentication data was collected. Customer completed authentication.

:
**Data Type \& Length:** String (1)

payer_authentication_validate_e_commerce_indicator
:
Indicator that distinguishes Internet transactions from other types. The authentication failed if this field is not returned. For Visa, if your payment processor is Streamline, Barclays, or AIBMS, you receive the value `vbv_failure` instead of internet when payer_authentication_eci is not present.
:
The value of this field is passed automatically to the authorization service if you request the services together. Possible values:

    * `aesk`: American Express SafeKey authentication verified successfully.
    * `aesk_attempted`: Card not enrolled in American Express SafeKey, but the attempt to authenticate was recorded.
    * `internet`: Authentication was not verified successfully.
    * `js`: J/Secure authentication verified successfully.
    * `js_attempted`: JCB card not enrolled in J/Secure, but the attempt to authenticate was recorded.
    * `spa`: Mastercard Identity Check authentication verified successfully.
    * `spa_failure`: Mastercard Identity Check failed authentication.
    * `vbv`: Visa Secure authentication verified successfully.
    * `vbv_attempted`: Card not enrolled in Visa Secure, but the attempt to authenticate was recorded.
    * `vbv_failure`: Visa Secure authentication unavailable.
    {#sa-response-fields_ul_cyp_bxg_kgc}

:
**Data Type \& Length:** String (255)

payer_authentication_validate_result
:
Raw authentication data that comes from the card-issuing bank that indicates whether authentication was successful and whether liability shift occurred. Possible values:

    * `-1`: Invalid PARes.
    * `0`: Successful validation.
    * `1`: Cardholder is not participating, but the attempt to authenticate was recorded.
    * `6`: Issuer unable to perform authentication.
    * `9`: Cardholder did not complete authentication.

    **Data Type \& Length:** String (255)

payer_authentication_white_list_status
:
Enables the communication of trusted beneficiary and whitelist status among the ACS, the directory server, and the 3-D Secure requester. Possible Values:

    * `Y`: 3-D Secure requester is whitelisted by cardholder
    * `N`: 3-D Secure requester is not whitelisted by cardholder

    **Data Type \& Length:** String (1)

payer_authentication_white_list_status_source
:
This field is populated by the system setting whitelist status. Possible Values:

    * `01`: 3-D Secure Server
    * `02`: Directory server
    * `03`: ACS

    **Data Type \& Length:** Integer (2)

payer_authentication_xid
:
Transaction identifier generated by payer authentication. Used to match an outgoing payer authentication request with an incoming payer authentication response.
:
**Data Type \& Length:** String (28)

payment_account_reference
:
Reference number serves as a link to the cardholder account and to all transactions for that account. The same value is returned whether the account is represented by a PAN or a network token.
:
**Data Type \& Length:** String (32)

payment_solution
:
Type of credential-on-file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. Possible values:

    * `014`: Mastercard
    * `015`: Visa
    * `016`: American Express

    **Data Type \& Length:** String (3)

payment_token
:
Identifier for the payment details. The payment token retrieves the card data, billing information, and shipping information from the payment repository.
:
This payment token supersedes the previous payment token and is returned if:

    * The merchant is configured for a 16-digit payment token that displays the last four digits of the primary account number (PAN) and passes Luhn mod-10 check. See [Payment Tokens](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/home-merch/sa-payment-tokens.md "").
    * The customer has updated the card number on their payment token. This payment token supersedes the previous payment token and should be used for subsequent transactions.
    {#sa-response-fields_ul_uzw_kxg_kgc} You must be using Token Management Services.

:
**Data Type \& Length:** String (32)

payment_token_instrument_identifier_id
:
Unique identifier for the `Token Management Service` (`TMS`) instrument identifier token. You can use it to understand when the same PAN is being used in different tokens, without being exposed to the PAN.
:
**Data Type \& Length:** String (32)

payment_token_instrument_identifier_new
:
Indicates whether the tokenized credential already exists as an Instrument Identifier or is a new credential. Possible values:

    * `Y`
    * `N`

:
**Data Type \& Length:** String (1)

payment_token_instrument_identifier_status
:
Issuer's status for the card number. If you use Account Updater, the status can be updated to *closed* if the PAN is not longer active. If you use network tokenization, the PAN might be *closed* (e.g. lost card), but the network token might still be active. Possible values:

    * `ACTIVE`
    * `CLOSED`: The card account is closed.

:
**Data Type \& Length:** String (6)

payment_token_latest_card_expiry_date
:
Card expiration date of the latest card issued to the cardholder.
:
Returned when Network Tokenization is enabled, and a payment_token with an associated Network Token is used in a transaction. Network Tokens can continue to be used even if the original card has expired.
:
Format: MM-yyyy
:
**Data Type \& Length:** Date (a) (7)

payment_token_latest_card_suffix
:
Last four digits of the latest card issued to the cardholder.
:
Returned when Network Tokenization is enabled, and a payment_token with an associated Network Token is used in a transaction. Network Tokens can continue to be used even if the original card number has changed due to a new card being issued. Use the last four digits in payment confirmation messages to cardholders, for example: "Thank you for your payment using your Visa card ending \[payment_token_latest_card_suffix\]".
:
**Data Type \& Length:** String (4)

paypal_address_status
:
Status of the street address on file with PayPal. Possible values:

    * `None`
    * `Confirmed`
    * `Unconfirmed`

    **Data Type \& Length:** String (12)

paypal_authorization_correlation_id
:
PayPal identifier that is used to investigate any issues.
:
**Data Type \& Length:** String (20)

paypal_authorization_transaction_id
:
Unique identifier for the transaction.
:
**Data Type \& Length:** String (17)

paypal_customer_email
:
Email address of the customer as entered during checkout. PayPal uses this value to pre-fill the PayPal membership sign-up portion of the PayPal login page.
:
**Data Type \& Length:** String (127)

paypal_do_capture_correlation_id
:
PayPal identifier that is used to investigate any issues.
:
**Data Type \& Length:** String (20)

paypal_do_capture_transaction_id
:
Unique identifier for the transaction.
:
**Data Type \& Length:** String (17)

paypal_ec_get_details_correlation_id
:
PayPal identifier that is used to investigate any issues.
:
**Data Type \& Length:** String (20)

paypal_ec_get_details_request_id
:
Value of the request ID returned from a PayPal get details service request.
:
**Data Type \& Length:** String (26)

paypal_ec_get_details_transaction_id
:
Unique identifier for the transaction.
:
**Data Type \& Length:** String (17)

paypal_ec_order_setup_correlation_id
:
PayPal identifier that is used to investigate any issues.
:
**Data Type \& Length:** String (20)

paypal_ec_order_setup_transaction_id
:
Unique identifier for the transaction.
:
**Data Type \& Length:** String (17)

paypal_ec_set_request_id
:
Value of the request ID returned from a PayPal set service request.
:
**Data Type \& Length:** String (26)

paypal_fee_amount
:
PayPal fee charged for the transaction. This value does not exceed the equivalent of 10,000 USD in any currency and does not include a currency symbol. The decimal separator is a period (.), and the optional thousands separator is a comma (,).
:
**Data Type \& Length:** String (9)

paypal_order_request_id
:
Value of the request ID returned from a PayPal order setup service request.
:
**Data Type \& Length:** String (26)

paypal_payer_id
:
Customer's PayPal account identification number.
:
Alphanumeric  
**Data Type \& Length:** String (13)

paypal_payer_status
:
Customer's status. Possible values:

    * `verified`
    * `unverified`

    **Data Type \& Length:** String (10)

paypal_pending_reason
:
Indicates the reason that payment is pending. Possible values:

    * `address`: Your customer did not include a confirmed shipping address, and your Payment Receiving preferences are set to manually accept or deny such payments. To change your preferences, go to the Preferences section of your PayPal profile.
    * `authorization`: The payment has been authorized but not settled. Capture the authorized amount.
    * `electronic check`: Payment was made by an echeck that has not yet cleared.
    * `intl`: You have a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment in your PayPal Account Overview.
    * `multi-currency`: You do not have a balance in the currency sent, and your Payment Receiving preferences are not set to automatically convert and accept this payment. You must manually accept or deny this payment in your PayPal Account Overview.
    * `none`: No pending reason.
    * `order`: The payment is part of an order that has been authorized but not settled.
    * `paymentreview`: The payment is being reviewed by PayPal for possible fraud.
    * `unilateral`: The payment was made to an email address that is not registered or confirmed.
    * `verify`: Your account is not yet verified. You must verify your account before you can accept this payment.

    **Data Type \& Length:** String (14)

paypal_pending_status
:
Status of the transaction. Possible values:

    * `Canceled-Reversal`: PayPal canceled the reversal, which happens when you win a dispute, and the funds for the reversal are returned to you.
    * `Completed`: PayPal completed the payment and added the funds to your account.
    * `Denied`: You denied a payment, which happens only if the payment was pending for the reason indicated in the reason_code field.
    * `Expired`: The authorization expired.
    * `Failed`: The payment failed. This event can happen only when the payment is made from your customer's bank account.
    * `In-Progress`: The transaction is not complete yet.
    * `None`: No status.
    * `Partially-Refunded`: The payment was partially refunded.
    * `Pending`: The payment is pending for the reason indicated in the paypal_pending_reason field.
    * `Processed`: PayPal accepted the payment.
    * `ReasonCode`
    * `Refunded`: You refunded the payment.

    **Data Type \& Length:** String (20)

paypal_pending_status
:
Continued status of the transaction. Possible values:

    * `Reversed`: PayPal reversed the payment for the reason specified in the reason_code field. The funds were transferred from your account to the customer's account.
    * `Voided`: The authorization was voided.

:
**Data Type \& Length:** String (20)

paypal_protection_eligibility
:
Seller protection in force for the transaction. Possible values:

    * `Eligible`: You are protected by the PayPal Seller Protection Policy for unauthorized payment and item not received.
    * `PartiallyEligible`: You are protected by the PayPal Seller Protection Policy for item not received.
    * `Ineligible`: You are not protected under the PayPal Seller Protection Policy.

    **Data Type \& Length:** String (17)

paypal_protection_eligibility_type
:
Seller protection in force for the transaction. Possible values:

    * `Eligible`: You are protected by the PayPal Seller Protection Policy for unauthorized payment and item not received.
    * `ItemNotReceivedEligible`: You are protected by the PayPal Seller Protection Policy for item not received.
    * `UnauthorizedPaymentEligible`: You are protected by the PayPal Seller Protection Policy for unauthorized payment.
    * `Ineligible`: You are not protected under the PayPal Seller Protection Policy.

    To enable the paypal_protection_eligibility_type field, contact customer support to have your account configured for this feature.

:
**Data Type \& Length:** String (32)

paypal_request_id
:
Identifier for the request generated by the client.
:
**Data Type \& Length:** String (26)

paypal_token
:
Timestamped PayPal token that identifies that PayPal Express Checkout is processing the transaction. Save this value to send in future request messages.
:
**Data Type \& Length:** String (20)

paypal_transaction_type
:
Indicates the PayPal transaction type. Possible value: `expresscheckout`
:
**Data Type \& Length:** String (16)

reason_code
:
Numeric value corresponding to the result of the payment card transaction request. See [Reason Codes](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-reason-codes.md "").
:
**Data Type \& Length:** String (5)

req_access_key
:
Authenticates the merchant with the application.
:
**Data Type \& Length:** String (32)

req_aggregator_id
:
Value that identifies you as a payment aggregator. Obtain this value for the processor.
:
**`Visa Platform Connect`:** The value for this field corresponds to this data in the TC 33 capture file:

    * Record: CP01 TCR6
    * Position: 95-105
    * Field: Mastercard Payment Facilitator ID

    {#sa-response-fields_ul_xt4_xxg_kgc} **FDC Compass:** This value must consist of uppercase characters.

:
**Data Type \& Length:** String

    * American Express Direct: 20
    * FDC Compass: 20
    * FDC Nashville Global: 15
    * `Visa Platform Connect`: 11
    {#sa-response-fields_ul_ysg_dyg_kgc}

req_amount
:
Total amount for the order. Must be greater than or equal to zero.
:
**Data Type \& Length:** String (15)

req_auth_indicator
:
Flag that specifies the purpose of the authorization. Possible values:

    * `0`: Preauthorization
    * `1`: Final authorization
    Mastercard requires European merchants to indicate whether the authorization is a final authorization or a preauthorization. To set the default for this field, contact customer support.

:
**Data Type \& Length:** String (1)

req_auth_type
:
Authorization type. Possible values:

    * `AUTOCAPTURE`: Automatic capture.
    * `STANDARDCAPTURE`: Standard capture.
    * `verbal`: Forced capture.

:
***Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and Cybersource Latin American Processing*:** Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture.
:
***Forced Capture*** Set this field to `verbal` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the transaction processing system.
:
***Verbal Authorization*** Set this field to `verbal` and include it in the capture request to indicate that the request is for a verbal authorization.
:
**Data Type \& Length:** Cielo, Comercio Latino, and Cybersource Latin American Processing: String (15)  
All other processors: String (11)

req_bill_payment
:
Flag that indicates a payment for a bill or for an existing contractual loan. Visa provides a Bill Payment program that enables customers to use their Visa cards to pay their bills. Possible values:

    * `true`: Bill payment or loan payment.
    * `false` (default): Not a bill payment or loan payment.

    **Data Type \& Length:** String (5)

req_bill_to_address_city
:
City in the billing address.
:
**Data Type \& Length:** String (50)

req_bill_to_address_country
:
ISO country code for the billing address.
:
**Data Type \& Length:** String (2)

req_bill_to_address_line1
:
First line of the street address in the billing address.
:
**Data Type \& Length:** String (60)

req_bill_to_address_line2
:
Second line of the street address in the billing address.
:
**Data Type \& Length:** String (60)

req_bill_to_address_postal_code
:
Postal code for the billing address. This field is returned if bill_to_address_country is U.S. or Canada.
:
**Data Type \& Length:** String (10)

req_bill_to_address_state
:
The state or province for the bill-to address. For the United States and Canada, the two-character ISO state and province code is returned. See *[State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/content/dam/docs/cybs/en-us/state-codes/reference/all/na/state-codes.pdf "")*.
:
**Data Type \& Length:** String (20)

req_bill_to_company_name
:
Name of the customer's company.
:
**Data Type \& Length:** String (60)

req_bill_to_email
:
Customer email address.
:
**Data Type \& Length:** String (255)

req_bill_to_forename
:
Customer first name.
:
**Data Type \& Length:** String (60)

req_bill_to_phone
:
Customer phone number.
:
**Data Type \& Length:** String (15)

req_bill_to_surname
:
Customer last name.
:
**Data Type \& Length:** String (60)

req_card_account_type
:
Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process.
:
**Cielo and Comercio Latino** possible values:

    * `CR`: Credit card
    * `DB`: Debit card

    {#sa-response-fields_ul_d1s_5yg_kgc} **`Visa Platform Connect`** possible values:

    * `CH`: Checking account
    * `CR`: Credit card account
    * `SA`: Savings account

    {#sa-response-fields_ul_e1s_5yg_kgc} This field is returned for:



    * Debit transactions on Cielo and Comercio Latino.
    * Transactions with Brazilian-issued cards on `Visa Platform Connect`.
    {#sa-response-fields_ul_f1s_5yg_kgc} Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. It is strongly recommended that you include this field for combo card transactions.

:
**Data Type \& Length:** String (2)

req_card_expiry_date
:
Card expiration date.
:
**Data Type \& Length:** String (7)

req_card_number
:
Card number.
:
**Data Type \& Length:** String (20)

req_card_type
:
Type of card.
:
**Data Type \& Length:** String (3)

req_company_tax_id
:
Company's tax identifier. The last four digits are not masked.
:
**Data Type \& Length:** String (9)

req_complete_route
:
Concatenation of individual travel legs in the format: SFO-JFK:JFK-LHR:LHR-CDG.
:
For a complete list of airport codes, see [IATA's City Code Directory](https://www.iata.org/en/publications/directories/code-search/ "").
:
In your request, send either the complete route field or the individual legs (journey_leg#_orig and journey_leg#_dest). If you send all the fields, the value of complete_route takes precedence over that of the journey_leg# fields.
:
**Data Type \& Length:** String (255)

req_consumer_id
:
Identifier for the customer account. This value is defined when creating a customer token.
:
**Data Type \& Length:** String (100)

req_currency
:
Currency used for the order. See [ISO currency codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf "")
:
**Data Type \& Length:** String (3)

req_customer_cookies_accepted
:
Indicates whether the customer's browser accepts cookies. Possible values:

    * `true`: Customer browser accepts cookies.
    * `false`: Customer browser does not accept cookies.

    **Data Type \& Length:** String (5)

req_customer_gift_wrap
:
Indicates whether the customer requested gift wrapping for this purchase. Possible values:

    * `true`: Customer requested gift wrapping.
    * `false`: Customer did not request gift wrapping.

    **Data Type \& Length:** String (5)

req_customer_ip_address
:
Customer IP address reported by your web server using socket information.

req_date_of_birth
:
Date of birth of the customer.
:
Format: yyyyMMDD.
:
**Data Type \& Length:** String (8)

req_debt_indicator
:
Flag that indicates a payment for an existing contractual loan under the VISA Debt Repayment program. Contact your processor for details and requirements. Possible formats:

    * `false` (default): Not a loan payment
    * `true`: Loan payment

    **Data Type \& Length:** String (5)

req_departure_time
:
Departure date and time of the first leg of the trip. Use one of these formats:

    * yyyy-MM-DD HH:mm z
    * yyyy-MM-DD hh:mm a z
    * yyyy-MM-DD hh:mma z
    * HH = 24-hour format
    * hh = 12-hour format
    * a = am or pm (case insensitive)
    * z = time zone of the departing flight.

    **Data Type \& Length:** String (29)

req_device_fingerprint_id
:
Field that contains the session ID for the fingerprint. The **Data Type \& Length:** String can contain uppercase and lowercase letters, digits, and these special characters: hyphen (-) and underscore (_).
:
However, do not use the same uppercase and lowercase letters to indicate different sessions IDs.
:
The session ID must be unique for each merchant ID. You can use any **Data Type \& Length:** String that you are already generating, such as an order number or web session ID.
:
**Data Type \& Length:** String (88)

req_driver_license_number
:
Driver's license number of the customer. The last four digits are not masked.
:
**Data Type \& Length:** String (30)

req_driver_license_state
:
State or province from which the customer's driver's license was issued.
:
**Data Type \& Length:** String (2)

req_e_commerce_indicator
:
The commerce indicator for the transaction type.
:
Value: `install`
:
This field is returned only for installment payments on Cybersource Latin American Processing.
:
**Data Type \& Length:** String (13)

req_echeck_account_number
:
Account number. This number is masked.
:
**Data Type \& Length:** Non-negative integer (17)

req_echeck_account_type
:
Account type. Possible values:

    * `C`: Checking
    * `S`: Savings (USD only)
    * `X`: Corporate checking (USD only)

:
**Data Type \& Length:** String (1)

req_echeck_check_number
:
Check number.
:
**Data Type \& Length:** Integer (8)

req_echeck_effective_date
:
Effective date for the transaction.
:
**Data Type \& Length:** Date (b) String (8)

req_echeck_routing_number
:
Bank routing number. It is also called the transit number.
:
**Data Type \& Length:** Non-negative integer (9)

req_echeck_sec_code
:
The authorization method for the transaction. Possible values:

    * `CCD`
    * `PPD`
    * `TEL`
    * `WEB`

    **Data Type \& Length:** String (3)

req_ignore_avs
:
Ignore the results of AVS verification. Possible values:

    * `true`
    * `false`

    **Data Type \& Length:** String (5)

req_ignore_cvn
:
Ignore the results of CVN verification. Possible values:

    * `true`
    * `false`

    **Data Type \& Length:** String (5)

req_installment_total_amount
:
Total amount of the loan that is being paid in installments.
:
This field is returned only for installment payments on Cybersource Latin American Processing or `Visa Platform Connect`.
:
**Data Type \& Length:** Amount (12)

req_installment_total_count
:
Total number of installment payments as part of an authorization. Possible values: `1` to `99`.
:
This field is returned only for installment payments on Cybersource Latin American Processing.
:
**Data Type \& Length:** Numeric String (2)

req_issuer_additional_data
:
Data defined by the issuer. See the "Discretionary Data" section in [*Credit Card Services Optional Features Supplement*](https://developer.cybersource.com/content/dam/new-documentation/documentation/en/credit-card/supplement/credit-card-services-optional-features-so.pdf "").
:
**Data Type \& Length:** Alphanumeric String (256)

req_item_#_code
:
Type of product. # can range from `0` to `199`.
:
**Data Type \& Length:** String (255)

req_item_#_description
:
Description of the item. # can range from `0` to `199`.
:
**Data Type \& Length:** String (255)

req_item_#_name
:
Name of the item. # can range from `0` to `199`.
:
**Data Type \& Length:** String (255)

req_item_#_passenger_email
:
Passenger's email address.
:
**Data Type \& Length:** String (255)

req_item_#_passenger_forename
:
Passenger's first name.
:
**Data Type \& Length:** String (60)

req_item_#_passenger_id
:
ID of the passenger to whom the ticket was issued. For example, you can use this field for the frequent flyer number.
:
**Data Type \& Length:** String (32)

req_item_#_passenger_phone
:
Passenger's phone number. If the order is from outside the U.S., it is recommended that you include the country code.
:
**Data Type \& Length:** String (15)

req_item_#_passenger_status
:
Your company's passenger classification, such as with a frequent flyer classification. In this case, you might use values such as standard, gold, or platinum.
:
**Data Type \& Length:** String (32)

req_item_#_passenger_surname
:
Passenger's last name.
:
**Data Type \& Length:** String (60)

req_item_#_passenger_type
:
Passenger classification associated with the price of the ticket. Possible values:

    * `ADT`: Adult
    * `CNN`: Child
    * `INF`: Infant
    * `YTH`: Youth
    * `STU`: Student
    * `SCR`: Senior Citizen
    * `MIL`: Military

    **Data Type \& Length:** String (32)

req_item_#_quantity
:
Quantity of line items. # can range from `0` to `199`.
:
**Data Type \& Length:** String (10)

req_item_#_sku
:
Identification code for the product. # can range from `0` to `199`.
:
**Data Type \& Length:** String (255)

req_item_#_tax_amount
:
Tax amount to apply to the line item. # can range from `0` to `199`. This value cannot be negative. The tax amount and the offer amount must be in the same currency.
:
**Data Type \& Length:** String (15)

req_item_#_unit_price
:
Price of the line item. # can range from `0` to `199`. This value cannot be negative.
:
**Data Type \& Length:** String (15)

req_journey_leg#_dest
:
Airport code for the origin of the leg of the trip, designated by the pound (#) symbol in the field name. For a complete list of airport codes, see [IATA's City Code Directory](https://www.iata.org/en/publications/directories/code-search/ "").
:
**Data Type \& Length:** String (3)

req_journey_leg#_orig
:
Airport code for the origin of the leg of the trip, designated by the pound (#) symbol in the field name. This code is usually three digits long; for example: SFO = San Francisco. For a complete list of airport codes, see [IATA's City Code Directory](https://www.iata.org/en/publications/directories/code-search/ "").
:
**Data Type \& Length:** String (3)

req_journey_type
:
Type of travel, such as one way or round trip.
:
**Data Type \& Length:** String (32)

req_jpo_installments
:
Total number of Japanese installment payments.
:
**Data Type \& Length:** String (2)

req_jpo_payment_method
:
Japanese payment method.
:
**Data Type \& Length:** String (1)

req_line_item_count
:
Total number of line items. Maximum amount is 200.
:
**Data Type \& Length:** String (3)

req_locale
:
Indicates the language to use for customer content. See [Activating a Profile](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-activate-profile.md "").
:
**Data Type \& Length:** String (5)

req_merchant_defined_data#
:
Optional fields that you can use to store information. # can range from `1` to `100`.
:
Merchant-defined data fields `1` to `4` are associated with the payment token and are used for subsequent token-based transactions. Merchant-defined data fields `5` to `100` are passed through to `Decision Manager` as part of the initial payment request and are not associated with the payment token.
> Merchant-defined data fields are not intended to and MUST NOT be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields and any ` Secure Acceptance ` field that is not specifically designed to capture personally identifying information.
Personally identifying information includes, but is not limited to, card number, bank account number, social security number, driver's license number, state-issued identification number, passport number, card verification numbers (CVV, CVC2, CVV2, CID, CVN). If it is discovered that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, the merchant's account WILL immediately be suspended, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.
:
**Data Type \& Length:** String (100)

req_merchant_descriptor
:
Your business name. This name appears on the cardholder's statement.
:
**Data Type \& Length:** String (23)

req_merchant_descriptor_alternate
:
Alternate contact information for your business, such as an email address or URL. This value might appear on the cardholder's statement.
:
**Data Type \& Length:** String (13)

req_merchant_descriptor_city
:
City for your business location. This value might appear on the cardholder's statement.
:
**Data Type \& Length:** String (13)

req_merchant_descriptor_contact
:
Telephone number for your business. This value might appear on the cardholder's statement.
:
**Data Type \& Length:** String (14)

req_merchant_descriptor_country
:
Country code for your business location. Use the standard ISO Standard Country Codes. This value might appear on the cardholder's statement.
:
**Data Type \& Length:** String (2)

req_merchant_descriptor_postal_code
:
Postal code for your business location. This value might appear on the cardholder's statement.
:
**Data Type \& Length:** String (14)

req_merchant_descriptor_state
:
State code or region code for your business location. This value might appear on the cardholder's statement.
:
**Data Type \& Length:** String (3)

req_merchant_descriptor_street
:
Street address for your business location. This value might appear on the cardholder's statement.
:
**Data Type \& Length:** String (60)

req_merchant_secure_data1
:
Optional field that you can use to store information. The data is encrypted before it is stored in the payment repository.
:
**Data Type \& Length:** String (100)

req_merchant_secure_data2
:
Optional field that you can use to store information. The data is encrypted before it is stored in the payment repository.
:
**Data Type \& Length:** String (100)

req_merchant_secure_data3
:
Optional field that you can use to store information. The data is encrypted before it is stored in the payment repository.
:
**Data Type \& Length:** String (100)

req_merchant_secure_data4
:
Optional field that you can use to store information. The data is encrypted before it is stored in the payment repository.
:
**Data Type \& Length:** String (2000)

req_override_backoffice_post_url
:
Overrides the backoffice post URL profile setting with your own URL.
:
**Data Type \& Length:** URL (255)

req_override_custom_cancel_page
:
Overrides the custom cancel page profile setting with your own URL.
:
**Data Type \& Length:** URL (255)

req_override_custom_receipt_page
:
Overrides the custom receipt profile setting with your own URL.
:
**Data Type \& Length:** URL (255)

req_payment_method
:
Method of payment. Possible values:

    * `card`
    * `echeck`
    * `paypal`

    **Data Type \& Length:** String (30)

req_payment_token
:
Identifier for the payment details. The payment token retrieves the card data, billing information, and shipping information from the payment repository. When this field is included in the request, the card data and billing and shipping information are optional.
:
You must be currently using the Token Management Service.
:
**Data Type \& Length:** String (32)

req_payment_token_comments
:
Optional comments about the customer token.
:
**Data Type \& Length:** String (255)

req_payment_token_title
:
Name of the customer token.
:
**Data Type \& Length:** String (60)

req_profile_id
:
Identifies the profile to use with each transaction.
:
**Data Type \& Length:** String (36)

req_promotion_code
:
Promotion code included in the transaction.
:
**Data Type \& Length:** String (100)

req_recipient_account_id
:
Identifier for the recipient's account. Use the first six digits and last four digits of the recipient's account number.
:
**Data Type \& Length:** Numeric String (10)

req_recipient_date_of_birth
:
Recipient's date of birth.
:
Format: yyyyMMDD.
:
**Data Type \& Length:** Date (b) String (8)

req_recipient_postal_code
:
Partial postal code for the recipient's address.
:
**Data Type \& Length:**Alphanumeric String (6)

req_recipient_surname
:
Recipient's last name.
:
**Data Type \& Length:** Alpha String (6)

req_recurring_amount
:
Payment amount for each installment or recurring subscription payment.
:
**Data Type \& Length:** String (15)

req_recurring_automatic_renew
:
Indicates whether to automatically renew the payment schedule for an installment subscription. Possible values:

    * `true` (default): Automatically renew.
    * `false`: Do not automatically renew.

    **Data Type \& Length:** Enumerated String (5)

req_recurring_frequency
:
Frequency of payments for an installment or recurring subscription.
:
**Data Type \& Length:** String (20)

req_recurring_number_of_installments
:
Total number of payments set up for an installment subscription.
:
**Data Type \& Length:** String (3)

req_recurring_start_date
:
First payment date for an installment or recurring subscription payment.
:
**Data Type \& Length:** String (8)

req_reference_number
:
Unique merchant-generated order reference or tracking number for each transaction.
:
**Data Type \& Length:** String (50)

req_returns_accepted
:
Indicates whether product returns are accepted. Possible values:

    * `true`
    * `false`

    **Data Type \& Length:** String (5)

req_sales_organization_id
:
Company ID assigned to an independent sales organization. Obtain this value from Mastercard.
:
**`Visa Platform Connect`** : The value for this field corresponds to this data in the TC 33 capture file:

    * Record: CP01 TCR6
    * Position: 106-116
    * Field: Mastercard Independent Sales Organization ID

    {#sa-response-fields_ul_qzw_vch_kgc} **Data Type \& Length:** Nonnegative integer (11)

req_ship_to_address_city
:
City of shipping address.
:
**Data Type \& Length:** String (50)
:
`Visa Click to Pay`: String (100)

req_ship_to_address_country
:
The two-character ISO country code.
:
**Data Type \& Length:** String (2)

req_ship_to_address_line1
:
First line of shipping address.
:
**Data Type \& Length:** String (60)
:
`Visa Click to Pay`: String (100)

req_ship_to_address_line2
:
Second line of shipping address.
:
**Data Type \& Length:** String (60)
:
`Visa Click to Pay`: String (100)

req_ship_to_address_postal_code
:
Postal code for the shipping address.
:
**Data Type \& Length:** String (10)
:
`Visa Click to Pay`: String (100)

req_ship_to_address_state
:
The two-character *[State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/content/dam/docs/cybs/en-us/state-codes/reference/all/na/state-codes.pdf "")*.
:
**Data Type \& Length:** String (2)

req_ship_to_company_name
:
Name of the company receiving the product.
:
**Data Type \& Length:** String (40)

req_ship_to_forename
:
First name of person receiving the product.
:
**Data Type \& Length:** String (60)
:
`Visa Click to Pay`: String (256)

req_ship_to_phone
:
Phone number for the shipping address.
:
**Data Type \& Length:** String (15)
:
`Visa Click to Pay`: String (30)

req_ship_to_surname
:
Last name of person receiving the product.
:
**Data Type \& Length:** String (60)
:
`Visa Click to Pay`: String (256)

req_shipping_method
:
Shipping method for the product. Possible values:

    * `sameday`: Courier or same-day service
    * `oneday`: Next day or overnight service
    * `twoday`: Two-day service
    * `threeday`: Three-day service
    * `lowcost`: Lowest-cost service
    * `pickup`: Store pick-up
    * `other`: Other shipping method
    * `none`: No shipping method

    **Data Type \& Length:** String (10)

req_skip_decision_manager
:
Indicates whether to skip `Decision Manager`. Possible values:

    * `true`
    * `false`

:
**Data Type \& Length:** String (5)

req_submerchant_city
:
Sub-merchant's city.
:
**Data Type \& Length:**

    * American Express Direct: String (15)
    * FDC Compass: String (21)
    * FDC Nashville Global: String (11)
    {#sa-response-fields_ul_khl_3lp_nfc}

req_submerchant_country
:
Sub-merchant's country.
:
**Data Type \& Length:** String (3)

req_submerchant_email
:
Sub-merchant's email address.
:
**`Visa Platform Connect`:** With American Express, the value for this field corresponds to this data in the TC 33 capture file:

    * Record: CP01 TCRB
    * Position: 25-64
    * Field: American Express Seller E-mail Address

    {#sa-response-fields_ul_iqq_hdh_kgc} **Data Type \& Length:**

    * American Express Direct: String (40)
    * FDC Compass: String (40)
    * FDC Nashville Global: String (19)
    * `Visa Platform Connect`: String (40)
    {#sa-response-fields_ul_vpg_llp_nfc}

req_submerchant_id
:
The ID you assigned to your sub-merchant.
:
**`Visa Platform Connect`:**  
With American Express, the value for this field corresponds to this data in the TC 33 capture file:

    * Record: CP01 TCRB
    * Position: 65-84
    * Field: American Express Seller ID

    {#sa-response-fields_ul_ywj_ldh_kgc}With Mastercard, the value for this field corresponds to this data in the TC 33 capture file:



    * Record: CP01 TCR6
    * Position: 117-131
    * Field: Mastercard Sub-Merchant ID
    {#sa-response-fields_ul_zwj_ldh_kgc}

:
**Data Type \& Length:**

    * American Express Direct: String (20)
    * FDC Compass: String (20)
    * FDC Nashville Global: String (14)
    * `Visa Platform Connect` with American Express: String (20)
    * `Visa Platform Connect` with Mastercard: String (15)
    {#sa-response-fields_ul_uxv_nlp_nfc}

req_submerchant_name
:
Sub-merchant's business name.
:
**Data Type \& Length:**

    * American Express Direct: String (37)
    * FDC Compass with American Express: String (19)
    * FDC Compass with Mastercard: String (37)
    * FDC Nashville Global: String (12)
    {#sa-response-fields_ul_snz_qlp_nfc}

req_submerchant_phone
:
Sub-merchant's telephone number.
:
**`Visa Platform Connect`:** With American Express, the value for this field corresponds to this data in the TC 33 capture file:

    * Record: CP01 TCRB
    * Position: 5-24
    * Field: American Express Seller Telephone Number
    {#sa-response-fields_ul_zww_4dh_kgc}

:
**Data Type \& Length:**

    * American Express Direct: String (20)
    * FDC Compass: String (13)
    * FDC Nashville Global: String (10)
    * `Visa Platform Connect`: String (20)
    {#sa-response-fields_ul_xbj_tlp_nfc}

req_submerchant_postal_code
:
Partial postal code for the sub-merchant's address.
:
**Data Type \& Length:**

    * American Express Direct: String (9)
    * FDC Compass: String (15)
    * FDC Nashville Global: String (9)
    {#sa-response-fields_ul_d3l_2kp_nfc}

req_submerchant_state
:
Sub-merchant's state or province.
:
**Data Type \& Length:** String (2)

req_submerchant_street
:
First line of the sub-merchant's street address.
:
**Data Type \& Length:**

    * American Express Direct: String (30)
    * FDC Compass: String (38)
    * FDC Nashville Global: String (25)
    {#sa-response-fields_ul_jy3_vlp_nfc}

req_tax_amount
:
Total tax to apply to the product.
:
**Data Type \& Length:** String (15)

req_transaction_type
:
The type of transaction requested.
:
**Data Type \& Length:** String (60)

req_transaction_uuid
:
Unique merchant-generated identifier. Include with the access_key field for each transaction.
:
**Data Type \& Length:** String (50)
:
`Visa Click to Pay`: String (100)

request_token
:
Request token data created for each response. This field is an encoded string that contains no confidential information.
:
You must store the request token value so that you can retrieve and send it in follow-on requests.
:
**Data Type \& Length:** String (256)

required_fields
:
Indicates which of the request fields were required but not provided.
:
**Data Type \& Length:** Variable

service_fee_amount
:
The service fee amount for the order.
:
**Data Type \& Length:** String (15)

service_fee_return_url
:
URL to POST the conditions_accepted field value to. See [Service Fees](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-portfolio-reseller-mgmt/sa-service-fees.md "").

signature
:
The Base64 signature returned by the server.
:
**Data Type \& Length:** String (44)

signed_date_time
:
The date and time of when the signature was generated by the server. Format: yyyy-MM-DDThh:mm:ssZ.
:
**Example:** 2020-08-11T22:47:57Z equals August 11, 2020, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC.
:
**Data Type \& Length:** String (20)

signed_field_names
:
A comma-separated list of response data that was signed by the server. All fields within this list should be used to generate a signature that can then be compared to the response signature to verify the response.
:
**Data Type:** Variable

transaction_id
:
The transaction identifier returned from the payment gateway.
:
**Data Type \& Length:** String (26)

utf8
:
Indicates whether the unicode characters are encoded. Possible value: `✓`
:
**Data Type \& Length:** String (3)  
RELATED TO THIS PAGE