Enums

This page documents every enum used in the AccruPay GraphQL API. Pass enum values as plain strings in JSON variables (e.g. "USD", "PAYMENT").

TRANSACTION_ACTION

Describes the type of operation a transaction represents.

Value	Description
`PAYMENT`	A charge to a payment method
`ADD_PAYMENT_METHOD`	Storing a payment method without charging it
`REFUND`	Returning funds to a previously charged payment method
`VOID`	Canceling an authorized or pending transaction before capture
`CREDIT`	Issuing a credit to a payment method outside of a prior charge
`CHARGEBACK`	A dispute-initiated reversal initiated by the cardholder's bank
`MODIFICATION`	Modification of a previously authorized amount
`AUTHORIZATION`	Reserving funds on a payment method without immediate capture
`AUTHENTICATION`	A 3DS or identity verification step without a payment
`PAYOUT`	Sending funds out to a payment method
`SETTLE`	Capture of a previously authorized amount
`UNKNOWN`	Action type not recognized or not yet mapped

TRANSACTION_STATUS

Describes where a transaction is in its lifecycle.

Value	Description
`PENDING`	Created and waiting to be started
`STARTED`	Processing has begun; awaiting provider response
`SUCCEEDED`	Completed successfully
`FAILED`	Processing completed but the transaction was not successful
`DECLINED`	Declined by the payment provider or card network
`CANCELED`	Canceled by the merchant or customer before completion
`EXPIRED`	Session or transaction timed out before completion
`ERROR`	An unexpected error occurred during processing
`UNKNOWN`	Status not recognized or not yet mapped

State transitions

PENDING → STARTED → SUCCEEDED
                  → FAILED
                  → DECLINED
                  → CANCELED
                  → ERROR
         STARTED  → EXPIRED
PENDING           → CANCELED

tip

Poll or use webhooks for STARTED transactions. A STARTED transaction that is not resolved may transition to EXPIRED after a provider-defined timeout.

warning

FAILED, DECLINED, and ERROR are distinct. DECLINED means the provider or card network rejected the payment. FAILED means processing completed but was unsuccessful for a business reason. ERROR means an unexpected system error occurred.

CLIENT_TRANSACTION_SESSION_KIND

Describes how a client transaction session was initiated.

Value	Description
`CLIENT`	Session initiated from a client (browser/mobile) context
`SERVER`	Session initiated from a server-side context

CLIENT_TRANSACTION_SESSION_STATUS

Describes the lifecycle state of a client transaction session. Sessions are short-lived and drive the payment UI flow.

Value	Description
`PENDING`	Session created but not yet used
`ACTIVE`	Session is open and the customer is interacting with the payment UI
`COMPLETED`	Session completed; call the matching verify mutation to get the final transaction
`CANCELED`	Session was canceled before completion
`DECLINED`	Session was declined by the provider
`EXPIRED`	Session timed out before the customer completed payment
`ERROR`	An error occurred during the session
`UNKNOWN`	Status not recognized or not yet mapped

note

COMPLETED does not mean the payment succeeded — it means the session flow finished. Always call the verify mutation and check the resulting transaction's status field.

PAYMENT_METHOD

The type of payment instrument.

Value	Description
`CARD`	Credit or debit card
`ACH`	ACH bank transfer (US only)
`OTHER`	Any other payment method type not covered above

PAYMENT_METHOD_STATUS

State of a stored payment method.

Value	Description
`ENABLED`	Usable for charges
`DISABLED`	Not usable (disabled locally or by the provider)
`EXPIRED`	Expired (e.g. card past its expiration date)

MERCHANT_TRANSACTION_PROVIDER_STATUS

State of a connected provider configuration.

Value	Description
`ENABLED`	Provider connection is active and routable
`DISABLED`	Provider connection is inactive

TRANSACTION_ACH_SECCODE

ACH Standard Entry Class codes. Only relevant for ACH transactions.

Value	Description
`CCD`	Corporate Credit or Debit — used for business-to-business payments
`WEB`	Internet-initiated — used for consumer payments authorized online
`TEL`	Telephone-initiated — used for consumer payments authorized by phone
`UNKNOWN`	SEC code not recognized or not yet mapped

ENTITY_TYPE

Account holder type for ACH transactions.

Value	Description
`INDIVIDUAL`	The bank account holder is a person
`COMPANY`	The bank account holder is a business

PAYMENT_PLAN_STATUS

Describes the current state of a recurring payment plan.

Value	Description
`INITIALIZING`	Plan is being set up with the provider
`ACTIVE`	Plan is active and scheduled billing will continue
`INACTIVE`	Plan exists but billing is paused or suspended
`CANCELED`	Plan was canceled; no further charges will occur
`ENDED`	Plan reached its natural end date or cycle limit
`ERROR`	An error occurred during plan setup or a billing cycle

PAYMENT_PLAN_TEMPLATE_STATUS

Describes whether a payment plan template is available for use.

Value	Description
`ENABLED`	Template is active and can be used to create payment plans
`DISABLED`	Template is inactive and cannot be used to create new plans

CUSTOMER_RESOLUTION_STRATEGY

Controls how merchantApiCustomerResolve (and customer selectors elsewhere) match or create a customer from the provided identifiers.

Value	Description
`AUTO`	Resolve based on the provided identifiers and metadata. Internal IDs and provider codes are prioritized. Throws if the provided identifiers do not match.
`MATCH_OR_CREATE`	Match on the provided identifiers and metadata; if not found, create a new customer with the provided data.
`MATCH_OR_FAIL`	Match on the provided identifiers and metadata; if not found, throw an error.
`STRICT`	Resolve on the provided identifiers only (e.g. `id`, `providerCode`); no metadata is used. Throws if not found.

CUSTOMER_STATUS

Status of a customer record relative to the connected provider.

Value	Description
`ENABLED`	Customer is active with the provider
`DISABLED`	Customer is disabled with the provider
`ERROR`	The last provider sync or verification errored
`UNKNOWN`	Status not recognized or not yet mapped

CURRENCY

Supported ISO 4217 currency codes. This is a fixed enum — only the values below are accepted.

Value	Currency
`USD`	US Dollar
`EUR`	Euro

Amounts are always in the smallest unit of the currency (cents for USD and EUR).

COUNTRY_ISO_2

ISO 3166-1 alpha-2 country codes. Common values:

Value	Country
`US`	United States
`GB`	United Kingdom
`CA`	Canada
`AU`	Australia
`DE`	Germany
`FR`	France

Any valid ISO 3166-1 alpha-2 two-letter code is accepted.

TRANSACTION_PROVIDER

The payment provider type.

Value	Provider
`NUVEI`	Nuvei
`STRIPE`	Stripe

note

The enum accepts both values, but a provider only works once it is configured and enabled for your merchant account (each connection is a MerchantTransactionProvider). Passing a provider you have not enabled fails provider resolution. See Provider Integrations.

DEVICE_TYPE

Device classification for the optional device object on payment and session inputs.

Value	Description
`DESKTOP`	Desktop computer
`SMARTPHONE`	Smartphone
`TABLET`	Tablet
`TV`	Television / set-top device
`UNKNOWN`	Device type not determined

TRANSACTION_ACTION​

TRANSACTION_STATUS​

State transitions​

CLIENT_TRANSACTION_SESSION_KIND​

CLIENT_TRANSACTION_SESSION_STATUS​

PAYMENT_METHOD​

PAYMENT_METHOD_STATUS​

MERCHANT_TRANSACTION_PROVIDER_STATUS​

TRANSACTION_ACH_SECCODE​

ENTITY_TYPE​

PAYMENT_PLAN_STATUS​

PAYMENT_PLAN_TEMPLATE_STATUS​

CUSTOMER_RESOLUTION_STRATEGY​

CUSTOMER_STATUS​

CURRENCY​

COUNTRY_ISO_2​

TRANSACTION_PROVIDER​

DEVICE_TYPE​