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
  • /v3/leases/{leaseId}
  • Response Parameters

Was this helpful?

Export as PDF
  1. API Reference
  2. Lease Management

Get Lease By ID

Returns the details of a lease.

/v3/leases/{leaseId}

GET https://apis.sandbox.flexshopper.com/v3/leases/{leaseId}

Path Parameters

Name
Type
Description

leaseId

string

Lease agreement identifier

Headers

Name
Type
Description

Customer-Token

string

Customer's authentication token

Authorization

string

Authentication token

{
  "data": {
    "leaseId": "\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1YTk...",
    "contract": "...base64 html contract",
    "leaseStatus": "signed"
  }
}
{
  "error": {
    "statusCode": 404,
    "code": "LeaseNotFound",
    "message": "The lease was not found",
    "data": {}
  }
}

Response Parameters

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the lease info

Key

Type

Description

leaseId

string

A unique identifier for the generated lease.

contract

string

The lease contract, expressed as base64-encoded HTML.

leaseStatus

string

The current status of this

lease, one of "signed" or "unsigned".

frequency

string

The frequency of payments, such as "weekly".

term

number

The term/length of the lease.

payment

number

The term payment amount with tax.

cashPrice

number

The total "Same as Cash" price of the lease, if available.

costOfRental

number

The lease total minus the cost.

PreviousCreate LeaseNextSign Lease

Last updated 2 months ago

Was this helpful?