List All EWA Disbursements for a Customer

Retrieve all Earned Wage Access (EWA) disbursements for a Customer Account. The enrollmentBeginDateFrom, enrollmentBeginDateTo, and timeZone query parameters are required. Use the sort query parameter to sort the results, and use the page and size query parameters to limit the number of results returned.

Endpoint

GET /v1/customer-profiles/{externalId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

externalId REQUIRED

string

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

Query Parameters

enrollmentBeginDateFrom REQUIRED

string (date), format: yyyy-MM-dd

Start date of the Customer’s EWA enrollment period. This filter will return Customer Profiles with an enrollment period that started on or after this date.

Can be used in conjunction with enrollmentBeginDateTo to define a date range for the enrollment period start date.

enrollmentBeginDateTo REQUIRED

string (date), format: yyyy-MM-dd

Start date of the Customer’s EWA enrollment period. This filter will return Customer Profiles with an enrollment period that started on or before this date.

Can be used in conjunction with enrollmentBeginDateFrom to define a date range for the enrollment period start date.

timeZone REQUIRED

string (timeZone)

Time zone for the enrollmentBeginDateFrom and enrollmentBeginDateTo filters. Must be entered as an IANA Time Zone Database Region in the format {Area}/{Location}. For example, the value for New York is America/New_York.

sort

array [string]

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

page

integer (int32)

Page number to return, based on zero-based page indexing.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns the EWA Profile and Disbursement object. This object contains the Customer’s EWA profile and a paginated response with an array of the Customer’s EWA disbursements.

SAMPLE RESPONSE

				
					{
  "id": "28562c80-155b-4ddc-bc4b-aedb7dcdeed2",
  "externalId": "52cb212e-d6d2-4afe-b9dc-4f9fe5c12c3b",
  "customerId": "ed51e0b5-ddbb-43e0-b14d-d66044bf81ac",
  "financialAccountId": "6aadfb7a-fc4f-481a-8f25-2d84810a4b9e",
  "latestEligibilityStatus": {
    "id": "2294d74b-c0e0-4a7f-9ea0-3a2117e83a4c",
    "eligibilityUpdateReason": "New application",
    "status": "NEW",
    "createdAt": "2024-01-22T22:20:55.610Z"
  },
  "enrollmentStatus": "ACTIVE",
  "firstName": "Sarah",
  "middleName": "Jane",
  "lastName": "Green",
  "programId": "abcdefg",
  "programName": "EWA",
  "amountToRecover": "-100.00",
  "enrollmentBegin": "2024-01-22T22:20:55.610Z",
  "enrollmentEnd": "2025-01-22T22:20:55.610Z",
  "payment": {
    "totalElements": 2,
    "totalPages": 1,
    "number": 0,
    "numberOfElements": 2,
    "hasNext": false,
    "content": [
      {
        "transactionId": "f3aaa9df-b0f7-4444-89c0-a50bcd29c385",
        "createdAt": "2024-02-02T23:36:26.752Z",
        "transactionType": "SEND",
        "latestStatus": {
          "status": "NEW"
        },
        "currency": "USD",
        "amount": "250.00"
      },
      {...}
    ]
  }
}