Merchant

Set Merchant Credentials

Available on Enterprise Plan

Sets or updates TaxCloud credentials for a merchant. Credentials are encrypted at rest with AES-256-GCM. On success an asynchronous webhook notification is sent to the configured endpoint.

Authentication

X-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
apiKeystringRequired

TaxCloud API key to associate with the merchant. Stored encrypted at rest with AES-256-GCM.

connectionIdstringRequired
TaxCloud connection ID that pairs with the API key to identify the merchant's TaxCloud integration.
merchantIdstringRequired
UUID of the merchant whose TaxCloud credentials are being set. The merchant must be owned by the calling account.

Response

OK
merchantIdstring
UUID of the merchant whose credentials were set.
messagestring

Human-readable description of the result.

statusstring

Result status of the operation (e.g. ‘success’).

Errors

400
Set Merchant Credentials Body Bad Request Error
401
Set Merchant Credentials Body Unauthorized Error
403
Set Merchant Credentials Body Forbidden Error
409
Set Merchant Credentials Body Conflict Error
422
Set Merchant Credentials Body Unprocessable Entity Error
500
Set Merchant Credentials Body Internal Server Error