Get all payment method kinds

GET /payment-method-kinds

Returns all payment method kinds that are supported by this service. Use the Accept-Language header for localization.

Headers

Query parameters

  • 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

    Hide headers attribute Show headers attribute
    • 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, ...

      • Hide attributes attributes Show attributes attributes
        • 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 can be onboarded/modified. Implict true means no. Otherwise yes. Most payment method kinds are no implicit, i.e., implicit=false. This field is optional and if not present should be assumed to indicate implicit=false.

        • vendorPRNs array[string]

          PACE resource name(s) to payment method vendors

        • data privacy information

          Hide dataPrivacy attribute Show dataPrivacy attribute
          • 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
            • 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
  • 401 application/vnd.api+json

    OAuth token missing or invalid or a linked identity is missing.

    Linked identity missing is a special case where you need to make sure that the user has additionally logged in / authorized with a third-party.

    This is not relevant for most use-cases.

    The specific error code that identifies a missing linked identity is missing-linked-identity

    Example:

      {
          "errors": [
              {
                  "id": "cbgmhslmp1o9or9kh1p0",
                  "title": "Missing linked identity for authorized access",
                  "detail": "Linked identity is needed to access this resource, please check why the user does not have a linked identity",
                  "status": "401",
                  "code": "missing-linked-identity"
              }
          ]
      }
    
    Hide response attribute Show response attribute object

    Error objects provide additional information about problems encountered while performing an operation. Errors also contain codes besides title and message which can be used for checks even if the detailed messages might change.

    * 1000: generic error * 1001: payment processing temporarily unavailable * 1002: requested amount exceeds the authorized amount of the provided token * 1003: implicit payment methods cannot be modified * 1004: payment method rejected by provider * provider:payment-method-rejected: payment method rejected by provider (identical to 1004) * rule:product-denied: Product restrictions forbid transaction, e.g., forbidden fuel type - token authorized only for Diesel but attempted to fuel Super.

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

        A unique identifier for 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
        • 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].

        • A string indicating which URI query parameter caused the error.

      • meta object

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

        Hide meta attribute Show meta attribute
  • 406 application/vnd.api+json

    The specified accept header is invalid

    Hide response attribute Show response attribute object

    Error objects provide additional information about problems encountered while performing an operation. Errors also contain codes besides title and message which can be used for checks even if the detailed messages might change.

    * 1000: generic error * 1001: payment processing temporarily unavailable * 1002: requested amount exceeds the authorized amount of the provided token * 1003: implicit payment methods cannot be modified * 1004: payment method rejected by provider * provider:payment-method-rejected: payment method rejected by provider (identical to 1004) * rule:product-denied: Product restrictions forbid transaction, e.g., forbidden fuel type - token authorized only for Diesel but attempted to fuel Super.

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

        A unique identifier for 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
        • 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].

        • A string indicating which URI query parameter caused the error.

      • meta object

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

        Hide meta attribute Show meta attribute
  • 500 application/vnd.api+json

    Internal server error

    Hide response attribute Show response attribute object

    Error objects provide additional information about problems encountered while performing an operation. Errors also contain codes besides title and message which can be used for checks even if the detailed messages might change.

    * 1000: generic error * 1001: payment processing temporarily unavailable * 1002: requested amount exceeds the authorized amount of the provided token * 1003: implicit payment methods cannot be modified * 1004: payment method rejected by provider * provider:payment-method-rejected: payment method rejected by provider (identical to 1004) * rule:product-denied: Product restrictions forbid transaction, e.g., forbidden fuel type - token authorized only for Diesel but attempted to fuel Super.

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

        A unique identifier for 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
        • 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].

        • A string indicating which URI query parameter caused the error.

      • meta object

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

        Hide meta attribute Show meta attribute
GET /payment-method-kinds
curl \
 -X GET https://api.pace.cloud/pay/2024-1/payment-method-kinds \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Accept-Language: de"
Response examples (200)
# Headers
Content-Language: en-GB

# Payload
{
  "data": [
    {
      "type": "paymentMethodKind",
      "id": "string",
      "attributes": {
        "name": "SEPA direct debit",
        "currencies": [
          "EUR",
          "PLN"
        ],
        "twoFactor": true,
        "fuelcard": false,
        "implicit": true,
        "vendorPRNs": [
          "prn:cms:payment-method-vendors:3af4b4a7-33fc-4930-9c2d-6eea7e488398",
          "prn:cms:payment-method-vendors:d546bbe8-e707-43ae-8345-0709e30e710f"
        ],
        "dataPrivacy": {
          "terms": {
            "markdown": "# Terms & Conditions\n\nLorem ipsum ...\n",
            "html": "<h1>Terms & Conditions</h1>\n\n<p>Lorem ipsum ...</p>\n"
          }
        },
        "vendors": [
          {
            "id": "3af4b4a7-33fc-4930-9c2d-6eea7e488398",
            "slug": "visa",
            "name": "VISA",
            "logo": {
              "href": "/cms/images/payment-method-vendors/visa.png",
              "variants": [
                {
                  "href": "string"
                }
              ]
            },
            "paymentMethodKindId": "creditcard"
          }
        ]
      }
    }
  ]
}
Response examples (401)
{
  "errors": [
    {
      "id": "string",
      "links": {
        "about": "string"
      },
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}
Response examples (406)
{
  "errors": [
    {
      "id": "string",
      "links": {
        "about": "string"
      },
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}
Response examples (500)
{
  "errors": [
    {
      "id": "string",
      "links": {
        "about": "string"
      },
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}