Path parameters

• gasStationId string(uuid) Required

  Gas station ID

Responses

• 200 application/vnd.api+json

  OK

  Hide response attributes Show response attributes object

  • data object
    Hide data attributes Show data attributes object

    • type string

      Value is getPumps.

    • id string(uuid)

      request ID

    • relationships object
      Hide relationships attribute Show relationships attribute object

      • pumps object
        Hide pumps attribute Show pumps attribute object

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

          • type string

            Value is pump.

          • id string(uuid)

            Pump ID

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

    • type string

      Type

      Value is pump.

    • id string(uuid)

      Pump ID

    • attributes object
      Hide attributes attributes Show attributes attributes object

      • identifier string

        Pump identifier

      • fuelingProcess string

        The fueling process that has to be followed

        • postPay the pump is free and needs to be paid after fueling
        • preAuth the pump is locked and has to be unlocked
        • preAuthWithFuelType the pump is locked and has to be unlocked, the carFuelType is required

        Values are postPay, preAuth, or preAuthWithFuelType.

      • status string

        Current pump status.

        • free the pump is free, fueling possible (nozzle not lifted), possible transitions inUse, locked, outOfOrder. Note: A transition from free to locked may implies the pump was pre-authorization was canceled.
        • inUse the pump is fueling, possible transitions readyToPay, locked, outOfOrder
        • readyToPay the pump can be payed using the post pay process, possible transitions free, locked, outOfOrder. Note: A transition from readyToPay to free implies the pump was paid.
        • locked the pump required a pre-authorization, possible transitions free, inTransaction, outOfOrder. Note: A transition from locked to free implies the pre-authorization was successful.
        • inTransaction the pump is in use by another user using the pre-authorization process, possible transitions locked, outOfOrder
        • outOfOrder the pump has a technical problem, this can only be resolved by the gas station staff on site, possible transitions free, locked. Note: The customer has to pay in the shop

        Values are free, inUse, readyToPay, locked, inTransaction, or outOfOrder.

      • fuelType string
      • productName string
      • fuelAmount number(decimal)

        Fuel amount in units

      • pricePerUnit number(decimal)

        Fuel price in currency/unit

      • unit string

        Fuel measurement unit. Eg: liter, us-gallon, uk-gallon, kilogram

      • VAT object
        Hide VAT attributes Show VAT attributes object

        • amount number(decimal)
        • rate number(decimal)
      • purposePRNs array[string]

        Only if status is locked or readyToPay: PRNs required for creating a token for payment at this gas station

      • priceWithoutVAT number(decimal)
      • priceIncludingVAT number(decimal)
      • currency string

        Currency as specified in ISO-4217.

        Format should match the following pattern: ^[A-Z]{3}$.

      • transactionId string(uuid)

        Provided if the user pre-authorized the pump

      • transaction object
        Hide transaction attributes Show transaction attributes object

        • type string

          Value is transaction.

        • id string(uuid)

          Transaction ID

        • attributes object
          Hide attributes attributes Show attributes attributes object

          • status string
          • authorizedAmount number(decimal)
          • PumpUUID string(uuid)

            UUID of the pump this transaction was created on

          • VAT object
            Hide VAT attributes Show VAT attributes object

            • amount number(decimal)
            • rate number(decimal)
          • priceWithoutVAT number(decimal)
          • priceIncludingVAT number(decimal)
          • currency string

            Currency as specified in ISO-4217.

            Format should match the following pattern: ^[A-Z]{3}$.

          • pricePerUnit number(decimal)
          • unit string

            Fuel measurement unit. Eg: liter, us-gallon, uk-gallon, kilogram

          • fuelType string
          • fuelAmount number(decimal)
          • productName string
          • paymentToken string
          • paymentTokenRestrictions array[string]

            PRNs describing the restrictions (station and fuel types) for a token, if a token is provided

      • availableProducts array[object]

        Only if status is locked: available fuel products at the given pump

        Hide availableProducts attributes Show availableProducts attributes object

        • type string
        • name string
• 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.

• 403 application/vnd.api+json

  Forbidden

  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.

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

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

• 410 application/vnd.api+json

  Resource is gone

  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.

• 502 application/vnd.api+json

  Error occurred while communicating with PACE services

  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.