Get Transaction By ID

Get transaction by Id

GET /v3/transactions/{transactionId}

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"

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.

200

{
    "data": {
        "id": "eyJhbGcfasdvczOiJIUzI1NiIsInR5cCI6IkpXVC...",
        "orderId": "2f962a52-df63-426f-abc7-617055dba2f7",
        "customer": {
            "id": "5a319511a86980001d602095",
            "firstName": "John",
            "lastName": "Doe",
            "email": "[e-mail]"
        },
        "shippingCost": 1.23,
        "createdAt": "2018-03-19T15:51:27.080Z",
        "lease": {
            "id": "eyJhbGcfasdvczOiJIUzI1NiIsInR5cCI6IkpXVC...",
            "status": "signed"
        },
        "purchaseTotal": 3795,
        "purchaseSalesTax": 808
    }
}

400

{
    "error": {
        "statusCode": 400,
        "code": "UserAlreadyExists",
        "message": "User already exists with email [e-mail]",
        "data": {}
    }
}

404

{
    "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.id	string		transaction identifier
data.orderId	string		The reference to the external order ID
data.customer.id	string		User id
data.customer.firstName	string		First Name
data.customer.lastName	string		Last Name
data.customer.email	string		Last Name
data.shippingCost	number		shipping cost number
data.createdAt	string		transaction creation date
data.lease.id	string		order identifier
data.lease.status	string		Signing status of the transaction
data.items	array		N/A
data.purchaseTotal	number		total purchase cost in cents
data.purchaseSalesTax	number		total sale tax in cents