Table of Contents
...
| Field Name | Required (R); Optional (O); Conditional (C); Read Only (RO) | Data Type & Length | Description & Field Values |
|---|---|---|---|
| tran_id | C | Int | Unique number that is assigned by GTB for every transaction entered into the system. If trans_id exists in GTB then that record is updated; otherwise, a new record is created. If a tran_id is provided that doesn't exist then you get an error message. |
| customer_id | R | Int | GTB generated customer ID, returned in CustomerInfo |
| account_id | R | Int | GTB generated account ID for the payment account, returned in AccountInfo |
| tran_type | R | Int | Determines type of transaction, i.e. ACH or credit card
(*) ARC must be MICR read and image of check stored. All of these transaction types have special ACH rules and should not be coded to without help from GTB. |
| record_type | R | Int | Description: Determines whether transaction activity
|
| auth_type | C | Int | Indicates method of ACH transaction authorization. These are ONLY used on ACH transactions. Before implementing any ACH transactions please consult GTB for compliance and NACHA regulations. Auth_type is normally 1, 2 or 3 under most circumstances. Values:
(*) Consult with GTB for extra compliance issues and NACHA regulations. |
| occurrence | O | String | Indicates presence of any recurring transaction activity. Applicable to both CC and ACH transactions.
|
| occurrence_number | C | Int | Determines the number of times that a particular transaction is to be recurred. Any integer value represents the number of occurrences left for this particular transaction. If not provided and occurrence type is not single, transaction will repeat indefinitely. |
| amount | R | Float | The amount of the transaction. |
| check_number | C | String (50) | |
| tran_date | C | String (50) | The date the transaction is scheduled to process. Format is YYYYMMDD |
| notes | O | String | |
| memo | O | String | |
| is_corporate | O | Boolean | |
| po_number | C | String (50) | Required if is_corporate is TRUE |
| sales_tax | C | Float | |
| sales_tax_type | C | Int | Required if sales_tax is provided |
| order_id | O | String (50) | Unique transaction ID field specified by the merchant. Also used in determining duplicate submissions. |
| ticket_id | C | String (50) | Only Credit card transactions receive Ticket ID. This Ticket ID is required when submitting a VOID transaction. |
| customer_int | O | Boolean |
|
| process | O | Boolean | Set to true to process a CC transaction for the current date, and approvals are not needed. |
| account | RO | String | Masked account number associated with a transaction |
| account_type | RO | String | Type of account for the transaction |
| account_expiration | RO | String | Expiration date of a credit card account |
| tran_code | RO | String | Not in a Post, only in a Get as it is the descriptive reason message on credit card transactions. Things like Decline reasons of invalid exp date, etc. They can exist even on Approvals. |
| tran_status | RO | String | Status of a Transaction |
| invoice_id | RO | String | GTB created. If someone pays an invoice that is generated out of GTB, the invoice number is entered into this field to tie the transaction to the invoice number. |
| date_created | RO | String | |
| approvals_needed | RO | Int | Is the number of people that need to approve the transaction before it can process. |
| auth_code | RO | String | Authorization code for a credit card transaction |
| avs_code | RO | String | Credit card transaction response foraddress verification. |
| cvv2_code | RO | String | Credit card transaction response for the CVV security code supplied. |
| reference_id | RO | String | The Reference ID is an internally generated number. It will be the order_id if supplied by the merchant. This field is displayed in the reports so that merchant supplied order_id’s would be visible to them. |
| payment_category | RO | String | These are added to the transaction only from Click-n-pay when the consumer chooses one of the categories specified by the merchant when they schedule the payment. |
| track1 | O | String | Track1 data obtained from scanned credit cards. This data is only accepted when creating a transaction and is not returned as part of the TransInfo object |
| track2 | O | String | Track2 data obtained from scanned credit cards. This data is only accepted when creating a transaction and is not returned as part of the TransInfo object |
| check_image_front | O | Base64Binary | For imaged ACH transactions, this is the front image of the check |
| check_image_back | O | Base64Binary | For imaged ACH transactions, this is the back image of the check |
| custom_fields | O | Array | Array containing CustomField data that should be attached to the transaction. |
| verify_ach | O | Boolean | Set to true to enable.. otherwise, default is off. There are two levels of ACH verification but that is set on the Account Level at gotoBilling. If an ACH transaction receives an Authorization the status sent back will be R, if it is Declined, the status will be D. |
| lock_status | O | Int | The lock status will indicate any type of user or system lock that is current in affect for the transaction:
|
...