---
title: "POST /payments/{paymentId}/tokens"
method: POST
path: "/payments/{paymentId}/tokens"
tags: ["payment-controller"]
---

# POST /payments/{paymentId}/tokens

`POST /payments/{paymentId}/tokens`

## Path parameters

- `paymentId` integer, required

## Headers

- `X-Zendesk-Doorman-Auth-Response` string, required

## Request body

- PaymentPlanTokenRequest
  - `sourceType` 'ZENDESK' | 'ZENDESK_CHAT' | 'INTERCOM' | 'HELP_SCOUT' | 'FRESHDESK' | 'KUSTOMER' | 'MANUAL_IMPORT' | 'BROWSER_EXTENSION' | 'AIRCALL' | 'SALESFORCE' | 'HELPSHIFT' | 'DIXA' | 'FRONT' | 'GORGIAS' | 'TALKDESK' | 'FRESHCHAT' | 'GENESYS', required
  - `name` string
  - `subdomain` string
  - `token` string
  - `tokenSecret` string
  - `username` string
  - `clientId` string
  - `clientSecret` string
  - `redirectUri` string
  - `range` 'BACK_1_DAY' | 'BACK_7_DAYS' | 'BACK_1_MONTH' | 'PREVIOUS_WEEK' | 'THIS_WEEK' | 'THIS_MONTH' | 'PREVIOUS_MONTH'
  - `addToAllTeams` boolean
  - `maskClientData` boolean
  - `ignoreTicketFields` string[]
  - `includeTicketTags` string[]
  - `ignoreTicketTags` string[]
  - `groupNameFilterList` string[]
  - `includeGroups` string[]
  - `ignoreGroups` string[]
  - `mailboxNameFilterList` string[]
  - `includeMailboxes` string[]
  - `ignoreMailboxes` string[]
  - `includeChannels` string[]
  - `ignoreChannels` string[]
  - `ignoreCsatAbove` string
  - `pullBodyFromIntegration` boolean
  - `pullSubjectFromIntegration` boolean
  - `removeAttachmentUrls` boolean
  - `intercomTeamId` string
  - `intercomSubdomain` string
  - `salesforceSandbox` boolean
  - `dataRetentionPeriod` string
  - `region` string

## Response `200`

OK

---

[API](https://skmtc.net/klausapp/apis/klaus-rest-api-documentation.md) · [All operations](https://skmtc.net/klausapp/apis/klaus-rest-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/klausapp/klaus-rest-api-documentation/versions/65c3cb19dc22/schema)