Skip to content

Statuses & enums

The Payments API returns values by name (e.g. SUBSCRIPTION_START). Some webhook fields (status_id, transaction_type_code), the platform filters and the reports use the numeric code.

Value Description
ACTIVE Subscription active; renewals are billed.
SINGLE_PURCHASE Customer of a one-time product. No renewals.
UNSUBSCRIBED Subscription cancelled. No further charges.
UNBILLABLE No merchant account could authorize the card at signup.
OVERDUE Payment overdue.
FROZEN Temporarily suspended.
Value Code Description Refundable
RECURRING_PAYMENT 100 Renewal payment. Yes
SUBSCRIPTION_START 101 First payment of a subscription. Yes
TEST_MID 108 Test payment made by CreditCore to check a merchant account. Yes
PREAUTHORIZED 110 Authorization hold, not captured yet. No
CAPTURE_PREAUTHORIZED 111 Capture of a previous authorization. Yes
VOIDED 120 Authorization cancelled before settlement. No
REFUNDED 122 Full or partial refund (negative amount). No
ONE_TIME_PAYMENT 130 Single payment for a one-time product. Yes
Value Code Description
NO_REFUNDABLE 0 Can’t be refunded (e.g. declined, voided, pre-authorization).
REFUNDABLE 1 Can be refunded. Set on successful transactions of a refundable type.
ALERT 2 A chargeback-prevention alert (Ethoca) was received for it.
REFUNDED 3 Fully refunded.
PARTIALLY_REFUNDED 4 Part of the amount was refunded.
Value Code Description
DENY 0 Deny all transactions.
REFUND 1 Allow only refunds.
REBILLS 2 Allow only renewals of existing customers.
ALL 3 Allow all transactions.
Value Description
CONVERSION New customer.
TRANSACTION Charge attempted (first payment or renewal).
REFUND Refund processed.
CANCELLATION Customer unsubscribed.
Value Platform label Description
ROLE_ADMIN Admin Full access to the account, including users and the API token.
ROLE_NORMAL_USER Normal User Day-to-day operation.
ROLE_REPORTS Reports Reporting access.

See Users & access.

See Decline codes.