API Requests
Every request to FlexShopper API must include an API Key in the Authorization header. This API Key is provided by FlexShopper.
Last updated
Every request to FlexShopper API must include an API Key in the Authorization header. This API Key is provided by FlexShopper.
Last updated
To construct a REST API request, combine these components:
All monetary values included in the request (prices, costs, etc.) are displayed as dollars.
To access a customer's resources such as applications or leases, the request must be signed with a temporary JSON Web Token. JWT tokens are generated by customer approval and stored in the Customer-Token
header.
Component
Description
The HTTP method
GET
. Requests data from a resource.POST
. Submits data to a resource to process.PUT
.
The URL to the API service
Sandbox. https://apis.sandbox.flexshopper.com
Live. https://apis.flexshopper.com
The URI to the resource
The resource to query, submit data to, update, or delete. For example, v3/transactions
.
Query parameters
Optional. Controls which data appears in the response. Use to filter, limit the size of, and sort the data in an API response.
HTTP request headers
Includes the Authorization
header with the access token.
A JSON request body
Required for most GET
and POST
calls.
Key
Required
Description
Authorization
Yes
FlexShopper API Key.
Customer-Token
No
Temporary token to access customers resources.