FlexShopper API
3.0-legacy
FlexShopper API
3.0-legacy
  • Getting Started
  • Our Platforms
    • FlexPay Payment Platform
    • FlexShopper Backend API
  • API Reference
    • Get Started
      • API Requests
      • API Responses
      • Error Codes
    • User Management
      • Create User
      • Get Users
      • Get User
      • Verify User Exists
      • Deeply Verify User Exists
      • Get LoanPaymentPro Child Key
      • Add Payment Method
    • Customer Authentication
      • Request Passcode
      • Login Customer
    • Customer Application
      • Initiate Application
      • Get Verification Questions
      • Verify Answers
      • Validate Routing Number
    • Lease Management
      • Create Lease
      • Get Lease By ID
      • Sign Lease
      • Checkout
    • Purchase Transactions
      • Get Transactions
      • Get Transaction By ID
      • Cancel Items
      • Return Items
      • Confirm Shipment
      • Confirm Receipt
    • Products
      • Get Products
    • Settings
  • Change Log
Powered by GitBook
On this page
  • Request body parameters
  • Authorization Headers

Was this helpful?

Export as PDF
  1. API Reference
  2. Get Started

API Requests

Every request to FlexShopper API must include an API Key in the Authorization header. This API Key is provided by FlexShopper.

Request body parameters

To construct a REST API request, combine these components:

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 Authorizationheader with the access token.

A JSON request body

Required for most GETand POST calls.

All monetary values included in the request (prices, costs, etc.) are displayed as dollars.

Authorization Headers

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.

Key

Required

Description

Authorization

Yes

FlexShopper API Key.

Customer-Token

No

Temporary token to access customers resources.

PreviousGet StartedNextAPI Responses

Last updated 6 years ago

Was this helpful?