...
Changelog
| x_version | Description | Date |
|---|---|---|
| ~ | Added PN transaction-type for indicating ACH Pre-Note requests. | 2021-07-14 |
| 1.3 | x_customer_id now allows for alpha-numeric characters, as well as, the special characters period ., underscore _, and dash - | 2021-06-15 |
...
| Field | Required | Max Length | Description |
|---|---|---|---|
| x_transaction_type | Required | 2 | This field identifies the type of transaction being submitted. Valid transaction types are: Credit Card Type:
ACH Transactions:
Transaction Administration:
|
| x_invoice_id | Required | an 32 | Unique transaction ID field specified by the merchant. Also used in determining duplicate submissions. For transaction type ‘RM’ this can be set to a specific id to remove a single transaction, or can be set to ‘ALL’ to remove all transactions currently pending for the given customer id. |
| x_amount | Required | n 10 | Amount to be charged or credited. AmountThe amount may be formatted with or without a decimal. If no decimal is given two (2) decimal places are assumed (1.00 = 100). Note: Must be zero (0) for |
| x_process_date | Optional | n 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_invoice_file | Optional | File containing information to be sent to the customer via email when the transaction is processed. | |
| x_payment_token_id | Optional | an 20 | 1) Initially the payment account information (CC Number, ACH Account) can be sent along with the x_payment_token_id. 2) The account can then be accessed in the future simply by passing the x_payment_token_id for the desired account. The individual account information is not needed. 3) If any account information is passed with an existing x_payment_token_id. That account information will be updated to match the information given. The x_payment_token_id should be unique. Validation will be added for this, however it is not currently live. |
| x_memo | Optional | ans 255 | Description of transaction to be forwarded to the customer. |
| x_notes | Optional | ans 255 | Internal notes to be stored with the transaction. |
| x_occurrence_type | Optional | an 10 | Used for setting up recurring transactions. Available types: • week • biweek • month • bimonth • quarter • semiannual • annual |
| x_occurrence_number | Optional | n 3 | Specify the number of occurrences for a recurring transaction. If no occurrence number is giving, the default will be set to indefinite until deleted manually. |
| x_source_description | Optional | an 20 | This is to be used by the developer to send the name and version number of the software that is sending the transactions. It’s a free form description field to tell GTB the source of the transactions. |
| x_module_description | Optional | an 20 | This field is used by the developer to send the name and version number of a module or plugin that was built using this API. This allows for proper tracking of plugins or modules that may be built and then used in other software applications. The end software application name and version number would be put into the “source_description” field. |
| x_custom_field | Optional | n 1 | Presentment indicator for ACH transactions. |
| x_po_number | Optional | an 50 | PO number associated with the transaction. Unique PO numbers can also be used by allow duplicate transactions if duplicate processing is current disabled. |
...