> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/docs/developers/api-documentation/payment-method/update-paymentmethods-details.md).

# Update paymentmethods details

Update paymentmethod details for tenant.

`settlementCode` can only be set and updated for EXTERNAL payment methods. It must have the prefix `EXTERNAL_`.

For all other payment methods, the payment code is used as the settlement code.

Required permissions: PAYMENT\_METHOD

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"PaymentMethod","description":"PaymentMethod"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"TenantPaymentMethodUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantPaymentMethodUpdateRequestSchema"}}}}},"schemas":{"TenantPaymentMethodUpdateRequestSchema":{"title":"TenantPaymentMethodUpdateRequestSchema","type":"object","properties":{"active":{"type":"boolean"},"name":{"type":"string","description":"The name will be displayed in the clients and on the receipt"},"description":{"type":"string","description":"A description of the payment method, shown in the client"},"receiptText":{"type":"string","maxLength":500,"description":"Text printed on the receipt when this payment method is used. Omit to leave unchanged."},"allowSale":{"type":"boolean"},"allowRefund":{"type":"boolean"},"allowCashback":{"type":"boolean"},"allowPrepayment":{"type":"boolean"},"settlementCode":{"type":"string"},"position":{"type":"integer","description":"order of appearance in lists"},"visibility":{"$ref":"#/components/schemas/PaymentMethodVisibilityENUM"},"amountInput":{"$ref":"#/components/schemas/TenantPaymentMethodAmountInputENUM"},"useRounding":{"type":"boolean"},"requireCustomer":{"type":"boolean"},"requireCustomerMobile":{"type":"boolean"},"requireCustomerEmail":{"type":"boolean"},"requireCustomerType":{"$ref":"#/components/schemas/PaymentMethodCustomerTypeENUM"},"requireCustomerContact":{"type":"boolean"},"requireRefundToSameMethod":{"type":"boolean"},"requireExclusiveUse":{"type":"boolean"}}},"PaymentMethodVisibilityENUM":{"title":"PaymentMethodVisibilityENUM","type":"string","enum":["FEATURED","LISTED","HIDDEN","HIDDEN_WHEN_NOT_REQUIRED"]},"TenantPaymentMethodAmountInputENUM":{"title":"TenantPaymentMethodAmountInputENUM","type":"string","enum":["NONE","AUTOFILL_REMAINING","FORCE_REMAINING"]},"PaymentMethodCustomerTypeENUM":{"title":"PaymentMethodCustomerTypeENUM","type":"string","enum":["ANY","PERSON","COMPANY"]},"TenantPaymentMethodResponseSchema":{"title":"TenantPaymentMethodResponseSchema","type":"object","required":["active","name","description","settlementCode","paymentMethod","allowRefund","tenantPaymentMethodUid","allowSale","allowPrepayment","allowCashback","parameters","externalSystemMappings","position","visibility","requirements","amountInput","useRounding","receiptText"],"properties":{"active":{"type":"boolean"},"name":{"type":"string","description":"The name will be displayed in the clients and on the receipt"},"description":{"type":"string","description":"A description of the payment method, shown in the client"},"receiptText":{"type":"string","maxLength":500,"description":"Text printed on the receipt when this payment method is used. Empty when not configured."},"settlementCode":{"type":"string"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethodResponseSchema"},"allowRefund":{"type":"boolean","description":"if true, paymentMethod can be used when settling a refund."},"tenantPaymentMethodUid":{"$ref":"#/components/schemas/UID"},"allowSale":{"type":"boolean","description":"if true, paymentMethod can be used when settling a sale."},"allowPrepayment":{"type":"boolean","description":"if true, paymentMethod can be used when settling a sale."},"allowCashback":{"type":"boolean","description":"if true, settlement amount can be higher than remainingAmount when settling a sale."},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/TenantPaymentMethodParameterExtractResponseSchema"}},"externalSystemMappings":{"type":"array","items":{"$ref":"#/components/schemas/TenantPaymentMethodMappingResponseSchema"}},"position":{"type":"integer","description":"order of appearance in lists"},"visibility":{"$ref":"#/components/schemas/PaymentMethodVisibilityENUM"},"requirements":{"$ref":"#/components/schemas/PaymentMethodRequirementResponseSchema"},"amountInput":{"$ref":"#/components/schemas/TenantPaymentMethodAmountInputENUM"},"useRounding":{"type":"boolean"}}},"PaymentMethodResponseSchema":{"title":"PaymentMethodResponseSchema","type":"object","required":["allowRefund","allowSale","allowAmount","allowCashback","allowPrepayment","requireExclusiveUse","name","parameters","paymentCode"],"properties":{"allowRefund":{"type":"boolean","description":"if true, paymentMethod can be used when settling a refund."},"allowSale":{"type":"boolean","description":"if true, paymentMethod can be used when settling a sale."},"allowAmount":{"type":"boolean","description":"if true, settled amount can be != remainingAmount set when settling a sale."},"allowCashback":{"type":"boolean","description":"if true, settlement amount can be higher than remainingAmount when settling a sale."},"allowPrepayment":{"type":"boolean","description":"if true, payment method is allowed as a prepayment settlement"},"requireExclusiveUse":{"type":"boolean","description":"defines whether or not the payment method can be used in combination with other payment methods."},"name":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodParameterSchema"}},"paymentCode":{"$ref":"#/components/schemas/PaymentMethodCodeENUM"}}},"PaymentMethodParameterSchema":{"description":"PaymentMethodParameter","properties":{"key":{"type":"string"},"keyType":{"$ref":"#/components/schemas/PaymentMethodParameterTypeENUM"},"name":{"type":"string"},"required":{"type":"boolean"}},"required":["keyType","key","name","required"],"title":"PaymentMethodParameterSchema","type":"object"},"PaymentMethodParameterTypeENUM":{"description":"","enum":["TEXT","INTEGER","DATE","MOBILE","MODULUS10","MODULUS11"],"title":"PaymentMethodParameterTypeENUM","type":"string"},"PaymentMethodCodeENUM":{"description":"`PAYEX_CARD` is discontinued: it stays for historical orders, settlements and filters, but it cannot be added to a tenant or store, and a new settlement with it is refused.","enum":["CASH","INVOICE","VIPPS","ADYEN_CARD","PAYEX_CARD","SANTANDER","EXTERNAL","TRANSFER_MONEY","FLOWGIFTCARD","STORE_CREDIT","STRIPE_CARD","TWO_INVOICE","NETS_CARD","VERIFONE_CARD","FOREIGN_CASH","SWISH","DINTERO_PAYMENT_LINK","DINTERO_CARD","BRITANNIA","PREPAYMENT","SOFTPAY_CARD","PAYMENT_GATEWAY","LOYALTY_POINTS","PAYEX_GIFTCARD"],"title":"PaymentMethodCodeENUM","type":"string"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"TenantPaymentMethodParameterExtractResponseSchema":{"title":"TenantPaymentMethodParameterExtractResponseSchema","description":"TenantPaymentMethodParameterExtractResponseSchema","type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"required":{"type":"boolean"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/TenantPaymentMethodParameterTypeENUM"},"regex":{"type":"string","description":"regular expression"}},"required":["name","description","required","key","type","regex"]},"TenantPaymentMethodParameterTypeENUM":{"title":"TenantPaymentMethodParameterTypeENUM","type":"string","enum":["TEXT","INTEGER","NUMERIC","DATE","MOBILE","MODULUS10","MODULUS11"]},"TenantPaymentMethodMappingResponseSchema":{"title":"TenantPaymentMethodMappingResponseSchema","allOf":[{"$ref":"#/components/schemas/GeneralMappingResponseSchema"},{"type":"object","required":["tenantPaymentMethodMappingUid"],"properties":{"tenantPaymentMethodMappingUid":{"type":"string"}}}]},"GeneralMappingResponseSchema":{"title":"GeneralMappingResponseSchema","type":"object","required":["systemCode","externalId"],"properties":{"systemCode":{"$ref":"#/components/schemas/ExternalSystemCodeENUM"},"externalId":{"type":"string"}}},"ExternalSystemCodeENUM":{"title":"ExternalSystemCodeENUM","type":"string","enum":["OMNIUM","ORDER_IMPORT","PROFRAKT"]},"PaymentMethodRequirementResponseSchema":{"title":"PaymentMethodRequirementResponseSchema","type":"object","description":"PaymentMethodRequirementResponseSchema","required":["requireCustomer","requireCustomerMobile","requireCustomerEmail","requireCustomerType","requireCustomerContact","requireExclusiveUse","requireRefundToSameMethod"],"properties":{"requireCustomer":{"type":"boolean"},"requireCustomerMobile":{"type":"boolean"},"requireCustomerEmail":{"type":"boolean"},"requireCustomerType":{"$ref":"#/components/schemas/PaymentMethodCustomerTypeENUM"},"requireCustomerContact":{"type":"boolean"},"requireExclusiveUse":{"type":"boolean"},"requireRefundToSameMethod":{"type":"boolean"}}}},"responses":{"TenantPaymentMethodResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantPaymentMethodResponseSchema"}}},"description":"Return a list of all paymentMethods in FlowRetail"}}},"paths":{"/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}":{"put":{"description":"Update paymentmethod details for tenant.\n\n`settlementCode` can only be set and updated for EXTERNAL payment methods. It must have the prefix \n`EXTERNAL_`.\n\nFor all other payment methods, the payment code is used as the settlement code.\n\nRequired permissions: PAYMENT_METHOD","operationId":"put-tenants-paymentmethods-details","requestBody":{"$ref":"#/components/requestBodies/TenantPaymentMethodUpdateRequest"},"responses":{"200":{"$ref":"#/components/responses/TenantPaymentMethodResponse"}},"summary":"Update paymentmethods details","tags":["PaymentMethod"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flowretail.com/docs/developers/api-documentation/payment-method/update-paymentmethods-details.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.