---
title: "Update a client session secret (no auth)"
method: POST
path: "/setup-intents/public/{setupIntentId}/refresh-client-session-secret"
tags: ["Setup intents"]
---

# Update a client session secret (no auth)

`POST /setup-intents/public/{setupIntentId}/refresh-client-session-secret`

## Request

- Base URL: `https://api.dojo.tech`
- URL: `https://api.dojo.tech/setup-intents/public/{setupIntentId}/refresh-client-session-secret`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/dojo/apis/dojo-api/docs/setup-intents/public/:setupIntentId/refresh-client-session-secret/post.ts> (a function with typed inputs; its response is checked against the schema)

Updates a client session secret.

## Path parameters

- `setupIntentId` string, nullable, required

## Headers

- `version` string, date, required

## Response `200`

OK

- SetupIntentPublicResponse
  - `id` string, nullable: The unique identifier for the setup intent.
  - `clientSessionSecret` string, nullable: The client secret.
  - `clientSessionSecretExpirationDate` string, date-time, nullable: The expiration date of `clientSessionSecret`.
  - `status` 'Created' | 'Authorized' | 'Canceled' | 'Completed' | 'Expired' | 'CardExpired' | 'Closed': Current status of the setup intent.
  - `paymentMethods` PaymentMethod[], nullable: The payment methods that customers can use to pay. (Card, Wallet, SavedCard)
  - `customer` Customer: Details about the customer.
    - `id` string, nullable: The unique identifier of the customer.
    - `name` string, nullable: The customer's name.
    - `emailAddress` string, nullable: The customer's email address.
    - `phoneNumber` string, nullable: The customer's phone number.
  - `requestSecurity` RequestSecurity: Customer's device information.
    - `userAgent` string, nullable: The customer's browser agent.
    - `ipAddress` string, nullable: The customer's device IP address.
    - `device` string, nullable: The customer's device type.
  - `billingAddress` Address: Details about the address.
    - `address1` string, nullable: Address line 1 (for example, company name).
    - `address2` string, nullable: Address line 2 (for example, street, apartment, or suite).
    - `address3` string, nullable: Address line 3.
    - `address4` string, nullable: Address line 4.
    - `city` string, nullable: City, town, district, suburb, or village.
    - `state` string, nullable: State, province, or region.
    - `postcode` string, nullable: ZIP or postal code.
    - `countryCode` string, required: Two-letter country code in [ISO 3166–1-alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
    - `locality` string, nullable: Locality, can use in addition to city.
    - `county` string, nullable: County or zone.
  - `shippingDetails` ShippingDetails: Details about the shipping.
    - `name` string, nullable: The name of the customer.
    - `deliveryNotes` string, nullable: The delivery notes.
    - `address` Address: Details about the address.
      - `address1` string, nullable: Address line 1 (for example, company name).
      - `address2` string, nullable: Address line 2 (for example, street, apartment, or suite).
      - `address3` string, nullable: Address line 3.
      - `address4` string, nullable: Address line 4.
      - `city` string, nullable: City, town, district, suburb, or village.
      - `state` string, nullable: State, province, or region.
      - `postcode` string, nullable: ZIP or postal code.
      - `countryCode` string, required: Two-letter country code in [ISO 3166–1-alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
      - `locality` string, nullable: Locality, can use in addition to city.
      - `county` string, nullable: County or zone.
  - `createdAt` string, date-time: The creation date, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format.
  - `updatedAt` string, date-time: The timestamp of the update date, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format.
  - `expireAt` string, date-time, nullable: The timestamp and date of when a setup intent will be voided, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. This occurs when a setup intent is created and not yet authorized.
  - `reference` string, nullable: A unique identifier for the payment. For example, `Order 236`.
  - `description` string, nullable: The payment description.
  - `merchantConfig` MerchantConfig: Details about the merchant configuration.
    - `supportedPaymentMethods` SupportedPaymentMethods
      - `cardSchemes` CardScheme[], nullable: Supported card schemes.
      - `wallets` WalletPaymentOption[], nullable: List of supported payment wallets.
  - `config` PaymentIntentConfigResponse
    - `title` string, nullable: The [checkout page’s title](../payments/accept-payments/checkout-page/configuration#add-information-about-your-company).
    - `redirectUrl` string, uri, nullable: The URL that a customer will be directed to after payment.
    - `cancelUrl` string, uri, nullable: The URL that a customer will be directed to when canceling a payment.
    - `customerEmail` PaymentIntentConfigCustomerEmail: Include a configurable customer email address as part of the payment intent. Configurable fields can be altered later by [updating](./payments/manage-payments/change-amount) the payment intent.
      - `collectionRequired` boolean: Set to `true` if the object requires collection.
    - `details` PaymentIntentConfigDetails
      - `showTotal` boolean: If has the value `true`, the total order amount will be showed.
      - `showReference` boolean: If the value is `true`, the order reference ID will be shown.
    - `billingAddress` PaymentIntentConfigBillingAddress
      - `collectionRequired` boolean: Set to `true` if the object requires collection.
    - `shippingDetails` PaymentIntentConfigShippingDetails
      - `collectionRequired` boolean: Set to `true` if the object requires collection.
    - `payment` PaymentConfigDetails
      - `customAmountAllowed` boolean: If set to `true` the amount of the payment intent can be changed.
      - `tipsAllowed` boolean: If set to `true`, tip is allowed.
  - `metadata` object, nullable: A set of key-value pairs that you can use to store additional information.
  - `paymentDetails` PaymentDetails: The payment details object.
    - `transactionId` string, nullable: The unique identifier of the transaction.
    - `transactionDateTime` string, nullable: The date and time of the payment in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format.
    - `message` string, nullable: The description of the operation.
    - `paymentMethodId` string, nullable: The unique identifier of the customer payment method.
    - `authCode` string, nullable: The acquirer's authorization code. This code is returned on a successful transaction.
    - `card` Card
      - `cardNumber` string, nullable: The card number.
      - `cardName` string, nullable: The name of the cardholder.
      - `expiryDate` string, nullable: If available, the expiry date of the card in the format 'MM/YY'.
      - `cardType` string, nullable: The card scheme.
      - `cardFundingType` string: The main funding types are credit, debit, pre-paid, and charge.
      - `last4PAN` string, nullable: The last four digits of the Primary Account Number. For Visa and Mastercard, this will be the four numbers at the end of the sixteen-digit card number.
      - `entryMode` string: Entry mode of the payment. (Contactless, ContactChip, Magstripe, ManualEntry, Unknown)
      - `verificationMethod` string: Method used to verify that the person presenting the card is the legitimate cardholder. The most common verification methods are PIN and signature. (Pin, Signature, Device, None)
    - `avsResult` string, nullable: The result of the Address Verification Service (AVS) check.
  - `intendedAmount` Money: The amount intended to be collected by this payment intent excluding `tipsAmount` `serviceChargeAmount` and `cashbackAmount`.
    - `value` integer, required: The amount in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) minor units, for example, "100" for 1.00 GBP.
    - `currencyCode` string, required: Three-letter currency code in [ISO 4217 alpha-3](https://www.iso.org/iso-4217-currency-codes.html) format. Accepts `GBP` and `EUR`.
  - `merchantInitiatedTransactionType` string: Details about the merchant-initiated transaction type (NoShow, Unscheduled)
  - `terms` string, nullable: The terms that customers are required to review before adding a card to the setup intent.
  - `paymentSource` string, nullable: Information about a single payment source type. Invalid if used along with `paymentSources` parameter.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `404`: Not found

---

[API](https://skmtc.dev/dojo/apis/dojo-api.md) - [All operations](https://skmtc.dev/dojo/apis/dojo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dojo/apis/dojo-api/revisions/29fc8900ba37?raw)