EWA Disbursement Object

The Earned Wage Access (EWA) Disbursement object represents a disbursement made to a Customer as part of an EWA Program. This object contains the disbursement transaction details, the EWA Program ID, the Customer ID, and the Customer’s EWA enrollment status.

Attributes

businessAccountId

string (UUID)

ID of the Business Account that manages the Earned Wage Access (EWA) program.

customerProfileId

string (UUID)

ID of the Customer’s Earned Wage Access (EWA) Profile in RocketKOR.

externalId

string

Your organization’s Earned Wage Access (EWA) reference number for the employee.

customerId

string (UUID)

ID of the Customer Account.

eligibilityStatus

string enum, values: NEW, ELIGIBLE, INELIGIBLE, ARREARS, BAD_DEBT, DISABLED

Customer’s eligibility status for Earned Wage Access (EWA) programs. The following values are supported:

NEW An EWA Customer Profile has been created for the Customer. This is the default value when a Customer is created or onboarded to an EWA Program.
ELIGIBLE The EWA Customer Profile has access to an EWA Program. Funds can be disbursed to the Customer Profile from the EWA Program.
INELIGIBLE The EWA Customer Profile is no longer able to access the EWA Program. Funds will not be disbursed to the Customer Profile but recovery will still be attempted.
ARREARS The latest recovery attempt for the EWA Customer Profile was not processed successfully. Funds will not be disbursed to the Customer Profile.
BAD_DEBT Several recovery attempts for the EWA Customer Profile have failed and funds are no longer expected to be recovered. Funds will not be disbursed to or recovered from the Customer Profile.
DISABLED The EWA Customer Profile is no longer eligible for the EWA Program.

enrollmentStatus

string enum, values: ACTIVE, INACTIVE

Customer’s EWA enrollment status. The following values are supported:

ACTIVE The Customer Profile is enrolled in an active EWA Program.
INACTIVE The Customer Profile is not enrolled in an active EWA Program.

programId

string

ID of the Earned Wage Access (EWA) program for the Customer.

payment

object

Disbursement payment details.

transactionId

string (number)

ID of the disbursement transaction in the RocketKOR system.

createdAt

string (date-time)

Date and time the disbursement transaction was created in the RocketKOR system.

transactionType

string enum, values: SEND

Type of transaction. The following value is supported:

SEND Push funds from an internal or Business Financial Account to the Customer’s external Financial Account.

latestStatus

object

Current status of the transaction.

status

string enum, values: NEW, PENDING, PROCESSING, APPROVED, SETTLED, CLEARED, CANCELLED, DECLINED, REVERSED, ERROR

Transaction status. The following values are supported:

NEW The transaction has been created in RocketKOR.
PENDING The transaction has been moved from the RocketKOR Transaction Domain to one of the RocketKOR Processing Domains. The transaction is still in the RocketKOR system (meaning it has not been transmitted to the Provider for processing) and is in a state where it can be cancelled.
PROCESSING One of the following is true: (a) the transaction is in a RocketKOR Processing Domain but can no longer be cancelled, or (b) the transaction has been transmitted to the Provider for processing.
APPROVED Disbursement has been approved by the Provider.
SETTLED The transaction has been settled by the Provider.
CLEARED The Sponsor has indicated that funds movement for the transaction is complete. The funds are now available in the Master Settlement Account (MSA). This status is only applicable for “received” transactions.
CANCELLED The transaction has been cancelled.
DECLINED Disbursement has been declined by the Provider.
REVERSED A transaction was submitted by RocketKOR to move funds in the opposite direction of the initial transaction. This “reverses” the transaction by moving the funds back to the original account.
ERROR The transaction could not be processed due to one or more errors (for example, the Provider system is unavailable after a number of retries). The ERROR status is only activated after RocketKOR determines that it cannot continue processing the transaction.

currency

string

Currency used for the transaction. Must be an ISO 4217 alpha 3-character currency code.

amount

string (decimal)

Amount of the transaction.

EWA Disbursement Object

				
					{
  "businessAccountId": "string(UUID)",
  "customerProfileId": "string(UUID)",
  "externalId": "string",
  "customerId": "string(UUID)",
  "eligibilityStatus": "NEW | ELIGIBLE | INELIGIBLE | ARREARS | BAD_DEBT | DISABLED",
  "enrollmentStatus": "ACTIVE | INACTIVE",
  "programId": "string",
  "payment": {
    "transactionId": "string(UUID)",
    "createdAt": "string(date-time)",
    "transactionType": "SEND",
    "latestStatus": {
      "status": "NEW | PENDING | PROCESSING | APPROVED | SETTLED | CLEARED | CANCELLED | DECLINED | REVERSED | ERROR"
    },
    "currency": "string",
    "amount": "string"
  }
}