get

/payment-methods/{paymentMethodId}

Returns the details of the payment method identified by {paymentMethodId}.

Authorization

oauth2 - clientCredentials

Request Parameters

1 Path Parameter

Responses

1 Example
Schema
object
taxClass
string

The tax class. Can be REGULAR, REDUCED, or EXEMPT.

onlinePayment
boolean

Indicates if the payment method is an online payment. Can be true or false.

workflow
string

The payment workflow for the current payment. Can be one of PAYMENT_ON_SELECTION, EMBEDDED_ON_SELECTION, PAYMENT_ON_BUY, or EMBEDDED_ON_BUY.

_links
object
description
string

Description of the payment method that is used during checkout.

officialName
string

The official name of the payment method chosen by the merchant during setup.

serviceableCountries
array

The list of target countries this payment method can be used in.

minimumOrderValue
object

The minimum value of the cart so that this payment method can be used.

discountOrFee
object

The details about the fee to be payed or discount to be granted for this payment method.

name
string

The name of the payment method that is used during checkout.

officialDescription
string

The official description of the payment method chosen by the merchant during setup.

position
number

The sorting position of the payment method in the Commerce Cockpit in relation to other payment methods.

_id
string

The immutable, unique identifier of the requested resource.

activated
boolean

Indicates if a payment method is active. Can be true or false.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
paymentMethodId
$$.env
2 variables not set
host
oauth_access_token