Legacy APIEssentials

Authorized with Capture

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

Request

Authorized With Capture Request
apiLoginIDstringRequired>=7 characters<=8 characters

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

apiKeystringRequired=8 characters

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

customerIDstringRequired>=5 characters<=50 characters

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).

cartIDstringRequiredformat: "uuid">=5 characters<=50 characters

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).

Something went wrong!
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).

orderIDstringRequired>=5 characters<=50 characters
This is the immutable Order identifier used by your system to idenitify unique orders.
dateAuthorizedstringOptionalformat: "date-time"

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

dateCapturedstringOptionalformat: "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.

Response

OK
AuthorizedWithCaptureResultobject or null