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 immediately process a CC transaction sent with today as the transaction date. If not set to true, transactions will be placed into batch for later processing. Transactions will not process immediately if management approval is required. Future-dated transactions will be placed in batch for the date given. |
| 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:
|
...
- 102: Invalid customer ID
- 103: invalid account ID
- 110: Missing transaction ID
- 111: authorization type required for ACH transactions
- 112: A PO number is required for Corporate cards
- 113: sales tax type is required when submittin a tax amount
- 114: a ticket ID must be specified to submit a void transaction
- 115: occurrence type is a required field
- 116: invalid transaction date
- 117: Invalid transaction date. Date must be for the current date or the future, past dates are not allowe
- 118: transaction is locked, you cannot change a locked transaction
- 119: invalid transaction type
- 120: invalid record type
- 121: invalid amount
- 127: invalid occurrence number
- 131: invalid lock status given.
- 133: Velocity Limit has been exceeded.
Errors Codes
This is a list of returned error codes and descriptions of their meaning.
| Code | Description |
|---|---|
| 101 | You are not authorized to use this service with the credentials you provided. Be sure you have supplied the correct Login and pin. |
| 102 | Invalid customer ID, either the supplied ID did not exist or was incorrectly formatted |
| 103.1 | Invalid account ID, either the supplied ID did not exist or was incorrectly formatted |
| 103.2 | Invalid account ID, either the supplied ID did not exist or was incorrectly formatted |
| 104 | A routing number is required for ACH accounts |
| 105 | The account type supplied is unknown |
| 106 | Invalid account number |
| 107 | A valid routing number must be supplied |
| 108 | Card expiration date was in an invalid format. Valid format is: MMYY |
| 109 | An attribute was supplied out of order, make sure that the parameters are in the correct order and resubmit |
| 110 | Invalid transaction ID, either the supplied ID did not exist or was incorrectly formatted |
| 111 | Auth_type field is required for ACH transactions. |
| 112 | A PO number is required for corporate card transactions |
| 113 | The sales_tax_type field is required when submitting sales tax |
| 114 | A ticket_id must be supplied to void a transaction. |
| 115 | An occurrence type is required for all transactions. |
| 116 | Invalid transaction date. The date you supplied was not a valid date string representation. |
| 117 | Transaction date must be for the current or future date. |
| 118 | Transaction is locked and cannot be changed at this time. |
| 119 | Invalid tran_type. |
| 120 | Invalid record type. Refer to the TransactionInfo complex type for valid values. |
| 121 | Invalid amount. Amounts must be a valid number. |
| 122 | You do not have the necessary permissions to do the requested action. |
| 123 | The first_name attribute must be supplied for a customer contact. |
| 124 | The last_name attribute must be supplied for a customer contact. |
| 125 | The company attribute must be supplied for a company customer. |
| 126 | Invalid customer_name given. |
| 126.1 | Invalid customer_name given. Already in use by another customer. |
| 127 | The occurrence number you specified is invalid. |
| 128 | Invalid card security code(CVV). The CVV code submitted was invalid, it must be 4 or less numbers. |
| 129 | Invalid card zip code. |
| 130 | Invalid search criteria |
| 131 | Invalid lock status given. |
| 132 | Cannot delete this account, there are pending transaction associated with it |
| 133 | Velocity Limit has been exceeded. |
Usage Examples
Create a customer and return the GTB assigned Customer ID
...