Headers

• Accept-Language string

  Language preference of localized response properties. The full standard of RFC 7231 (https://tools.ietf.org/html/rfc7231#section-5.3.5) is supported.

Path parameters

• clientId string Required

  ID of the client

Query parameters

• additionalData boolean

  Flag to allow more data to the payment method kinds.

• poiID string(uuid)

  Filter allowed payment methods kinds by poi.

Responses

• 200 application/vnd.api+json

  All payment method kinds for the given clientID

  Hide headers attribute Show headers attribute

  • Content-Language string

    Language of the localized response properties. Is not necessarily one of the values provided by the Accept-Language request header.

  Hide response attribute Show response attribute object

  • data array[object]
    Hide data attributes Show data attributes object

    • type string

      Value is paymentMethodKind.

    • id string

      one of sepa, creditcard, paypal, paydirekt, dkv, applepay, ...

    • attributes object
      Hide attributes attributes Show attributes attributes object

      • name string

        localized name

      • currencies array[string]

        Currencies supported by payment method kind

      • twoFactor boolean

        indicates if the payment method kind requires two factors later on

      • fuelcard boolean

        Indicates whether the payment method is a fuel card. Fuelcard no means no.

      • implicit boolean

        Indicates whether the payment method has been onboarded implicitely, e.g., an on-device payment method such as Apple Pay or Google Pay. This field is optional and if not present should be assumed to indicate implicit=false.

      • managed boolean

        Indicates whether the payment method can be onboarded/modified. Managed true means no. Otherwise yes. Most payment method kinds are not managed, i.e., managed=false.

      • vendorPRNs array[string]

        PACE resource name(s) to payment method vendors

      • dataPrivacy object

        data privacy information

        Hide dataPrivacy attribute Show dataPrivacy attribute object

        • terms object

          Localized data privacy terms. The terms come formatted in multiple ways, which are all equally valid if given. Additional formats might be added in the future.

          Hide terms attributes Show terms attributes object

          • markdown string

            Terms formatted as markdown. Does not contain external resources like images.

          • html string

            Terms formatted as markdown. Does not contain external resources like images.

      • vendors array[object]
        Hide vendors attributes Show vendors attributes object

        • id string(uuid)

          ID of the payment method vendor.

        • slug string
        • name string
        • logo object
          Hide logo attributes Show logo attributes object

          • href string
          • variants array[object]

            variants of the vendor's logo

            Hide variants attribute Show variants attribute object

            • href string
        • paymentMethodKindId string
• 406 application/vnd.api+json

  The specified accept header is invalid

  Hide response attribute Show response attribute object

  • errors array[object]
    Hide errors attributes Show errors attributes object

    • id string

      A unique identifier for this particular occurrence of the problem.

    • links object
      Hide links attribute Show links attribute object

      • about string

        A link that leads to further details about this particular occurrence of the problem.

    • status string

      the HTTP status code applicable to this problem, expressed as a string value.

    • code string

      an application-specific error code, expressed as a string value.

    • title string

      A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

    • detail string

      a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

    • source object

      An object containing references to the source of the error.

      Hide source attributes Show source attributes object

      • pointer string

        A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute].

      • parameter string

        A string indicating which URI query parameter caused the error.

    • meta object

      a meta object containing non-standard meta-information about the error.

• 500 application/vnd.api+json

  Internal server error

  Hide response attribute Show response attribute object

  • errors array[object]
    Hide errors attributes Show errors attributes object

    • id string

      A unique identifier for this particular occurrence of the problem.

    • links object
      Hide links attribute Show links attribute object

      • about string

        A link that leads to further details about this particular occurrence of the problem.

    • status string

      the HTTP status code applicable to this problem, expressed as a string value.

    • code string

      an application-specific error code, expressed as a string value.

    • title string

      A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

    • detail string

      a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

    • source object

      An object containing references to the source of the error.

      Hide source attributes Show source attributes object

      • pointer string

        A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute].

      • parameter string

        A string indicating which URI query parameter caused the error.

    • meta object

      a meta object containing non-standard meta-information about the error.