Authorize and Capture a previous Lookup request. Required for tax reporting.

AuthorizedWithCapture Description

Request

POST https://api.taxcloud.net/1.0/TaxCloud/AuthorizedWithCapture

Request body

The request body takes a complete AuthorizedWithCapture resource, containing the following writable properties:

{
    "apiKey": "string",
    "apiLoginID": "string",
    "cartID": "uuid",
    "customerID": "string",
    "dateAuthorized": "date-time",
    "dateCaptured": "date-time",
    "orderID": "string"
}

Properties

Name Type Description Additional
apiKey string

Find your API KEY via https://taxcloud.com/go/stores/

apiLoginID string

Find your API ID via https://taxcloud.com/go/stores/

cartID uuid

CartID is very similar to an Order ID, except most systems do not issue immutable (permanent) identifiers for orders until customers actually place their order (clicking the BUY button).

IMPORTANT: You must be able to persist the CartID accross all Lookup requests for a particular customer (including situations where a customer puts an item in her cart before logging in, then proceeds ordering after logging in).

If your system does not provide a mechanism to create unique identifiers, you can omit this parameter (or submit as null) and TaxCloud will provide a unique identifier in the response (which you should persist for subsequent Lookup calls and the ultimate Authorized or AuthorizedWithCapture calls).

customerID string

This should be the abstract identifier used by your system to uniquely identify customers. Note: This should not be your customer's email address or any other form of Personally Identifiable Information (PII).

dateAuthorized date-time

The Date/Time of record for Authorization. If omitted, this value is inferred from the time the API call is received.

Optional
dateCaptured date-time

The Date/Time of record for Capture (or shipping date). If omitted, this value is inferred from the time the API call is received.

Optional
orderID string

This is the immutable Order identifier used by your system to idenitify unique orders.

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

AuthorizedWithCaptureResponse

Explore this API

AuthorizedWithCapture
Request Content-Type
Response Content-Type
Try it out!