GET payment_methods

get

https://api.bookingexperts.com/v3/administrations/{administration_id}/payment_methods

Returns payment methods of the administration

Path Params

administration_id

string

required

Administration ID

Query Params

page[number]

integer

≥ 1

Page number

page[size]

integer

1 to 100

Page size

sort

string

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id, position, created_at, updated_at

fields[payment_method]

string

Fieldset. Specify a comma separated list of attributes to return

include

string

Includes list. Specify a comma separated list of resources to include.

filter[id]

string

Filter on ID

filter[name]

string

Filter on name

filter[description]

string

Filter on description

filter[archived]

string

Filter on archived

filter[pos_enabled]

string

Filter on pos_enabled

filter[requires_debtor_details]

string

Filter on requires_debtor_details

filter[kind]

string

Filter on kind

filter[preferred_country_codes]

string

Filter on preferred_country_codes

filter[accepted_currencies]

string

Filter on accepted_currencies

filter[accepted_sequence_types]

string

Filter on accepted_sequence_types

filter[debtor_types]

string

Filter on debtor_types

filter[currencies]

string

Filter on currencies

filter[sequence_types]

string

Filter on sequence_types

filter[payment_type]

string

Filter on payment_type

filter[position]

string

Filter on position

filter[created_at]

string

Filter on created_at

filter[updated_at]

string

Filter on updated_at

filter[logos]

string

Filter on logos. Specify a comma separated list of IDs to filter on.

filter[administration]

string

Filter on administration. Specify a comma separated list of IDs to filter on.

include_archived

boolean

When true, archived payment methods are included in the response

Headers

Accept-Language

string

Supported languages. A comma separated list with one or more of the following locales: cs, da, de, de-AT, de-CH, en, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr. Default: 'en'.

Responses

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.api+json

200PaymentMethodCollectionResponse

429Error

defaultError