Cost Ingestion

Set connector credentials

Changed on

Store the webhook secret and report-download credential for one registered connector account. Unregistered connector IDs are rejected with HTTP 400 before credentials are encoded or saved.

post/merchant-account/{merchantId}/connectors/{connector}/credentials

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/merchant-account/{merchantId}/connectors/{connector}/credentials
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Path parameters

merchantIdstring required

Merchant account id.

connectorstring required

Connector slug.

Request body

accountstring required

Connector-side account, e.g. Adyen merchantAccountCode.

webhook_secretstring required

Secret used to verify inbound webhook signatures.

download_authstring required

For Checkout, the secret key is treated as an opaque credential; the API URL is selected from server configuration using environment. For Adyen, Basic auth as user:password or a Report Service API key (X-API-Key). For Chase, JSON authentication credentials; token_url and reports_url fields are ignored in favor of server configuration.

environment'prod' | 'sandbox'

Checkout only. Selects the report API URL from cost_ingestion.connector server configuration; omitted means production. Missing endpoint settings default to https://api.checkout.com and https://api.sandbox.checkout.com. The backend stores the existing secret_key/api_base_url JSON internally.

Response

Credentials stored

merchant_idstring
connectorstring
accountstring
statusstring

Changes