Checkout.com Control profiles API

openapi: 3.2.0
info:
  title: Checkout.com API Reference Control profiles API
  description: '## Get started

    Checkout.com provides a collection of APIs that enable you to integrate with our various products and services.

    Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. You can consume the APIs directly using any HTTP or REST library.

    Sign up for a test account to gain access to the sandbox environment, where you can test API calls without affecting live data.

    For more information, see:


    - API endpoints

    - API rate limits

    - API changes

    - Idempotency

    - Private connections


    ## Base URLs

    The base URLs you must use for your API calls to the sandbox and production environments are unique to you.


    - `https://{prefix}.api.sandbox.checkout.com/{path}`

    - `https://{prefix}.api.checkout.com/{path}`

    - `https://{prefix}.access.sandbox.checkout.com/{path}`

    - `https://{prefix}.access.checkout.com/{path}`


    The unique API endpoint host names resolve to Checkout.com''s IP addresses. Do not allowlist these IP addresses.

    The `{prefix}` value in each base URL is a string containing the first eight characters of each of your environments'' unique `client_id`, excluding the `cli_` prefix.

    To find your unique base URL:

    1. Sign in to the Dashboard environment you want to retrieve the base URL for:


    - Sandbox

    - Production


    2. Go to _Developers_ > _Overview_.

    Your unique base URL is displayed on the _Developer overview_ page. For example, `https://vkuhvk4v.api.checkout.com`.


    3. Alternatively, go to _Settings_ > _Account details_.

    Your unique base URL is displayed under _Connection settings_.


    If you are unsure of your client ID or base URL for either environment, contact your account manager or request support.

    For more information, see API endpoints.

    ## Authentication

    When you sign up for an account, you can authenticate with either Access keys (OAuth 2.0), or Secret API keys.

    Unless explicitly stated, all endpoints require authentication using either your Access or Secret API Keys. Public keys should only be used in JavaScript or native applications.


    - **Client-side authentication**. Use your public key for client-side authentication. It only has access to a limited set of our APIs – mostly those called as part of your payment environment.


    - **Server-to-server authentication**. Use your secret key or OAuth for server-to-server communication. Support for API keys depends on the endpoint.


    Never share your OAuth credentials, API keys, or access tokens. Keep them guarded and secure.'
  termsOfService: https://www.checkout.com/legal/terms-and-policies
  contact:
    name: Checkout.com Support
    url: https://dashboard.checkout.com/support
  version: v1.0.0
servers:
- url: https://{prefix}.api.sandbox.checkout.com
  description: Sandbox environment
  variables:
    prefix:
      default: '{prefix}'
      description: Your unique <a href="https://www.checkout.com/docs/developer-resources/api/api-endpoints" target="_blank">base URL</a>. There is no default value.
- url: https://{prefix}.api.checkout.com
  description: Production environment
  variables:
    prefix:
      default: '{prefix}'
      description: Your unique <a href="https://www.checkout.com/docs/developer-resources/api/api-endpoints" target="_blank">base URL</a>. There is no default value.
tags:
- name: Control profiles
  description: Creates a control profile and applies it to the specified target.
paths:
  /issuing/controls/control-profiles:
    post:
      tags:
      - Control profiles
      summary: Create a control profile
      description: Creates a control profile.
      operationId: createControlProfile
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/add-control-profile-request'
        required: true
      responses:
        '201':
          description: Control profile created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/add-update-control-profile-response'
        '401':
          description: Unauthorized
        '422':
          description: Invalid data was sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssuingValidationError'
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
      - OAuth:
        - issuing:controls-write
    get:
      tags:
      - Control profiles
      summary: Get all control profiles
      description: Retrieves a list of control profiles for the currently authenticated client, or for a specific card if a card ID is provided.
      operationId: getControlProfilesByTarget
      parameters:
      - name: target_id
        in: query
        schema:
          $ref: '#/components/schemas/IssuingCardId'
      responses:
        '200':
          description: Control profiles retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-control-profiles-client-response'
        '401':
          description: Unauthorized
        '404':
          description: Client not found
        '422':
          description: Invalid data was sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssuingValidationError'
        '500':
          description: Internal Server Error
      security:
      - OAuth:
        - issuing:controls-read
  /issuing/controls/control-profiles/{controlProfileId}:
    get:
      tags:
      - Control profiles
      summary: Get control profile details
      description: Retrieves the details of an existing control profile.
      operationId: getControlProfile
      parameters:
      - name: controlProfileId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/IssuingControlProfileId'
      responses:
        '200':
          description: Control profile retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/add-update-control-profile-response'
        '401':
          description: Unauthorized
        '404':
          description: Control profile not found
        '500':
          description: Internal Server Error
      security:
      - OAuth:
        - issuing:controls-read
    patch:
      tags:
      - Control profiles
      summary: Update a control profile
      description: Update the control profile
      operationId: updateControlProfile
      parameters:
      - name: controlProfileId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/IssuingControlProfileId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update-control-profile-request'
        required: true
      responses:
        '200':
          description: Control profile updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/add-update-control-profile-response'
        '401':
          description: Unauthorized
        '404':
          description: Control profile not found
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
      - OAuth:
        - issuing:controls-write
    delete:
      tags:
      - Control profiles
      summary: Remove a control profile
      description: Removes the control profile. A control profile cannot be removed if it is used by a control.
      operationId: deleteControlProfile
      parameters:
      - name: controlProfileId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/IssuingControlProfileId'
      responses:
        '200':
          description: Control profile deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: Control profile not found
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
      - OAuth:
        - issuing:controls-write
  /issuing/controls/control-profiles/{controlProfileId}/add/{targetId}:
    post:
      tags:
      - Control profiles
      summary: Add target to control profile
      description: Adds a target to an existing control profile.
      operationId: addTargetToControlProfile
      parameters:
      - name: controlProfileId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/IssuingControlProfileId'
      - name: targetId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/IssuingTargetIdToAddToControlProfile'
      responses:
        '200':
          description: Target added successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/add-control-profile-target-response'
        '401':
          description: Unauthorized
        '404':
          description: Control profile not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssuingNotFoundError'
        '500':
          description: Internal Server Error
      security:
      - OAuth:
        - issuing:controls-write
  /issuing/controls/control-profiles/{controlProfileId}/remove/{targetId}:
    post:
      tags:
      - Control profiles
      summary: Remove target from control profile
      description: Removes a target from an existing control profile.
      operationId: removeTargetFromControlProfile
      parameters:
      - name: controlProfileId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/IssuingControlProfileId'
      - name: targetId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/IssuingTargetIdToRemoveFromControlProfile'
      responses:
        '200':
          description: Target removed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/remove-control-profile-target-response'
        '401':
          description: Unauthorized
        '404':
          description: Control profile not found
        '500':
          description: Internal Server Error
      security:
      - OAuth:
        - issuing:controls-write
components:
  schemas:
    update-control-profile-request:
      type: object
      properties:
        name:
          maxLength: 256
          type: string
          description: The control profile name.
          example: Low Risk MCC Profile
      description: 'The control profile to update.

        '
    get-control-profile-response:
      required:
      - id
      - name
      - created_date
      - last_modified_date
      type: object
      properties:
        id:
          $ref: '#/components/schemas/IssuingControlProfileId'
        name:
          maxLength: 256
          type: string
          description: Control profile name.
        created_date:
          type: string
          description: Creation date of the control profile.
          format: date-time
        last_modified_date:
          type: string
          description: Last modified date of the control profile.
          format: date-time
      description: The control profile's details.
    add-control-profile-target-response:
      type: object
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/ControlProfileLinks'
    ControlProfileLinks:
      minItems: 1
      required:
      - self
      type: object
      properties:
        self:
          type: object
          allOf:
          - $ref: '#/components/schemas/IssuingLink'
          description: The URI to retrieve the control profile's details.
      description: The links related to the control profile.
      example:
        self:
          href: https://{prefix}.api.checkout.com/issuing/controls/control-profiles/cpr_j4mvlui5qotufgvaeqwhvlbfna
          actions:
          - GET
          types:
          - application/json
    IssuingNotFoundError:
      type: object
      properties:
        request_id:
          type: string
          example: 0HLHPN8802NUF:00000003
        error_type:
          type: string
          example: not_found
        error_codes:
          type: array
          items:
            type: string
            example: card_not_found
    IssuingTargetIdToRemoveFromControlProfile:
      maxLength: 30
      minLength: 30
      pattern: ^crd_[a-z0-9]{26}$
      type: string
      description: The ID of the card the control profile should no longer apply to.
      example: crd_fa6psq42dcdd6fdn5gifcq1491
    IssuingTargetIdToAddToControlProfile:
      maxLength: 30
      minLength: 30
      pattern: ^crd_[a-z0-9]{26}$
      type: string
      description: The ID of the card to apply the control profile to.
      example: crd_fa6psq42dcdd6fdn5gifcq1491
    IssuingControlProfileId:
      maxLength: 30
      minLength: 30
      pattern: ^cpr_[a-z0-9]{26}$
      type: string
      description: The control profile's unique identifier.
      example: cpr_j4mvlui5qotufgvaeqwhvlbfna
    IssuingValidationError:
      type: object
      properties:
        request_id:
          type: string
          example: 0HLHPN8802NUF:00000003
        error_type:
          type: string
          example: request_invalid
        error_codes:
          maxItems: 20
          type: array
          items:
            type: string
            example: request_body_malformed
      additionalProperties: false
    remove-control-profile-target-response:
      type: object
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/ControlProfileLinks'
    IssuingCardId:
      maxLength: 30
      minLength: 30
      pattern: ^crd_[a-z0-9]{26}$
      type: string
      description: The card's unique identifier.
      example: crd_fa6psq242dcd6fdn5gifcq1491
    get-control-profiles-client-response:
      required:
      - control_profiles
      type: object
      properties:
        control_profiles:
          type: array
          items:
            $ref: '#/components/schemas/get-control-profile-response'
          description: The list of control profiles for the specified client.
          example:
          - id: cpr_j4mvlui5qotufgvaeqwhvlbfna
            name: Low Risk MCC Profile
            created_date: '2024-03-12T18:13:45.7155085+00:00'
            last_modified_date: '2024-03-13T15:44:56.7155085+00:00'
          - id: cpr_53mkhdc4jjlu5jcryx76bjbrgm
            name: Medium Risk MCC Profile
            created_date: '2024-05-05T10:43:13.7155085+00:00'
            last_modified_date: '2024-06-17T06:32:18.7155085+00:00'
          - id: cpr_j4ma3rclvgcu3pn5tsdgb3e3a4
            name: High Risk MCC Profile
            created_date: '2024-02-29T12:55:55.7155085+00:00'
            last_modified_date: '2024-03-01T10:12:12.7155085+00:00'
      description: The list of control profiles for the specified client.
    add-control-profile-request:
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: Control profile name.
      description: The control profile to create
      example:
        name: Low Risk MCC Profile
    IssuingLink:
      required:
      - href
      - actions
      - types
      type: object
      properties:
        href:
          maxLength: 100
          pattern: ^https:\/.*$
          type: string
          description: The link URL.
        actions:
          maxItems: 20
          type: array
          items:
            maxLength: 100
            pattern: ^(GET|POST|PUT|DELETE|PATCH)$
            enum:
            - GET
            - POST
            - PUT
            - DELETE
            - PATCH
            type: string
          additionalProperties: false
          description: The HTTP Methods that can be performed on the link.
        types:
          type: array
          items:
            maxLength: 100
            pattern: ^application\/.*$
            type: string
          additionalProperties: false
          description: The Content Types for the link to the resource
      additionalProperties: false
    add-update-control-profile-response:
      required:
      - id
      - name
      - created_date
      - last_modified_date
      - _links
      type: object
      properties:
        id:
          $ref: '#/components/schemas/IssuingControlProfileId'
        name:
          maxLength: 256
          type: string
          description: Control profile name.
        created_date:
          type: string
          description: Creation date of the control profile.
          format: date-time
        last_modified_date:
          type: string
          format: date-time
        _links:
          allOf:
          - $ref: '#/components/schemas/ControlProfileLinks'
      description: The control profile's details.
      example:
        id: cpr_j4mvlui5qotufgvaeqwhvlbfna
        name: Low Risk MCC Profile
        created_date: '2024-03-12T18:13:45.7155085+00:00'
        last_modified_date: '2024-03-12T18:13:45.7155085+00:00'
        _links:
          self:
            href: https://{prefix}.api.checkout.com/issuing/controls/control-profiles/cpr_j4mvlui5qotufgvaeqwhvlbfna
            actions:
            - GET
            types:
            - application/json
  securitySchemes:
    ApiPublicKey:
      type: apiKey
      description: "Public keys are for client-side authentication and supported only in JavaScript or native applications.\n  \n#### Format\n\n- Sandbox – `pk_sbox_xxxxxxxxxxxxxxxxxxxxxxxxxx`\n\n- Production – `pk_xxxxxxxxxxxxxxxxxxxxxxxxxx`\n\nWhen specifying your public key, use the format `Bearer {{PublicApiKey}}`.\n"
      name: Authorization
      in: header
      x-cko-type: publicKey
    ApiSecretKey:
      type: apiKey
      description: 'You can pass your secret API key in the `Authorization` header of your requests for supported endpoints.


        #### Format


        - Sandbox – `sk_sbox_xxxxxxxxxxxxxxxxxxxxxxxxxx`


        - Production – `sk_xxxxxxxxxxxxxxxxxxxxxxxxxx`


        When specifying your secret key, use the format `Bearer {{SecretApiKey}}`.


        ```

        curl --location --request POST ''https://{prefix}.api.checkout.com/{{path}}'' \

        --header ''Content-Type: application/json'' \

        --header ''Accept: application/json'' \

        --header ''Authorization: Bearer {{SecretApiKey}}'' \

        --data-raw ''{

        "amount": 10000,

        "currency": "USD",

        "reference": "Visa-USD-Test",

        ...

        }''

        ```

        '
      name: Authorization
      in: header
      x-cko-type: secretKey
    OAuth:
      type: oauth2
      description: "Your OAuth credentials include an access key ID and an access key secret. They correspond to an OAuth 2.0 client ID and a client secret respectively. \n\nTo exchange these credentials for an access token, call the [Request an access token](/tag/access/POST/connect/token) endpoint. Authenticate using basic authentication, with your access key ID as the username and your access key secret as the password.\n\n| Environment   |      Authorization server                            |\n|---------------|------------------------------------------------------|\n| Sandbox       |  https://{prefix}.access.sandbox.checkout.com/connect/token   |\n| Production    |  https://{prefix}.access.checkout.com/connect/token           |\n\n```\ncurl --location 'https://{prefix}.access.checkout.com/connect/token' \\\n--header 'Content-Type: application/x-www-form-urlencoded' \\\n--data-urlencode 'grant_type=client_credentials' \\\n--data-urlencode 'client_id=ack_...' \\\n--data-urlencode 'client_secret=...' \n```\n\nThe token server returns a Bearer `access_token` in JSON Web Token (JWT) format. Use this token in the `Authorization` header of your API requests.\n\n```\ncurl --location --request POST 'https://{prefix}.api.checkout.com/{{path}}' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Bearer {{AccessToken}}' \\\n--data-raw '{\n  \"amount\": 10000,\n  \"currency\": \"USD\",\n  \"reference\": \"Visa-USD-Test\",\n  ...\n}'\n```\n\nThe `expires_in` field in the response indicates the validity period of your access token in seconds. When your token expires, you must request a new one.\n\nDepending on the Environment against which you're making your requests against you'll need to request the token from a different Authorization Server.\n\n| Environment   |      Authorization Server                            |\n|---------------|------------------------------------------------------|\n| Sandbox       |  https://{prefix}.access.sandbox.checkout.com/connect/token   |\n| Production    |  https://{prefix}.access.checkout.com/connect/token           |\n\nYour base URL `{prefix}` is unique. To learn how to retrieve your unique base URLs for the sandbox and production environments, see [API endpoints](https://www.checkout.com/docs/developer-resources/api/api-endpoints).\n"
      flows:
        clientCredentials:
          tokenUrl: string
          scopes:
            vault: Access to all Vault resources
            vault:apme-enrollment: Manage Apple Pay Domain Enrollment
            vault:customers: Manage customers
            vault:card-metadata: Read card metadata
            vault:instruments: Create instruments
            vault:network-tokens: Manage network tokens
            vault:tokenization: Tokenize payment instruments
            vault:real-time-account-updater: Access to real-time account updater
            gateway: Access to all Gateway resources
            gateway:payment: Request payments
            gateway:payment-details: Get payment details
            gateway:payment-authorizations: Increment authorizations
            gateway:payment-voids: Void payments
            gateway:payment-captures: Capture payments
            gateway:payment-contexts: Manage payment contexts
            gateway:payment-cancellations: Manage payment cancellations
            gateway:payment-refunds: Refund payments
            fx: Foreign exchange services
            payouts:bank-details: Get bank details
            sessions:app: App-based authentication
            sessions:browser: Browser-based authentication
            disputes: Access to all Disputes resources
            disputes:view: View disputes
            disputes:provide-evidence: Provide dispute evidence
            disputes:accept: Accept disputes
            disputes:scheme-files: Read dispute scheme files
            accounts: Manage sub-entities
            flow: Access to all Flow resources
            flow:workflows: Manage workflows
            flow:events: Retrieve events
            flow:reflow: Manage workflows
            files: Access to all Files resources
            files:retrieve: Retrieve files
            files:upload: Upload files
            files:download: Download files
            forward: Access to Forward api
            forward:secrets: Manage secrets in Forward api
            balances: Access to all Balances resources
            balances:view: View balances
            balances:top-up-instructions: Get top-up instructions
            transfers: Access to all Transfers resources
            transfers:view: View transfers
            transfers:create: Create transfers
            middleware: Access to all Middleware resources
            middleware:merchants-secret: Allows merchant identity and Middleware token exchange from a secure execution environment
            middleware:merchants-public: Allows merchant identity and Middleware token exchange from an insecure execution environment
            payment-sessions: Access to all Payment Sessions resources
            payments:search: Search payments
            reports: Access to all Reports resources
            reports:view: View reports
            financial-actions: Access to all Financial actions resources
            financial-actions:view: View financial actions
            card-management: Access to all Card management resources
            issuing:card-management-read: Gives access to card management endpoints with GET operations
            issuing:card-management-write: Gives access to card management endpoints with POST/ PUT / DELETE operations
            issuing:controls-read: Gives access to card control endpoints with GET operations
            issuing:controls-write: Gives access to card control endpoints with POST/ PUT / DELETE operations
            transactions: Access to all transactions resources
            issuing:transactions-read: Gives access to get and search transactions
            issuing:transactions-write: Gives access to simulate transactions for testing purposes
            issuing-disputes: Access to Issuing disputes resources
            issuing:disputes-read: Gives access to get disputes
            issuing:disputes-write: Gives access to create and submit Issuing disputes
            identity-verification: Access to all Identities endpoints
            Payment Context: Read payment context
            agentic:inventory: Manage agentic commerce inventory and reservations
    SessionSecret:
      type: apiKey
      description: 'A base64 encoded value prefixed with `sek_` that gives access to client-side operations for a single authentication within the Sessions API. This value is returned as the `session_secret` when requesting a session.

        '
      name: Authorization
      in: header
x-tagGroups:
- name: Set up
  tags:
  - Access
- name: Handle payments and payouts
  tags:
  - Payments
  - Flow
  - Payment Setups
  - Payment Links
  - Hosted Payments Page
  - Forex
  - Apple Pay
  - Bacs Direct Debit
  - Google Pay
  - Transfers
  - Balances
- name: Payment Context
  tags:
  - Payment Context
- name: Payment Methods
  tags:
  - Payment Methods
- name: Store and forward payment credentials
  tags:
  - Tokens
  - Instruments
  - Customers
  - Forward
- name: Authentication
  tags:
  - Standalone
- name: Risk management
  tags:
  - Disputes
- name: Notifications
  tags:
  - Workflows
- name: Platforms
  tags:
  - Platforms
  - Business details
  - Payment instruments
  - Payout schedules
  - Reserve rules
  - Onboarding Simulator
- name: Card issuing
  tags:
  - Cardholders
  - Cards
  - Controls
  - Control profiles
  - Control groups
  - Cardholder access tokens
  - Transactions
  - Issuing disputes
  - Card testing
- name: Identities
  tags:
  - Applicants
  - Identity Verification
  - AML Screening
  - Face Authentication
  - ID Document Verification
  - Address Document Verification
- name: Reporting
  tags:
  - Reports
  - Financial actions
- name: Metadata
  tags:
  - Card metadata
- name: Network Tokens
  tags:
  - Network Tokens
- name: Standalone Account Updater
  tags:
  - Standalone Account Updater
- name: Compliance requests
  tags:
  - Compliance requests
- name: Agentic Commerce
  tags:
  - Agentic Commerce Protocol
  - Inventory