Used in POST /v1/transactions and returned in transaction responses.
| Value | Description |
|---|---|
sale | Single-step transaction — authorizes and captures simultaneously |
auth | Two-step authorization — requires a subsequent capture |
capture | Captures a previously authorized transaction |
cancel | Cancels an authorized transaction before settlement |
refund | Refunds a captured/settled transaction |
payment | Bank account debit — sends funds from customer to merchant |
payout | Bank account credit — sends funds from merchant to customer/vendor |
Returned in transaction_state on transaction responses.
| Value | Description |
|---|---|
authorized | Authorization received; not yet captured |
pending | Received; requires additional action (for example, 3D-Secure) |
completed | Funds transfer has been completed |
canceled | Authorization has been fully reversed |
settled | Funds have been settled to the financial institution |
failed | Error processing the request |
Returned in response_status on all responses.
| Value | Description |
|---|---|
approved | Request was successful |
declined | Request was denied |
error | An error occurred |
Used in POST /v1/transactions/{id}/cancel.
| Value | Description |
|---|---|
cancel | Cancel (void) the transaction before settlement |
refund | Refund the transaction after settlement |
Used in POST /v1/clients and returned in client responses.
| Value | Description |
|---|---|
merchant | A merchant account that processes transactions |
reseller | A reseller that manages sub-merchants |
Returned in type on payment token responses.
| Value | Description |
|---|---|
card | Credit or debit card token |
ach | Bank account (ACH) token |
Returned in status on payment token responses.
| Value | Description |
|---|---|
active | Token is verified and ready for transactions |
expired | Card expiry date has passed |
inactive | Token has been soft-deleted |
verification_pending | Bank account awaiting verification |
verification_failed | Bank account verification did not pass |
Returned in card.brand on payment method responses and used in TSYS integration card_brand.
| Value | Description |
|---|---|
visa | Visa |
mastercard | Mastercard |
american_express | American Express |
discover | Discover |
diners_club | Diners Club |
jcb | JCB |
unionpay | UnionPay |
visa_debit | Visa Debit (TSYS integrations only) |
mastercard_debit | Mastercard Debit (TSYS integrations only) |
Returned in card.funding on payment method responses.
| Value | Description |
|---|---|
credit | Credit card |
debit | Debit card |
prepaid | Prepaid card |
unknown | Funding type could not be determined |
Used in bank_account.account_type.
| Value | Description |
|---|---|
checking | Checking account |
savings | Savings account |
Returned in avs_result_code on transaction responses when address data is provided.
| Code | Description |
|---|---|
a | Street address matched; postal code did not |
b | No address information provided, or transaction declined |
n | Neither street address nor postal code matched |
p | Postal code matched; street address not verified |
r | Retry — system unavailable or timed out |
s | AVS not supported by the issuer |
u | Address information unavailable |
w | 9-digit ZIP matched; street address did not |
x | Exact match — street address and 9-digit ZIP both matched |
y | Street address and 5-digit ZIP both matched |
z | 5-digit ZIP matched; street address did not |
Returned in card.address_check on tokenization and transaction responses.
| Value | Description |
|---|---|
match | Address/ZIP matched |
no_match | Address/ZIP did not match |
unavailable | Check could not be performed |
unchecked | Check was not requested |
Used in TSYS integration general_details.industry_type.
| Value | Description |
|---|---|
p | Card Present (Retail, CAT, Banking) |
e | E-commerce |
m | Mail Order / Telephone Order (MOTO) |
Used in admin_contact_details.time_zone and time_zone on user objects.
| Value | Description |
|---|---|
america/los_angeles | Pacific Time |
america/phoenix | Mountain Standard Time (no DST) |
america/denver | Mountain Time |
america/chicago | Central Time |
america/new_york | Eastern Time |
pacific/honolulu | Hawaii Time |
america/anchorage | Alaska Time |
Used in POST /v1/mfa/challenges.
| Value | Description |
|---|---|
forgot_password | Request OTP for password reset |
2fa | Request OTP for multi-factor authentication |
Used in query parameters for list endpoints.
| Value | Description |
|---|---|
asc | Ascending (oldest first) |
desc | Descending (newest first, default) |
Used in Vericheck integration onboarding.
| Value | Description |
|---|---|
retail | Retail |
restaurant | Restaurant |
convenience | Convenience |
internet | Internet |
miscellaneous | Miscellaneous |
Used in Vericheck integration onboarding.
| Value | Description |
|---|---|
corporation | Corporation |
llc | LLC |
llp | LLP |
individual_proprietorship | Individual / Sole Proprietorship |
government | Government |
non_profit | Non-Profit |
partnership | Partnership |