FlexShopper API
3.0
FlexShopper API
3.0
  • Introduction
  • 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
  • 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

The details below help you form your HTTP requests to this endpoint.

Headers

You may need to provide specific headers.

Name
Type
Required
Description

customer-token

string

Customer's authentication token

x-version-override

string

N/A

Response

The details below help you understand the responses you could get from this endpoint.

Samples

Below are samples of responses, with tabs corresponding to returned status code.

{
    "data": {
        "leaseId": "\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1YTk...",
        "contract": "...base64 html contract",
        "leaseStatus": "signed",
        "frequency": "weekly",
        "term": 52,
        "payment": 17.28,
        "cashPrice": 400,
        "costOfRental": 440,
        "isExpired": false
    }
}
{
    "error": {
        "statusCode": 400,
        "code": "UserAlreadyExists",
        "message": "User already exists with email ex@example.com",
        "data": {}
    }
}
{
    "error": {
        "statusCode": 404,
        "code": "LeaseNotFound",
        "message": "The lease requested was not found",
        "data": {}
    }
}

Schema

The response's schema is outlined below.

Name
Type
Required
Description

data.leaseId

string

A unique identifier for the generated lease

data.contract

string

The lease contract, expressed as base64-encoded HTML

data.leaseStatus

string

N/A

data.frequency

string

Frequency of lease payments

data.term

number

Term of the lease

data.payment

number

Periodic payment with tax

data.cashPrice

number

Cash price of the lease

data.costOfRental

number

Cost of the lease

data.isExpired

boolean

Whether the lease has expired

PreviousGet TransactionsNextGet Transaction By ID

Last updated 4 days ago

Was this helpful?