Query parameters

• page[number] integer

  Number of the page that should be returned (sometimes referred to as "offset"). Page 0 is the first page.

• page[size] integer

  Page size of the currently returned page (sometimes referred to as "limit").

• sort string

  Sort by given attribute, plus and minus are used to indicate ascending and descending order.

  Values are id, createdAt, updatedAt, paymentMethodId, paymentMethodKind, purposePRN, providerPRN, fuel.productName, fuel.type, -id, -createdAt, -updatedAt, -paymentMethodId, -paymentMethodKind, -purposePRN, -providerPRN, -fuel.productName, or -fuel.type.

• filter[id] string

  ID of the payment transaction

• filter[createdAt] string(date-time)

  Time the transaction was created.

• filter[updatedAt] string(date-time)

  Time the transaction was last updated.

• filter[paymentMethodId] string(uuid)

  Payment method ID of the transaction.

• filter[paymentMethodKind] string

  Payment method kind of the transaction.

• filter[purposePRN] string

  PACE resource name of the resource, for which the payment was authorized.

• filter[providerPRN] string

  PACE resource name - referring to the transaction purpose with provider details.

• filter[fuel.productName] string

  Product name of the fuel that was used in the transaction.

• filter[fuel.type] string

  Fuel type which was used in the transaction.

Responses

• 200 application/vnd.api+json

  List of transactions

  Hide response attributes Show response attributes object

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

    • type string

      Value is transaction.

    • id string(uuid)

      ID of the new transaction.

    • links object
      Hide links attributes Show links attributes object

      • receipt object
        Hide receipt attributes Show receipt attributes object

        • href string
        • meta object
          Hide meta attribute Show meta attribute object

          • mimeType string

            Value is image/png.

      • receiptPDF object
        Hide receiptPDF attributes Show receiptPDF attributes object

        • href string
        • meta object
          Hide meta attribute Show meta attribute object

          • mimeType string

            Value is application/pdf.

    • attributes object
      Hide attributes attributes Show attributes attributes object

      • createdAtLocaltime string

        Initial creation date of the transaction (local-time of the gas station/point of interest) (https://tools.ietf.org/html/rfc3339#section-5.6).

      • createdAt string(date-time)

        Initial creation date of the transaction (UTC) (https://tools.ietf.org/html/rfc3339#section-5.6).

      • updatedAt string(date-time)

        Date of the last update (UTC) (https://tools.ietf.org/html/rfc3339#section-5.6).

      • paymentMethodKind string

        Payment Method Kind as name.

      • paymentMethodId string(uuid)

        ID of the paymentMethod

      • authorizePaymentTokenId string(uuid)

        ID of the authorization payment token

      • paymentToken string

        Payment token value

      • paymentTokenRequestID string

        Request ID of the payment token

      • paymentTransactionRequestID string

        Request ID of the payment transaction

      • purposePRN string

        PACE resource name

      • providerPRN string

        PACE resource name - referring to the transaction purpose with provider details.

      • issuerPRN string

        PACE resource name

      • vin string

        Vehicle identification number

      • driverVehicleID string

        Driver/vehicle identification

      • mileage integer

        Current mileage in meters

      • numberPlate string

        Number plate of the car

      • additionalData string

        additional data for omv

      • productFlow string

        The given productFlow (e.g. preAuth, postPay)

      • priceIncludingVATBeforeDiscount number(decimal)

        If a discount was applied, this the transaction sum, before applying the discound

      • priceIncludingVAT number(decimal)

        If a discount was applied, this is the already fully discounted transaction sum

      • priceWithoutVAT number(decimal)
      • discountAmount number(decimal)

        Amount that was discounted. Only if any discounts were applied earlier.

      • fuel object
        Hide fuel attributes Show fuel attributes object

        • pumpNumber integer

          Number of the pump used for fueling, i.e., the actual number that is being displayed to the customer

        • unit string

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

        • pricePerUnit number(decimal)

          Price per unit (with three decimal places)

        • amount number(decimal)

          Fuel amount in provided unit

        • productName string

          Product Name of the current fuel.productName

        • type string

          Fuel type for cars, based on the EU fuel marking

          Values are ron98, ron98e5, ron95e10, diesel, e85, ron95e5, ron100, dieselGtl, dieselB0, dieselB7, dieselB15, dieselPremium, dieselSynthetic, syntheticDiesel, lpg, cng, lng, h2, truckDiesel, adBlue, truckAdBlue, truckDieselPremium, truckLpg, heatingOil, dieselHvo, dieselBMix, or dieselRed.

      • currency string

        Currency as specified in ISO-4217.

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

      • VAT object
        Hide VAT attributes Show VAT attributes object

        • amount number(decimal)
        • rate number(decimal)
      • references array[string]
      • location object
        Hide location attributes Show location attributes object

        • latitude number(float)
        • longitude number(float)
        • brand string
        • stationName string
        • brandId string
        • address object
          Hide address attributes Show address attributes object

          • street string
          • houseNo string
          • postalCode string
          • city string
          • countryCode string

            Country code in as specified in ISO 3166-1.

      • error string

        Description of the error that occured

    • relationships object
      Hide relationships attribute Show relationships attribute object

      • discountTokens object
        Hide discountTokens attribute Show discountTokens attribute object

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

          • type string

            Value is discount.

          • id string(uuid)

            Discount Token ID

  • meta object
    Hide meta attribute Show meta attribute object

    • count number

      the amount of available transactions.

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

    • type string

      Value is discount.

    • id string(uuid)

      Discount Token ID

    • attributes object
      Hide attributes attributes Show attributes attributes object

      • title string

        Line item

      • amount number(decimal)

        Amount in the currency of the pumps ready to pay amount

      • provider string

        Technical reference to the provider/campaign

• 400 application/vnd.api+json

  Bad request

  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.

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

    • 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

  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.

    • 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

  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.

    • 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
• 409 application/vnd.api+json

  Resource conflicts

  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.

    • 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
• 415 application/vnd.api+json

  The specified content type 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.

    • 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
• 422 application/vnd.api+json

  The request was well-formed but was unable to be followed due to semantic errors.

  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.

    • 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

  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.

    • 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