Data Type: String

Field Dependence: Required

Sensitive: No

Description: The cardholder's address, line 1. Required when AccountNumberIndicator=4 and to guarantee a transaction unless explicitly exempted by our platform.

Maximum Length: 30

Data Type: String

Field Dependence: Optional

Sensitive: No

Description: The cardholder's address, line 2.

Maximum Length: 30

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The cardholder’s city. Required to guarantee a transaction unless explicitly exempted by our platform.

Maximum Length: 30

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The cardholder’s two-character country code. Use the ISO-3166 official country codes. Required to guarantee a transaction unless explicitly exempted by our platform.

Maximum Length: 2

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The cardholder’s first name. Required to guarantee a transaction unless explicitly exempted by our platform.

Maximum Length: 20

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The cardholder’s last name. Required to guarantee a transaction unless explicitly exempted by our platform.

Maximum Length: 20

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The cardholder’s ZIP or postal code. Required when AccountNumberIndicator=4 and to guarantee a transaction unless explicitly exempted by our platform.

Maximum Length: 10

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The cardholder’s region name. For U.S. addresses, use the two-character state code. Required to guarantee a transaction unless explicitly exempted by our platform.

Maximum Length: 30

Data Type: String

Field Dependence: Required

Sensitive: No

Description: API username.

Maximum Length: 32

Data Type: String

Field Dependence: Required

Sensitive: Yes

Description: The credit/debit card number, token or the BIN plus Last4 of the credit/debit card number/ApplePay Encrypted Payment Token to be authorized. If AccountNumberIndicator=4, then the value entered must be either 10 digits or 4 digits: BIN = First 6 digits of the credit/debit card number and Last4 = Last 4 digits of the credit/debit card number.

Maximum Length: 19

Data Type: Integer

Field Dependence: Required

Sensitive: No

Description: The type of account number being sent to the API.

Maximum Length: 1

Possible Values:

1 - Credit card (credit card number)

2 - Temporary token

3 - Permanent token

4 - BIN + Last4

5 - ApplePay Encrypted Payment Token

Data Type: Currency

Field Dependence: Required

Sensitive: No

Description: The amount of money sent for authorization.

Maximum Length: 12

Data Type: Numeric

Field Dependence: Conditional

Sensitive: Yes

Description: The credit/debit card security code (e.g., CVV2 for MC and Visa or CID for American Express). If PaymentSource=PPD, this field is not required.

Maximum Length: 4

Data Type: String

Field Dependence: Optional

Sensitive: No

Description: The fraud or Revenue Assurance (RA) gateway user account name.

Maximum Length: 128

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The identification number associated with the merchant account.

Maximum Length: 20

Data Type: Integer

Field Dependence: Conditional

Sensitive: No

Description: The number of installments.

Data Type: String

Field Dependence: Optional

Sensitive: No

Description: The unique data element created to identify a customer, such as a billing account number.

Maximum Length: 64

Data Type: String

Field Dependence: Required

Sensitive: Yes

Description: API password.

Maximum Length: 64

Data Type: String

Field Dependence: Optional

Sensitive: No

Description: The description of the transaction. Used for tracking purposes and to identify the transaction when contacting Support.

Maximum Length: 128

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The source of the transaction.

Possible Values:

PPD - Use this to specify that the transaction has been prearranged. This is used when the credit/debit card number has been validated or already had a successful charge against it. When this option is used, the CVV is not required.

TEL - Use this to specify that the transaction has been taken over a telephone through a call center or interactive voice response (IVR) system.

WEB - Use this to specify that the transaction has been taken over the Web, the mobile Web, a native mobile application, or a hybrid-mobile application.

Data Type: String

Field Dependence: Optional

Sensitive: No

Description: The payment plan used for the transaction.

Possible Values:

0 - Onetime, Non-Installment Payment

1 - Monthly Installment Principal Only

2 - Monthly Installment Principal and Interest

3 - Monthly Installment Interest Only

Data Type: String

Field Dependence: Optional

Sensitive: No

Description: The attribute-based XML blob that contains information the merchant wishes to report on for the specific transaction. The information does not affect processing. It is passed through to use in reporting and PRT search functionality.

Maximum Length: N/A

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The XML string containing risk-related data. See the Risk Information XML and contact your Integration Specialist for details.

Maximum Length: N/A

Data Type: Boolean

Field Dependence: Optional

Sensitive: No

Description: Indicates if the credit/debit card number needs to be exchanged for a permanent token.

Maximum Length: N/A

Possible Values:

0 - Do not exchange card number for a permanent token

1 - Exchange card number for a permanent token

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The unique identification number used to track the transaction.

Maximum Length: 36

Data Type: String

Field Dependence: Conditional

Sensitive: No

Description: The WebSessionID generated by the GetSessionTags API for the current transaction. This is used for device fingerprinting.

Maximum Length: 4000

Data Type: Currency

Sensitive: No

Description: Returns the amount of money authorized by your gateway/acquirer. This amount may be less than the original requested amount.

Maximum Length: 12

Data Type: Numeric

Sensitive: No

Description: Returns the first six digits of the credit/debit card number processed.

Maximum Length: 6

Data Type: Numeric

Sensitive: No

Description: Returns the last four digits of the credit/debit card number processed.

Maximum Length: 4

Data Type: Integer

Sensitive: No

Description: Returns the issuer type for the credit/debit card number processed.

Maximum Length: N/A

Possible Values:

1 - AAFEES

3 - American Express

4 - Visa

5 - MasterCard

6 - Discover

7 - Diners Club

9 - Carte Blanche

25 - Dankort

27 - Electron

34 - Lasercard

35 - Maestro

98 - Unknown

Data Type: Boolean

Sensitive: No

Description: Returns whether our platform can guarantee the transaction.

Maximum Length: N/A

Possible Values:

0 - Payment cannot be guaranteed

1 - Payment can be guaranteed

Data Type: Boolean

Sensitive: No

Description: Returns whether the transaction is a shadow payment (not actually guaranteed).

Maximum Length: N/A

Possible Values:

1 - This is a shadow payment and so not actually guaranteed.

Data Type: String

Sensitive: No

Description: Returns the unique data element for identifying a customer.

Maximum Length: 64

Data Type: Integer

Sensitive: No

Description: Returns our platform's decision to guarantee the payment.

Maximum Length: N/A

Possible Values:

1 - Guaranteed payment

2 - Non-guaranteed payment

Data Type: String

Sensitive: No

Description: Returns the identification number to track the transaction.

Maximum Length: 12

Data Type: Integer

Sensitive: No

Description: Result of the authorization request.

Maximum Length: N/A

Possible Values:

1 - Bank denied.

2 - Pending. This can occur if Vesta has determined that additional insight could help determine the risk of this transaction. See the response parameter PendResolutionMethods for the resolution method that was used for the transaction.

3 - Fraud denied. This can occur if our platform has determined that this transaction is too risky to process, or the customer is not reliable.

5 - Authorized.

6 - Authorization communication error. The transaction did not complete. Re-run the transaction. If the problem persists, contact Support.

10 - Successful payment.

51 - Pre-Authorization completed.

52 - Post-Authorization completed.

61 - Pre-Authorization communication failure. The transaction did not complete. Re-run the transaction. If the problem persists, contact Support.

62 - Post-Authorization communication failure. The transaction did not complete. Re-run the transaction. If the problem persists, contact Support.

Data Type: Integer

Sensitive: No

Description: The method Vesta used to gather additional insights on the transaction to resolve the Pending status.

Maximum Length: N/A

Possible Values:

20 - Silent Pending. See Silent Pending.

21 - Manual Review. See Manual Review.

Data Type: String

Sensitive: No

Description: Returns a permanent token for the credit/debit card number when StoreCard=1.

Maximum Length: 19

Data Type: Integer

Sensitive: No

Description: Returns a 0 for success or a non-zero code for failure to process the API. See Response Codes for the possible non-zero code returned by the ChargePaymentRequest API.

Maximum Length: N/A

Data Type: String

Sensitive: No

Description: Returns a description for non-zero Response Codes.

Maximum Length: 1024

Data Type: Integer

Sensitive: No

Description: Returns the decision code from the decision engine when the transaction is denied or pended.

Maximum Length: N/A

Possible Values:

1701 - Score exceeds risk system thresholds.

1702 - Insufficient information for risk system to approve.

1703 - Insufficient checking account history.

1704 - Suspended account.

1705 - Payment method type is not accepted.

1706 - Duplicate transaction.

1707 - Other payment(s) still in process.

1708 - SSN and/or address did not pass bureau validation.

1709 - Exceeds check amount limit.

1710 - High risk based upon checking account history (EWS).

1711 - Declined due to ACH regulations.

1712 - Information provided does not match what is on file at bank.

1713 - Information on file does not match what is on file.

1714 - Try again with a new debit/credit card.

1715 - Phone verification requested.

1716 - Additional information needed for verification.

Data Type: String

Sensitive: No

Description: Returns the description of the decision code from the decision engine when the transaction is denied or pended.

Maximum Length: N/A

Data Type: Integer

Sensitive: No

Description: Returns the level of risk associated with accepting the requested transaction.

Maximum Length: N/A

Possible Values:

1 - High Risk

2 - Mild Risk

3 - Average

4 - Safe

5 - Very Safe

Data Type: Integer

Sensitive: No

Description: Returns the risk score associated with the transaction. Valid values are 0-100; the higher the score, the greater the fraud risk associated with the transaction. This score is only presented if the Fraud Score feature is enabled.

Maximum Length: N/A

Suggested Customer Message: Transaction completed.

Note: Not an error condition.

Suggested Customer Message: System not available. Please try again later.

Note: A low-level error message that may indicate a communication problem, a timing problem, an intermittent failure to contact an acquirer, or another condition not captured by the other response codes. If this response code is returned after repeated attempts, contact Support.

Note: No value was sent for a required parameter. Check all required parameters are included in the API call.

Note: A required parameter contains too many characters. Check the length does not exceed the maximum length value specified for the parameter.

Note: A general type-mismatch error. Check the required parameters are being populated correctly.

Note: The parameter is empty. Check the parameter that fills this field.

Suggested Customer Message: Please select a correct value.

Note: The input value does not match one of the multiple-choice values provided.

Suggested Customer Message: Please check your credit card information.

Note: The credit/debit card number must contain 13 to 19 digits.

Suggested Customer Message: System not available. Please try again later.

Note: Authentication failed. Check your credentials and try again, or contact Support.

Suggested Customer Message: Transaction not found.

Note: Credit/debit card number must contain 13 to 19 digits.

Suggested Customer Message: Please check your credit card information.

Note: The credit/debit card number provided does not pass basic length and format validation. Mod-10 is a basic numeric check to see if it meets the minimum rules to be valid. Usually, this occurs when the credit/debit card number has been mistyped.

Suggested Customer Message: System not available. Please try again later.

Note: Indicates a problem with the merchant's account. Contact Support.

Note: The full customer information and address must be provided.

Note: The full customer address must be provided.

Note: The full customer information must be provided.

Suggested Customer Message: We were unable to process this transaction. Please try again later.

Note: An acquirer is required to complete this transaction. If the problem persists, contact Support.

Suggested Customer Message: We cannot process this type of card. Please select a credit/debit card with a Visa, Discover, American Express, or MasterCard logo.

Note: Your configuration only supports debit transactions. The customer provided a credit card.