For the complete documentation index, see llms.txt. This page is also available as Markdown.

Finalize Lease

Finalize a transaction

POST /v3/transactions/{transactionId}/finalize

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

x-consumer-custom-id

string

Consumer data with the format "channel:vendorId"

Path Parameters

The endpoint path expects parameters.

Name
Type
Required
Description

transactionId

string

The transaction ID provided at lease generation.

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": {
        "transactionId": "ABC-129384",
        "loanNumber": "1234567",
        "leaseNumber": "1234567"
    }
}
{
    "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

object

N/A

data.transactionId

string

N/A

data.loanNumber

string

N/A

data.leaseNumber

string

N/A

Last updated

Was this helpful?