Fuel API - JSON Schema

DOCS

Last updated: Aug 15th, 8:02am

The Use Case samples include only the attributes and fields being used for that specific example. The following samples show the full range of available attributes.

retrieveSiteInformation
updateFuelEvent
pumpAuthorization
settlement

Note: Code samples in this guide have been formatted for readability and may not precisely match the format in samples you can obtain on your system.

retrieveSiteInformation Full Example

Request

url/STLOCBO202

Response

1{
2   "retrieveSiteInformationResponse":{
3      "storeLocationID":"STLOCBO202",
4      "additionalData":[
5         {
6            "key":"SAMPLE_KEY_ONE",
7            "value":"sample value"
8         },
9         {
10            "key":"SAMPLE_KEY_TWO",
11            "value":"sample value"
12         }
13      ],
14      "fuelPumps":[
15         {
16            "available":true,
17            "additionalData":[
18               {
19                  "key":"SAMPLE_KEY_ONE",
20                  "value":"sample value"
21               },
22               {
23                  "key":"SAMPLE_KEY_TWO",
24                  "value":"sample value"
25               }
26            ],
27            "fuelGrades":[
28               {
29                  "available":true,
30                  "description":"PAYLD1",
31                  "id":"FG1",
32                  "price":{
33                     "amount":1.11,
34                     "currencyCode":"USD"
35                  }
36               },
37               {
38                  "available":true,
39                  "description":"PAYLD2",
40                  "id":"FG2",
41                  "price":{
42                     "amount":2.11,
43                     "currencyCode":"USD"
44                  }
45               },
46               {
47                  "available":false,
48                  "description":"PAYLD3",
49                  "id":"FG3",
50                  "price":{
51                     "amount":3.11,
52                     "currencyCode":"USD"
53                  }
54               },
55               {
56                  "available":true,
57                  "description":"PAYLD4",
58                  "id":"FG4",
59                  "price":{
60                     "amount":4.11,
61                     "currencyCode":"USD"
62                  }
63               }
64            ],
65            "fuelType":"PETROL",
66            "pumpNumber":"PN1"
67         },
68         {
69            "available":true,
70            "additionalData":[
71               {
72                  "key":"SAMPLE_KEY_ONE",
73                  "value":"sample value"
74               },
75               {
76                  "key":"SAMPLE_KEY_TWO",
77                  "value":"sample value"
78               }
79            ],
80            "fuelGrades":[
81               {
82                  "available":true,
83                  "description":"PAYLD1",
84                  "id":"FG1",
85                  "price":{
86                     "amount":1.11,
87                     "currencyCode":"USD"
88                  }
89               },
90               {
91                  "available":true,
92                  "description":"PAYLD2",
93                  "id":"FG2",
94                  "price":{
95                     "amount":2.11,
96                     "currencyCode":"USD"
97                  }
98               },
99               {
100                  "available":false,
101                  "description":"PAYLD3",
102                  "id":"FG3",
103                  "price":{
104                     "amount":3.11,
105                     "currencyCode":"USD"
106                  }
107               },
108               {
109                  "available":true,
110                  "description":"PAYLD4",
111                  "id":"FG4",
112                  "price":{
113                     "amount":4.11,
114                     "currencyCode":"USD"
115                  }
116               }
117            ],
118            "fuelType":"PETROL",
119            "pumpNumber":"PN2"
120         },
121         {
122            "available":true,
123            "additionalData":[
124               {
125                  "key":"SAMPLE_KEY_ONE",
126                  "value":"sample value"
127               },
128               {
129                  "key":"SAMPLE_KEY_TWO",
130                  "value":"sample value"
131               }
132            ],
133            "fuelGrades":[
134               {
135                  "available":true,
136                  "description":"PAYLD1",
137                  "id":"FG1",
138                  "price":{
139                     "amount":1.11,
140                     "currencyCode":"USD"
141                  }
142               },
143               {
144                  "available":true,
145                  "description":"PAYLD2",
146                  "id":"FG2",
147                  "price":{
148                     "amount":2.11,
149                     "currencyCode":"USD"
150                  }
151               },
152               {
153                  "available":false,
154                  "description":"PAYLD3",
155                  "id":"FG3",
156                  "price":{
157                     "amount":3.11,
158                     "currencyCode":"USD"
159                  }
160               },
161               {
162                  "available":true,
163                  "description":"PAYLD4",
164                  "id":"FG4",
165                  "price":{
166                     "amount":4.11,
167                     "currencyCode":"USD"
168                  }
169               }
170            ],
171            "fuelType":"DIESEL",
172            "pumpNumber":"PN3"
173         },
174         {
175            "available":false,
176            "additionalData":[
177               {
178                  "key":"SAMPLE_KEY_ONE",
179                  "value":"sample value"
180               },
181               {
182                  "key":"SAMPLE_KEY_TWO",
183                  "value":"sample value"
184               }
185            ],
186            "fuelGrades":[
187               {
188                  "available":true,
189                  "description":"PAYLD1",
190                  "id":"FG1",
191                  "price":{
192                     "amount":1.11,
193                     "currencyCode":"USD"
194                  }
195               },
196               {
197                  "available":true,
198                  "description":"PAYLD2",
199                  "id":"FG2",
200                  "price":{
201                     "amount":2.11,
202                     "currencyCode":"USD"
203                  }
204               },
205               {
206                  "available":false,
207                  "description":"PAYLD3",
208                  "id":"FG3",
209                  "price":{
210                     "amount":3.11,
211                     "currencyCode":"USD"
212                  }
213               },
214               {
215                  "available":true,
216                  "description":"PAYLD4",
217                  "id":"FG4",
218                  "price":{
219                     "amount":4.11,
220                     "currencyCode":"USD"
221                  }
222               }
223            ],
224            "fuelType":"DIESEL",
225            "pumpNumber":"PN4"
226         }
227      ],
228      "latitude":"6.846664",
229      "longitude":"79.863775",
230      "siteResources":[
231         {
232            "available":true,
233            "description":"Carwash Normal",
234            "additionalData":[
235               {
236                  "key":"SAMPLE_KEY_ONE",
237                  "value":"sample value"
238               },
239               {
240                  "key":"SAMPLE_KEY_TWO",
241                  "value":"sample value"
242               }
243            ],
244            "id":"CW1",
245            "name":"Carwash Normal",
246            "itemPrice":{
247               "amount":10.0,
248               "currencyCode":"USD"
249            },
250            "tax":{
251               "amount":0.0,
252               "currencyCode":"USD"
253            }
254         },
255         {
256            "available":true,
257            "description":"Carwash Super",
258            "additionalData":[
259               {
260                  "key":"SAMPLE_KEY_ONE",
261                  "value":"sample value"
262               },
263               {
264                  "key":"SAMPLE_KEY_TWO",
265                  "value":"sample value"
266               }
267            ],
268            "id":"CW2",
269            "name":"Carwash Super",
270            "itemPrice":{
271               "amount":15.0,
272               "currencyCode":"USD"
273            },
274            "tax":{
275               "amount":0.0,
276               "currencyCode":"USD"
277            }
278         },
279         {
280            "available":false,
281            "description":"Carwash Heavy Vehicle",
282            "additionalData":[
283               {
284                  "key":"SAMPLE_KEY_ONE",
285                  "value":"sample value"
286               },
287               {
288                  "key":"SAMPLE_KEY_TWO",
289                  "value":"sample value"
290               }
291            ],
292            "id":"CW3",
293            "name":"Carwash Heavy Vehicle",
294            "itemPrice":{
295               "amount":20.0,
296               "currencyCode":"USD"
297            },
298            "tax":{
299               "amount":0.0,
300               "currencyCode":"USD"
301            }
302         },
303         {
304            "available":true,
305            "description":"Carwash Deluxe",
306            "additionalData":[
307               {
308                  "key":"SAMPLE_KEY_ONE",
309                  "value":"sample value"
310               },
311               {
312                  "key":"SAMPLE_KEY_TWO",
313                  "value":"sample value"
314               }
315            ],
316            "id":"CW4",
317            "name":"Carwash Deluxe",
318            "itemPrice":{
319               "amount":20.0,
320               "currencyCode":"USD"
321            },
322            "tax":{
323               "amount":0.0,
324               "currencyCode":"USD"
325            }
326         }
327      ],
328      "status":{
329         "statusCode":"200",
330         "statusDetails":"SUCCESS"
331      }
332   }
333}

updateFuelEvent Full Example

See Methods for a description of the method requirements.

Request

1{
2   "updateFuelEventRequest":{
3      "messageHeader":{
4         "partnerId":null,
5         "messageId":"MessageId#123",
6         "versionId":null,
7         "environmentId":null
8      },
9      "paydiantTransactionRefId":"PaydiantTransactionRefId#12345",
10      "transactionFlowRule":"SUBMIT_FUEL_BEGIN",
11      "paymentCharge":{
12         "paymentInstrument":{
13            "paymentTender":{
14               "accountTypeName":"CREDIT",
15               "accountTypeUri":"ippi#154541-147515",
16               "networkTypeName":"VISA",
17               "networkTypeUri":"NTU#546525151"
18            },
19            "additionalData":[
20               {
21                  "key":"maskedCard",
22                  "value":"xxxxxxxx9648"
23               },
24               {
25                  "key":"nickname",
26                  "value":"testCard"
27               }
28            ],
29            "paymentInstrumentUri":"PIURI#132421",
30            "paymentInstrumentId":"PIID#5648",
31            "maskedCardNumber":"xxxxxxxxx5487"
32         },
33         "amount":{
34            "amount":10.0,
35            "currencyCode":"USD"
36         },
37         "merchantTenderData":{
38            "tenderLocalDate":"LocalDate",
39            "tenderLocalTime":"LocalTime",
40            "merchantTenderId":"MerchantTenderId#123"
41         }
42      },
43      "fuelReceipt":{
44         "totalAmount":{
45            "amount":10.0,
46            "currencyCode":"USD"
47         },
48         "totalDiscount":{
49            "amount":10.0,
50            "currencyCode":"USD"
51         },
52         "unitsDispensed":20.0,
53         "fuelAmount":{
54            "amount":10.0,
55            "currencyCode":"USD"
56         },
57         "pricePerUnit":{
58            "amount":10.0,
59            "currencyCode":"USD"
60         },
61         "unitType":"GALLON",
62         "fuelGrade":{
63            "available":true,
64            "description":"FuelGradeDesc",
65            "id":"FuelGradeId",
66            "price":{
67               "amount":10.0,
68               "currencyCode":"USD"
69            }
70         },
71         "additionalData":[
72            {
73               "key":"maskedCard",
74               "value":"xxxxxxxx9648"
75            },
76            {
77               "key":"nickname",
78               "value":"testCard"
79            }
80         ],
81         "totalTax":{
82            "amount":10.0,
83            "currencyCode":"USD"
84         },
85         "fuelDiscount":{
86            "fuelDiscountTotal":{
87               "amount":10.0,
88               "currencyCode":"USD"
89            },
90            "discount":{
91               "amount":10.0,
92               "currencyCode":"USD"
93            },
94            "units":"GALLON"
95         },
96         "carWashInfo":{
97            "carWashCodeExpirationDate":"CWED#12/89/2001",
98            "siteResource":{
99               "available":true,
100               "description":"SiteResourceDesc",
101               "additionalData":[
102                  {
103                     "key":"maskedCard",
104                     "value":"xxxxxxxx9648"
105                  },
106                  {
107                     "key":"nickname",
108                     "value":"testCard"
109                  }
110               ],
111               "id":"SiteResourceId",
112               "name":"SiteResourceName",
113               "itemPrice":{
114                  "amount":10.0,
115                  "currencyCode":"USD"
116               },
117               "tax":{
118                  "amount":10.0,
119                  "currencyCode":"USD"
120               }
121            },
122            "carWashCode":"CarWashCode#123",
123            "siteResourceDiscount":{
124               "amount":10.0,
125               "currencyCode":"USD"
126            }
127         },
128         "receiptText":"ReceiptText",
129         "fuelTax":{
130            "amount":10.0,
131            "currencyCode":"USD"
132         }
133      },
134      "secondaryIdentifier":"SECID#5151815",
135      "reconciliationInfo":{
136         "terminalID":"TID#156151",
137         "retailerID":"RTID#15151",
138         "additionalData":[
139            {
140               "key":"maskedCard",
141               "value":"xxxxxxxx9648"
142            },
143            {
144               "key":"nickname",
145               "value":"testCard"
146            }
147         ],
148         "invoiceID":"IVID#15151"
149      },
150      "storeLocationID":"10001088",
151      "pumpNumber":"1"
152   }
153}

Response

1{
2   "updateFuelEventResponse":{
3      "messageHeader":{
4         "partnerId":null,
5         "messageId":"MessageId#123",
6         "versionId":null,
7         "environmentId":null
8      },
9      "status":{
10         "statusCode":"SUCCESS",
11         "statusDescription":"STATUSDESC",
12         "errors":[
13
14         ]
15      },
16      "configurationDetails":[
17
18      ],
19      "paymentResult":{
20         "paymentInstrument":{
21            "paymentTender":{
22               "accountTypeName":"CREDIT",
23               "accountTypeUri":"ippi#154541-147515",
24               "networkTypeName":"VISA",
25               "networkTypeUri":"NTU#546525151"
26            },
27            "additionalData":[
28               {
29                  "key":"maskedCard",
30                  "value":"xxxxxxxx9648"
31               },
32               {
33                  "key":"nickname",
34                  "value":"testCard"
35               }
36            ],
37            "paymentInstrumentUri":"PIURI#132421",
38            "paymentInstrumentId":"PIID#5648",
39            "maskedCardNumber":"xxxxxxxxx5487"
40         },
41         "amount":{
42            "amount":10.0,
43            "currencyCode":"USD"
44         },
45         "merchantTenderData":{
46            "tenderLocalDate":"LocalDate",
47            "tenderLocalTime":"LocalTime",
48            "merchantTenderId":"MerchantTenderId#123"
49         },
50         "paydiantTenderID":"PAYTENDERID#564515",
51         "paymentStatus":"PAYSTATUS",
52         "paymentStatusCode":200,
53         "externalPaymentStatusCode":"EXTPAYSTATUS#115151",
54         "externalPaymentStatusDescription":"EXTDESC",
55         "externalPaymentAuthCode":"EXTPAYAUTH#4894919"
56      },
57      "paydiantTransactionRefId":"PTREF#5485155"
58   }
59}

pumpAuthorization Full Example

See Methods for a description of the method requirements.

Request

1{
2   "pumpAuthorizationRequest":{
3      "storeLocationID":"SHELL12345678",
4      "fuelTicket":{
5         "selectedPumpNumber":"1",
6         "fixedAmount":{
7            "amount":0.0,
8            "currencyCode":"USD"
9         },
10         "fuelDiscount":{
11            "fuelDiscountTotal":{
12               "amount":2.0,
13               "currencyCode":"USD"
14            },
15            "discount":{
16               "amount":0.10,
17               "currencyCode":"USD"
18            },
19            "units":"GALLON"
20         },
21         "selectedSiteResources":[
22            {
23               "available":true,
24               "description":"Carwash Normal",
25               "additionalData":[
26                  {
27                     "key":"SAMPLE_KEY_ONE",
28                     "value":"sample value"
29                  },
30                  {
31                     "key":"SAMPLE_KEY_TWO",
32                     "value":"sample value"
33                  }
34               ],
35               "id":"CW1",
36               "name":"Carwash Normal",
37               "itemPrice":{
38                  "amount":10.0,
39                  "currencyCode":"USD"
40               },
41               "tax":{
42                  "amount":0.0,
43                  "currencyCode":"USD"
44               }
45            },
46            {
47               "available":true,
48               "description":"Carwash Super",
49               "additionalData":[
50                  {
51                     "key":"SAMPLE_KEY_ONE",
52                     "value":"sample value"
53                  },
54                  {
55                     "key":"SAMPLE_KEY_TWO",
56                     "value":"sample value"
57                  }
58               ],
59               "id":"CW2",
60               "name":"Carwash Super",
61               "itemPrice":{
62                  "amount":15.0,
63                  "currencyCode":"USD"
64               },
65               "tax":{
66                  "amount":0.0,
67                  "currencyCode":"USD"
68               }
69            },
70            {
71               "available":false,
72               "description":"Carwash Heavy Vehicle",
73               "additionalData":[
74                  {
75                     "key":"SAMPLE_KEY_ONE",
76                     "value":"sample value"
77                  },
78                  {
79                     "key":"SAMPLE_KEY_TWO",
80                     "value":"sample value"
81                  }
82               ],
83               "id":"CW3",
84               "name":"Carwash Heavy Vehicle",
85               "itemPrice":{
86                  "amount":20.0,
87                  "currencyCode":"USD"
88               },
89               "tax":{
90                  "amount":0.0,
91                  "currencyCode":"USD"
92               }
93            },
94            {
95               "available":true,
96               "description":"Carwash Deluxe",
97               "additionalData":[
98                  {
99                     "key":"SAMPLE_KEY_ONE",
100                     "value":"sample value"
101                  },
102                  {
103                     "key":"SAMPLE_KEY_TWO",
104                     "value":"sample value"
105                  }
106               ],
107               "id":"CW4",
108               "name":"Carwash Deluxe",
109               "itemPrice":{
110                  "amount":20.0,
111                  "currencyCode":"USD"
112               },
113               "tax":{
114                  "amount":0.0,
115                  "currencyCode":"USD"
116               }
117            }
118         ],
119         "printReceipts":true,
120         "additionalData":[
121            {
122               "key":"SAMPLE_KEY_ONE",
123               "value":"sample value"
124            },
125            {
126               "key":"SAMPLE_KEY_TWO",
127               "value":"sample value"
128            }
129         ]
130      },
131      "thirdPartyLoyaltyInstrument":{
132         "paymentTender":{
133            "accountTypeName":"Loyalty",
134            "accountTypeUri":"paydiant:payment-account-management.accounttype#Loyalty",
135            "networkTypeName":"FuelRewards",
136            "networkTypeUri":"paydiant:payment-account-management.networktype#retailerName"
137         },
138         "additionData":[
139
140         ],
141         "loyaltyInstrumentUri":"fuel:accountmenagement:cardaccount#17e2e62e-5835-41c4-9667-d88068d0a360",
142         "loyaltyInstrumentId":"cardaccount#17e2e62e-5835",
143         "loyaltyId":"4552999912122223"
144      },
145      "paydiantTransactionRefId":"e2526064-2e0e-458f-a7c1-66347f47ddb1",
146      "customerSelectedPaymentInstrument":{
147         "paymentTender":{
148            "accountTypeName":"CREDIT",
149            "accountTypeUri":"paydiant:payment-account-management.accounttype#Credit",
150            "networkTypeName":"VISA",
151            "networkTypeUri":"paydiant:payment-account-management.networktype#Visa"
152         },
153         "additionalData":[
154
155         ],
156         "paymentInstrumentUri":"fuel:accountmenagement:cardaccount#17e2e62e-5835-41c4-9667-d88068d0a360",
157         "paymentInstrumentId":"cardaccount#17e2e62e-5835",
158         "altFuelId":"455299",
159         "maskedCardNumber":"xxxxxxxxxxxx1234"
160      },
161      "walletIssuerId":"RetailerWallet"
162   }
163}

Response

1{
2   "pumpAuthorizationResponse":{
3      "status":{
4         "statusCode":"200",
5         "statusDetails":"SUCCESS"
6      },
7      "paydiantTransactionRefId":"c98eca3b-e37c-4855-bf03-3db69b8ec035"
8   }
9}

settlement Full Example

See Methods for a description of the method requirements.

Request

1{
2   "settlementRequest":{
3      "messageHeader":{
4         "environmentId":"",
5         "messageId":"",
6         "partnerId":"",
7         "versionId":""
8      },
9      "tenant":{
10         "partnerUri":"",
11         "tenantUri":""
12      },
13      "transactionInfo":{
14         "partnerUri":"SkyBridge populates based on the request from fuel site",
15         "acceptancePartnerUri":"SkyBridge populates based on fuel site request",
16         "acceptanceLocationUri":"SkyBridge populates based on fuel site request",
17         "additionalInformation":[
18            "Merchant_ID, Site_ID might be in this array"
19         ]
20      },
21      "settlementInfo":{
22         "settlementPeriodTimestamp":"",
23         "settlementPeriodId":"",
24         "terminalTotal":"",
25         "totalsInfo":[
26            {
27               "totalAmount":"total amount"
28            }
29         ],
30         "primaryCardType":"First level categorization of payment type",
31         "secondaryCardType":"Sub-level categorization of payment type",
32         "transactionCount":"Number of transactions represented in group",
33         "amount":"Dollar amount of all transactions in group",
34         "currency":"3-digit ISO currency code",
35         "additionalInformation":[
36            {
37               "key":"SAMPLE_KEY_ONE",
38               "value":"sample value"
39            }
40         ]
41      }
42   }
43}

Response

1{
2   "settlementRequest":{
3      "messageHeader":{
4         "environmentId":"",
5         "messageId":"",
6         "partnerId":"",
7         "versionId":""
8      },
9      "tenant":{
10         "partnerUri":"",
11         "tenantUri":""
12      },
13      "transactionInfo":{
14         "partnerUri":"",
15         "acceptancePartnerUri":"",
16         "acceptanceLocationUri":"",
17         "additionalInformation":[
18
19         ]
20      },
21      "settlementInfo":{
22         "settlementPeriodTimestamp":"",
23         "settlementPeriodId":"",
24         "terminalTotal":"",
25         "totalsInfo":[
26            "totalAmount":{
27               "primaryCardType":"",
28               "secondaryCardType":"",
29               "transactionCount":"",
30               "amount":"",
31               "currency":"",
32               "additionalInformation":[
33                  {
34                     "key":"",
35                     "value":""
36                  }
37               ]
38            }
39         }
40      }

Fuel API - JSON Schema

retrieveSiteInformation Full Example

Request

Response

updateFuelEvent Full Example

Request

Response

pumpAuthorization Full Example

Request

Response

settlement Full Example

Request

Response

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more