FlexShopper API
3.0-preview
FlexShopper API
3.0-preview
  • 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
  • Body
  • Response
  • Samples
  • Schema

Was this helpful?

Export as PDF
  1. Lease

Sign Lease

Signs a lease agreement and makes prepayment if necessary

POST /v3/leases/{leaseId}/sign

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

Body

You must provide a JSON payload.

Name
Type
Required
Description

ipAddress

string

The IP address of the device that was used to sign the lease.

timestamp

string

The date and time of the lease's signing.

signed

boolean

The signed status of the lease. Should be true

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": {}
}
{
    "error": {
        "statusCode": 400,
        "code": "UserAlreadyExists",
        "message": "User already exists with email ex@example.com",
        "data": {}
    }
}
{
    "error": {
        "statusCode": 402,
        "code": "PaymentRequired",
        "message": "User user must make a payment to access a requested resource",
        "data": {}
    }
}
{
    "error": {
        "statusCode": 404,
        "code": "LeaseNotFound",
        "message": "The lease requested was not found",
        "data": {}
    }
}
{
    "error": {
        "statusCode": 410,
        "code": "LeaseExpired",
        "message": "The lease expired. Please create a new lease.",
        "data": {}
    }
}

Schema

The response's schema is outlined below.

PreviousGet Transaction By IDNextFinalize Lease

Last updated 1 day ago

Was this helpful?