This API allows a bank client to check the availability and conditions of the Earned Wage Access (EWA) service. The response provides information about whether the service is enabled, the maximum EWA amount, upcoming pay dates, and other relevant details.
Request
- Method:
GET - Endpoint:
/api/PinW/earnedWageAccess - Authentication: The request is made under the bank client's credentials (typically using an authentication token or session).
Response
The API returns information about Earned Wage Access, such as availability, terms, and conditions. The response structure is as follows:
Field Descriptions:
-
EWA Service Response – Field Descriptions
-
connectedFinancialAccountId – The account ID where Earned Wage Access (EWA) funds are sent.
-
maxEwaAmount – The maximum amount (in cents) the user can withdraw right now through EWA.
-
nextPayDate – The expected date of the user’s next paycheck.
-
ewaPayDate – The date when EWA funds will be made available to the user.
-
fee – The service fee charged for using EWA.
-
reviewStatus – Internal review stage
- Review = 1
- Accepted = 2
- Rejected = 3
- Cancelled = 4
- Repaid = 5
-
updateRequestStatusDate – The date/time when the status was last updated.
-
currentStatus (object with the current EWA service state)
-
isActive – Whether EWA is currently active for the user.
-
frequency – How often EWA is provided:
1 = One-time withdrawal.
2 = Every paycheck (recurring).
-
userOwnsMoney – Whether the user currently owes repayment for a previous EWA withdrawal.
-
ewaAmount – The amount (in cents) currently approved for withdrawal.
Example Response:
{
"connectedFinancialAccountId": "123456789",
"maxEwaAmount": "50000",
"nextPayDate": "2024-10-01",
"ewaPayDate": "2024-09-28",
"reviewStatus": 3,
"fee": 5,
"currentStatus": {
"isActive": true,
"frequency": 1,
"userOwnsMoney": true,
"ewaAmount": 20000
}
}