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

# Create a payment processor

> Creates an offline payment processor and returns it under `payment_processor`.

Send the new processor under `payment_processor`, with a `gateway_name` such as `CASH`, the `currency` `id`, and `credentials.maximumRetryOnFailure` set to `"0"` or `"1"`; without that value the create is refused. The response carries `gateway_name` and `credentials` where a read has `provider`.

> [!NOTE]
>
> The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload.


## OpenAPI

````yaml POST /settings/payment_processors
openapi: 3.1.0
info:
  title: Exsited API
  version: v4
servers:
  - url: https://{host}/api/v4
    variables:
      host:
        default: your-api-host.example.com
        description: Your Exsited API host name, without https://.
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Accounts
  - name: Account emails
  - name: Account groups
  - name: Communications
  - name: Communication profiles
  - name: Orders
  - name: Quote orders
  - name: Express
  - name: Usages
  - name: Sales reps
  - name: Gift certificates
  - name: Invoices
  - name: Pro-forma invoices
  - name: Payments
  - name: Refunds
  - name: Credit notes
  - name: Credit note applications
  - name: Reconciliations
  - name: Items
  - name: Inventory adjustments
  - name: Units of measurement
  - name: Zones
  - name: Shipping packages
  - name: Shipping rules
  - name: Fulfillment profiles
  - name: Fulfillment terms
  - name: Item fulfillments
  - name: Item receipts
  - name: Bookings
  - name: Rental assets
  - name: Return merchandise authorisations
  - name: Purchase orders
  - name: Purchase invoices
  - name: Purchase payments
  - name: Purchase refunds
  - name: Purchase credit notes
  - name: Purchase credit note applications
  - name: Purchase express
  - name: Return vendor authorizations
  - name: ABA files
  - name: Receive terms
  - name: Labours
  - name: Tasks
  - name: Timesheets
  - name: Milestones
  - name: Employees
  - name: Departments
  - name: Designations
  - name: Teams
  - name: Time periods
  - name: Workflows
  - name: Workflow settings
  - name: Events
  - name: Custom events
  - name: System events
  - name: Approvals
  - name: Approval profiles
  - name: Approval user groups
  - name: Alerts
  - name: Alert responsibility settings
  - name: Alert responsibilities
  - name: Action scripts
  - name: Note groups
  - name: Note attachments
  - name: Instance settings
  - name: Accounting codes
  - name: Additional codes
  - name: Billing periods
  - name: Charging periods
  - name: Pricing periods
  - name: Invoice terms
  - name: Days of the month
  - name: Countries
  - name: Salutations
  - name: Document templates
  - name: Email templates
  - name: Roles
  - name: Operators
  - name: Operator groups
  - name: User settings
  - name: Custom attributes
  - name: Custom components
  - name: Custom features
  - name: Custom fields
  - name: Custom forms
  - name: Attribute attachments
  - name: Portal
  - name: Integration connections
  - name: External databases
  - name: Reports
  - name: Applications
  - name: Organisation
  - name: Child organisations
  - name: Webhooks
paths:
  /settings/payment_processors:
    post:
      tags:
        - Instance settings
      summary: Create a payment processor
      description: >-
        Send the new processor under `payment_processor`, with a `gateway_name`
        such as `CASH`, the `currency` `id`, and
        `credentials.maximumRetryOnFailure` set to `"0"` or `"1"`; without that
        value the create is refused. The response carries `gateway_name` and
        `credentials` where a read has `provider`.
      operationId: settings_create_settings_payment_processor
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                payment_processor:
                  type: object
                  properties:
                    name:
                      type: string
                      description: The processor's name.
                    gateway_name:
                      type: string
                      description: The gateway, such as `CASH` for an offline processor.
                    currency:
                      type: string
                      description: The currency's `id`.
                    status:
                      type: string
                      description: Such as `inactive`.
                    credentials:
                      type: object
                      properties:
                        maximumRetryOnFailure:
                          type: string
                          description: Must be `"0"` or `"1"`.
                          enum:
                            - '0'
                            - '1'
                      required:
                        - maximumRetryOnFailure
                  required:
                    - credentials
              required:
                - payment_processor
            example:
              payment_processor:
                name: Cash payments
                gateway_name: CASH
                currency: 221b2c3d4e5f4a6b8c7d9e0f1a2b3c4d
                status: inactive
                credentials:
                  maximumRetryOnFailure: '0'
      responses:
        '201':
          description: The new payment processor, under `payment_processor`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsPaymentProcessorSavedResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X POST "$EXSITED_BASE_URL/api/v4/settings/payment_processors"
            \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "payment_processor": {
                  "name": "Cash payments",
                  "gateway_name": "CASH",
                  "currency": "221b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
                  "status": "inactive",
                  "credentials": {
                    "maximumRetryOnFailure": "0"
                  }
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.settings.create_settings_payment_processor(
                {
                    "payment_processor": {
                        "name": "Cash payments",
                        "gateway_name": "CASH",
                        "currency": "221b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
                        "status": "inactive",
                        "credentials": {"maximumRetryOnFailure": "0"},
                    }
                }
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.settings.createSettingsPaymentProcessor({
                payment_processor: {
                    name: 'Cash payments',
                    gateway_name: 'CASH',
                    currency: '221b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
                    status: 'inactive',
                    credentials: {maximumRetryOnFailure: '0'},
                },
            });

            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->settings->createSettingsPaymentProcessor([
                'payment_processor' => [
                    'name' => 'Cash payments',
                    'gateway_name' => 'CASH',
                    'currency' => '221b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
                    'status' => 'inactive',
                    'credentials' => ['maximumRetryOnFailure' => '0'],
                ],
            ]);
            print_r($response->data);
        - lang: java
          label: Java
          source: >
            import com.exsited.client.ApiResponse;

            import com.exsited.client.ClientRegistry;

            import com.exsited.client.ExsitedClient;

            import
            com.exsited.resources.settings.settings_dto.SettingsDto.SettingsPaymentProcessorSaved;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<SettingsPaymentProcessorSaved> response =
            client.settings().createSettingsPaymentProcessor(
                    Map.of(
                            "payment_processor", Map.of(
                                    "name", "Cash payments",
                                    "gateway_name", "CASH",
                                    "currency", "221b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
                                    "status", "inactive",
                                    "credentials", Map.of("maximumRetryOnFailure", "0"))));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.Settings.CreateSettingsPaymentProcessorAsync(new
            Dictionary<string, object?>

            {
                ["payment_processor"] = new Dictionary<string, object?>
                {
                    ["name"] = "Cash payments",
                    ["gateway_name"] = "CASH",
                    ["currency"] = "221b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
                    ["status"] = "inactive",
                    ["credentials"] = new Dictionary<string, object?>
                    {
                        ["maximumRetryOnFailure"] = "0",
                    },
                },
            });


            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: >
            import 'package:exsited/exsited.dart';


            final client = buildClient();


            final response = await
            client.settings.createSettingsPaymentProcessor({
              'payment_processor': {
                'name': 'Cash payments',
                'gateway_name': 'CASH',
                'currency': '221b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
                'status': 'inactive',
                'credentials': {'maximumRetryOnFailure': '0'},
              },
            });

            print(response.map);
        - lang: go
          label: Go
          source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.Settings().CreateSettingsPaymentProcessor(context.Background(), map[string]any{\n\t\"payment_processor\": map[string]any{\n\t\t\"name\":         \"Cash payments\",\n\t\t\"gateway_name\": \"CASH\",\n\t\t\"currency\":     \"221b2c3d4e5f4a6b8c7d9e0f1a2b3c4d\",\n\t\t\"status\":       \"inactive\",\n\t\t\"credentials\":  map[string]any{\"maximumRetryOnFailure\": \"0\"},\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    SettingsPaymentProcessorSavedResponse:
      type: object
      properties:
        payment_processor:
          $ref: '#/components/schemas/SettingsPaymentProcessorSaved'
    SettingsPaymentProcessorSaved:
      type: object
      properties:
        accounting_code:
          description: Can be null.
        conversion_rate:
          type: number
        created_by:
          description: Can be null.
        created_on:
          type: string
        credentials:
          description: Can be null.
        currency:
          $ref: '#/components/schemas/SettingsPaymentProcessorSavedCurrency'
        description:
          type: string
        disconnected:
          type: boolean
        display_name:
          type: string
        gateway_name:
          type: string
        gateway_type:
          type: string
        href:
          type: string
        id:
          type: string
        integration_state:
          type: string
        is_default:
          type: boolean
        is_foreign_currency:
          type: boolean
        last_updated_by:
          description: Can be null.
        last_updated_on:
          type: string
        name:
          type: string
        object:
          type: string
        provider:
          type: string
        status:
          type: string
        version:
          type: integer
    SettingsPaymentProcessorSavedCurrency:
      type: object
      properties:
        code:
          type: string
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew
        it for you.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.