Fuel API Overview

Paydiant is now PayPal's White Label Wallet (WLW).

As a WLW partner, you can integrate your fuel site software with the WLW platform using the Fuel API. The API allows you to create a set of simple interfaces that enable an interaction between the WLW platform and a fuel site in order to drive a Pay-at-the-Pump user experience.

Integration design

The WLW Fuel Integration design combines the power of the WLW Cloud with the Fuel Retailer/Technology vendor capabilities to provide seamless fuel site integration with the WLW mobile payments services.

The WLW Solution is built using a Modular Server Architecture, which enables our partners to leverage the platform to interact with a variety of third-party systems. This design also enables WLW to support multiple tender types within various mobile wallets across disparate systems.

Our Connector Framework is used to connect the WLW Cloud to the Fuel Site. The Geo-based Fuel design requires that messages originate from both Cloud platforms. This solution leverages two interfaces on the WLW platform:

  • the Connector Framework for sending messages to the Fuel Retailer
  • the B2B Gateway for receiving messages that originate from the Fuel Retailer

In the following figure, RetrieveSiteInformation and PumpAuthorization represent the site information that is provided by the Fuel Site to the WLW Cloud.

The updateFuelEvent API is the data managed via the WLW B2B Gateway.

Modular Architecture

Points of interaction

There are three basic points of interaction between the WLW Cloud and the Fuel Vendor’s Cloud services that drive a Geo-based Fuel flow:

Interaction Points

Data agreement requirements

The type and scope of information that is returned during any given transaction is based on the POS Integration policy configuration defined by the terms of the Wallet Issuer Data Agreement.

Depending on the terms of the policy in place for your organization, some of the information associated with method attributes documented in this guide may not be returned as stated.

If no data agreement is in place, the policy reverts to the most restrictive setting, passing only information that is critical to the actual purchase, such as the amount and date.

If you believe there is a discrepancy between the configurations you apply to your POS integration and the data being returned, consult your data agreement to determine the data that is available to you and the acceptable uses for that data.

Resource URL

All request calls using the updateFuelEvent endpoint must be directed to:

URL/b2b-gateway/

where <URL> is the Resource URL provided by WLW at the time of partner onboarding.

Authentication header

Only authorized WLW Issuing Partners are permitted access to the B2B Gateway API endpoints. Contact your WLW representative for more information about obtaining the credentials required to access these APIs.

All calls to the B2B updateFuelEvent endpoint must be accompanied by an authorization header that contains the authorization value provided by WLW, encoded per WLW’s instructions (typically base-64 encoding). This authorization is the access point for all of a fuel site’s locations. The authorization is not location specific.

  • Header Type: Authorization Basic Base64encode
  • Format: accessid:accessKey
  • Example: Authorization: Basic eGFPeDl1R2dZYzpGdWVs

UNIX timestamp

Many dates in these methods are in UNIX timestamp format.

Ignore unused response content

When parsing JSON response content, WLW recommends ignoring attributes you are not using. This technique helps avoid problems that can arise when new fields or attributes are added.

Secure Communication

All communication, regardless of transport, needs to run over a TLS encrypted (https) session.

Next