B2B Mobility Card Recent Transaction 1.0.5

Getting Started with B2B Mobility Card Recent Transactions

B2B Mobility Card Recent Transactions endpoint allows querying last 48 hours of transaction data of Shell Card (i.e. Priced, Billed, Unbilled etc. sales items). It provides a flexible search criteria and supports pagination. E.g., if the request is made at 08:30 AM on 18 Aug 2022 then transactions until 16 Aug 2022 08:30 AM (including) can be retrieved.

Authentication

Shell API’s are secured by OAuth 2.0. It uses the 'Client Credentials' Grant Type to allow the API consumer to access data. The end to end process is illustrated in the sequence diagram below.

sequenceDiagram participant PartnerApplication participant Shell autonumber alt Manual Process rect rgb(200, 150, 255) PartnerApplication ->>Shell: Request Client ID and Client Secret activate Shell Shell ->> PartnerApplication : Generate and provide Client ID and Client Secret deactivate Shell end end alt Authentication/Authorization rect rgb(191, 223, 255) PartnerApplication ->>Shell: Inititate request to OAuth end point with credentials activate Shell Shell ->> PartnerApplication : (200-OK) Returns Bearer Token deactivate Shell end end alt Call Functional Endpoint rect rgb(200, 150, 255) PartnerApplication ->>Shell: Initiate request to functional endpoint along with bearer token received from previous step activate Shell Shell ->> PartnerApplication : Returns a response on validation of the bearer token deactivate Shell end end

This step is to generate the API Access Token using the unique Client ID and Client Secret provided by Shell. (Please note that this credentials is to validate the API request between Shell and its partner so its system to system access token)

Key Request Parameters

Once you receive the client ID & Secret, next step is to call the https://api-test.shell.com/oauth/v1/mobility/token endpoint to authenticate. Following are the key parameters-

Sample cURL Request

curl --location --request POST 'https://api-test.shell.com/oauth/v1/mobility/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=***********' \
--data-urlencode 'client_secret=*************' \
--data-urlencode 'grant_type=client_credentials'

On receiving the request Shell Authorization system will verify all the parameters in the request and, if everything checks out, it will generate your access token and return it in the response.

Sample Response

{
    "access_token": "***********",
    "token_type": "Bearer",
    "expires_in": 899
}

The response will contain the following parameters:

  • access_token: The token to be used to call the functional APIs
  • expires_in: The amount of seconds until the access token expires.
  • token_type: Bearer

Exception Handling

All error scenarios are returned with a response body and identifier.

{
      "error_descrription": "invalid client or client credentials",
      "error": "invalid_client"
}
HTTP Code Description Scenarios
400 Bad Request If Invalid scope passed to Token url
Invalid grant type passed to Token url
401 Unauthorized If Invalid id/secret passed to Token url
If Invalid or expired token passed to destination system’s API

Get Recent Transactions Data

This end point allows querying last 48 hours of transaction data of Shell Card (i.e. Priced, Billed, Unbilled etc. sales items). It provides a flexible search criteria and supports pagination.

Supported operations

  • Search by Date and Time range (within the last 48 hours only)
  • Search by Payer and/or Account number
  • Search by Card
  • Search by Purchased Country
  • Search by Transaction posting date
  • Search by Driver Name or Vehicle registration number
  • Search by Fuel only transactions
  • Search by Product and/or Product group

Business Case - 1

Customer wants to download the complete list of recent transactions for the last 48 hours for all his accounts (Based on single Payer Number)

Introduction

  • Mandatory Parameters
    • Note that the API has pagination implemented and the the number records to be viewed in the response can be set in the request with PageSize parameter. (Minimum = 1 and Maximum = 1000)
    • Also the page number for which the records needs to viewed needs to be passed in the request.
    • ColCoCode - Collecting company code of the selected payer needs to be always passed in the request.
    • PayerNumber - Payer Number of the selected payer needs to be always passed in the request.
  • Optional Parameters
    • ColumnList - by deafult "All" is set in the API where all the parameters will be provided in the response.

Key Request Parameters

  • Method : POST
  • URI : https://api-test.shell.com/test/transaction-data/v1/recent
  • Headers :
    • Authorization : Bearer access_token (Access Token generated from the OAuth end point)
    • RequestId : GUID in order to track and trace the request
  • Body :
    • PageSize : Number of records per page (Eg: 2).
    • Page : Page number.
    • ColCoCode : ColCoCode of the selected payer.
    • PayerNumber : Payer Number of the selected payer.
    • ColumnList : All to be passed to view all the response parameters.

Sample cURL Request

curl --location --request POST 'https://api-test.shell.com/test/transaction-data/v1/recent' \
--header 'RequestId: 233e4567-e89b-12d3-a456-426614174000' \
--header 'Authorization: Bearer ********' \
--header 'Content-Type: application/json' \
--data-raw '{
  "PageSize": 2,
  "Page": 1,
  "Filters": {
    "ColCoCode": 5,
    "PayerNumber": "GB99213576",
    "ColumnList" : "All"
 }
}'

Sample Response

{
    "RequestId": "233e4567-e89b-12d3-a456-426614174000",
    "Status": "SUCCESS",
    "CurrentPage": 1,
    "RowCount": 142,
    "TotalPages": 71,
    "Data": [
        {
            "AccountNumber": "GB99214035",
            "CardIssueNumber": "1",
            "CollectingCompanyCurrencyIsoCode": "GBP",
            "CustDataCustomerEntered": "",
            "CustDataDriverId": "",
            "CustDataFleetDescription": "",
            "FleetIdInput": "",
            "Amount": "69.56",
            "EuroshellSiteNumber": "",
            "IncomingProductCode": "",
            "ProductCode": "30",
            "ProductName": "Diesel AGO",
            "SiteCode": "",
            "HostingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "HostingCollectingCompanyNumber": "05",
            "IccdataTranTypeCode": "",
            "TransactionType": "Purchase Request",
            "ColCoCode": 5,
            "Latitude": "",
            "PayerNumber": "GB99213576",
            "Longitude": "",
            "MerchantCategory": "5541",
            "MerchantCategoryDescription": "",
            "PurchasedInCountry": "United Kingdom",
            "MerchantId": "9089           ",
            "SiteName": "",
            "Network": "2002296826",
            "DelcoCode": "",
            "OdometerInput": "123",
            "OdometerReadingKm": "198.06763285024155",
            "OdometerReadingMiles": "123",
            "CardPAN": "700205*******320615",
            "PINIndicator": "Y",
            "POIReceiptNumber": "",
            "ProductsCodeAdditional": "",
            "ProductsTaxCode": "0",
            "FuelVolume": "37.22",
            "SfgwCardDateOfExpiry": "2025-12",
            "SiteCurrencyISOCode": "GBP",
            "CardId": "092688",
            "TransactionDate": "2022-08-31",
            "TransactionDateTime": "2022-08-31 11:34:44.000",
            "TransactionId": "1135575003",
            "TransactionStatus": "APPROVED",
            "UnitOfMeasure": "L",
            "VehicleRegistrationNumber": "WD XXXX",
            "DeclinedReason": "",
            "NetworkDelcoName": "",
            "ProductGroupName": "Automotive Gas Oil",
            "FuelProduct": "All Fuels",
            "AccountCustomerName": "XYZ",
            "PayerName": "XYZ",
            "TransactionTime": "11:34:44",
            "TransactionCurrencySymbol": "£",
            "UnitPrice": "1.86",
            "AuthorisedFlag": "Y",
            "TransactionTimeGMT": "10:34:44",
            "ReasonCode": "00",
            "IssuerActionCode": "",
            "IssuerActionCodeDescription": "",
            "CardStatusReasonDescription": "Approved or completed successfully",
            "TransactionCountry": "",
            "IssuingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "CardIssuerName": "H3-United Kingdom",
            "DriverName": "",
            "BearerDescription": "",
            "CardCategoryDescription": "Vehicle Card",
            "CardTypeDescription": "GB STD FLT NAT MULTI R7",
            "CardTokenTypeDescription": "GB STD FLT NAT MULTI  - CHIP",
            "EmbossType": "Vehicle"
        },
        {
            "AccountNumber": "GB20000315",
            "CardIssueNumber": "1",
            "CollectingCompanyCurrencyIsoCode": "GBP",
            "CustDataCustomerEntered": "",
            "CustDataDriverId": "",
            "CustDataFleetDescription": "",
            "FleetIdInput": "",
            "Amount": "106.09",
            "EuroshellSiteNumber": "0623",
            "IncomingProductCode": "",
            "ProductCode": "30",
            "ProductName": "Diesel AGO",
            "SiteCode": 32934,
            "HostingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "HostingCollectingCompanyNumber": "05",
            "IccdataTranTypeCode": "",
            "TransactionType": "Purchase Request",
            "ColCoCode": 5,
            "Latitude": "53.37200",
            "PayerNumber": "GB99213576",
            "Longitude": "-1.38892",
            "MerchantCategory": "5541",
            "MerchantCategoryDescription": "",
            "PurchasedInCountry": "United Kingdom",
            "MerchantId": "GB0623000000000",
            "SiteName": "EG CREST SERVICE STATION",
            "Network": "0000000826",
            "DelcoCode": "005",
            "OdometerInput": "74601",
            "OdometerReadingKm": "120130.4347826087",
            "OdometerReadingMiles": "74601",
            "CardPAN": "700205*******152607",
            "PINIndicator": "Y",
            "POIReceiptNumber": "0000071175",
            "ProductsCodeAdditional": "",
            "ProductsTaxCode": "4",
            "FuelVolume": "57.07",
            "SfgwCardDateOfExpiry": "2025-03",
            "SiteCurrencyISOCode": "GBP",
            "CardId": "806977",
            "TransactionDate": "2022-08-31",
            "TransactionDateTime": "2022-08-31 11:26:40.000",
            "TransactionId": "1135579241",
            "TransactionStatus": "APPROVED",
            "UnitOfMeasure": "L",
            "VehicleRegistrationNumber": "WD XXXX",
            "DeclinedReason": "",
            "NetworkDelcoName": "Shell U.K. Oil Products Limited",
            "ProductGroupName": "Automotive Gas Oil",
            "FuelProduct": "All Fuels",
            "AccountCustomerName": "XYZ",
            "PayerName": "XYZ",
            "TransactionTime": "11:26:40",
            "TransactionCurrencySymbol": "£",
            "UnitPrice": "1.859",
            "AuthorisedFlag": "Y",
            "TransactionTimeGMT": "10:26:40",
            "ReasonCode": "00",
            "IssuerActionCode": "",
            "IssuerActionCodeDescription": "",
            "CardStatusReasonDescription": "Approved or completed successfully",
            "TransactionCountry": "",
            "IssuingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "CardIssuerName": "H3-United Kingdom",
            "DriverName": "",
            "BearerDescription": "",
            "CardCategoryDescription": "Vehicle Card",
            "CardTypeDescription": "GB STD FLT NAT MULTI R7",
            "CardTokenTypeDescription": "GB STD FLT NAT MULTI  - CHIP",
            "EmbossType": "Vehicle"
        }
    ]
}

Business Case - 2

Customer wants to download the complete list of recent transactions for the last 48 hours for all a particular account number.

Introduction

  • Mandatory Parameters
    • Note that the API has pagination implemented and the the number records to be viewed in the response can be set in the request with PageSize parameter. (Minimum = 1 and Maximum = 1000)
    • Also the page number for which the records needs to viewed needs to be passed in the request.
    • ColCoCode - Collecting company code of the selected payer needs to be always passed in the request.
    • PayerNumber - Payer Number of the selected payer needs to be always passed in the request.
    • AccountNumber - Account number for which data needs to be requested.
  • Optional Parameters
    • ColumnList - by deafult "All" is set in the API where all the parameters will be provided in the response.

Key Request Parameters

  • Method : POST
  • URI : https://api-test.shell.com/test/transaction-data/v1/recent
  • Headers :
    • Authorization : Bearer access_token (Access Token generated from the OAuth end point)
    • RequestId : GUID in order to track and trace the request
  • Body :
    • PageSize : Number of records per page (Eg: 2).
    • Page : Page number.
    • ColCoCode : ColCoCode of the selected payer.
    • PayerNumber : Payer Number of the selected payer.
    • AccountNumber : Account number of the selected payer.
    • ColumnList : All to be passed to view all the response parameters.

Sample cURL Request

curl --location --request POST 'https://api-test.shell.com/test/transaction-data/v1/recent' \
--header 'RequestId: 233e4567-e89b-12d3-a456-426614174000' \
--header 'Authorization: Bearer *********' \
--header 'Content-Type: application/json' \
--data-raw '{
  "PageSize": 1,
  "Page": 1,
  "Filters": {
    "ColCoCode": 5,
    "PayerNumber": "GB99213576",
    "AccountNumber": "GB99214035",
    "ColumnList" : "All"
 }
}'

Sample Response

{
    "RequestId": "233e4567-e89b-12d3-a456-426614174000",
    "Status": "SUCCESS",
    "CurrentPage": 1,
    "RowCount": 71,
    "TotalPages": 71,
    "Data": [
        {
            "AccountNumber": "GB99214035",
            "CardIssueNumber": "1",
            "CollectingCompanyCurrencyIsoCode": "GBP",
            "CustDataCustomerEntered": "",
            "CustDataDriverId": "",
            "CustDataFleetDescription": "",
            "FleetIdInput": "",
            "Amount": "235.59",
            "EuroshellSiteNumber": "2163",
            "IncomingProductCode": "",
            "ProductCode": "30",
            "ProductName": "Diesel AGO",
            "SiteCode": 33200,
            "HostingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "HostingCollectingCompanyNumber": "05",
            "IccdataTranTypeCode": "",
            "TransactionType": "Purchase Request",
            "ColCoCode": 5,
            "Latitude": "53.13739",
            "PayerNumber": "GB99213576",
            "Longitude": "-1.33362",
            "MerchantCategory": "5541",
            "MerchantCategoryDescription": "",
            "PurchasedInCountry": "United Kingdom",
            "MerchantId": "GB2163000000000",
            "SiteName": "SHELL CHESTERFIELD NORTH",
            "Network": "0000000826",
            "DelcoCode": "005",
            "OdometerInput": "",
            "OdometerReadingKm": "",
            "OdometerReadingMiles": "",
            "CardPAN": "707705*******510330",
            "PINIndicator": "Y",
            "POIReceiptNumber": "0000066970",
            "ProductsCodeAdditional": "",
            "ProductsTaxCode": "d",
            "FuelVolume": "120.26",
            "SfgwCardDateOfExpiry": "2025-04",
            "SiteCurrencyISOCode": "GBP",
            "CardId": "845571",
            "TransactionDate": "2022-08-31",
            "TransactionDateTime": "2022-08-31 12:21:27.000",
            "TransactionId": "1135622161",
            "TransactionStatus": "APPROVED",
            "UnitOfMeasure": "L",
            "VehicleRegistrationNumber": "WD XXX",
            "DeclinedReason": "",
            "NetworkDelcoName": "Shell U.K. Oil Products Limited",
            "ProductGroupName": "Automotive Gas Oil",
            "FuelProduct": "All Fuels",
            "AccountCustomerName": "XYZ",
            "PayerName": "XYZ",
            "TransactionTime": "12:21:27",
            "TransactionCurrencySymbol": "£",
            "UnitPrice": "1.959",
            "AuthorisedFlag": "Y",
            "TransactionTimeGMT": "11:21:27",
            "ReasonCode": "00",
            "IssuerActionCode": "",
            "IssuerActionCodeDescription": "",
            "CardStatusReasonDescription": "Approved or completed successfully",
            "TransactionCountry": "",
            "IssuingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "CardIssuerName": "H3-United Kingdom",
            "DriverName": "",
            "BearerDescription": "",
            "CardCategoryDescription": "Vehicle Card",
            "CardTypeDescription": "GB STD CRT NAT MULTI R7",
            "CardTokenTypeDescription": "GB STD CRT NAT MULTI - CHIP",
            "EmbossType": "Vehicle"
        }
    ]
}

Business Case - 3

Customer wants to download the complete list of recent transactions for the last 48 hours for all a particular card .

Introduction

  • Mandatory Parameters
    • Note that the API has pagination implemented and the the number records to be viewed in the response can be set in the request with PageSize parameter. (Minimum = 1 and Maximum = 1000)
    • Also the page number for which the records needs to viewed needs to be passed in the request.
    • ColCoCode - Collecting company code of the selected payer needs to be always passed in the request.
    • PayerNumber - Payer Number of the selected payer needs to be always passed in the request.
    • CardPAN - Card number for which data needs to be requested.
  • Optional Parameters
    • ColumnList - by deafult "All" is set in the API where all the parameters will be provided in the response.

Key Request Parameters

  • Method : POST
  • URI : https://api-test.shell.com/test/transaction-data/v1/recent
  • Headers :
    • Authorization : Bearer access_token (Access Token generated from the OAuth end point)
    • RequestId : GUID in order to track and trace the request
  • Body :
    • PageSize : Number of records per page (Eg: 2).
    • Page : Page number.
    • ColCoCode : ColCoCode of the selected payer.
    • PayerNumber : Payer Number of the selected payer.
    • CardPAN : Card number of the selected payer.
    • ColumnList : All to be passed to view all the response parameters.

Sample cURL Request

curl --location --request POST 'https://api-test.shell.com/test/transaction-data/v1/recent' \
--header 'RequestId: 233e4567-e89b-12d3-a456-426614174000' \
--header 'Authorization: Bearer **********' \
--header 'Content-Type: application/json' \
--data-raw '{
  "PageSize": 1,
  "Page": 1,
  "Filters": {
    "ColCoCode": 5,
    "PayerNumber": "GB99213576",
    "CardPAN": "7002057036251320730",
    "ColumnList" : "All"
 }
}'

Sample Response

{
    "RequestId": "233e4567-e89b-12d3-a456-426614174000",
    "Status": "SUCCESS",
    "CurrentPage": 1,
    "RowCount": 2,
    "TotalPages": 2,
    "Data": [
        {
            "AccountNumber": "GB99214035",
            "CardIssueNumber": "1",
            "CollectingCompanyCurrencyIsoCode": "GBP",
            "CustDataCustomerEntered": "",
            "CustDataDriverId": "",
            "CustDataFleetDescription": "",
            "FleetIdInput": "",
            "Amount": "90.48",
            "EuroshellSiteNumber": "0477",
            "IncomingProductCode": "",
            "ProductCode": "30",
            "ProductName": "Diesel AGO",
            "SiteCode": 32741,
            "HostingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "HostingCollectingCompanyNumber": "05",
            "IccdataTranTypeCode": "",
            "TransactionType": "Purchase Request",
            "ColCoCode": 5,
            "Latitude": "52.06807",
            "PayerNumber": "GB99213576",
            "Longitude": "-0.73669",
            "MerchantCategory": "5541",
            "MerchantCategoryDescription": "",
            "PurchasedInCountry": "United Kingdom",
            "MerchantId": "GB0477000000000",
            "SiteName": "SHELL BLAKELANDS",
            "Network": "0000000826",
            "DelcoCode": "005",
            "OdometerInput": "",
            "OdometerReadingKm": "",
            "OdometerReadingMiles": "",
            "CardPAN": "700205*******320730",
            "PINIndicator": "Y",
            "POIReceiptNumber": "0000085491",
            "ProductsCodeAdditional": "",
            "ProductsTaxCode": "d",
            "FuelVolume": "49.2",
            "SfgwCardDateOfExpiry": "2026-05",
            "SiteCurrencyISOCode": "GBP",
            "CardId": "237684",
            "TransactionDate": "2022-08-31",
            "TransactionDateTime": "2022-08-31 06:16:04.000",
            "TransactionId": "1135221633",
            "TransactionStatus": "APPROVED",
            "UnitOfMeasure": "L",
            "VehicleRegistrationNumber": "WD XXXX",
            "DeclinedReason": "",
            "NetworkDelcoName": "Shell U.K. Oil Products Limited",
            "ProductGroupName": "Automotive Gas Oil",
            "FuelProduct": "All Fuels",
            "AccountCustomerName": "XYZ",
            "PayerName": "XYZ",
            "TransactionTime": "06:16:04",
            "TransactionCurrencySymbol": "£",
            "UnitPrice": "1.839",
            "AuthorisedFlag": "Y",
            "TransactionTimeGMT": "05:16:04",
            "ReasonCode": "00",
            "IssuerActionCode": "",
            "IssuerActionCodeDescription": "",
            "CardStatusReasonDescription": "Approved or completed successfully",
            "TransactionCountry": "",
            "IssuingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "CardIssuerName": "H3-United Kingdom",
            "DriverName": "",
            "BearerDescription": "",
            "CardCategoryDescription": "Vehicle Card",
            "CardTypeDescription": "GB STD FLT NAT MULTI R7",
            "CardTokenTypeDescription": "GB STD FLT NAT MULTI  - CHIP",
            "EmbossType": "Vehicle"
        }
    ]
}

Business Case - 4

Customer wants to download the complete list of recent transactions for a particular time range within the last 48 hours. Eg : Get the data for the last 6 hours

Introduction

  • Mandatory Parameters
    • Note that the API has pagination implemented and the the number records to be viewed in the response can be set in the request with PageSize parameter. (Minimum = 1 and Maximum = 1000)
    • Also the page number for which the records needs to viewed needs to be passed in the request.
    • ColCoCode - Collecting company code of the selected payer needs to be always passed in the request.
    • PayerNumber - Payer Number of the selected payer needs to be always passed in the request.
    • FromDateTime - Start Date and Time (UTC) to be provided
    • ToDateTime - End Date and Time (UTC) to be provided
  • Optional Parameters
    • ColumnList - by deafult "All" is set in the API where all the parameters will be provided in the response.

Key Request Parameters

  • Method : POST
  • URI : https://api-test.shell.com/test/transaction-data/v1/recent
  • Headers :
    • Authorization : Bearer access_token (Access Token generated from the OAuth end point)
    • RequestId : GUID in order to track and trace the request
  • Body :
    • PageSize : Number of records per page (Eg: 2).
    • Page : Page number.
    • ColCoCode : ColCoCode of the selected payer.
    • PayerNumber : Payer Number of the selected payer.
    • FromDateTime - Start Date and Time (UTC) to be provided
    • ToDateTime - End Date and Time (UTC) to be provided
    • ColumnList : All to be passed to view all the response parameters.

Sample cURL Request

curl --location --request POST 'https://api-test.shell.com/test/transaction-data/v1/recent' \
--header 'RequestId: 233e4567-e89b-12d3-a456-426614174000' \
--header 'Authorization: Bearer ********' \
--header 'Content-Type: application/json' \
--data-raw '{
  "PageSize": 1,
  "Page": 1,
  "Filters": {
    "ColCoCode": 5,
    "PayerNumber": "GB99213576",
    "FromDateTime":"2018-08-30 10:19:24.000",
    "ToDateTime":"2022-08-30 12:53:00.000",
    "ColumnList" : "All"    
 }
}'

Sample Response

{
    "RequestId": "233e4567-e89b-12d3-a456-426614174000",
    "Status": "SUCCESS",
    "CurrentPage": 1,
    "RowCount": 58,
    "TotalPages": 58,
    "Data": [
        {
            "AccountNumber": "GB99214035",
            "CardIssueNumber": "1",
            "CollectingCompanyCurrencyIsoCode": "GBP",
            "CustDataCustomerEntered": "",
            "CustDataDriverId": "",
            "CustDataFleetDescription": "",
            "FleetIdInput": "",
            "Amount": "65.47",
            "EuroshellSiteNumber": "2484",
            "IncomingProductCode": "",
            "ProductCode": "30",
            "ProductName": "Diesel AGO",
            "SiteCode": 33498,
            "HostingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "HostingCollectingCompanyNumber": "05",
            "IccdataTranTypeCode": "",
            "TransactionType": "Purchase Request",
            "ColCoCode": 5,
            "Latitude": "53.42442",
            "PayerNumber": "GB99213576",
            "Longitude": "-1.25623",
            "MerchantCategory": "5541",
            "MerchantCategoryDescription": "",
            "PurchasedInCountry": "United Kingdom",
            "MerchantId": "GB2484000000000",
            "SiteName": "SHELL BRAMLEY",
            "Network": "0000000826",
            "DelcoCode": "005",
            "OdometerInput": "",
            "OdometerReadingKm": "",
            "OdometerReadingMiles": "",
            "CardPAN": "700205*******320375",
            "PINIndicator": "Y",
            "POIReceiptNumber": "0000073310",
            "ProductsCodeAdditional": "",
            "ProductsTaxCode": "d",
            "FuelVolume": "35.99",
            "SfgwCardDateOfExpiry": "2025-06",
            "SiteCurrencyISOCode": "GBP",
            "CardId": "899053",
            "TransactionDate": "2022-08-30",
            "TransactionDateTime": "2022-08-30 12:47:45.000",
            "TransactionId": "1134649977",
            "TransactionStatus": "APPROVED",
            "UnitOfMeasure": "L",
            "VehicleRegistrationNumber": "WD XXXX",
            "DeclinedReason": "",
            "NetworkDelcoName": "Shell U.K. Oil Products Limited",
            "ProductGroupName": "Automotive Gas Oil",
            "FuelProduct": "All Fuels",
            "AccountCustomerName": "XYZ",
            "PayerName": "XYZ",
            "TransactionTime": "12:47:45",
            "TransactionCurrencySymbol": "£",
            "UnitPrice": "1.819",
            "AuthorisedFlag": "Y",
            "TransactionTimeGMT": "11:47:45",
            "ReasonCode": "00",
            "IssuerActionCode": "",
            "IssuerActionCodeDescription": "",
            "CardStatusReasonDescription": "Approved or completed successfully",
            "TransactionCountry": "",
            "IssuingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "CardIssuerName": "H3-United Kingdom",
            "DriverName": "",
            "BearerDescription": "",
            "CardCategoryDescription": "Vehicle Card",
            "CardTypeDescription": "GB STD FLT NAT MULTI R7",
            "CardTokenTypeDescription": "GB STD FLT NAT MULTI  - CHIP",
            "EmbossType": "Vehicle"
        }
    ]
}

Business Case - 5

Customer wants to download the complete list of recent transactions for the last 48 hours for all a particular Vehicle registration number .

Introduction

  • Mandatory Parameters
    • Note that the API has pagination implemented and the the number records to be viewed in the response can be set in the request with PageSize parameter. (Minimum = 1 and Maximum = 1000)
    • Also the page number for which the records needs to viewed needs to be passed in the request.
    • ColCoCode - Collecting company code of the selected payer needs to be always passed in the request.
    • PayerNumber - Payer Number of the selected payer needs to be always passed in the request.
    • VehicleRegistrationNumber - Vehicle Registration number for which data needs to be requested.
  • Optional Parameters
    • ColumnList - by deafult "All" is set in the API where all the parameters will be provided in the response.

Key Request Parameters

  • Method : POST
  • URI : https://api-test.shell.com/test/transaction-data/v1/recent
  • Headers :
    • Authorization : Bearer access_token (Access Token generated from the OAuth end point)
    • RequestId : GUID in order to track and trace the request
  • Body :
    • PageSize : Number of records per page (Eg: 2).
    • Page : Page number.
    • ColCoCode : ColCoCode of the selected payer.
    • PayerNumber : Payer Number of the selected payer.
    • VehicleRegistrationNumber : Vehicle Registration number of the selected payer.
    • ColumnList : All to be passed to view all the response parameters.

Sample cURL Request

curl --location --request POST 'https://api-test.shell.com/test/transaction-data/v1/recent' \
--header 'RequestId: 233e4567-e89b-12d3-a456-426614174000' \
--header 'Authorization: Bearer **********' \
--header 'Content-Type: application/json' \
--data-raw '{
  "PageSize": 1,
  "Page": 1,
  "Filters": {
    "ColCoCode": 5,
    "PayerNumber": "GB99213576",
            "VehicleRegistrationNumber": "WD XXXX",
    "ColumnList" : "All"    
 }
}'

Sample Response

{
    "RequestId": "233e4567-e89b-12d3-a456-426614174000",
    "Status": "SUCCESS",
    "CurrentPage": 1,
    "RowCount": 1,
    "TotalPages": 1,
    "Data": [
        {
            "AccountNumber": "GB70365100",
            "CardIssueNumber": "1",
            "CollectingCompanyCurrencyIsoCode": "GBP",
            "CustDataCustomerEntered": "",
            "CustDataDriverId": "",
            "CustDataFleetDescription": "",
            "FleetIdInput": "",
            "Amount": "107.67",
            "EuroshellSiteNumber": "0330",
            "IncomingProductCode": "",
            "ProductCode": "30",
            "ProductName": "Diesel AGO",
            "SiteCode": 32740,
            "HostingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "HostingCollectingCompanyNumber": "05",
            "IccdataTranTypeCode": "",
            "TransactionType": "Purchase Request",
            "ColCoCode": 5,
            "Latitude": "52.04970",
            "PayerNumber": "GB99213576",
            "Longitude": "-0.79944",
            "MerchantCategory": "5541",
            "MerchantCategoryDescription": "",
            "PurchasedInCountry": "United Kingdom",
            "MerchantId": "GB0330000000000",
            "SiteName": "SHELL STACEY BUSHES",
            "Network": "0000000826",
            "DelcoCode": "005",
            "OdometerInput": "",
            "OdometerReadingKm": "",
            "OdometerReadingMiles": "",
            "CardPAN": "700205*******004392",
            "PINIndicator": "Y",
            "POIReceiptNumber": "0000184567",
            "ProductsCodeAdditional": "",
            "ProductsTaxCode": "d",
            "FuelVolume": "58.55",
            "SfgwCardDateOfExpiry": "2025-12",
            "SiteCurrencyISOCode": "GBP",
            "CardId": "089063",
            "TransactionDate": "2022-08-31",
            "TransactionDateTime": "2022-08-31 06:14:20.000",
            "TransactionId": "1135220930",
            "TransactionStatus": "APPROVED",
            "UnitOfMeasure": "L",
            "VehicleRegistrationNumber": "WD XXXX",
            "DeclinedReason": "",
            "NetworkDelcoName": "Shell U.K. Oil Products Limited",
            "ProductGroupName": "Automotive Gas Oil",
            "FuelProduct": "All Fuels",
            "AccountCustomerName": "XYZ",
            "PayerName": "XYZ",
            "TransactionTime": "06:14:20",
            "TransactionCurrencySymbol": "£",
            "UnitPrice": "1.839",
            "AuthorisedFlag": "Y",
            "TransactionTimeGMT": "05:14:20",
            "ReasonCode": "00",
            "IssuerActionCode": "",
            "IssuerActionCodeDescription": "",
            "CardStatusReasonDescription": "Approved or completed successfully",
            "TransactionCountry": "",
            "IssuingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "CardIssuerName": "H3-United Kingdom",
            "DriverName": "",
            "BearerDescription": "",
            "CardCategoryDescription": "Vehicle Card",
            "CardTypeDescription": "GB STD FLT NAT MULTI R7",
            "CardTokenTypeDescription": "GB STD FLT NAT MULTI  - CHIP",
            "EmbossType": "Vehicle"
        }
    ]
}

Business Case - 6

Customer wants to download the complete list of recent transactions for the last 48 hours for all fuel only transactions .

Introduction

  • Mandatory Parameters
    • Note that the API has pagination implemented and the the number records to be viewed in the response can be set in the request with PageSize parameter. (Minimum = 1 and Maximum = 1000)
    • Also the page number for which the records needs to viewed needs to be passed in the request.
    • ColCoCode - Collecting company code of the selected payer needs to be always passed in the request.
    • PayerNumber - Payer Number of the selected payer needs to be always passed in the request.
    • FuelOnly - Fuel Only flag needs to be set as true.
  • Optional Parameters
    • ColumnList - by deafult "All" is set in the API where all the parameters will be provided in the response.

Key Request Parameters

  • Method : POST
  • URI : https://api-test.shell.com/test/transaction-data/v1/recent
  • Headers :
    • Authorization : Bearer access_token (Access Token generated from the OAuth end point)
    • RequestId : GUID in order to track and trace the request
  • Body :
    • PageSize : Number of records per page (Eg: 2).
    • Page : Page number.
    • ColCoCode : ColCoCode of the selected payer.
    • PayerNumber : Payer Number of the selected payer.
    • FuelOnly : Fuel Only flag needs to be set as true.
    • ColumnList : All to be passed to view all the response parameters.

Sample cURL Request

curl --location --request POST 'https://api-test.shell.com/test/transaction-data/v1/recent' \
--header 'RequestId: 233e4567-e89b-12d3-a456-426614174000' \
--header 'Authorization: Bearer **********' \
--header 'Content-Type: application/json' \
--data-raw '{
  "PageSize": 1,
  "Page": 1,
  "Filters": {
    "ColCoCode": 5,
    "PayerNumber": "GB99213576",
    "FuelOnly": "True",
    "ColumnList" : "All"    
 }
}'

Sample Response

{
    "RequestId": "233e4567-e89b-12d3-a456-426614174000",
    "Status": "SUCCESS",
    "CurrentPage": 1,
    "RowCount": 171,
    "TotalPages": 171,
    "Data": [
        {
            "AccountNumber": "GB99214035",
            "CardIssueNumber": "1",
            "CollectingCompanyCurrencyIsoCode": "GBP",
            "CustDataCustomerEntered": "",
            "CustDataDriverId": "",
            "CustDataFleetDescription": "",
            "FleetIdInput": "",
            "Amount": "135.41",
            "EuroshellSiteNumber": "0013",
            "IncomingProductCode": "",
            "ProductCode": "30",
            "ProductName": "Diesel AGO",
            "SiteCode": 32966,
            "HostingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "HostingCollectingCompanyNumber": "05",
            "IccdataTranTypeCode": "00",
            "TransactionType": "Purchase Request",
            "ColCoCode": 5,
            "Latitude": "53.62698",
            "PayerNumber": "GB99213576",
            "Longitude": "-1.23802",
            "MerchantCategory": "5541",
            "MerchantCategoryDescription": "",
            "PurchasedInCountry": "United Kingdom",
            "MerchantId": "GB0013000000000",
            "SiteName": "SHELL BARNSDALE BAR STH",
            "Network": "0000000826",
            "DelcoCode": "005",
            "OdometerInput": "",
            "OdometerReadingKm": "",
            "OdometerReadingMiles": "",
            "CardPAN": "700205*******320813",
            "PINIndicator": "Y",
            "POIReceiptNumber": "0000113060",
            "ProductsCodeAdditional": "",
            "ProductsTaxCode": "d",
            "FuelVolume": "72.45",
            "SfgwCardDateOfExpiry": "2026-08",
            "SiteCurrencyISOCode": "GBP",
            "CardId": "353323",
            "TransactionDate": "2022-08-31",
            "TransactionDateTime": "2022-08-31 15:38:20.000",
            "TransactionId": "1135832587",
            "TransactionStatus": "APPROVED",
            "UnitOfMeasure": "L",
            "VehicleRegistrationNumber": "WD XXXX",
            "DeclinedReason": "",
            "NetworkDelcoName": "Shell U.K. Oil Products Limited",
            "ProductGroupName": "Automotive Gas Oil",
            "FuelProduct": "All Fuels",
            "AccountCustomerName": "XYZ",
            "PayerName": "XYZ",
            "TransactionTime": "15:38:20",
            "TransactionCurrencySymbol": "£",
            "UnitPrice": "1.869",
            "AuthorisedFlag": "Y",
            "TransactionTimeGMT": "14:38:20",
            "ReasonCode": "00",
            "IssuerActionCode": "",
            "IssuerActionCodeDescription": "",
            "CardStatusReasonDescription": "Approved or completed successfully",
            "TransactionCountry": "826",
            "IssuingCollectingCompanyName": "Shell U.K. Oil Products Limited",
            "CardIssuerName": "H3-United Kingdom",
            "DriverName": "",
            "BearerDescription": "",
            "CardCategoryDescription": "Vehicle Card",
            "CardTypeDescription": "GB STD FLT NAT MULTI R7",
            "CardTokenTypeDescription": "GB STD FLT NAT MULTI  - CHIP",
            "EmbossType": "Vehicle"
        }
    ]
}

Business Case - 7

Customer wants to download the complete list of recent transactions for the last 48 hours for all and receive only specific parameters in the response .

Introduction

  • Mandatory Parameters
    • Note that the API has pagination implemented and the the number records to be viewed in the response can be set in the request with PageSize parameter. (Minimum = 1 and Maximum = 1000)
    • Also the page number for which the records needs to viewed needs to be passed in the request.
    • ColCoCode - Collecting company code of the selected payer needs to be always passed in the request.
    • PayerNumber - Payer Number of the selected payer needs to be always passed in the request.
    • ColumnList - by deafult "All" is set in the API where all the parameters will be provided in the response. If you need specific parameters, then all the parameters to be passed as comma separated string.

Key Request Parameters

  • Method : POST
  • URI : https://api-test.shell.com/test/transaction-data/v1/recent
  • Headers :
    • Authorization : Bearer access_token (Access Token generated from the OAuth end point)
    • RequestId : GUID in order to track and trace the request
  • Body :
    • PageSize : Number of records per page (Eg: 2).
    • Page : Page number.
    • ColCoCode : ColCoCode of the selected payer.
    • PayerNumber : Payer Number of the selected payer.
    • ColumnList : PayerNumber,AccountNumber,CardPAN,DriverName,Amount,FuelVolume,UnitOfMeasure,TransactionDateTime to be passed in request to get only these parameters in the response. Please note that PayerNumber needs to be mandatory when you want to have a specific response

Sample cURL Request

curl --location --request POST 'https://api-test.shell.com/test/transaction-data/v1/recent' \
--header 'RequestId: 233e4567-e89b-12d3-a456-426614174000' \
--header 'Authorization: Bearer hXQavGjC17a2alMYB1Gt3fEAUCGh' \
--header 'Content-Type: application/json' \
--data-raw '{
  "PageSize": 1,
  "Page": 1,
  "Filters": {
    "ColCoCode": 5,
    "PayerNumber": "GB99213576",
    "ColumnList" : "AccountNumber,PayerNumber,CardPAN,DriverName,Amount,FuelVolume,UnitOfMeasure,TransactionDateTime"    
 }
}'

Sample Response

{
    "RequestId": "233e4567-e89b-12d3-a456-426614174000",
    "Status": "SUCCESS",
    "CurrentPage": 1,
    "RowCount": 172,
    "TotalPages": 172,
    "Data": [
        {
            "CardPAN": "7002057******320813",
            "DriverName": "",
            "UnitOfMeasure": "L",
            "TransactionDateTime": "2022-08-31 15:38:20.000",
            "FuelVolume": "72.45",
            "PayerNumber": "GB99213576",
            "Amount": "135.41",
            "AccountNumber": "GB99214035"
        }
    ]
}

About us

The Shell Developer Portal is here to support partners to onboard to Shell APIs, the portal is here to take ideas to production

 

Shell logo

Contact

Get in touch

api@shell.com

Contact sales

Contact support

Login to your account