listmethodsrequest.md

ListMethodsRequest

Fields

Field	Type	Required	Description	Example
SequenceType	*components.SequenceType	➖	Set this parameter to first to only return the enabled methods that can be used for the first payment of a recurring sequence. Set it to recurring to only return enabled methods that can be used for recurring payments or subscriptions.	oneoff
Locale	*components.Locale	➖	Passing a locale will sort the payment methods in the preferred order for the country, and translate the payment method names in the corresponding language.	en_US
Amount	*components.Amount	➖	If supplied, only payment methods that support the amount and currency are returned. Example: /v2/methods?amount[value]=100.00&amount[currency]=USD
Resource	*components.MethodResourceParameter	➖	: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. ⚠️ We no longer recommend using the Orders API. Please refer to the Payments API instead. Indicate if you will use the result for the Create order or the Create payment endpoint. When passing the value orders, the result will include payment methods that are only available for payments created via the Orders API.	payments
BillingCountry	*string	➖	The country taken from your customer's billing address in ISO 3166-1 alpha-2 format. This parameter can be used to check whether your customer is eligible for certain payment methods, for example for Klarna. Example: /v2/methods?resource=orders&billingCountry=DE	DE
IncludeWallets	*components.MethodIncludeWalletsParameter	➖	A comma-separated list of the wallets you support in your checkout. Wallets often require wallet specific code to check if they are available on the shoppers device, hence the need to indicate your support.	applepay
OrderLineCategories	*components.LineCategories	➖	A comma-separated list of the line categories you support in your checkout. Example: /v2/methods?orderLineCategories=eco,meal	eco
ProfileID	*string	➖	The identifier referring to the profile you wish to retrieve the resources for. Most API credentials are linked to a single profile. In these cases the profileId must not be sent. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.
Include	*string	➖	This endpoint allows you to include additional information via the include query string parameter.
Testmode	*bool	➖	Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
IdempotencyKey	*string	➖	A unique key to ensure idempotent requests. This key should be a UUID v4 string.	123e4567-e89b-12d3-a456-426