Enable/Disable EWA

This API method is used by the bank client to enable or disable the Earned Wage Access (EWA) service. It allows the user to activate or deactivate the service based on the provided parameters.

Request Payload:

{  
  "active": true,       // Boolean indicating whether to enable (true) or disable (false) the service  
  "frequency": 0,       // Integer specifying the type of service (0 for one-time, 1 for recurring)  
  "ewaAmount": 0,       // The amount of funds to be accessed via EWA  
  "ewaDate": "2024-09-25T14:07:47.657Z" // The date when the EWA transaction is to be processed  
}

Request Parameters:

active:

  • Type: Boolean
  • Description: Controls whether the service is being activated (true) or deactivated (false).
  • Example: "active": true enables the service, while "active": false disables it.

frequency:

  • Type: Integer
  • Description: Specifies the type of service:
    • 0 for a one-time EWA service.
    • 1 for a recurring EWA service.
  • Example: "frequency": 0

ewaAmount:

  • Type: Integer
  • Description: The amount of money to be accessed through the EWA service.
  • Example: "ewaAmount": 500

ewaDate:

  • Type: DateTime (ISO 8601 format)
  • Description: The date and time when the EWA transaction should be processed.
  • Example: "ewaDate": "2024-09-25T14:07:47.657Z"

Response:

On success, this API will confirm the activation or deactivation of the service with the provided parameters.

Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!