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
Poll or use webhooks for STARTED transactions. A STARTED transaction that is not resolved may transition to EXPIRED after a provider-defined timeout.
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 |
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 |
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 |
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 |
CURRENCY
ISO 4217 currency codes. Common values:
| Value | Currency |
|---|---|
USD | US Dollar |
EUR | Euro |
GBP | British Pound Sterling |
CAD | Canadian Dollar |
AUD | Australian Dollar |
JPY | Japanese Yen |
Any valid ISO 4217 three-letter code is accepted. Amounts are always in the smallest unit of the currency (cents for USD, pence for GBP, etc.).
JPY and other zero-decimal currencies do not use minor units. An amount of 500 in JPY means ¥500, not ¥5.00. Check the currency's decimal places before sending amounts.
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
Provider values are integration-specific. See the Provider Integrations section in the sidebar (Nuvei, Stripe) for the list of accepted values for each payment provider you have configured.
TRANSACTION_PROVIDER values are not listed here because they depend on which providers are enabled for your merchant account. Contact AccruPay support or refer to your integration documentation for the exact values to use.