> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Delete payment configuration for an organisation



## OpenAPI

````yaml /api-reference/specs/payment.yaml delete /config/{payrollConfigId}
openapi: 3.0.3
info:
  title: FlowPayroll Payment API
  description: >-
    Payment Service API for FlowPayroll. Generates and serves BACS (Standard 18,
    Barclays CSV/TXT, Allica) payment files for completed pay runs, manages
    per-organisation payment configuration, and handles retry of failed
    payment-file generation.
  version: 0.1.0
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/payment
security:
  - XAuthToken: []
    XOrgId: []
tags:
  - name: PaymentFile
    description: >-
      Generated BACS payment file for a completed pay run. Status transitions:
      GENERATED | PARTIAL_SUCCESS | FAILED → (admin retries) RETRYING →
      GENERATED | PARTIAL_SUCCESS | FAILED. PARTIAL_SUCCESS means the file was
      generated for the employees that passed BACS validation AND
      `failure.affectedEmployees` lists the ones that need attention. When
      status is FAILED, no file was generated; `failure.affectedEmployees` lists
      every employee blocking the file. The UI can render affected employees
      with anchors to their profiles in both PARTIAL_SUCCESS and FAILED states.
  - name: AvailablePaymentConfig
    description: >-
      List of BACS payment methods and formats available for an organisation to
      configure.
  - name: OrganisationPaymentConfig
    description: >-
      Per-organisation payment configuration. Stores the BACS source bank
      account, service user number, and which (method, format, file-format)
      combination drives payment file generation for that org's completed pay
      runs.
paths:
  /config/{payrollConfigId}:
    delete:
      tags:
        - OrganisationPaymentConfig
      summary: Delete payment configuration for an organisation
      operationId: deleteOrganisationPaymentConfig
      parameters:
        - name: payrollConfigId
          in: path
          required: true
          schema:
            type: string
          example: org-payroll-123
      responses:
        '200':
          description: Payroll Configuration Deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
              example:
                message:
                  text: Payment configuration deleted successfully
                  token: deleteOrganisationPaymentConfigSuccess
                  tokenArguments: []
                content:
                  data: null
                  metadata:
                    dateFormat: yyyy-MM-dd
                    dateTimeFormat: yyyy-MM-ddTHH:mm:ss.fffZ
                    paginationToken: null
                validationIssues: []
                messageToken: deleteOrganisationPaymentConfigSuccess
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
components:
  schemas:
    ResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          type: object
          properties:
            data:
              type: object
              nullable: true
            metadata:
              type: object
              nullable: true
              properties:
                dateFormat:
                  type: string
                  default: yyyy-MM-dd
                dateTimeFormat:
                  type: string
                  default: yyyy-MM-ddTHH:mm:ss.fffZ
                paginationToken:
                  type: string
                  nullable: true
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
        messageToken:
          type: string
    MessageWithTokenResponse:
      type: object
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
    ValidationIssue:
      type: object
      description: >
        Field validation item. `reasonToken` is a stable snake_case key for i18n
        or custom client messages; `reason` is the default English text from the
        API.
      properties:
        field:
          type: string
          description: Dot-path of the field (e.g. name.firstName, address.line1).
        reason:
          type: string
          description: Default human-readable message.
        reasonToken:
          type: string
          description: Machine-readable error identifier (snake_case).
        reasonTokenArguments:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
    ValidationIssueArgument:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
  securitySchemes:
    XAuthToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Access token obtained from OAuth2 client credentials flow
    XOrgId:
      type: apiKey
      in: header
      name: X-Org-Id
      description: >-
        Organisation to scope the request to. Required when the principal can
        access more than one organisation; optional for single-organisation
        principals (the authorizer resolves it automatically).

````