> ## Documentation Index > Fetch the complete documentation index at: https://build.practicehub.io/llms.txt > Use this file to discover all available pages before exploring further. # Create payment_methods ## OpenAPI ````yaml /openapi.json post /payment_methods openapi: 3.0.3 info: title: PracticeHub API version: 1.0.0 description: > The canonical PracticeHub REST API. Every clinic account is a tenant addressed by the host the practice signs in on: `https://{clinic}.{region}.practicehub.io` (region host `neptune` London, `mercury` Frankfurt, `vulcan` Ohio, `jupiter` Singapore, `apollo` Sydney). ## Filtering List endpoints accept `?attribute=operator:value` with operators `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `null`, `not-null`, `like`, `contains`, `in`, `not-in`, `between` (`null`/`not-null` take no value; `in`, `not-in`, `between` take comma-separated values; `contains` is a case-insensitive substring match with no wildcards to escape). A value with no operator is an equality match. Only attributes marked filterable may be filtered (422 otherwise). ## Metadata Every record carries an integrator-owned `metadata` object of string, number or boolean values (max 50 keys). Send `metadata` on create/update to merge keys (`null` removes a key) and filter with `?metadata[key]=operator:value`. ## Sorting & pagination `?sort=attr[,attr]:asc|desc` on sortable attributes; `?page=` and `?page_size=` (max 100). List responses wrap rows in `data` with `links` and `meta`. servers: - url: https://{clinic}.{region}.practicehub.io/v3/api description: PracticeHub API — the host the practice signs in on variables: clinic: default: your-clinic description: The clinic subdomain region: default: neptune enum: - neptune - mercury - vulcan - jupiter - apollo description: >- The region host from the practice login URL: neptune (London), mercury (Frankfurt), vulcan (Ohio), jupiter (Singapore), apollo (Sydney) security: - bearerAuth: [] tags: - name: Utility description: Liveness, identity and discovery - name: Availability description: Free, bookable slots — check before creating an appointment - name: Appointments description: The appointments resource - name: Appointment Types description: The appointment_types resource - name: Practitioner Availabilities description: The practitioner_availabilities resource - name: Resources description: The resources resource - name: Patients description: The patients resource - name: Tags description: The tags resource - name: Patient Tags description: The patient_tags resource - name: Numbers description: The numbers resource - name: Addresses description: The addresses resource - name: Patient Logs description: The patient_logs resource - name: Patient Log Tags description: The patient_log_tags resource - name: Files description: The files resource - name: Care Plans description: The care_plans resource - name: Clinical Notes description: Clinical notes on the patient record - name: Form Templates description: The form_templates resource - name: Invoices description: The invoices resource - name: Line Items description: The line_items resource - name: Payments description: The payments resource - name: Refunds description: The refunds resource - name: Payment Allocations description: The payment_allocations resource - name: Payment Methods description: The payment_methods resource - name: Billable Items description: The billable_items resource - name: Locations description: The locations resource - name: Practitioners description: The practitioners resource - name: Modalities description: The modalities resource - name: Referral Sources description: The referral_sources resource - name: Deleted Entities description: The deleted_entities resource paths: /payment_methods: post: tags: - Payment Methods summary: Create payment_methods operationId: create_payment_methods parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PaymentMethodsCreate' responses: '201': description: The resource content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PaymentMethods' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/ReadOnlyKey' '409': $ref: '#/components/responses/Conflict' '422': $ref: '#/components/responses/ValidationError' components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: >- Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record. schema: type: string maxLength: 255 schemas: PaymentMethodsCreate: type: object properties: name: type: string maxLength: 255 description: The method's display name — Cash, Bank Transfer, a custom method. active: type: boolean description: >- Only an active method can be recorded against a payment (422 payment_method_inactive otherwise). Deactivate instead of deleting — there is no DELETE. sort_order: type: integer nullable: true description: Position in the app's payment method lists. metadata: $ref: '#/components/schemas/Metadata' required: - name PaymentMethods: type: object properties: id: type: integer description: >- Unique method id.Positive ids only — PracticeHub's special types (negative ids) appear on payments it wrote and are not listed here. name: type: string maxLength: 255 description: The method's display name — Cash, Bank Transfer, a custom method. active: type: boolean nullable: true description: >- Only an active method can be recorded against a payment (422 payment_method_inactive otherwise). Deactivate instead of deleting — there is no DELETE. sort_order: type: integer nullable: true description: Position in the app's payment method lists. created_at: type: string description: When the method was created, UTC. Server-managed. updated_at: type: string description: When the method last changed, UTC. Server-managed. metadata: $ref: '#/components/schemas/Metadata' example: id: 3 name: Bank Transfer active: true sort_order: 2 created_at: '2026-09-01T09:15:00Z' updated_at: '2026-09-01T09:15:00Z' Metadata: type: object description: >- Integrator-owned key/value metadata (max 50 keys). Values are strings (≤500 chars), numbers or booleans and read back with the type they were written with. On write, a null value removes the key. Filter with metadata[key]=op:value; number operands compare numerically. additionalProperties: nullable: true oneOf: - type: string maxLength: 500 - type: number - type: boolean Error: type: object required: - message - code properties: message: type: string description: Human-readable; may change — do not parse code: type: string description: >- Stable machine-readable code (snake_case), e.g. validation_failed, not_found, key_read_only, not_online_bookable, group_full, appointment_rule, billing_rule, idempotency_key_reused, rate_limited errors: type: object additionalProperties: type: array items: type: string description: Present on validation failures, keyed by attribute responses: Unauthenticated: description: Missing or invalid credentials content: application/json: schema: $ref: '#/components/schemas/Error' ReadOnlyKey: description: The API key is read-only content: application/json: schema: $ref: '#/components/schemas/Error' Conflict: description: >- A domain rule rejected the change (e.g. group_full, already processed, void) content: application/json: schema: $ref: '#/components/schemas/Error' ValidationError: description: Invalid input; `errors` is keyed by attribute content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearerAuth: type: http scheme: bearer description: 'API key from Developers → API Keys, sent as Authorization: Bearer .' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.