Path parameters

• paymentMethodId string(uuid) Required

  ID of the paymentMethod

Responses

• 200 application/vnd.api+json

  The requested payment method.

  Hide response attributes Show response attributes object

  • data object
    Hide data attributes Show data attributes object

    • type string

      Value is paymentMethod.

    • id string(uuid)

      Payment method ID

    • attributes object
      Hide attributes attributes Show attributes attributes object

      • kind string

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

      • status string

        The desired status for a payment method is verified, this means the method is ready to use. A payment method that has the status created has yet to be verified. This is the case for payment methods, which have an asynchronous verification process, e.g., paydirekt (waiting for an email).

        Values are created, verified, pending, or unacceptable.

      • identificationString string
      • vendorPRN string

        PACE resource name(s) to payment method vendor

      • twoFactor boolean

        indicates if the payment method kind requires two factors later on

      • approvalURL string(url)

        URL for the user to call in order to approve this payment method.

      • alias string

        Customer chosen alias for the payment method

      • implicit boolean

        Implicit (true) payment methods are read-only and cannot be deleted, e.g., ApplePay

      • pacePay boolean

        Identifies if the payment method is a PACE payment method (true) or a broker method (false)

      • mandatoryAuthorisationAttributes array[object]

        Mandatory transaction attribute validator

        Mandatory transaction attribute validator

        Hide mandatoryAuthorisationAttributes attributes Show mandatoryAuthorisationAttributes attributes object

        • name string
        • maxLength integer
        • regex string
      • expiry string(date-time)

        Expiry date of the payment method. If empty or not present the payment method does not have an expiry date.

      • managed boolean

        Managed (true) payment methods are read-only and cannot be deleted other than by the client (oauth/oidc) that created them.

      • userID string(uuid)
    • meta object
      Hide meta attribute Show meta attribute object

      • merchantName string

        Merchant name if the request was made in a way that a merchant name can be determined. For example if requesting payment methods for a specific gas station, it is the merchant name at that gas station.

    • relationships object
      Hide relationships attributes Show relationships attributes object

      • paymentMethodVendor object
        Hide paymentMethodVendor attribute Show paymentMethodVendor attribute object

        • data object
          Hide data attributes Show data attributes object

          • type string

            Value is paymentMethodVendor.

          • id string(uuid)
      • paymentMethodKind object
        Hide paymentMethodKind attribute Show paymentMethodKind attribute object

        • data object
          Hide data attributes Show data attributes object

          • type string

            Value is paymentMethodKind.

          • id string(uuid)
      • paymentTokens object
        Hide paymentTokens attribute Show paymentTokens attribute object

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

          • type string

            Value is paymentToken.

          • id string(uuid)
    • links object
      Hide links attribute Show links attribute object

      • authorize object
        Hide authorize attributes Show authorize attributes object

        • href string(url)
        • meta object
          Hide meta attribute Show meta attribute object

          • authFlow string

            Values are token-provided or method-onboarded.

  • included array[object]
    Any of:

    PaymentMethodVendor object PaymentMethodKindMinimal object

    Hide attributes Show attributes

    • type string

      Value is paymentMethodVendor.

    • id string(uuid)
    • attributes object
      Hide attributes attributes Show attributes attributes object

      • name string

        Human-readable version of the vendor name. Should be used for display.

      • slug string

        Short and lowercased version. Should NOT be used for display.

      • logo object
        Hide logo attributes Show logo attributes object

        • href string
        • variants array[object]
          Hide variants attribute Show variants attribute object

          • dark object
            Hide dark attribute Show dark attribute object

            • href string

    Hide attributes Show attributes

    • type string

      Value is paymentMethodKind.

    • id string(uuid)
    • 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 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

• 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

  • 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.

      Hide meta attribute Show meta attribute object

      • Additional properties are allowed
• 404 application/vnd.api+json

  Resource not found

  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.

      Hide meta attribute Show meta attribute object

      • Additional properties are allowed
• 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.

      Hide meta attribute Show meta attribute object

      • Additional properties are allowed
• 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.

      Hide meta attribute Show meta attribute object

      • Additional properties are allowed