Skip to content

Enumerated values

Transaction type

Used in POST /v1/transactions and returned in transaction responses.

ValueDescription
saleSingle-step transaction — authorizes and captures simultaneously
authTwo-step authorization — requires a subsequent capture
captureCaptures a previously authorized transaction
cancelCancels an authorized transaction before settlement
refundRefunds a captured/settled transaction
paymentBank account debit — sends funds from customer to merchant
payoutBank account credit — sends funds from merchant to customer/vendor

Transaction state

Returned in transaction_state on transaction responses.

ValueDescription
authorizedAuthorization received; not yet captured
pendingReceived; requires additional action (for example, 3D-Secure)
completedFunds transfer has been completed
canceledAuthorization has been fully reversed
settledFunds have been settled to the financial institution
failedError processing the request

Response status

Returned in response_status on all responses.

ValueDescription
approvedRequest was successful
declinedRequest was denied
errorAn error occurred

Cancel/refund type

Used in POST /v1/transactions/{id}/cancel.

ValueDescription
cancelCancel (void) the transaction before settlement
refundRefund the transaction after settlement

Client type

Used in POST /v1/clients and returned in client responses.

ValueDescription
merchantA merchant account that processes transactions
resellerA reseller that manages sub-merchants

Payment token type

Returned in type on payment token responses.

ValueDescription
cardCredit or debit card token
achBank account (ACH) token

Payment token status

Returned in status on payment token responses.

ValueDescription
activeToken is verified and ready for transactions
expiredCard expiry date has passed
inactiveToken has been soft-deleted
verification_pendingBank account awaiting verification
verification_failedBank account verification did not pass

Card brand

Returned in card.brand on payment method responses and used in TSYS integration card_brand.

ValueDescription
visaVisa
mastercardMastercard
american_expressAmerican Express
discoverDiscover
diners_clubDiners Club
jcbJCB
unionpayUnionPay
visa_debitVisa Debit (TSYS integrations only)
mastercard_debitMastercard Debit (TSYS integrations only)

Card funding type

Returned in card.funding on payment method responses.

ValueDescription
creditCredit card
debitDebit card
prepaidPrepaid card
unknownFunding type could not be determined

Bank account type

Used in bank_account.account_type.

ValueDescription
checkingChecking account
savingsSavings account

AVS result codes

Returned in avs_result_code on transaction responses when address data is provided.

CodeDescription
aStreet address matched; postal code did not
bNo address information provided, or transaction declined
nNeither street address nor postal code matched
pPostal code matched; street address not verified
rRetry — system unavailable or timed out
sAVS not supported by the issuer
uAddress information unavailable
w9-digit ZIP matched; street address did not
xExact match — street address and 9-digit ZIP both matched
yStreet address and 5-digit ZIP both matched
z5-digit ZIP matched; street address did not

Address check results

Returned in card.address_check on tokenization and transaction responses.

ValueDescription
matchAddress/ZIP matched
no_matchAddress/ZIP did not match
unavailableCheck could not be performed
uncheckedCheck was not requested

Industry type

Used in TSYS integration general_details.industry_type.

ValueDescription
pCard Present (Retail, CAT, Banking)
eE-commerce
mMail Order / Telephone Order (MOTO)

Time zones

Used in admin_contact_details.time_zone and time_zone on user objects.

ValueDescription
america/los_angelesPacific Time
america/phoenixMountain Standard Time (no DST)
america/denverMountain Time
america/chicagoCentral Time
america/new_yorkEastern Time
pacific/honoluluHawaii Time
america/anchorageAlaska Time

OTP request type

Used in POST /v1/mfa/challenges.

ValueDescription
forgot_passwordRequest OTP for password reset
2faRequest OTP for multi-factor authentication

Sort order

Used in query parameters for list endpoints.

ValueDescription
ascAscending (oldest first)
descDescending (newest first, default)

Vericheck business type

Used in Vericheck integration onboarding.

ValueDescription
retailRetail
restaurantRestaurant
convenienceConvenience
internetInternet
miscellaneousMiscellaneous

Vericheck corporate structure

Used in Vericheck integration onboarding.

ValueDescription
corporationCorporation
llcLLC
llpLLP
individual_proprietorshipIndividual / Sole Proprietorship
governmentGovernment
non_profitNon-Profit
partnershipPartnership