...
| FIELD | REQUIRED | VALUE | MAX LENGTH | DESCRIPTION |
|---|---|---|---|---|
| x_amount | Required | Any amount | 15 | Total value to be charged or credited inclusive of tax. |
| x_process_date | Optional | Numeric | 8 | Date on which the transaction is to be processed. If no date is given, the transaction will default to the date it is submitted on. Format:YYYYMMDD |
| x_occurrence_type | Optional | single, week, biweek, month, bimonth, quarter, semiannual, annual | 10 | Selects the type of occurrence the transaction should have. Defaults to single if none is specified. |
| x_allow_recurring | Optional | TRUE,FALSE | 5 | Offers options to the paying customer to select if the payment should be recurring, what schedule to charge recurring payments on, and the maximum number of payments to collect. |
| x_occurrence_number | Optional | Numeric | 3 | Selects the amount of occurrences a recurring transaction should have. Defaults to indefinite if none is specified. |
| x_currency_code | Optional | Valid code | 3 | Currency of the transaction amount. If left blank, this value will default to the value specified in the Merchant Interface. See Appendix I for other values. |
| x_method | Required | CC, ECHECK | N/A | Indicates the method of payment for the transaction being sent to the system. If left blank, this value will default to CC. |
| x_type | Required | AUTH_CAPTURE, AUTH_ONLY, CAPTURE_ONLY, CREDIT, VOID, PRIOR_AUTH_CAPTURE, AVSONLY | N/A | Indicates the type of transaction. If the value in the field does not match any of the values stated, the transaction will be rejected. If no value is submitted in this field, the gateway will process the transaction as an AUTH_CAPTURE |
| x_bank_aba_code | Conditional. Required if x_method = ECHECK. | Valid routing number | 9 | Routing number of a bank for eCheck transactions. |
| x_bank_acct_num | Conditional. Required if x_method = ECHECK | Valid account number | 20 | Checking or savings account number. |
| x_bank_acct_type | Conditional. Required if x_method = ECHECK | CHECKING, BUSINESSCHECKING, SAVINGS | 16 | Describes the type of bank account; if no value is provided, default is set to CHECKING. |
| x_bank_name | Conditional. Required if x_method = ECHECK | Valid bank name | 50 | Contains the name of the customer’s financial institution. |
| x_bank_acct_name | Conditional. Required if x_method = ECHECK | Alphanumeric | 50 | Is the customer’s name as it appears on their bank account. |
| x_echeck_type | Conditional. Required if x_method = ECHECK | ARC, PPD, TEL, WEB | 3 | Indicates the type of eCheck payment request. |
| x_bank_check_number | Conditional; Required if x_echeck_type = ARC or BOC. | Alpha-numeric | 15 | The check number on the customer’s paper check. See Appendix B for details on eCheck types. |
| x_card_name | Optional | Valid Name | 22 | Cardholder Name. |
| x_card_num | Conditional; Required if x_method = CC; | Numeric credit card number | 22 | Credit card number. |
| x_exp_date | Conditional; Required if x_method = CC | MMYY | 4 | Contains the date on which the credit card expires. |
| x_card_code | Optional | Valid CVV2, CVC2 or CID value | 4 | The three or four-digit number on the back of a credit card (on front for American Express). |
| x_trans_id | Conditional; Required if x_type = CREDIT, VOID, or PRIOR_AUTH_CAPTURE | Valid transaction ID | 10 | ID of a transaction previously authorized by the gateway. |
| x_auth_code | Conditional; Required if x_type = CAPTURE_ONLY | Valid authorization code | 6 | Authorization code for a previous transaction not authorized on the gateway that is being submitted for capture. |
| x_authentication_indicator | Optional; Conditional; Required only for AUTH_ONLY and AUTH_CAPTURE transactions processed through cardholder authentication programs. When submitted with other transaction types, this value is ignored. | Valid ECI or UCAF indicator value (obtained by the merchant after the authentication process). | N/A | The commerce indicator (ECI) value for a Visa transaction; or the universal cardholder authentication field indicator (UCAF for a MasterCard transaction. This field is currently supported through FDC Nashville and Vital. This field is also supported by Wells Fargo SecureSource for Visa transactions only. |
| x_cardholder_authentication_value | Optional; Required only for AUTH_ONLY and AUTH_CAPTURE transactions processed through cardholder authentication programs. When submitted with other transaction types, this value is ignored. | Valid CAVV, AVV, or UCAF value (obtained by the merchant after the authentication process). | N/A | The cardholder authentication verification value (CAVV) for a Visa transaction; or account holder authentication value (AVV)/ universal cardholder authentication field (UCAF) for a MasterCard transaction. This field is currently supported through FDC Nashville and Vital. This field is also supported by Wells Fargo SecureSource for Visa transactions only. |
| x_track_data | Optional | For swiped cards this is the track1 and track2 data. Used in providing proof of a swiped card present transaction, which can allow for lower rates when processing. May be track1, track2, or a combined track1/track2 read. Typically recommended to pass the data to GoToBilling exactly as received (track1/track2 combined). Should not be specified if referencing a ticket id. GoToBilling strictly validates the formatting of trackdata. If sending a combined track1/track2, you must use standardized framing characters. Track 1 must begin with % and end with ? Track 2 must begin with ; and end with ? Track 1 must always begin with a capital B (after the start sentinel if provided). The framing characters are optional if only sending track1 or track2. GoToBilling does not allow leading, trailing or separating whitespace or LRC characters in the trackdata format. | ||
| x_reference_id | Optional | Alphanumeric | 32 | Unique reference number for the transaction. Will be passed back in the response once the transaction has processed. |
| x_ach_verification | Optional | 'true','false' | 5 | Flag indicating whether or not to pass the ACH account information through the verification network. If verification is enabled and the verification fails, the transaction will be declined. Defaults to 'false'. |
| x_token | Optional | Alphanumeric, Valid 3DS Payment Token | N/A | A valid 3DS (3D Secure) payment token, issued by a trusted provider offering payment tokenization, must be presented in this field. The x_token field value must be included along with the other conditionally required fields for x_method = CC (x_card_num and x_exp_date). |
Level 2 Data
The system supports Level 2 transaction data by providing the following fields as part of the transaction submission API. The tax, freight, and duty fields allow a delimited string for submitting extended information.
...