Application
Use the Application APIs to create and manage application forms on behalf of merchants.
What are applications?
Applications are forms to fill in on behalf of the merchant you wish to onboard on FlexFactor.
FlexFactor team will review the application + their attached documents before issuing an
APPROVEDorDECLINEDstatus.
Application endpoints
| endpoint | link to documentation |
|---|---|
| POST /v1/onboarding/application | Create a new applicant |
| GET /v1/onboarding/application/{id} | Retrieve the details on a specific application. |
| PUT /v1/onboarding/application/{id} | Edit the details of a specific application |
| POST /v1/onboarding/application/{id}/submit | Send an application for underwriting review |
| GET /v1/onboarding/application/list | Retrieve the status of multiple applications |
| POST /v1/onboarding/application/{id}/cancel | Cancel a pending application |
| POST /v1/onboarding/application/{id}/convert | Convert an APPROVED applicant into a merchant |
General information
The APIs are RESTful, they use HTTP methods (POST, PUT, GET) to perform functions on objects.
Some requests include data in their message body, for example to define the attributes of the object being created or updated.
Endpoints
| Sandbox testing | https://api-sandbox.flex-charge.com/v1/ |
| Production environment | https://api.flex-charge.com/v1/ |
The sandbox is a completely isolated environment, so feel free to experiment. When you're ready to move to production, we will provide you production credentials and give you access to the live environment.
Real financial data should never be used in the Sandbox.
Headers
To communicate with the Core API, you must include the proper headers in your API requests.
Request headers
You must include the following headers in requests sent to the Core API:
| Name | Description | Request Type | Value |
|---|---|---|---|
| authorization | Any request must be authenticated. | GET, POST, PUT | Api key/Token |
| content-type | The media type of the resource | POST, PUT | application/json |
Versioning
The Core API version is indicated in each endpoint resource path.
For example, <https://api.flex-charge.com/v1/transmit> indicates the API is at version 1.
FlexFactor increments the version number when it releases a new version containing backwards-incompatible changes. Minor updates and bug fixes are typically released without incrementing the version number.
Ensure that your application handles API revisions by allowing for additional, unspecified resource fields in the response and for variable response sizes.
Errors
Use this list to diagnose failed transactions and fine-tune your exception-handling capabilities.
Error codes are based on HTTP response codes: the first three digits specify the HTTP response code, and the last three digits represent the error.
| Response Code | Description |
|---|---|
| 200 OK | Your request completed successfully. |
| 201 Created | Resource created successfully. |
| 204 No Content | Returned on a successful DELETE. |
| 401 Unauthorized | Enter valid credentials to continue. |
| 403 Forbidden | Access to the requested resource is denied. |
| 405 Method Not Allowed | The method you supplied is not allowed for that resource, for example a PUT method on a read-only resource. |
| 500 Internal Server Error | An error occurred that could not be handled by the application. |
| 502 Bad Gateway | An invalid response was received by the server. |
| 503 Service Unavailable | The server is temporarily unable to handle this request. |
| 504 Gateway Timeout | The server timed out while attempting to complete this request. |
Updated 3 days ago