Payment Settings

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

Essential knowledge

Author:

Fluent Commerce

Changed on:

1 Nov 2023

Overview

The below settings control the allowed values in the order transaction create method in the REST API (POST /api/v4.1/order/{orderId}/transaction). The createFinancialTransaction GraphQL mutation can use custom-defined paymentProvider, paymentMethod and currency fields. We recommend that the below settings be used as the way to look up current configured values dynamically without hardcoding values for these fields. These settings can be modified and retrieved via the settings API.

Key points

Understand the basic setup of payment settings
Example of how payment settings can be used

Tip on update setting by using REST API

When updating settings via this api it will overwrite the existing settings, to add new values to an existing setting it is best to do a GET request and append the new values to the returned results.

Example of use

The combination of these three fields provides a range of flexibility to control logic for a variety of use cases:

financialTransation Field	Setting	Example 1	Example 2	Example 3
cardType	No custom values allowed	VISA	MASTERCARD	(empty)
paymentMethod	PAYMENT.METHOD	ELECTRON	CREDITCARD	GIFTCARD
paymentProvider	PAYMENT.PROVIDER	ADYEN	SQUARE	CUSTOM_PROVIDER1
currency	PAYMENT.CURRENCY	USD	EURO	BITCOIN

The above table combines the four different payment-related fields that can be used in combination to trigger different payment-related logic in workflows. Each example combination could be used to fire custom events to execute card, payment method, or provider-specific logic or returns requirements.

Payment Settings

Overview

Key points

Example of use

Fluent Commerce

Building Blocks

By Type

Helpful Resources

Quick Links