# 

Values are case-sensitive unless a page says otherwise, and several are spelled
differently on the way in and the way out. Those pairs are the ones worth reading
twice.

This page is generated from the API description, so it cannot drift from it.

## Transactions

### `TransactionCreateType`

`type` on `POST /v1/transactions`.

| Value | Meaning |
|  --- | --- |
| `SALE` | Requests payment card or ACH authorization with an immediate, automatic capture of authorized funds. Includes payment cards and ACH debits. Funds transferred from customer to merchant. |
| `AUTH` | Requests payment card authorization that is not automatically captured. Completed by a manual capture of the authorized funds. |
| `PAYOUT` | An ACH credit. Funds transferred from merchant to customer. |


### `TransactionResponseType`

`type` on a response, and the `type` report filter.

| Value | Meaning |
|  --- | --- |
| `SALE` | Payment card or ACH authorization with an immediate, automatic capture of the authorized funds. Funds transferred from customer to merchant. |
| `AUTH` | Payment card authorization that was not automatically captured, and is completed by a manual capture. |
| `INCREMENTAL_AUTH` | An authorization that raised the amount held by an earlier `AUTH`. |
| `PAYOUT` | An ACH credit. Funds transferred from merchant to customer. |
| `REFUND` | A refund of a settled payment. Funds transferred from merchant to customer. |
| `CANCEL` | A payment cancelled before settlement. Covers a void, a reversal, and a reversed transaction, which the gateway reports under this single value. |
| `CAPTURE` | Manual capture of an authorized payment. |


### `TransactionCancelType`

The `type` discriminator on a cancel or refund body.

| Value | Meaning |
|  --- | --- |
| `VOID` | Cancels a `SALE` or captured `AUTH` before settlement. |
| `REFUND` | Refunds a settled payment. Funds transferred from merchant to customer. |


### `Result`

`result` on every transaction.

| Value | Meaning |
|  --- | --- |
| `APPROVED` | The transaction was approved by the issuer. |
| `DECLINED` | The transaction was declined by the issuer. |
| `ERROR` | The transaction experienced an error after it was successfully created by the API server. |


### `Initiator`

`initiator`.

| Value | Meaning |
|  --- | --- |
| `MERCHANT` | Merchant-initiated transaction (MIT) — billed without the cardholder present. |
| `CUSTOMER` | Customer-initiated transaction (CIT) — the cardholder is actively present. |
| `THIRD_PARTY` | Initiated by a third party on the merchant's behalf. |


### `RecurringSequence`

`recurring_details.sequence`.

| Value | Meaning |
|  --- | --- |
| `INITIAL` | The first, customer-initiated (CIT) transaction in the agreement. Establishes the stored credential. |
| `SUBSEQUENT` | A follow-on transaction billed against the agreement established by the INITIAL transaction. Usually merchant-initiated (MIT). |


### `SettlementIssue`

`settlement_issue`.

| Value | Meaning |
|  --- | --- |
| `REMOVED_FROM_BATCH` | The transaction was removed from its batch before settlement. |
| `null` | — |


## Payment methods

### `PaymentMethodTypeInput`

`payment_method.type` on a request.

| Value | Meaning |
|  --- | --- |
| `ACH` | A bank account debited or credited over ACH. |
| `CARD` | A credit or debit card. |
| `TOKEN` | A stored payment method, referenced by its token. |


### `PaymentMethodTypeOutput`

`payment_method.type` on a response.

| Value | Meaning |
|  --- | --- |
| `ACH` | A bank account debited or credited over ACH. |
| `CARD` | A credit or debit card. |


### `EntryMethod`

`payment_method.entry_method` on a request.

| Value | Meaning |
|  --- | --- |
| `MOTO` | A Card Not Present entry method where the payment method information was obtained over the phone or via postal mail. |
| `ECOMMERCE` | A Card Not Present entry method where the payment method information was obtained over the Internet via a web browser. |
| `null` | — |


### `CardType`

`payment_method.card_type`.

`DEBIT`, `CREDIT`, `UNKNOWN`

### `AvsResultCode`

`payment_method.avs_result_code`.

| Value | Meaning |
|  --- | --- |
| `A` | The street address matched, but the postal code did not. |
| `B` | No address information was provided or transaction declined. |
| `N` | Neither the street address nor postal code matched. |
| `P` | AVS is not applicable for this transaction. |
| `R` | Retry — AVS was unavailable or timed out. |
| `S` | AVS is not supported by card issuer. |
| `U` | Address information is unavailable. |
| `W` | The US ZIP+4 code matches, but the street address does not. |
| `X` | Both the street address and the US ZIP+4 code matched. |
| `Y` | The street address and postal code matched. |
| `Z` | The postal code matched, but the street address did not. |
| `0` | AVS not requested or not applicable. |


### `BankAccountType`

`payment_method.account_type`.

| Value | Meaning |
|  --- | --- |
| `CHECKING` | Checking account. |
| `SAVINGS` | Savings account. |


### `StandardEntryClass`

`payment_method.standard_entry_class`.

| Value | Meaning |
|  --- | --- |
| `PPD` | Prearranged Payment and Deposit — consumer account transactions authorized in writing. |
| `CCD` | Corporate Credit or Debit — business-to-business ACH transactions. |
| `WEB` | Internet-initiated entries — consumer transactions authorized via the internet. |
| `TEL` | Telephone-initiated entries — consumer transactions authorized by phone. |
| `POP` | Point-of-Purchase — check conversion transactions at the point of sale. |
| `BOC` | Back Office Conversion — check conversion after the sale. |


## Batches and processors

### `BatchType`

`batch_type` on a batch close.

| Value | Meaning |
|  --- | --- |
| `Credit` | Credit batch — contains credit/sale transactions. |
| `Debit` | Debit batch — contains debit transactions. |


### `OpenBatchCardType`

`card_type` on `GET /v1/batches/transactions`.

`DEBIT`, `CREDIT`

### `Processor`

`processor` in a request body.

| Value | Meaning |
|  --- | --- |
| `Tsys` | TSYS payment processor |
| `Vericheck` | Vericheck ACH processor |


### `IntegrationsEnum`

`integrations` on a response, and the `integration` filter.

| Value | Meaning |
|  --- | --- |
| `TSYS` | The TSYS card processor. Returned on card transactions. |
| `VERICHECK` | The Vericheck ACH processor. Returned on bank account (ACH) transactions. |


## Clients

### `ClientType`

`type` on a client.

| Value | Meaning |
|  --- | --- |
| `reseller` | Reseller — a client that resells services to merchants. |
| `merchant` | Merchant — a client that processes payments. |


### `ClientAddressType`

`address[].type`.

| Value | Meaning |
|  --- | --- |
| `LEGAL` | The client's registered legal address. |
| `BILLING` | The address used for billing the client. |
| `PHYSICAL` | The client's physical location address. |


### `TimeZone`

`time_zone` on admin contact details.

| Value | Meaning |
|  --- | --- |
| `America/Los_Angeles` | Pacific Time Zone |
| `America/Phoenix` | Mountain Standard Time (MST, no DST) |
| `America/Denver` | Mountain Time Zone |
| `America/Chicago` | Central Time Zone |
| `America/New_York` | Eastern Time Zone |
| `Pacific/Honolulu` | Hawaii-Aleutian Standard Time (HAST) |
| `America/Anchorage` | Alaska Time Zone |


## Sorting

### `SortOrder`

`sort_order`.

| Value | Meaning |
|  --- | --- |
| `ASC` | Ascending order (oldest first). |
| `DESC` | Descending order (newest first). |


## Where the vocabularies differ

Three pairs catch people out.

|  | Request | Response |
|  --- | --- | --- |
| Transaction type | `SALE`, `AUTH`, `PAYOUT` | adds `INCREMENTAL_AUTH`, `REFUND`, `CANCEL`, `CAPTURE` |
| Payment method type | `ACH`, `CARD`, `TOKEN` | `ACH`, `CARD` |
| Processor | `Tsys`, `Vericheck` | `TSYS`, `VERICHECK` |


**You send `VOID` and you read `CANCEL`.** There is no `VOID` in the response
vocabulary, and filtering a report on it returns a server error.

**You send `TOKEN` and you read `CARD` or `ACH`.** A response reports the card
or bank account the token stands for, and the token itself comes back in
`payment_token`.

**`entry_method` is a different vocabulary again on a response** — a free-form
string naming how the card was read (`keyed`, `swiped`, `chip`, `contactless`,
`magstripe`, `barcode`, `qr`, `other`), not one of the two request values.

## Next steps

* [API response codes](/docs/reference/response-codes)
* [Known limitations](/docs/reference/known-limitations)