FlexShopper API
3.0-preview
FlexShopper API
3.0-preview
  • Integration Guides
    • Medusa
    • Payment Plugin
  • Customer
    • Verify User Exists
    • Deeply Verify User Exists
    • Create User
    • Get Users
    • Get User
    • Create Authorization Token
    • Add Payment Method
      • Get LoanPaymentPro Child Key
      • Get Clover PKMS Key
  • Decision
    • Apply for Spending Limit
  • Lease
    • Create Lease
    • Get Transactions
    • Get Lease By ID
    • Get Transaction By ID
    • Sign Lease
    • Finalize Lease
    • Cancel Items
    • Return Items
    • Confirm Shipment
    • Confirm Receipt
Powered by GitBook
On this page
  • Request
  • Headers
  • Path Parameters
  • Response
  • Samples
  • Schema

Was this helpful?

Export as PDF
  1. Lease

Get Lease By ID

Returns the details of a lease.

GET /v3/leases/:leaseId

Request

Headers

Name
Type
Description

Customer-Token

string

Customer's authentication token

Authorization

string

Authentication token

Path Parameters

Name
Type
Description

leaseId

string

Lease agreement identifier

Response

Samples

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

Schema

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.

PreviousGet TransactionsNextGet Transaction By ID

Last updated 9 days ago

Was this helpful?