EWA Profile and Disbursement Object

The Earned Wage Access (EWA) Profile and Disbursement object represents a Customer who has been enrolled in an EWA Program and the EWA disbursements they have received. The object includes information about the Customer, their Financial Account, their EWA eligibility status, and the EWA Program in which they are enrolled. It also includes details for the EWA disbursement transactions made to the Customer.

Attributes

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. This should be a string that is used to identify the employee in your internal systems, such as your payroll software. The EWA reference number is added to the employee’s Customer Account, allowing you to easily locate the employee in RocketKOR. EWA reference numbers must be unique within the Business Account.

customerId

string (UUID)

ID of the Customer Account.

financialAccountId

string (UUID)

ID of the Customer’s external card Financial Account. This Financial Account is used for the EWA Program.

latestEligibilityStatus

object

Customer’s current eligibility status for the Earned Wage Access (EWA) program.

string (UUID)

ID of the status.

eligibilityUpdateReason

string

Reason the Customer’s status has been updated.

status

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

Customer’s current eligibility status. 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 and can be used to disburse funds.
INELIGIBLE The EWA Customer Profile is no longer able to access the EWA Program. Funds will not be disbursed 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.
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 or recovered.
DISABLED The EWA Customer Profile is no longer valid for the EWA Program.

createdAt

string (date-time)

Date and time the status was assigned to the Customer.

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.

firstName

string, min length: 1, max length: 40

Customer’s first name.

middleName

string, min length: 1, max length: 40

Customer’s middle name.

lastName

string, min length: 1, max length: 40

Customer’s last name.

programId

string

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

programName

string

Name of the Earned Wage Access (EWA) Program for the Customer.

amountToRecover

string (decimal)

Total amount to be recovered from the Customer.

enrollmentBegin

string (date-time

Start date of the Customer’s EWA enrollment period.

enrollmentEnd

string (date-time

End date of the Customer’s EWA enrollment period.

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 Profile and Disbursement Object

				
					{
  "id": "string(UUID)",
  "externalId": "string",
  "customerId": "string(UUID)",
  "financialAccountId": "string(UUID)",
  "latestEligibilityStatus": {
    "id": "string(UUID)",
    "eligibilityUpdateReason": "string",
    "status": "NEW | ELIGIBLE | INELIGIBLE | ARREARS | BAD_DEBT | DISABLED",
    "createdAt": "string(date-time)"
  },
  "enrollmentStatus": "ACTIVE | INACTIVE",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "programId": "string",
  "programName": "string",
  "amountToRecover": "string",
  "enrollmentBegin": "string(date-time)",
  "enrollmentEnd": "string(date-time)",
  "payment": {
    "totalElements": integer(int32),
    "totalPages": integer(int32),
    "number": integer(int32),
    "numberOfElements": integer(int32),
    "hasNext": boolean,
    "content": [
      {
        "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"
      },
      {...}
    ]
  }
}