---
title: "Create a payment method"
description: "Use POST /paymethods to create a project-level payment-method definition."
canonical: https://docs.ordering.co/api-reference/guides/create-paymethod/
---

# Create a payment method

> **API operation:** [Open the endpoint in Scalar](https://docs.ordering.co/api-reference/#tag/paymethods/POST/paymethods)

Use `POST /paymethods` to create a project-level payment-method definition. The operation documented here is `Paymethod.register`.

The documented schema requires `name` and a unique `gateway`; optional fields include `enabled`, `allow_with_zero_balance`, and `data_template`.

The documented operation uses super-administrator middleware. Creating a definition does not by itself implement a working payment integration or associate the payment method with a business. Gateway libraries, business credentials, product support, and payment flows are separate concerns.

See the [payment method model](https://docs.ordering.co/api-reference/guides/paymethods-model/) and [Business payment-method credential model](https://docs.ordering.co/api-reference/guides/business-paymethod-model/) for the identity boundary.

## OpenAPI reference

**Operation:** `POST /paymethods`

**Request body fields**

| Name                      | Type          | Required |
| ------------------------- | ------------- | -------- |
| `allow_with_zero_balance` | boolean       | No       |
| `data_template`           | array \| null | No       |
| `enabled`                 | boolean       | No       |
| `gateway`                 | any           | Yes      |
| `name`                    | any           | Yes      |

**Responses**

| Code | Description                           |
| ---- | ------------------------------------- |
| 200  | OK                                    |
| 400  | Bad Request (ErrorResponse)           |
| 401  | Unauthorized                          |
| 404  | Not Found                             |
| 429  | Too Many Requests (ErrorResponse)     |
| 500  | Internal Server Error (ErrorResponse) |
| 503  | Service Unavailable (ErrorResponse)   |

[Open this operation in the API reference](https://docs.ordering.co/api-reference/#tag/paymethods/POST/paymethods)