On this page
No Headings
Fuel API Guide - Integrate
Last updated: June 3, 2026
DOCS
Paydiant is now PayPal's White Label Wallet (WLW).
Use Cases
This section includes transaction flow diagrams for the following Fuel use cases.
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.
Standard Use Cases
Standard Fuel Transaction
Fuel Transaction with Access Code
updateFuelEvent Use Cases
These samples show several cases in which the updateFuelEvent method can be implemented, as well as sample code.
Fuel Only Transaction for a Total Amount of $42.00
This use case shows:
- A Fuel-Only sale for a total amount of $42.00.
- 20 Gallons pumped at $2.10 per gallon.
{
"updateFuelEventRequest": {
"paydiantTransactionRefId": "c98eca3b-e37c-4855-bf03-3db69b8ec035",
"transactionFlowRule": "SUBMIT_FUEL_END",
"paymentCharge": {
"merchantTenderData": {
"tenderLocalDate": "20150219",
"tenderLocalTime": "084027",
"merchantTenderId": "7wndyGSotSEO"
}
},
"fuelReceipt": {
"totalAmount": {
"amount": 42,
"currencyCode": "USD"
},
"unitsDispensed": 20,
"fuelAmount": {
"amount": 42,
"currencyCode": "USD"
},
"fuelTax": {
"amount": 1,
"currencyCode": "USD"
},
"pricePerUnit": {
"amount": 2.1,
"currencyCode": "USD"
},
"unitType": "GALLON",
"fuelGrade": {
"description": "Premium",
"id": "3",
},
"totalTax": {
"amount": 1,
"currencyCode": "USD"
}
},
"reconciliationInfo": {
"terminalID": "12345678",
"retailerID": "12345678901",
"invoiceID": "10001234"
},
"storeLocationID": "10001088",
"pumpNumber" : "1"
}
}{
"updateFuelEventResponse": {
"messageHeader": null,
"status": {
"statusCode": "SUCCESS",
"statusDescription": "Success",
"errors": []
},
"configurationDetails": [],
"paymentResult": {
"paymentInstrument": {
"paymentTender": {
"accountTypeName": "CREDIT",
"accountTypeUri": "ippi#154541-147515",
"networkTypeName": "VISA",
"networkTypeUri": "NTU#546525151"
},
"additionalData": [
{
"key": "NickName",
"value": "TestCredit"
},
{
"key": null,
"value": null
}
],
"paymentInstrumentUri": "PIURI#132421",
"paymentInstrumentId": "PIID#5648",
"maskedCardNumber": "xxxxxxxxx5487"
},
"amount": {
"amount": 44.95,
"currencyCode": "USD"
},
"merchantTenderData": {
"tenderLocalDate": "LocalDate",
"tenderLocalTime": "LocalTime",
"merchantTenderId": "MerchantTenderId#123"
},
"paydiantTenderID": "PAYDIANTTENDERID#8089890",
"paymentStatus": "APPROVED",
"paymentStatusCode": 200,
"externalPaymentStatusCode": "EXTPAYSTATUS#565657",
"externalPaymentStatusDescription": "EXTPAYSTATUSDESC#998907",
"externalPaymentAuthCode": "EXTPAYAUTH#121232"
},
"paydiantTransactionRefId": " c98eca3b-e37c-4855-bf03-3db69b8ec035"
}
}Fuel with Car Wash Purchase
This use case shows:
- $4.95 car wash
- $42.00 in fuel with 20 gallons pumped at $2.10 per gallon.
- Car Wash Code expires in 5 days.
{
"updateFuelEventRequest": {
"paydiantTransactionRefId": " c98eca3b-e37c-4855-bf03-3db69b8ec035",
"transactionFlowRule": "SUBMIT_FUEL_END",
"paymentCharge": {
"merchantTenderData": {
"tenderLocalDate": "20150219",
"tenderLocalTime": "084027",
"merchantTenderId": "7wndyGSotSEO"
}
},
"fuelReceipt": {
"totalAmount": {
"amount": 46.95,
"currencyCode": "USD"
},
"unitsDispensed": 20,
"fuelAmount": {
"amount": 42,
"currencyCode": "USD"
},
"fuelTax": {
"amount": 1,
"currencyCode": "USD"
},
"pricePerUnit": {
"amount": 2.1,
"currencyCode": "USD"
},
"unitType": "GALLON",
"fuelGrade": {
"available": true,
"description": "Premium",
"id": "3",
"price": {
"amount": 2.1,
"currencyCode": "USD"
}
},
"totalTax": {
"amount": 1.5,
"currencyCode": "USD"
},
"carWashInfo": {
"siteResource": {
"available": true,
"description": "Premium car wash with Rainbow Soap",
"id": "4",
"name": "Premium",
"itemPrice": {
"amount": 4.95,
"currencyCode": "USD"
},
"tax": {
"amount": 0.5,
"currencyCode": "USD"
}
},
"carWashCode": "123456",
"carWashCodeExpirationDate": "20150224"
}
},
"reconciliationInfo": {
"terminalID": "12345678",
"retailerID": "12345678901",
"invoiceID": "10001234"
},
"storeLocationID": "10001088",
"pumpNumber" : "1"
}
}{
"updateFuelEventResponse": {
"messageHeader": null,
"status": {
"statusCode": "SUCCESS",
"statusDescription": "Success",
"errors": []
},
"configurationDetails": [],
"paymentResult": {
"paymentInstrument": {
"paymentTender": {
"accountTypeName": "CREDIT",
"accountTypeUri": "ippi#154541-147515",
"networkTypeName": "VISA",
"networkTypeUri": "NTU#546525151"
},
"additionalData": [
{
"key": "NickName",
"value": "TestCredit"
},
{
"key": null,
"value": null
}
],
"paymentInstrumentUri": "PIURI#132421",
"paymentInstrumentId": "PIID#5648",
"maskedCardNumber": "xxxxxxxxx5487"
},
"amount": {
"amount": 44.95,
"currencyCode": "USD"
},
"merchantTenderData": {
"tenderLocalDate": "LocalDate",
"tenderLocalTime": "LocalTime",
"merchantTenderId": "MerchantTenderId#123"
},
"paydiantTenderID": "PAYDIANTTENDERID#8089890",
"paymentStatus": "APPROVED",
"paymentStatusCode": 200,
"externalPaymentStatusCode": "EXTPAYSTATUS#565657",
"externalPaymentStatusDescription": "EXTPAYSTATUSDESC#998907",
"externalPaymentAuthCode": "EXTPAYAUTH#121232"
},
"paydiantTransactionRefId": " c98eca3b-e37c-4855-bf03-3db69b8ec035"
}
}Discounted Fuel Purchase with Car Wash
This sample shows:
- A purchase total amount of $44.95.
- $40.00 in fuel with 20 Gallons pumped at $2.00 per gallon (10 cents per gallon roll back).
- Car wash code expires in 5 days.
{
"updateFuelEventRequest": {
"paydiantTransactionRefId": " c98eca3b-e37c-4855-bf03-3db69b8ec035",
"transactionFlowRule": "SUBMIT_FUEL_END",
"paymentCharge": {
"merchantTenderData": {
"tenderLocalDate": "20150219",
"tenderLocalTime": "084027",
"merchantTenderId": "7wndyGSotSEO"
}
},
"fuelReceipt": {
"totalAmount": {
"amount": 44.95,
"currencyCode": "USD"
},
"unitsDispensed": 20,
"fuelAmount": {
"amount": 40,
"currencyCode": "USD"
},
"fuelTax": {
"amount": 1,
"currencyCode": "USD"
},
"pricePerUnit": {
"amount": 2,
"currencyCode": "USD"
},
"unitType": "GALLON",
"fuelGrade": {
"available": true,
"description": "Premium",
"id": "3",
"price": {
"amount": 2.1,
"currencyCode": "USD"
}
},
"totalTax": {
"amount": 1.5,
"currencyCode": "USD"
},
"totalDiscount": {
"amount": 2,
"currencyCode": "USD"
},
"fuelDiscount" : {
"fuelDiscountTotal" : {
"amount" : 2.0,
"currencyCode" : "USD"
},
"discount" : {
"amount" : 0.10,
"currencyCode" : "USD"
},
"units" : "GALLON"
},
"carWashInfo": {
"siteResource": {
"available": true,
"description": "Premium car wash with Rainbow Soap",
"id": "4",
"name": "Premium",
"itemPrice": {
"amount": 4.95,
"currencyCode": "USD"
},
"tax": {
"amount": 0.5,
"currencyCode": "USD"
}
},
"carWashCode": "123456",
"carWashCodeExpirationDate": "20150224"
}
},
"reconciliationInfo": {
"terminalID": "12345678",
"retailerID": "12345678901",
"invoiceID": "10001234"
},
"storeLocationID": "10001088",
"pumpNumber" : "1"
}
}{
"updateFuelEventResponse": {
"messageHeader": null,
"status": {
"statusCode": "SUCCESS",
"statusDescription": "Success",
"errors": []
},
"configurationDetails": [],
"paymentResult": {
"paymentInstrument": {
"paymentTender": {
"accountTypeName": "CREDIT",
"accountTypeUri": "ippi#154541-147515",
"networkTypeName": "VISA",
"networkTypeUri": "NTU#546525151"
},
"additionalData": [
{
"key": "NickName",
"value": "TestCredit"
},
{
"key": null,
"value": null
}
],
"paymentInstrumentUri": "PIURI#132421",
"paymentInstrumentId": "PIID#5648",
"maskedCardNumber": "xxxxxxxxx5487"
},
"amount": {
"amount": 44.95,
"currencyCode": "USD"
},
"merchantTenderData": {
"tenderLocalDate": "LocalDate",
"tenderLocalTime": "LocalTime",
"merchantTenderId": "MerchantTenderId#123"
},
"paydiantTenderID": "PAYDIANTTENDERID#8089890",
"paymentStatus": "APPROVED",
"paymentStatusCode": 200,
"externalPaymentStatusCode": "EXTPAYSTATUS#565657",
"externalPaymentStatusDescription": "EXTPAYSTATUSDESC#998907",
"externalPaymentAuthCode": "EXTPAYAUTH#121232"
},
"paydiantTransactionRefId": " c98eca3b-e37c-4855-bf03-3db69b8ec035"
}
}Discounted Fuel Purchase with Discount Car Wash
This use case shows:
- Purchase total amount of $43.95.
- $3.95 car wash that was Discounted by $1.00.
- $40.00 in fuel with 20 Gallons pumped at $2.00 per gallon (10 cent per gallon roll back).
- Car Wash code expires in 5 days.
{
"updateFuelEventRequest": {
"paydiantTransactionRefId": "c98eca3b-e37c-4855-bf03-3db69b8ec035",
"transactionFlowRule": "SUBMIT_FUEL_END",
"paymentCharge": {
"merchantTenderData": {
"tenderLocalDate": "20150219",
"tenderLocalTime": "084027",
"merchantTenderId": "7wndyGSotSEO"
}
},
"fuelReceipt": {
"totalAmount": {
"amount": 43.95,
"currencyCode": "USD"
},
"unitsDispensed": 20,
"fuelAmount": {
"amount": 40,
"currencyCode": "USD"
},
"fuelTax": {
"amount": 1,
"currencyCode": "USD"
},
"pricePerUnit": {
"amount": 2,
"currencyCode": "USD"
},
"unitType": "GALLON",
"fuelGrade": {
"available": true,
"description": "Premium",
"id": "3",
"price": {
"amount": 2.1,
"currencyCode": "USD"
}
},
"totalTax": {
"amount": 1.5,
"currencyCode": "USD"
},
"totalDiscount": {
"amount": 3,
"currencyCode": "USD"
},
"fuelDiscount": {
"fuelDiscountTotal": {
"amount": 2,
"currencyCode": "USD"
},
"discount": {
"amount": 0.1,
"currencyCode": "USD"
},
"units": "GALLON"
},
"carWashInfo": {
"siteResource": {
"available": true,
"description": "Premium car wash with Rainbow Soap",
"id": "4",
"name": "Premium",
"itemPrice": {
"amount": 3.95,
"currencyCode": "USD"
},
"tax": {
"amount": 0.5,
"currencyCode": "USD"
}
},
"carWashCode": "123456",
"carWashCodeExpirationDate": "20150224",
"siteResourceDiscount": {
"amount": 1,
"currencyCode": "USD"
}
}
},
"reconciliationInfo": {
"terminalID": "12345678",
"retailerID": "12345678901",
"invoiceID": "10001234"
},
"storeLocationID": "10001088",
"pumpNumber" : "1"
}
}{
"updateFuelEventResponse": {
"messageHeader": null,
"status": {
"statusCode": "SUCCESS",
"statusDescription": "Success",
"errors": []
},
"configurationDetails": [],
"paymentResult": {
"paymentInstrument": {
"paymentTender": {
"accountTypeName": "CREDIT",
"accountTypeUri": "ippi#154541-147515",
"networkTypeName": "VISA",
"networkTypeUri": "NTU#546525151"
},
"additionalData": [
{
"key": "NickName",
"value": "TestCredit"
},
{
"key": null,
"value": null
}
],
"paymentInstrumentUri": "PIURI#132421",
"paymentInstrumentId": "PIID#5648",
"maskedCardNumber": "xxxxxxxxx5487"
},
"amount": {
"amount": 44.95,
"currencyCode": "USD"
},
"merchantTenderData": {
"tenderLocalDate": "LocalDate",
"tenderLocalTime": "LocalTime",
"merchantTenderId": "MerchantTenderId#123"
},
"paydiantTenderID": "PAYDIANTTENDERID#8089890",
"paymentStatus": "APPROVED",
"paymentStatusCode": 200,
"externalPaymentStatusCode": "EXTPAYSTATUS#565657",
"externalPaymentStatusDescription": "EXTPAYSTATUSDESC#998907",
"externalPaymentAuthCode": "EXTPAYAUTH#121232"
},
"paydiantTransactionRefId": " c98eca3b-e37c-4855-bf03-3db69b8ec035"
}
}Submit Secondary ID with Matching Values
This use case shows:
- Submitting the secondary ID
- The value entered on the pump matches the value on the phone
{
"updateFuelEventRequest": {
"paydiantTransactionRefId": "c98eca3b-e37c-4855-bf03-3db69b8ec035",
"transactionFlowRule": "SUBMIT_SECONDARY_ID_FOR_VALIDATION",
"secondaryIdentifier": "7890",
"storeLocationID": "10001088",
"pumpNumber" : "1"
}
}{
"updateFuelEventResponse": {
"messageHeader": null,
"status": {
"statusCode": "SUCCESS",
"statusDescription": "Success",
"errors": []
},
"configurationDetails": [],
"paymentResult": null,
"paydiantTransactionRefId": "c98eca3b-e37c-4855-bf03-3db69b8ec035"
}
}Submit Secondary ID with Non-Matching Values
This use case shows:
- Submit Secondary ID
- Values on pump and phone do not match
- The number of configured retries has not been exceeded.
{
"updateFuelEventRequest": {
"paydiantTransactionRefId": "c98eca3b-e37c-4855-bf03-3db69b8ec035",
"transactionFlowRule": "SUBMIT_SECONDARY_ID_FOR_VALIDATION",
"secondaryIdentifier": "7890",
"storeLocationID": "10001088",
"pumpNumber" : "1"
}
}{
"updateFuelEventResponse": {
"messageHeader": null,
"status": {
"statusCode": " INVALID_SECONDARY_ID ",
"statusDescription": " ID entered into pump did not match ID on phone ",
"errors": []
},
"configurationDetails": [],
"paymentResult": null,
"paydiantTransactionRefId": "c98eca3b-e37c-4855-bf03-3db69b8ec035"
}
}Submit Secondary ID Non-Matching Values and Exceeded Retries
This use case shows:
- Submitting the Secondary ID
- Values on the Pump and Phone do not match
- The number of configured retries has been exceeded.
{
"updateFuelEventRequest": {
"paydiantTransactionRefId": "c98eca3b-e37c-4855-bf03-3db69b8ec035",
"transactionFlowRule": "SUBMIT_SECONDARY_ID_FOR_VALIDATION",
"secondaryIdentifier": "7890",
"storeLocationID": "10001088",
"pumpNumber" : "1"
}
}{
"updateFuelEventResponse": {
"messageHeader": null,
"status": {
"statusCode": "CANCELED_TRANSACTION",
"statusDescription": "Transaction has been canceled",
"errors": []
},
"configurationDetails": [],
"paymentResult": null,
"paydiantTransactionRefId": "c98eca3b-e37c-4855-bf03-3db69b8ec035"
}
}Request a Pre-Auth
This use case shows:
- Request for a pre-authorization of $75.00.
{
"updateFuelEventRequest" : {
"paydiantTransactionRefId" : "c98eca3b-e37c-4855-bf03-3db69b8ec035",
"transactionFlowRule" : "SUBMIT_PRE_AUTH",
"paymentCharge" : {
"paymentInstrument" : {
"paymentInstrumentUri" : "fuel:accountmenagement:cardaccount#17e2e62e-5835-41c4-9667-d88068d0a360"
},
"amount" : {
"amount" : 75.0,
"currencyCode" : "USD"
},
"merchantTenderData" : {
"tenderLocalDate" : "20150219",
"tenderLocalTime" : "084027"
}
},
"reconciliationInfo" : {
"terminalID" : "12345678",
"retailerID" : "12345678901",
"invoiceID" : "10001234"
},
"storeLocationID": "10001088",
"pumpNumber" : "1"
}
}{
"updateFuelEventResponse" : {
"messageHeader" : null,
"status" : {
"statusCode" : "SUCCESS",
"statusDescription" : "Success",
"errors" : [ ]
},
"configurationDetails" : [ ],
"paymentResult" : {
"paymentInstrument" : {
"paymentTender" : {
"accountTypeName" : "CREDIT",
"accountTypeUri" : "paydiant:payment-account-management.accounttype#Credit",
"networkTypeName" : "VISA",
"networkTypeUri" : "paydiant:payment-account-management.networktype#Visa "
},
"additionalData" : [],
"paymentInstrumentUri" : "fuel:accountmenagement:cardaccount#17e2e62e-5835-41c4-9667-d88068d0a360",
"paymentInstrumentId" : "cardaccount#17e2e62e-5835",
"maskedCardNumber" : "xxxxxxxxx5487"
},
"amount" : {
"amount" : 75.0,
"currencyCode" : "USD"
},
"merchantTenderData" : {
"tenderLocalDate" : "20150219",
"tenderLocalTime" : "084027",
"merchantTenderId" : "7wndyGSotSEO"
},
"paydiantTenderID" : "c7ypRBGRpbae",
"paymentStatus" : "AUTH_APPROVED",
"paymentStatusCode" : 210,
"externalPaymentStatusCode" : "EXTPAYSTATUS#115151",
"externalPaymentStatusDescription" : "EXTDESC",
"externalPaymentAuthCode" : null
},
"paydiantTransactionRefId" : "c98eca3b-e37c-4855-bf03-3db69b8ec035"
}
}Cancel Transaction
This samples shows a site pump-initiated cancel, not a mobile app-initiated cancel.
{
"updateFuelEventRequest": {
"paydiantTransactionRefId": "c98eca3b-e37c-4855-bf03-3db69b8ec035",
"transactionFlowRule": "SUBMIT_FUEL_CANCEL",
"storeLocationID": "10001088",
"pumpNumber" : "1"
}
}{
"updateFuelEventResponse": {
"messageHeader": null,
"status": {
"statusCode": "SUCCESS",
"statusDescription": "Success",
"errors": []
},
"configurationDetails": [],
"paymentResult": null,
"paydiantTransactionRefId": "c98eca3b-e37c-4855-bf03-3db69b8ec035"
}
}pumpAuthorization Use Cases
These samples show several cases in which the pumpAuthorization method can be implemented, as well as sample code.
Simple Pump Authorization with Loyalty
The following JSON sample shows the pump Authorization Request used to process a transaction with the following requirements:
- A third-party loyalty option is available.
- Car wash is not available at this site.
- Offers are not available.
- The customer can select the payment instrument.
{
"pumpAuthorizationRequest": {
"storeLocationID":"12345678",
"fuelTicket":{
"selectedPumpNumber":"1",
"fixedAmount" : [],
"selectedSiteResources":[ ],
"printReceipts":true,
"additionalData":[ ],
"fuelDiscount":{ }
},
"thirdPartyLoyaltyInstrument":{
"paymentTender":{
"accountTypeName":"Loyalty",
"accountTypeUri":"paydiant:payment-account-management.accounttype#Loyalty",
"networkTypeName":"FuelRewards",
"networkTypeUri":"paydiant:payment-account-management.networktype#retailerName"
},
"additionalData":[],
"loyaltyInstrumentUri":"fuel:accountmenagement:cardaccount#17e2e62e-5835-41c4-9667-d88068d0a360",
"loyaltyInstrumentId":"cardaccount#17e2e62e-5835",
"loyaltyId":"4552999912122223"
},
"paydiantTransactionRefId":"c98eca3b-e37c-4855-bf03-3db69b8ec035",
"customerSelectedPaymentInstrument":{
"paymentTender":{
"accountTypeName":"CREDIT",
"accountTypeUri":"paydiant:payment-account-management.accounttype#Credit",
"networkTypeName":"VISA",
"networkTypeUri":"paydiant:payment-account-management.networktype#Visa"
},
"additionalData":[ ],
"paymentInstrumentUri":"fuel:accountmenagement:cardaccount#17e2e62e-5835-41c4-9667-d88068d0a360",
"paymentInstrumentId":"cardaccount#17e2e62e-5835",
"altFuelId":"455299",
"maskedCardNumber" : "xxxxxxxxxxxx1234"
},
"walletIssuerId":"RetailerWallet"
}
}{
"pumpAuthorizationResponse":{
"status":{
"statusCode":"200",
"statusDetails":"SUCCESS"
},
"paydiantTransactionRefId":"c98eca3b-e37c-4855-bf03-3db69b8ec035"
}
}Pump Authorization with Loyalty
This use case shows:
- Pump Authorization call
- Third Party Loyalty associated by the consumer's mobile wallet.
{
"pumpAuthorizationRequest": {
"storeLocationID":"12345678",
"fuelTicket":{
"selectedPumpNumber":"1",
"fixedAmount" : [],
"selectedSiteResources":[ ],
"printReceipts":true,
"additionalData":[ ],
"fuelDiscount":{ }
},
"thirdPartyLoyaltyInstrument":{
"paymentTender":{
"accountTypeName":"Loyalty",
"accountTypeUri":"paydiant:payment-account-management.accounttype#Loyalty",
"networkTypeName":"FuelRewards",
"networkTypeUri":"paydiant:payment-account-management.networktype#retailerName"
},
"additionData":[],
"loyaltyInstrumentUri":"fuel:accountmenagement:cardaccount#17e2e62e-5835-41c4-9667-d88068d0a360",
"loyaltyInstrumentId":"cardaccount#17e2e62e-5835",
"loyaltyId":"4552999912122223"
},
"paydiantTransactionRefId":"c98eca3b-e37c-4855-bf03-3db69b8ec035",
"customerSelectedPaymentInstrument":{
"paymentTender":{
"accountTypeName":"CREDIT",
"accountTypeUri":"paydiant:payment-account-management.accounttype#Credit",
"networkTypeName":"VISA",
"networkTypeUri":"paydiant:payment-account-management.networktype#Visa"
},
"additionalData":[ ],
"paymentInstrumentUri":"fuel:accountmenagement:cardaccount#17e2e62e-5835-41c4-9667-d88068d0a360",
"paymentInstrumentId":"cardaccount#17e2e62e-5835",
"altFuelId":"455299",
"maskedCardNumber" : "xxxxxxxxxxxx1234"
},
"walletIssuerId":"RetailerWallet"
}
}{
"pumpAuthorizationResponse":{
"status":{
"statusCode":"200",
"statusDetails":"SUCCESS"
},
"paydiantTransactionRefId":"c98eca3b-e37c-4855-bf03-3db69b8ec035"
}
}Pump Authorization without Third Party Loyalty
This use case shows:
- Pump Authorization call
- There is no loyalty program associated with this transaction.
{
"pumpAuthorizationRequest": {
"storeLocationID":"12345678",
"fuelTicket":{
"selectedPumpNumber":"1",
"fixedAmount" : [],
"selectedSiteResources":[ ],
"printReceipts":true,
"additionalData":[ ],
"fuelDiscount":{ }
},
"thirdPartyLoyaltyInstrument":[],
"paydiantTransactionRefId":"c98eca3b-e37c-4855-bf03-3db69b8ec035",
"customerSelectedPaymentInstrument":{
"paymentTender":{
"accountTypeName":"CREDIT",
"accountTypeUri":"paydiant:payment-account-management.accounttype#Credit",
"networkTypeName":"VISA",
"networkTypeUri":"paydiant:payment-account-management.networktype#Visa"
},
"additionalData":[ ],
"paymentInstrumentUri":"fuel:accountmenagement:cardaccount#17e2e62e-5835-41c4-9667-d88068d0a360",
"paymentInstrumentId":"cardaccount#17e2e62e-5835",
"altFuelId":"455299",
"maskedCardNumber" : "xxxxxxxxxxxx1234"
},
"walletIssuerId":"RetailerWallet"
}
}{
"pumpAuthorizationResponse":{
"status":{
"statusCode":"200",
"statusDetails":"SUCCESS"
},
"paydiantTransactionRefId":"c98eca3b-e37c-4855-bf03-3db69b8ec035"
}
}retrieveSiteInformation Use Cases
These samples show several cases in which the retrieveSiteInformation method can be implemented, as well as sample code.
Pumps Only
This sample retrieves the site information for a fuel site where:
- The pumps are defined with the minimum required information.
- There is no car wash available.
{
"retrieveSiteInformationResponse":{
"storeLocationID":"STLOCBO202",
"additionalData":[],
"fuelPumps":[
{
"available":true,
"additionalData":[],
"fuelGrades":[],
"fuelType":[],
"pumpNumber":"PN1"
},
{
"available":true,
"additionalData":[],
"fuelGrades":[],
"fuelType":[],
"pumpNumber":"PN2"
},
{
"available":true,
"additionalData":[],
"fuelGrades":[],
"fuelType":"DIESEL",
"pumpNumber":"PN3"
},
{
"available":false,
"additionalData":[],
"fuelGrades":[],
"fuelType":"DIESEL",
"pumpNumber":"PN4"
}
],
"latitude":"6.846664",
"longitude":"79.863775",
"siteResources":[],
"status":{
"statusCode":"200",
"statusDetails":"SUCCESS"
}
}
}Pumps and Car Wash
This sample shows a fuel site where:
- The pumps are defined with only the required information.
- A car wash is available.
{
"retrieveSiteInformationResponse":{
"storeLocationID":"STLOCBO202",
"additionalData":[],
"fuelPumps":[
{
"available":true,
"additionalData":[],
"fuelGrades":[],
"fuelType":[],
"pumpNumber":"PN1"
},
{
"available":true,
"additionalData":[],
"fuelGrades":[],
"fuelType":[],
"pumpNumber":"PN2"
},
{
"available":true,
"additionalData":[],
"fuelGrades":[],
"fuelType":"DIESEL",
"pumpNumber":"PN3"
},
{
"available":false,
"additionalData":[],
"fuelGrades":[],
"fuelType":[],
"pumpNumber":"PN4"
}
],
"latitude":"6.846664",
"longitude":"79.863775",
"siteResources":[]
"siteResources":[
{
"available":true,
"description":"Carwash Normal",
"additionalData":[
{
"key":"SAMPLE_KEY_ONE",
"value":"sample value"
},
{
"key":"SAMPLE_KEY_TWO",
"value":"sample value"
}
],
"id":"CW1",
"name":"Carwash Normal",
"itemPrice":{
"amount":10.0,
"currencyCode":"USD"
},
"tax":{
"amount":0.0,
"currencyCode":"USD"
}
},
{
"available":true,
"description":"Carwash Super",
"additionalData":[
{
"key":"SAMPLE_KEY_ONE",
"value":"sample value"
},
{
"key":"SAMPLE_KEY_TWO",
"value":"sample value"
}
],
"id":"CW2",
"name":"Carwash Super",
"itemPrice":{
"amount":15.0,
"currencyCode":"USD"
},
"tax":{
"amount":0.0,
"currencyCode":"USD"
}
},
{
"available":false,
"description":"Carwash Heavy Vehicle",
"additionalData":[
{
"key":"SAMPLE_KEY_ONE",
"value":"sample value"
},
{
"key":"SAMPLE_KEY_TWO",
"value":"sample value"
}
],
"id":"CW3",
"name":"Carwash Heavy Vehicle",
"itemPrice":{
"amount":20.0,
"currencyCode":"USD"
},
"tax":{
"amount":0.0,
"currencyCode":"USD"
}
},
{
"available":true,
"description":"Carwash Deluxe",
"additionalData":[
{
"key":"SAMPLE_KEY_ONE",
"value":"sample value"
},
{
"key":"SAMPLE_KEY_TWO",
"value":"sample value"
}
],
"id":"CW4",
"name":"Carwash Deluxe",
"itemPrice":{
"amount":20.0,
"currencyCode":"USD"
},
"tax":{
"amount":0.0,
"currencyCode":"USD"
}
}
],
"status":{
"statusCode":"200",
"statusDetails":"SUCCESS"
}
}
}Pumps, Car Wash, and Fuel Info
The following sample retrieves the site information for a fuel site where:
- The full details are defined for the pumps
- A car wash is available.
{
"retrieveSiteInformationResponse":{
"storeLocationID":"STLOCBO202",
"additionalData":[
{
"key":"SAMPLE_KEY_ONE",
"value":"sample value"
},
{
"key":"SAMPLE_KEY_TWO",
"value":"sample value"
}
],
"fuelPumps":[
{
"available":true,
"additionalData":[
{
"key":"SAMPLE_KEY_ONE",
"value":"sample value"
},
{
"key":"SAMPLE_KEY_TWO",
"value":"sample value"
}
],
"fuelGrades":[
{
"available":true,
"description":"PAYLD1",
"id":"FG1",
"price":{
"amount":1.11,
"currencyCode":"USD"
}
},
{
"available":true,
"description":"PAYLD2",
"id":"FG2",
"price":{
"amount":2.11,
"currencyCode":"USD"
}
},
{
"available":false,
"description":"PAYLD3",
"id":"FG3",
"price":{
"amount":3.11,
"currencyCode":"USD"
}
},
{
"available":true,
"description":"PAYLD4",
"id":"FG4",
"price":{
"amount":4.11,
"currencyCode":"USD"
}
}
],
"fuelType":"PETROL",
"pumpNumber":"PN1"
},
{
"available":true,
"additionalData":[
{
"key":"SAMPLE_KEY_ONE",
"value":"sample value"
},
{
"key":"SAMPLE_KEY_TWO",
"value":"sample value"
}
],
"fuelGrades":[
{
"available":true,
"description":"PAYLD1",
"id":"FG1",
"price":{
"amount":1.11,
"currencyCode":"USD"
}
},
{
"available":true,
"description":"PAYLD2",
"id":"FG2",
"price":{
"amount":2.11,
"currencyCode":"USD"
}
},
{
"available":false,
"description":"PAYLD3",
"id":"FG3",
"price":{
"amount":3.11,
"currencyCode":"USD"
}
},
{
"available":true,
"description":"PAYLD4",
"id":"FG4",
"price":{
"amount":4.11,
"currencyCode":"USD"
}
}
],
"fuelType":"PETROL",
"pumpNumber":"PN2"
},
{
"available":true,
"additionalData":[
{
"key":"SAMPLE_KEY_ONE",
"value":"sample value"
},
{
"key":"SAMPLE_KEY_TWO",
"value":"sample value"
}
],
"fuelGrades":[
{
"available":true,
"description":"PAYLD1",
"id":"FG1",
"price":{
"amount":1.11,
"currencyCode":"USD"
}
},
{
"available":true,
"description":"PAYLD2",
"id":"FG2",
"price":{
"amount":2.11,
"currencyCode":"USD"
}
},
{
"available":false,
"description":"PAYLD3",
"id":"FG3",
"price":{
"amount":3.11,
"currencyCode":"USD"
}
},
{
"available":true,
"description":"PAYLD4",
"id":"FG4",
"price":{
"amount":4.11,
"currencyCode":"USD"
}
}
],
"fuelType":"DIESEL",
"pumpNumber":"PN3"
},
{
"available":false,
"additionalData":[
{
"key":"SAMPLE_KEY_ONE",
"value":"sample value"
},
{
"key":"SAMPLE_KEY_TWO",
"value":"sample value"
}
],
"fuelGrades":[
{
"available":true,
"description":"PAYLD1",
"id":"FG1",
"price":{
"amount":1.11,
"currencyCode":"USD"
}
},
{
"available":true,
"description":"PAYLD2",
"id":"FG2",
"price":{
"amount":2.11,
"currencyCode":"USD"
}
},
{
"available":false,
"description":"PAYLD3",
"id":"FG3",
"price":{
"amount":3.11,
"currencyCode":"USD"
}
},
{
"available":true,
"description":"PAYLD4",
"id":"FG4",
"price":{
"amount":4.11,
"currencyCode":"USD"
}
}
],
"fuelType":"DIESEL",
"pumpNumber":"PN4"
}
],
"latitude":"6.846664",
"longitude":"79.863775",
"siteResources":[
{
"available":true,
"description":"Carwash Normal",
"additionalData":[
{
"key":"SAMPLE_KEY_ONE",
"value":"sample value"
},
{
"key":"SAMPLE_KEY_TWO",
"value":"sample value"
}
],
"id":"CW1",
"name":"Carwash Normal",
"itemPrice":{
"amount":10.0,
"currencyCode":"USD"
},
"tax":{
"amount":0.0,
"currencyCode":"USD"
}
},
{
"available":true,
"description":"Carwash Super",
"additionalData":[
{
"key":"SAMPLE_KEY_ONE",
"value":"sample value"
},
{
"key":"SAMPLE_KEY_TWO",
"value":"sample value"
}
],
"id":"CW2",
"name":"Carwash Super",
"itemPrice":{
"amount":15.0,
"currencyCode":"USD"
},
"tax":{
"amount":0.0,
"currencyCode":"USD"
}
},
{
"available":false,
"description":"Carwash Heavy Vehicle",
"additionalData":[
{
"key":"SAMPLE_KEY_ONE",
"value":"sample value"
},
{
"key":"SAMPLE_KEY_TWO",
"value":"sample value"
}
],
"id":"CW3",
"name":"Carwash Heavy Vehicle",
"itemPrice":{
"amount":20.0,
"currencyCode":"USD"
},
"tax":{
"amount":0.0,
"currencyCode":"USD"
}
},
{
"available":true,
"description":"Carwash Deluxe",
"additionalData":[
{
"key":"SAMPLE_KEY_ONE",
"value":"sample value"
},
{
"key":"SAMPLE_KEY_TWO",
"value":"sample value"
}
],
"id":"CW4",
"name":"Carwash Deluxe",
"itemPrice":{
"amount":20.0,
"currencyCode":"USD"
},
"tax":{
"amount":0.0,
"currencyCode":"USD"
}
}
],
"status":{
"statusCode":"200",
"statusDetails":"SUCCESS"
}
}
}