Skip to content

Latest commit

 

History

History
14 lines (11 loc) · 16.7 KB

File metadata and controls

14 lines (11 loc) · 16.7 KB

ListAllMethodsRequest

Fields

Field Type Required Description Example
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/all?amount[value]=100.00&amount[currency]=USD
Include *string This endpoint allows you to include additional information via the
include query string parameter.
SequenceType *components.SequenceType Set this parameter to first to only return the methods that
can be used for the first payment of a recurring sequence.

Set it to recurring to only return methods that can be used for recurring payments or subscriptions.
oneoff
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.
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