payment.method: fields, relations and API
The payment.method model ("Payment Method") is a persistent model declared by the Payment Engine module. It exposes 22 fields, 16 of them declared directly on the model; 5 fields from other models point to it. Below you will find every field with its technical name, type, label and relations, followed by an Odoo 19 JSON-2 API call.
Model identity
- Technical name
payment.method- Label
- Payment Method
- Type
- Persistent (models.Model)
- SQL table
payment_method- Origin module
- Payment Engine (
payment) - Default order (_order)
active desc, sequence, name
Model fields
16 own fields, 0 inherited from mixins and 6 automatic ORM fields. Click a name to get a direct link to that field.
22 of 22 fields shown
| Technical name | Label | Type | Details |
|---|---|---|---|
| active | Active | boolean | |
| brand_ids | Brands The brands of the payment methods that will be displayed on the payment form. | one2many | inverse: |
| code | Code The technical code of this payment method. | char | required |
| image | Image The base image used for this payment method; in a 64x64 px format. | image | required |
| image_payment_form | The resized image displayed on the payment form. | image | related: |
| is_primary | Is Primary Payment Method | boolean | computed |
| name | Name | char | requiredtranslatable |
| primary_payment_method_id | Primary Payment Method The primary payment method of the current payment method, if the latter is a brand. For example, "Card" is the primary payment method of the card brand "VISA". | many2one | |
| provider_ids | Providers The list of providers supporting this payment method. | many2many | |
| sequence | Sequence | integer | |
| support_express_checkout | Express Checkout Express checkout allows customers to pay faster by using a payment method that provides all required billing and shipping information, thus allowing to skip the checkout process. | boolean | |
| support_manual_capture | Manual Capture The payment is authorized and captured in two steps instead of one. | selection | required Values: |
| support_refund | Refund Refund is a feature allowing to refund customers directly from the payment in Odoo. | selection | required Values: |
| support_tokenization | Tokenization Tokenization is the process of saving the payment details as a token that can later be reused without having to enter the payment details again. | boolean | |
| supported_country_ids | Countries The list of countries in which this payment method can be used (if the provider allows it). In other countries, this payment method is not available to customers. | many2many | |
| supported_currency_ids | Currencies The list of currencies for that are supported by this payment method (if the provider allows it). When paying with another currency, this payment method is not available to customers. | many2many | |
| create_date | Created on | datetime | read-onlyautomatic |
| create_uid | Created by | many2one | read-onlyautomatic |
| display_name | Display Name | char | read-onlycomputedautomatic |
| id | ID | integer | read-onlyautomatic |
| write_date | Last Updated on | datetime | read-onlyautomatic |
| write_uid | Last Updated by | many2one | read-onlyautomatic |
Relations
Models linked from this model
- payment.method: brand_ids, primary_payment_method_id
- payment.provider: provider_ids
- res.country: supported_country_ids
- res.currency: supported_currency_ids
Fields of other models pointing here
- payment.method: primary_payment_method_id
- payment.provider: payment_method_ids
- payment.token: payment_method_id
- payment.transaction: payment_method_id, primary_payment_method_id
Reading this model through the API
Odoo 19 JSON-2 API call reading the first five records with real fields of the model. Replace the instance, database and API key with your own.
curl -X POST "https://your-instance.odoo.com/json/2/payment.method/search_read" \
-H "Authorization: bearer $ODOO_API_KEY" \
-H "X-Odoo-Database: your-db" \
-H "Content-Type: application/json" \
-d '{"domain":[],"fields":["name","code","support_manual_capture","support_refund","primary_payment_method_id"],"limit":5}'import requests
BASE_URL = "https://your-instance.odoo.com/json/2"
headers = {"Authorization": f"bearer {API_KEY}", "X-Odoo-Database": "your-db"}
res = requests.post(
f"{BASE_URL}/payment.method/search_read",
headers=headers,
json={"domain": [], "fields": ["name","code","support_manual_capture","support_refund","primary_payment_method_id"], "limit": 5},
)
res.raise_for_status()
print(res.json())- External API access requires Odoo's Custom plan.
- XML-RPC and JSON-RPC will be removed in Odoo 22 (fall 2028): use JSON-2.
- The access rights and record rules of the key's user apply.
Cite this tool
Writing a tutorial, internal documentation or a forum answer? Copy this link to send your readers to the up-to-date reference.
<a href="https://aidoo.ai/en/outils/explorateur-modeles-odoo/payment-method">payment.method (Odoo 19.0)</a>Sources
Data verified on September 23, 2026 · Odoo 19.0 Community
Have an Odoo project, or want to put your ERP to work with AI? Let's talk
Implementation, custom module development, connecting Claude or ChatGPT to your data: tell us about your context and we will reply within 24 business hours.