Enumerations

Look up source-linked Newline account, transfer, transaction, and VRN statuses, initiator types, and lock reasons.

Use this index to look up documented API values, distinguish resource statuses, and find the reference for the field you are implementing.

An enumeration is a field with a defined set of allowed values. Use the endpoint reference for required fields, defaults, nullable behavior, and constraints that are specific to an operation.

Status values belong to specific resources: a Transfer status, Transaction status, authorization status, and VRN registration status are not interchangeable. This index covers the values documented below; it is not a complete inventory of every API enum.

Account Resource Statuses

Account statuses describe the account itself, not its line items or individual payments.

Custodial Account Status

Source: Custodial Account Statuses.

ValueDescription
activeThe account is open and available for funds movement and balance inquiries.
archivedThe account is archived and has a zero balance.

Synthetic Account Status

Source: Synthetic Account Statuses.

ValueDescription
initiatedThe creation request is valid; account opening or validation is in progress.
activeThe account is available for supported transfers and transaction and balance inquiries.
failedThe account could not progress from initiated to active.
archivedThe account is no longer available and has a zero balance.

Transfers

Status

Source: Transfer Statuses.

ValueDescription
queuedNewline received a valid request and is preparing the Transfer.
pendingMovement of funds has begun.
canceledThe Transfer was canceled. Cancellation eligibility depends on its processing stage; a request during pending may fail if execution has begun.
failedThe Transfer failed because of a system or account issue. The reference states that a new Transfer is required to move the assets.
settledThe Transfer is complete and funds have settled in the destination Synthetic Account.

Do not use Combined Transfer statuses interchangeably with these values. The Combined Transfer reference documents a separate resource and lists queued, pending, failed, and completed.

Initiator Type

Field: initiator_type on Initiate a Transfer.

Default: customer.

ValueBehavior
customerDefault initiator type. Supplied transmitter information is ignored.
transmitterRequired when supplying transmitter information.

Set initiator_type explicitly to transmitter when submitting transmitter information. Consult the endpoint reference for the required transfer and rail-specific fields.

Transactions

Status

Source: Transaction Statuses and Types.

ValueDescription
queuedThe Transaction is being prepared from a Transfer request. Externally originated Transactions do not receive this status.
pendingProcessing is in progress until the related Transaction Events settle or cannot be completed.
canceledThe Transaction was canceled as a result of its Transfer being canceled.
deniedAn authorization request was rejected.
failedA related Transaction Event could not settle. Reversal of associated line items may be required.
settledThe Transaction is complete and all related Transaction Events have settled.
expiredA debit card authorization expired.
authorization_pendingA received VRN Transaction is awaiting client authorization.
authorization_deniedA received VRN Transaction was denied authorization and returned to the sender.

authorization_pending and authorization_denied are Transaction statuses, not values to substitute for the separate authorization status field.

Transaction Types and Authorization Statuses

Use Transaction Statuses and Types for the documented transaction types and separate authorization statuses. Type values distinguish payment activity, such as ach, wire, book_transfer, and instant_payment, from return and reversal records.

Client Authorization applies to received, not originated, transactions in programs with VRNs enabled. Confirm the accepted decision values against Approve or deny a transaction; do not assume every reported authorization outcome can be submitted as a decision.

For report inclusion and feature dependencies, see Authorizations CSVs Explained. Report selection criteria are not a substitute for an endpoint's accepted enum values.

Virtual Reference Numbers

VRN Status

Source: Virtual Reference Number Statuses.

ValueDescription
activeThe VRN is available for use and mapped to a general Synthetic Account.
archivedThe VRN is unavailable and cannot receive payments to its previously mapped account.

Instant Payment Rail Registration Status

Registration status is separate from VRN status. Instant Payment acceptance depends on rail access and registration; active alone does not establish readiness to receive Instant Payments.

Source: Virtual Reference Number Statuses.

ValueDescription
pendingRegistration setup with the RTP network is not complete.
registeredRegistration with the RTP network succeeded, allowing Instant Payment receipt to the mapped account.
unregisteredThe VRN is not registered for Instant Payment acceptance. The reference documents this state for clients without Instant Payment rail access.
failedThe reference describes a VRN failure. Contact your Newline Specialist for assistance.

VRNs without Instant Payment rail access can still receive ACH and wire payments as documented in Virtual Reference Number Statuses.

Lock Reasons

Source: Virtual Reference Number (VRN) Errors, error 30012, which lists customer_request and admin as allowed lock reasons.

Review Lock a single Virtual Reference Number for the current request requirements. Lock reasons are not additional VRN status values.

Related Documentation

Use the line-item endpoint references for supported filters and sorting parameters. Use the Wire transition guide for address format requirements; address formats are not presented here as API configuration enum values.


Did this page help you?