Skip to main content

B2B Mobility Card Transaction Data 2.3.5

Get status change, maintenance and version updates about this API.

Shell B2B Mobility Card Transaction Data API - Quick Start Guide

API Version: 2.3.5 | Authentication: OAuth 2.0 | Status: Production

Overview

The Shell Card Transaction Data API is a REST-based API that enables developers to retrieve and analyze transaction data from Shell fuel cards programmatically. The API provides access to priced transactions, fees, volume-based pricing, bonus rules, exceptions, and card usage summaries.

Note: This guide covers only OAuth 2.0 authenticated endpoints (base path: /transaction-data/v1). Legacy Basic Auth endpoints (/fleetmanagement/v1/transaction) are not included as they are being phased out.

Key Features

  • Retrieve priced transaction details including EV transactions
  • Access fuel transaction details with sales items and fees
  • Get transaction summary data for Fuel and NFR transactions
  • Query volume-based pricing and bonus rules
  • Retrieve fee items and fee summary data
  • Access card and transaction exceptions
  • Analyze card usage and expenditure data
  • Support for multi-payer transaction queries

Important Notice - OAuth 2.0

IMPORTANT: OAuth 2.0 is now the standard authentication method

  • New integrations: Use OAuth 2.0 from the start
  • Existing integrations: Plan your migration to OAuth 2.0
  • Legacy methods: Basic Auth is being phased out

Contact Shell Technical Support to obtain your OAuth 2.0 credentials (client_id and client_secret).

Authentication

OAuth 2.0 (Standard Authentication Method)

The Shell Card Transaction Data API uses OAuth 2.0 Client Credentials flow for secure authentication.

WARNING: All customers should plan to adopt OAuth 2.0 authentication. This is the recommended and future-proof authentication method for the Shell Card Transaction Data API. Legacy authentication methods are being phased out.

OAuth 2.0 Flow

Step 1: Obtain Access Token

Request an access token from the OAuth token endpoint:

POST /oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=your-client-id&client_secret=your-client-secret

Step 2: Use Access Token in API Requests

Authorization: Bearer <access-token>
Content-Type: application/json

Token Management

Token management best practices:

  • Access tokens have a limited lifetime (typically 15 mins)
  • Implement token caching to avoid unnecessary token requests
  • Refresh tokens before expiry to ensure uninterrupted service
  • Never share your client_secret or embed it in client-side code

OAuth 2.0 Adoption Strategy

Why Migrate to OAuth 2.0?

Security Benefits:

  • Industry-standard authentication protocol
  • Time-limited access tokens reduce security risks
  • No credentials transmitted with each request
  • Better support for token rotation and revocation

Operational Benefits:

  • Improved scalability and performance
  • Better monitoring and audit capabilities
  • Simplified credential management
  • Future-proof integration

Migration Path

If you're currently using legacy authentication methods, follow this migration path:

  1. Request OAuth 2.0 credentials from Shell Technical Support
  2. Implement OAuth token management in your application
  3. Test thoroughly in the Test/Sandbox environment
  4. Run parallel authentication (OAuth + legacy) during transition
  5. Monitor and validate OAuth integration
  6. Switch to OAuth-only once validated
  7. Decommission legacy authentication after successful migration

Environments

The API is available in two environments:

Environment Base URL Purpose
Production https://api.shell.com Live production environment
Test (Sandbox) https://api-test.shell.com/test Testing and development environment

Tip: Always test your integration in the Test environment before moving to production.

Quick Start

1. Get Your OAuth Credentials

2. Obtain Access Token

First, get your OAuth access token:

cURL Example:

curl -X POST https://api-test.shell.com/v2/oauth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=your-client-id&client_secret=your-client-secret"

Response:

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}

3. Make Your First API Request

Example: Get Priced Transactions

cURL Example:

curl -X POST https://api-test.shell.com/test/transaction-data/v1/priced \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "Filters": {
        "ColCoCode": "5",
        "PayerNumber": "DE26667080",
        "InvoiceStatus": "A",
        "IncludeFees": true,
        "FromDate": "2024-12-01 00:00:00",
        "ToDate": "2025-01-20 00:00:00"
    },
    "Page": 1,
    "PageSize": 1
}'

Example Response:

{
  "RequestId": "9d2dee33-7803-485a-a2b1-2c7538e597ee",
  "Status": "SUCCESS",
  "Data": [
    {
      "AccountName": "Blue Colour Ltd",
      "AccountId": 29484,
      "AccountNumber": "DE26667080",
      "AccountShortName": "Mathew",
      "Additional1": "GBALLEGO0002452",
      "Additional2": "GBALLEGO0002452",
      "Additional3": "GBALLEGO0002452",
      "Additional4": "GBALLEGO0002452",
      "AllowClearing": "Null",
      "AuthorisationCode": 300796,
      "TransactionStatus": "Y",
      "DriverName": "SATTY BHAMRA",
      "CardExpiryPeriod": 2204,
      "CardExpiry": "20220101",
      "CardGroupId": 40000,
      "CardGroupName": "006240 FIRE BRIGHT SOLUTIONS",
      "IssuerCode": 7002,
      "CardPAN": "7002053465789891000",
      "ReleaseCode": 9,
      "CardSequenceNumber": 617,
      "CardType": "GB STD FLT NAT SINGLE R9",
      "ColCoCode": "014",
      "UnitDiscountInvoiceCurrency": -0.0051,
      "ColCoExchangeRate": 0.851858,
      "InvoiceCurrencySymbol": "GBP",
      "CorrectionFlag": true,
      "CRMNumber": 10,
      "CustomerCountry": "United Kingdom",
      "CustomerCurrencyCode": "GBP",
      "CustomerCurrencySymbol": "£",
      "RebateonNetAmountInCustomerCurrency": 0,
      "EffectiveDiscountInCustomerCurrency": -0.22,
      "EffectiveUnitDiscountInCustomerCurrency": -0.0051,
      "UnitPriceInInvoiceCurrency": 1.1024,
      "InvoiceTax": 0,
      "InvoiceGrossAmount": 57.25,
      "InvoiceNetAmount": 47.71,
      "VATonNetAmountInCustomerCurrency": 9.54,
      "CustomerRetailPriceUnitGross": 0,
      "CustomerRetailValueTotalGross": 57.52,
      "CustomerRetailValueTotalNet": 47.93,
      "TransactionTypeDescription": 9.59,
      "RebateonNetAmountInTransactionCurrency": -0.22,
      "EffectiveDiscountInTrxCurrency": -0.22,
      "DelCoToColCoExchangeRate": 0,
      "Cards": [
        275549
      ],
      "UnitDiscountTransactionCurrency": -0.005,
      "TransactionGrossAmount": 57.25,
      "TransactionNetAmount": 47.71,
      "TransactionTax": 9.54,
      "VATonNetAmount": 9.54,
      "DelcoListPriceUnitNet": 0,
      "DelcoRetailPriceUnitGross": 1.32888,
      "UnitPriceInTransactionCurrency": 1.1074,
      "DelcoRetailPriceUnitNet": 1.1074,
      "DelcoRetailValueTotalGross": 57.52,
      "DelcoRetailValueTotalNet": 47.93,
      "TransactionCurrencySymbol": "$",
      "DiscountType": 1,
      "DisputeStatus": false,
      "IsShellSite": false,
      "FleetIdInput": "YG67OUM",
      "IncomingProductCode": 23,
      "PostingDate": "20210802",
      "PostingTime": "14:15:22",
      "ProductCode": 30,
      "ProductName": "Unleaded - Medium octane",
      "ProductGroupId": 22,
      "IncomingCurrencyCode": "GBP",
      "IncomingSiteDescription": "Shell Broadway Ring",
      "Location": "Shell Broadway Ring",
      "SiteName": "Shell Broadway Ring",
      "SiteCode": 32,
      "IncomingSiteNumber": 15,
      "InvoiceCurrencyCode": "GBP",
      "InvoiceDate": "20210802",
      "InvoiceNumber": 3201016193,
      "FuelProduct": true,
      "VATApplicable": "Y",
      "PayerName": "Colours Services Ltd",
      "PayerNumber": "GB12121212",
      "ParentCustomerNumber": "GB12121212",
      "PayerGroup": "H312066",
      "PayerGroupName": "12162566 - FUEL CARD SERVICE",
      "CheckDigit": 6,
      "NetInvoiceIndicator": "Y",
      "DelcoCode": 5,
      "NetworkCode": 3,
      "PurchasedInCountry": "United Kingdom",
      "SiteCountry": "United Kingdom",
      "VATCountry": "United Kingdom",
      "DelcoName": "Shell U.K. Oil Products Limited",
      "Network": "Shell",
      "OdometerInput": 0,
      "OriginalSalesItemId": "Null",
      "FleetIDDescription": "YG67OUM",
      "ParentCustomerId": 6494,
      "PINIndicator": "Y, N",
      "ProductGroupName": "Fees",
      "PurchasedInCountryCode": "GB",
      "Quantity": 43.28,
      "RebateRate": 0.0022,
      "ReceiptNumber": 6803,
      "RefundFlag": "Y",
      "SiteGroupId": 202,
      "SiteGroupName": "CZ 9100 ECONOMY NETWORK",
      "Latitude": 53.83606,
      "Longitude": -1.61854,
      "DelCoExchangeRate": 0.851858,
      "EuroRebateAmount": -0.258259,
      "NetEuroAmount": 56.01,
      "EuroVATAmount": 11.2,
      "ParentCustomerName": "FUEL CARD SERVICES LTD",
      "IsInvoiced": false,
      "TransactionCurrencyCode": "GBP",
      "CreditDebitCode": "D or C",
      "TransactionDate": "20210801",
      "TransactionTime": "12:16:58",
      "TransactionItemId": "H305908971030",
      "TrnIdentifier": "H305908971030",
      "Type": "SALE",
      "TransactionLine": 1,
      "TransactionType": "Purchase",
      "UTCOffset": "Europe/London",
      "VATCategory": "United Kingdom Standard VAT Rate",
      "VATRate": 0.2,
      "VehicleRegistration": "YG67OUM",
      "IsCancelled": "Y",
      "ColCoGrossAmount": 57.25,
      "ColCoNetAmount": 47.71,
      "ColCoVATAmount": 9.54,
      "OriginalCurrencySymbol": "$",
      "OriginalCurrencyCode": "$",
      "OriginalVATAmount": 0,
      "EmbossText": "PARKLANE PROPERTIES LTD",
      "OriginalExchangeRate": 0,
      "OriginalTransactionItemInvoiceDate": "20220202",
      "FeeTypeId": 1,
      "LineItemDescription": true,
      "FeeRuleDescription": "Simple Fee",
      "Frequency": 1,
      "FeeRuleId": 1,
      "SystemEntryDate": "20210828",
      "SystemEntryTime": "20:21:08",
      "IsManual": "Y",
      "OriginalTransactionItemId": "Y",
      "OriginalTransactionItemInvoiceNumber": 6750802,
      "OriginalTransactionItemInvoiceId": 234,
      "PayerShortName": "FUEL CARD SERVICES LTD",
      "ReverseCharge": "Y",
      "OriginalGrossAmount": 57.25,
      "OriginalNetAmount": 57.25,
      "UnitOfMeasure": "L",
      "RoadType": "National Road",
      "CustomerCountryIsoCode": "DE",
      "EVOperator": "Shell Recharge",
      "EVSerialId": "GBALLEGO0002452",
      "EVChargePointSerial": "GBALLEGO0002452",
      "EVChargePointConnectorType": 5,
      "EVChargePointConnectorTypeDescription": "DC 50 kW",
      "EVChargeDuration": "PT3205S",
      "EVChargeStartDate": "2021-08-01",
      "EVChargeStartTime": "20:08:01",
      "EVChargeEndDate": "2022-08-01",
      "EVChargeEndTime": "20:08:01",
      "HostingCollectingCompanyNumber": 0,
      "TransactionId": 0,
      "FuelOnly": true,
      "EVPrintedNumber": "ZZ2WJ53ZZ5",
      "IsRFID": true
    }
  ],
  "Page": 1,
  "PageSize": 1,
  "TotalPages": 5
}

API Endpoints Reference

Priced Transactions

Endpoint Method Description
/transaction-data/v1/priced POST Get priced transaction details including EV transactions (OAuth 2.0)
/transaction-data/v1/pricedtransaction POST Get fuel transaction details with sales items and fees (OAuth 2.0)
/transaction-data/v1/multipayerspricedtransactions POST Get priced transaction details for multiple payers (OAuth 2.0)

Common Use Cases:

  • Retrieve transactions by date range
  • Filter by Invoice status (Invoiced, Un-Invoiced, etc.)
  • Search by card PAN or vehicle registration
  • Get EV charging transactions
  • Query transactions across multiple payers

Transaction Summaries

Endpoint Method Description
/transaction-data/v1/pricedtransactionssummary POST Get priced transaction summary data for Fuel and NFR with sales items and fees (OAuth 2.0)
/transaction-data/v1/cardusagesummary POST Get expenditure analysis and usage summary for a card (OAuth 2.0)

Returns:

  • Aggregated transaction data by period
  • Total volumes and amounts
  • Breakdown by product type and category
  • Card-level expenditure analysis

Fee Management

Endpoint Method Description
/transaction-data/v1/feessummary POST Get fee items summary data for the given payer (OAuth 2.0)

Fee Information:

  • Retrieve fee items applied to transactions
  • Summary of all fees by period
  • Fee breakdown by type and category
  • Payer level fee analysis

Volume-Based Rules

Endpoint Method Description
/transaction-data/v1/volumebasedpricing POST Get In Arrears fee rules setup for the given payer (OAuth 2.0)
/transaction-data/v1/volumebasedbonus POST Get bonus and association bonus rules setup for the given payer (OAuth 2.0)

Volume-Based Features:

  • Access volume-based pricing rules
  • Retrieve bonus calculation rules
  • Get association bonus configurations

Exceptions

Endpoint Method Description
/transaction-data/v1/exceptions POST Get card or transaction related exceptions (OAuth 2.0)

Exception Types:

  • Transaction validation failures
  • Card usage anomalies
  • Authorization exceptions

Common Use Cases

This section maps common business scenarios to the appropriate API endpoints to help you quickly identify which APIs to use for your specific needs.

Use Case 1: Daily Transaction Reconciliation

Scenario: You need to reconcile all transactions from your fleet cards on a daily basis for accounting purposes.

Recommended API: /transaction-data/v1/priced

Why this API: This endpoint provides comprehensive transaction details including EV charging transactions, supports flexible date filtering, and includes both billed and unbilled transactions. Perfect for daily reconciliation with pagination support for large datasets.

Key Parameters:

  • PostingDateFrom and PostingDateTo - Set to yesterday's date
  • InvoiceStatus - Use "A" for all transactions
  • PageSize - Set to 100 for efficient data retrieval

Use Case 2: Invoice Validation and Verification

Scenario: You received an invoice and need to verify all transaction details, including fees and charges.

Recommended API: /transaction-data/v1/pricedtransaction

Why this API: Specifically designed to provide detailed fuel transaction information including sales items and all associated fees. Ideal for invoice validation as it matches the invoice structure.

Key Parameters:

  • InvoiceNumber - Specific invoice to validate
  • InvoiceDate - Invoice date from your billing
  • IncludeFees - Set to true to see all fee items

Use Case 3: Fuel Consumption Analysis and Reporting

Scenario: You need to analyze fuel consumption patterns across your fleet for the past month to optimize routes and reduce costs.

Recommended APIs:

  • /transaction-data/v1/pricedtransactionssummary - For aggregated data

Why these APIs: Summary endpoints provide aggregated data by product, site group, and time period, making it perfect for trend analysis without processing large transaction volumes.

Key Parameters:

  • PostingDateFrom and PostingDateTo - Set to last 30 days
  • ProductCode - Filter by specific fuel types
  • ProductGroupName - Group by fuel categories

Use Case 4: Multi-Fleet Management

Scenario: You manage multiple sub-accounts or payers and need to retrieve transaction data across all of them for consolidated reporting.

Recommended API: /transaction-data/v1/multipayerspricedtransactions

Why this API: Specifically designed to query transactions across multiple payers in a single API call, significantly reducing the number of requests and improving performance for multi-fleet scenarios.

Key Parameters:

  • Accounts - Array of payer IDs and numbers (max 10 payers)
  • InvoiceStatus - "A" for all transactions
  • PostingDateFrom and PostingDateTo - Reporting period

Use Case 5: Exception Monitoring and Fraud Detection

Scenario: You want to identify unusual transaction patterns such as high-value transactions, excessive fuel volumes, or cards with abnormal usage to prevent fraud or misuse.

Recommended API: /transaction-data/v1/exceptions

Why this API: Purpose-built for identifying transactions that exceed defined thresholds, making it ideal for monitoring exceptions and potential fraud.

Key Parameters:

  • Condition - Set threshold type (ValueGreaterThan, VolumeGreaterThan, etc.)
  • Value - Define the threshold value
  • OutputType - "Transaction" for transaction exceptions
  • TransactionsFromDate and TransactionsToDate - Monitoring period

Use Case 6: Fee and Charge Analysis

Scenario: You need to understand all fees and charges applied to your account to identify cost-saving opportunities or validate billing.

Recommended API: /transaction-data/v1/feessummary

Why this API: Provides aggregated fee information by fee type, product group, and fee group, making it easy to analyze fee structures and identify high-cost areas.

Key Parameters:

  • InvoiceStatus - "I" for invoiced fees only
  • FeeTypeGroup - Filter by "Card Charges", "Account Charges", etc.
  • PostingDateFrom and PostingDateTo - Analysis period

Use Case 7: Individual Card Expenditure Tracking

Scenario: A driver requests their transaction history for the past 6 months, or you need to analyze spending patterns for a specific card.

Recommended API: /transaction-data/v1/cardusagesummary

Why this API: Provides detailed expenditure analysis for individual cards over the past 7 months, grouped by site and product, perfect for card-level reporting.

Key Parameters:

  • CardId or PAN - Specific card to analyze
  • CardExpiry - For additional validation
  • AccountId - Optional account filter

Use Case 8: Volume-Based Pricing Eligibility Check

Scenario: You want to check if your account qualifies for volume-based pricing tiers and understand your current consumption levels against defined thresholds.

Recommended API: /transaction-data/v1/volumebasedpricing

Why this API: Shows your in-arrears fee rules, tier configurations, and current volume consumption, helping you understand pricing structures and plan to reach better tiers.

Key Parameters:

  • PayerNumber - Your payer account
  • IncludeHistory - Set to true to see historical calculations
  • IncludeCurrentPeriodVolume - Set to true for month-by-month breakdown

Use Case 9: Bonus and Rebate Tracking

Scenario: You have volume-based bonus agreements and want to track your progress toward bonus thresholds and view previously earned bonuses.

Recommended API: /transaction-data/v1/volumebasedbonus

Why this API: Provides complete details of bonus rules, current period consumption, and historical bonus calculations, enabling you to optimize purchasing to maximize bonuses.

Key Parameters:

  • PayerNumber - Your payer account
  • IncludeHistory - Set to true to see past bonus payments
  • IncludeCurrentPeriodVolume - Set to true to track current period progress

Usage Examples

Example 1: Get Priced Transactions (Including EV)

Request:

POST /transaction-data/v1/priced

{
  "PageSize": 1,
  "Page": 1,
  "Filters": {
    "ColCoCode": "5",
    "ColCoId": 5,
    "InvoiceStatus": "A",
    "PayerNumber": "DE26685263",
    "AccountId": 29484,
    "AccountNumber": "DE26667080",
    "CardPAN": "7002051006629890645",
    "FromDate": "2022-01-01 00:00:00",
    "ToDate": "2022-01-31 00:00:00",
    "IncludeFees": true
  }
}

Response:

{
  "RequestId": "9d2dee33-7803-485a-a2b1-2c7538e597ee",
  "Status": "SUCCESS",
  "Data": [
    {
      "AccountName": "Blue Colour Ltd",
      "AccountId": 29484,
      "AccountNumber": "DE26667080",
      "AccountShortName": "Mathew",
      "Additional1": "GBALLEGO0002452",
      "Additional2": "GBALLEGO0002452",
      "Additional3": "GBALLEGO0002452",
      "Additional4": "GBALLEGO0002452",
      "AllowClearing": "Null",
      "AuthorisationCode": 300796,
      "TransactionStatus": "Y",
      "DriverName": "SATTY BHAMRA",
      "CardExpiryPeriod": 2204,
      "CardExpiry": "20220101",
      "CardGroupId": 40000,
      "CardGroupName": "006240 FIRE BRIGHT SOLUTIONS",
      "IssuerCode": 7002,
      "CardPAN": "7002053465789891000",
      "ReleaseCode": 9,
      "CardSequenceNumber": 617,
      "CardType": "GB STD FLT NAT SINGLE R9",
      "ColCoCode": "014",
      "UnitDiscountInvoiceCurrency": -0.0051,
      "ColCoExchangeRate": 0.851858,
      "InvoiceCurrencySymbol": "GBP",
      "CorrectionFlag": true,
      "CRMNumber": 10,
      "CustomerCountry": "United Kingdom",
      "CustomerCurrencyCode": "GBP",
      "CustomerCurrencySymbol": "£",
      "RebateonNetAmountInCustomerCurrency": 0,
      "EffectiveDiscountInCustomerCurrency": -0.22,
      "EffectiveUnitDiscountInCustomerCurrency": -0.0051,
      "UnitPriceInInvoiceCurrency": 1.1024,
      "InvoiceTax": 0,
      "InvoiceGrossAmount": 57.25,
      "InvoiceNetAmount": 47.71,
      "VATonNetAmountInCustomerCurrency": 9.54,
      "CustomerRetailPriceUnitGross": 0,
      "CustomerRetailValueTotalGross": 57.52,
      "CustomerRetailValueTotalNet": 47.93,
      "TransactionTypeDescription": 9.59,
      "RebateonNetAmountInTransactionCurrency": -0.22,
      "EffectiveDiscountInTrxCurrency": -0.22,
      "DelCoToColCoExchangeRate": 0,
      "Cards": [
        275549
      ],
      "UnitDiscountTransactionCurrency": -0.005,
      "TransactionGrossAmount": 57.25,
      "TransactionNetAmount": 47.71,
      "TransactionTax": 9.54,
      "VATonNetAmount": 9.54,
      "DelcoListPriceUnitNet": 0,
      "DelcoRetailPriceUnitGross": 1.32888,
      "UnitPriceInTransactionCurrency": 1.1074,
      "DelcoRetailPriceUnitNet": 1.1074,
      "DelcoRetailValueTotalGross": 57.52,
      "DelcoRetailValueTotalNet": 47.93,
      "TransactionCurrencySymbol": "$",
      "DiscountType": 1,
      "DisputeStatus": false,
      "IsShellSite": false,
      "FleetIdInput": "YG67OUM",
      "IncomingProductCode": 23,
      "PostingDate": "20210802",
      "PostingTime": "14:15:22",
      "ProductCode": 30,
      "ProductName": "Unleaded - Medium octane",
      "ProductGroupId": 22,
      "IncomingCurrencyCode": "GBP",
      "IncomingSiteDescription": "Shell Broadway Ring",
      "Location": "Shell Broadway Ring",
      "SiteName": "Shell Broadway Ring",
      "SiteCode": 32,
      "IncomingSiteNumber": 15,
      "InvoiceCurrencyCode": "GBP",
      "InvoiceDate": "20210802",
      "InvoiceNumber": 3201016193,
      "FuelProduct": true,
      "VATApplicable": "Y",
      "PayerName": "Colours Services Ltd",
      "PayerNumber": "GB12121212",
      "ParentCustomerNumber": "GB12121212",
      "PayerGroup": "H312066",
      "PayerGroupName": "12162566 - FUEL CARD SERVICE",
      "CheckDigit": 6,
      "NetInvoiceIndicator": "Y",
      "DelcoCode": 5,
      "NetworkCode": 3,
      "PurchasedInCountry": "United Kingdom",
      "SiteCountry": "United Kingdom",
      "VATCountry": "United Kingdom",
      "DelcoName": "Shell U.K. Oil Products Limited",
      "Network": "Shell",
      "OdometerInput": 0,
      "OriginalSalesItemId": "Null",
      "FleetIDDescription": "YG67OUM",
      "ParentCustomerId": 6494,
      "PINIndicator": "Y, N",
      "ProductGroupName": "Fees",
      "PurchasedInCountryCode": "GB",
      "Quantity": 43.28,
      "RebateRate": 0.0022,
      "ReceiptNumber": 6803,
      "RefundFlag": "Y",
      "SiteGroupId": 202,
      "SiteGroupName": "CZ 9100 ECONOMY NETWORK",
      "Latitude": 53.83606,
      "Longitude": -1.61854,
      "DelCoExchangeRate": 0.851858,
      "EuroRebateAmount": -0.258259,
      "NetEuroAmount": 56.01,
      "EuroVATAmount": 11.2,
      "ParentCustomerName": "FUEL CARD SERVICES LTD",
      "IsInvoiced": false,
      "TransactionCurrencyCode": "GBP",
      "CreditDebitCode": "D or C",
      "TransactionDate": "20210801",
      "TransactionTime": "12:16:58",
      "TransactionItemId": "H305908971030",
      "TrnIdentifier": "H305908971030",
      "Type": "SALE",
      "TransactionLine": 1,
      "TransactionType": "Purchase",
      "UTCOffset": "Europe/London",
      "VATCategory": "United Kingdom Standard VAT Rate",
      "VATRate": 0.2,
      "VehicleRegistration": "YG67OUM",
      "IsCancelled": "Y",
      "ColCoGrossAmount": 57.25,
      "ColCoNetAmount": 47.71,
      "ColCoVATAmount": 9.54,
      "OriginalCurrencySymbol": "$",
      "OriginalCurrencyCode": "$",
      "OriginalVATAmount": 0,
      "EmbossText": "PARKLANE PROPERTIES LTD",
      "OriginalExchangeRate": 0,
      "OriginalTransactionItemInvoiceDate": "20220202",
      "FeeTypeId": 1,
      "LineItemDescription": true,
      "FeeRuleDescription": "Simple Fee",
      "Frequency": 1,
      "FeeRuleId": 1,
      "SystemEntryDate": "20210828",
      "SystemEntryTime": "20:21:08",
      "IsManual": "Y",
      "OriginalTransactionItemId": "Y",
      "OriginalTransactionItemInvoiceNumber": 6750802,
      "OriginalTransactionItemInvoiceId": 234,
      "PayerShortName": "FUEL CARD SERVICES LTD",
      "ReverseCharge": "Y",
      "OriginalGrossAmount": 57.25,
      "OriginalNetAmount": 57.25,
      "UnitOfMeasure": "L",
      "RoadType": "National Road",
      "CustomerCountryIsoCode": "DE",
      "EVOperator": "Shell Recharge",
      "EVSerialId": "GBALLEGO0002452",
      "EVChargePointSerial": "GBALLEGO0002452",
      "EVChargePointConnectorType": 5,
      "EVChargePointConnectorTypeDescription": "DC 50 kW",
      "EVChargeDuration": "PT3205S",
      "EVChargeStartDate": "2021-08-01",
      "EVChargeStartTime": "20:08:01",
      "EVChargeEndDate": "2022-08-01",
      "EVChargeEndTime": "20:08:01",
      "HostingCollectingCompanyNumber": 0,
      "TransactionId": 0,
      "FuelOnly": true,
      "EVPrintedNumber": "ZZ2WJ53ZZ5",
      "IsRFID": true
    }
  ],
  "Page": 3,
  "PageSize": 30,
  "TotalPages": 5
}

Example 2: Get Fuel Transaction Details

Request:

POST /transaction-data/v1/pricedtransaction

{
  "Filters": {
    "ColCoCode": 14,
    "InvoiceStatus": "A",
    "PayerId": 12345,
    "PayerNumber": "NL10042616"
  },
  "Page": 1,
  "PageSize": 50
}

Response:

{
  "RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
  "Status": "SUCCESS",
  "Data": [
    {
      "Transactions": [
        {
          "Type": "SalesItem /FeeItem",
          "CardId": 0,
          "CardPAN": "7002051006629891000",
          "CardExpiry": "2026-06-16",
          "TransactionDate": "2026-06-16",
          "TransactionTime": "string",
          "UTCOffset": "string",
          "FleetIdInput": "XYZ1234",
          "OdometerInput": 12345,
          "DriverName": "ANDREW GILBERRY",
          "VehicleRegistration": "MV65YLH",
          "InvoiceCurrencyCode": "GBP",
          "InvoiceCurrencySymbol": "$",
          "TransactionCurrencyCode": "GBP",
          "TransactionCurrencySymbol": "$",
          "TransactionNetAmount": 0,
          "TransactionTax": 0,
          "TransactionGrossAmount": 0,
          "InvoiceNetAmount": 0,
          "InvoiceTax": 0,
          "InvoiceGrossAmount": 0,
          "PurchasedInCountry": "Germany",
          "AccountId": 29484,
          "AccountNumber": "GB99215176",
          "AccountName": "MATTHEW ALGIE & COMPANY LIMITED",
          "AccountShortName": "string",
          "Quantity": 0,
          "FuelProduct": true,
          "UnitPriceInTransactionCurrency": 0,
          "UnitPriceInInvoiceCurrency": 0,
          "UnitDiscountTransactionCurrency": 0,
          "UnitDiscountInvoiceCurrency": 0,
          "IsInvoiced": true,
          "InvoiceNumber": "S04500493",
          "InvoiceDate": "string",
          "SiteCode": "050001 -\tCHARNOCK RICHARD NTHBOUND MWSA 0755",
          "SiteName": "050001 -\tCHARNOCK RICHARD NTHBOUND MWSA 0755",
          "SiteCountry": "Germany",
          "Location": {
            "Latitude": "37.4224764",
            "Longitude": "122.0842499"
          },
          "CardGroupName": "006240 FIRE BRIGHT SOLUTIONS",
          "ReceiptNumber": "1234",
          "ProductCode": "10 - TMF Charges",
          "ProductName": "Unleaded - High octane",
          "ProductGroupId": 1,
          "ProductGroupName": "Parent Product Group",
          "DelCoExchangeRate": 0,
          "ColCoExchangeRate": 0,
          "IsShellSite": true,
          "Network": "100013\tSTEINDORFER",
          "SiteGroupId": 202,
          "SiteGroupName": "CZ 9100 ECONOMY NETWORK",
          "PostingDate": "string",
          "IssuerCode": "7002",
          "PurchasedInCountryCode": "NL",
          "CustomerCountryCode": "NL",
          "CustomerCountry": "Netherlands",
          "ReleaseCode": "8",
          "CardGroupId": "string",
          "CardSequenceNumber": "2",
          "CheckDigit": "string",
          "FleetIDDescription": "string",
          "VATRate": "0.20 for 20%",
          "VATCategory": "1-Zero Rated",
          "VATonNetAmount": 0,
          "VATCountry": "Netherlands",
          "EffectiveDiscountInTrxCurrency": 0,
          "TransactionType": "Purchase when Card is Present else Blank",
          "PINIndicator": "“PIN Used”",
          "VATApplicable": "Y",
          "NetInvoiceIndicator": "Y",
          "CustomerCurrencyCode": "GBP",
          "CustomerCurrencySymbol": "£",
          "EffectiveUnitDiscountInCustomerCurrency": 0,
          "EffectiveDiscountInCustomerCurrency": 0,
          "VATonNetAmountInCustomerCurrency": 0,
          "DiscountType": "2-Pence per unit",
          "TransactionStatus": "U",
          "SalesItemId": 18315958002,
          "PayerGroup": "string",
          "PayerGroupName": "12119008 - SHELL GROUP OF COMPANIES",
          "RefundFlag": "string",
          "OriginalSalesItemId": "string",
          "DelcoName": "SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV",
          "DelcoCode": "14",
          "PayerNumber": "NL10042616",
          "PayerName": "V.M. LE COMTE",
          "CardExpiryPeriod": "1901",
          "AuthorisationCode": "1011256",
          "TransactionId": "io9KVXk1UkW57XWKyeaHHg",
          "TransactionLine": "1",
          "AllowClearing": "Y",
          "CRMNumber": "string",
          "DisputeStatus": "No Dispute",
          "RebateRate": 28.279,
          "DelCoToColCoExchangeRate": 1,
          "NetEuroAmount": 0,
          "EuroVATAmount": 0,
          "ParentCustomerNumber": "string",
          "ParentCustomerName": "string",
          "ParentCustomerId": 0,
          "IncomingSiteNumber": "100021",
          "IncomingSiteDescription": "HN3 INTI_02-82.02",
          "IncomingCurrencyCode": "GBP",
          "IncomingProductCode": "30",
          "CreditDebitCode": "D",
          "CorrectionFlag": "Y",
          "Additional1": "string",
          "Additional2": "string",
          "Additional3": "string",
          "Additional4": "string",
          "RebateonNetAmountInCustomerCurrency": -0.735,
          "RebateonNetAmountInTransactionCurrency": "AVEE PTUAZONW CUBFAO COSFS",
          "TrnIdentifier": "string",
          "CardType": "string",
          "DelcoListPriceUnitNet": 30.5,
          "DelcoRetailPriceUnitNet": 1.921,
          "DelcoRetailPriceUnitGross": 0,
          "DelcoRetailValueTotalNet": 0,
          "DelcoRetailValueTotalGross": 0,
          "CustomerRetailPriceUnitGross": 0,
          "CustomerRetailValueTotalNet": 0,
          "EVPrintedNumber": "3792",
          "IsRFID": true,
          "TokenTypeDescription": "string"
        }
      ]
    }
  ],
  "Page": 1,
  "PageSize": 1,
  "TotalPages": 15
}

Example 3: Get Priced Transaction Summary

Request:

POST /transaction-data/v1/pricedtransactionssummary

{
    "Filters": {
        "ColCoCode": 9,
        "PayerId": 12,
        "InvoiceStatus": "A",
        "FromDate": "2024-03-20",
        "ToDate": "2024-09-17",
        "PurchasedInCountryCode": "AT"
    }
}

Response:

{
  "RequestId": "2b0cbe11-f109-4c43-9201-49af0370df1c",
  "Status": "SUCCESS",
  "Data": [
    {
      "ProductId": 1234,
      "ProductCode": "10",
      "ProductName": "Diesel AGO",
      "ProductGroupId": 1,
      "ProductGroupName": "Fuels",
      "TotalFuelQuantity": 1250.75,
      "TotalNetAmount": 5420.50,
      "TotalGrossAmount": 6504.60,
      "InvoiceCurrencyCode": "GBP",
      "InvoiceCurrencySymbol": "£",
      "CustomerRetailValueTotalNet": 5420.50,
      "CustomerRetailValueTotalGross": 6504.60
    }
  ]
}

Example 4: Get Priced Summary

Request:

 POST /transaction-data/v1/pricedsummary
    
    {
  "Filters": {
    "ColCoCode": 86,
    "PayerNumber": "GB000000123",
    "CardId": 275549,
    "FromDate": "20240225",
    "ToDate": "20240225",
    "FuelOnly": false
  }
}

Response:

{
    "RequestId": "5f1bded6-416d-4478-ab7f-33905d7b5d4b",
    "Status": "SUCCESS",
    "Data": [
        {
            "CustomerRetailValueTotalGross": 114.13,
            "CustomerRetailValueTotalNet": 95.11,
            "InvoiceCurrencyCode": "EUR",
            "InvoiceCurrencySymbol": "€",
            "ProductCode": "21",
            "ProductGroupId": 3,
            "ProductGroupName": "Motor gasoline",
            "ProductId": 21,
            "ProductName": "Unleaded - High octane",
            "SiteGroupId": 104,
            "SiteGroupName": "Default Shell Stations Austria",
            "TotalFuelQuantity": 17.0,
            "TotalGrossAmount": 114.13,
            "TotalNetAmount": 95.11
        }
    ]
}

Example 5: Get Multi-Payer Priced Transactions

Request:

POST /transaction-data/v1/multipayerspricedtransactions

{
  "ColCoCode": 86,
  "Accounts": [
    {
      "PayerId": 12345,
      "PayerNumber": "GB987654322"
    },
    {
      "PayerId": 12346,
      "PayerNumber": "GB000000124"
    }
  ],
  "InvoiceStatus": "A",
  "FromDate": "20220101",
  "ToDate": "20220131",
  "PageSize": 50,
  "Page": 1
}

Response:

{
  "RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
  "Status": "SUCCESS",
  "Data": [
    {
      "Transactions": [
        {
          "Type": "SalesItem"
        }
      ],
      "CardId": 275549,
      "CardPAN": "7002051006629891000",
      "CardExpiry": "20250812",
      "TransactionDate": "20250812",
      "TransactionTime": "14:30:45",
      "UTCOffset": "+01:00:00",
      "FleetIdInput": "XYZ1234",
      "OdometerInput": 12345,
      "DriverName": "ANDREW GILBERRY",
      "VehicleRegistration": "MV65YLH",
      "InvoiceCurrencyCode": "GBP",
      "InvoiceCurrencySymbol": "£",
      "TransactionCurrencyCode": "GBP",
      "TransactionCurrencySymbol": "£",
      "TransactionNetAmount": 47.71,
      "TransactionTax": 9.54,
      "TransactionGrossAmount": 57.25,
      "InvoiceNetAmount": 47.71,
      "InvoiceTax": 9.54,
      "InvoiceGrossAmount": 57.25,
      "PurchasedInCountry": "Germany",
      "AccountId": 29484,
      "AccountNumber": "GB99215176",
      "AccountName": "MATTHEW ALGIE & COMPANY LIMITED",
      "AccountShortName": "MATTHEW",
      "Quantity": 43.28,
      "FuelProduct": true,
      "UnitPriceInTransactionCurrency": 1.1074,
      "UnitPriceInInvoiceCurrency": 1.1024,
      "UnitDiscountTransactionCurrency": -0.005,
      "UnitDiscountInvoiceCurrency": -0.0051,
      "IsInvoiced": true,
      "InvoiceNumber": "S04500493",
      "InvoiceDate": "20250815 09:30:00",
      "SiteCode": "050001",
      "SiteName": "CHARNOCK RICHARD NTHBOUND MWSA 0755",
      "SiteCountry": "Germany",
      "Location": {
        "Latitude": "53.83606",
        "Longitude": "-1.61854"
      },
      "CardGroupName": "006240 FIRE BRIGHT SOLUTIONS",
      "ReceiptNumber": "6803",
      "ProductCode": "10",
      "ProductName": "Unleaded - High octane",
      "ProductGroupId": 2,
      "ProductGroupName": "All Fuels",
      "DelCoExchangeRate": 0.851858,
      "ColCoExchangeRate": 0.851858,
      "IsShellSite": true,
      "Network": "SHELL",
      "SiteGroupId": 202,
      "SiteGroupName": "CZ 9100 ECONOMY NETWORK",
      "PostingDate": "20250812 14:30:45",
      "IssuerCode": "7002",
      "PurchasedInCountryCode": "DE",
      "CustomerCountryCode": "NL",
      "CustomerCountry": "Netherlands",
      "ReleaseCode": "8",
      "CardGroupId": "40000",
      "CardSequenceNumber": "617",
      "CheckDigit": "6",
      "FleetIDDescription": "YG67OUM",
      "VATRate": 0.2,
      "VATCategory": "1-Standard Rate",
      "VATonNetAmount": 9.54,
      "VATCountry": "Netherlands",
      "EffectiveDiscountInTrxCurrency": -0.22,
      "TransactionType": "Purchase",
      "PINIndicator": "PIN Used",
      "VATApplicable": "Y",
      "NetInvoiceIndicator": "N",
      "CustomerCurrencyCode": "GBP",
      "CustomerCurrencySymbol": "£",
      "EffectiveUnitDiscountInCustomerCurrency": -0.0051,
      "EffectiveDiscountInCustomerCurrency": -0.22,
      "VATonNetAmountInCustomerCurrency": 9.54,
      "DiscountType": "2-Pence per unit",
      "TransactionStatus": "I",
      "SalesItemId": 18315958002,
      "PayerGroup": "H312066",
      "PayerGroupName": "12119008 - SHELL GROUP OF COMPANIES",
      "RefundFlag": "N",
      "OriginalSalesItemId": null,
      "DelcoName": "SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV",
      "DelcoCode": "014",
      "PayerNumber": "GB987654322",
      "PayerName": "V.M. LE COMTE",
      "CardExpiryPeriod": "2504",
      "AuthorisationCode": "011256",
      "TransactionId": "io9KVXk1UkW57XWKyeaHHg",
      "TransactionLine": "1",
      "AllowClearing": "Y",
      "CRMNumber": null,
      "DisputeStatus": "No Dispute",
      "RebateRate": 28.279,
      "DelCoToColCoExchangeRate": 1,
      "NetEuroAmount": 56.01,
      "EuroVATAmount": 11.2,
      "ParentCustomerNumber": "GB12121212",
      "ParentCustomerName": "FUEL CARD SERVICES LTD",
      "ParentCustomerId": 6494,
      "IncomingSiteNumber": "100021",
      "IncomingSiteDescription": "HN3 INTI_02-82.02",
      "IncomingCurrencyCode": "GBP",
      "IncomingProductCode": "30",
      "CreditDebitCode": "D",
      "CorrectionFlag": "N",
      "Additional1": "GBALLEGO0002452",
      "Additional2": null,
      "Additional3": null,
      "Additional4": null,
      "RebateonNetAmountInCustomerCurrency": -0.735,
      "RebateonNetAmountInTransactionCurrency": -0.735,
      "TrnIdentifier": "H305908971030",
      "CardType": "GB STD FLT NAT SINGLE R9",
      "DelcoListPriceUnitNet": 30.5,
      "DelcoRetailPriceUnitNet": 1.1074,
      "DelcoRetailPriceUnitGross": 1.32888,
      "DelcoRetailValueTotalNet": 47.93,
      "DelcoRetailValueTotalGross": 57.52,
      "CustomerRetailPriceUnitGross": 1.32888,
      "CustomerRetailValueTotalNet": 47.93,
      "EVPrintedNumber": "3792",
      "IsRFID": true,
      "TokenTypeDescription": "Fleet Card"
    }
  ],
  "Page": 1,
  "PageSize": 20,
  "TotalPages": 15,
  "TotalRecords": 300
}

Example 6: Get Volume-Based Pricing Rules

Request:

POST /transaction-data/v1/volumebasedpricing

{
  "ColCoId": 1,
  "ColCoCode": 86,
  "PayerId": 12345,
  "PayerNumber": "GB000000123",
  "IncludeHistory": true,
  "IncludeCurrentPeriodVolume": true
}

Response:

{
  "RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
  "Status": "SUCCESS",
  "Data": [
    {
      "Configuration": [
        {
          "PricingAccountId": 123456,
          "PricingAccountNumber": "GB000000123",
          "PricingAccountShortName": "ABCD1234",
          "PricingAccountFullName": "ABCD1234",
          "FeeRuleId": 12345,
          "FeeRuleDescription": "NL/GAGO/D018/UP0.0120>1",
          "FeeRuleDateEffective": "20231223",
          "FeeRuleDateTerminated": "20231223",
          "BonusPaidTo": "1-Pay to Payer",
          "BonusPaidToAccountId": 123456,
          "BonusPaidToAccountNumber": "GB000000123",
          "BonusPaidToAccountShortName": "12345",
          "BonusPaidToAccountFullName": "GB000000123",
          "Frequency": "3-Weekly – Monday",
          "NextCalculationDate": "20231223",
          "PreviousCalculatedDate": "20231223",
          "FeeRuleBasis": "3-Lump Sum",
          "FeeRuleCurrencyCode": "GBP",
          "FeeRuleCurrencySymbol": "£",
          "FeeRuleAvailableFrom": "20231223",
          "FeeRuleAvailableTo": "20231223",
          "FeeRuleLocations": [
            {
              "DelcoId": 866,
              "Country": "United Kingdom",
              "CountryCode": "UK",
              "FuelNetworkId": 100007,
              "NetworkName": "VALERO",
              "SiteGroupId": 100007,
              "SiteGroupName": "VALERO ENERGY LTD",
              "SiteCode": 999493,
              "SiteId": 100007,
              "SiteName": "VALERO ENERGY LTD"
            }
          ],
          "FeeRuleProducts": [
            {
              "ProductGroupID": 3,
              "ProductGroupName": "Motor gasoline",
              "ProductCode": "30 for Diesel AGO",
              "ProductId": "30 for Diesel AGO",
              "ProductName": "Diesel AGO"
            }
          ],
          "FeeRuleTiers": [
            {
              "TierMinimum": 1234,
              "TierMaximum": 1234,
              "Value": 1234.12
            }
          ]
        }
      ],
      "CurrentPeriodConsumption": [
        {
          "FeeRuleId": 12345,
          "FeeRuleDescription": "NL/GAGO/D018/UP0.0120>1",
          "PriceRuleID": 100005,
          "PriceRuleDescription": "PL/GAGO/GMOT/UL0.055",
          "TotalVolume": 10000.78,
          "NextFeeCreationDate": "20231223"
        }
      ],
      "History": [
        {
          "FromDate": "20231223",
          "ToDate": "20231223",
          "FeesRuleID": 8081,
          "FeesRuleDescription": "PT/P067/D120/P4.0",
          "TotalVolume": 12356.66
        }
      ],
      "Warnings": [
        {
          "Message": "System is down for upgradation.",
          "Type": "System Outage"
        }
      ]
    }
  ]
}

Example 7: Get Volume-Based Bonus Rules

Request:

POST /transaction-data/v1/volumebasedbonus

{
  "ColCoId": 1,
  "ColCoCode": 86,
  "PayerId": 12345,
  "PayerNumber": "GB000000123",
  "IncludeHistory": true,
  "IncludeCurrentPeriodVolume": true
}

Response:

{
  "RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
  "Status": "SUCCESS",
  "Data": [
    {
      "Configuration": [
        {
          "PricingAccountId": 123456,
          "PricingAccountNumber": "GB000000123",
          "PricingAccountShortName": "MATTHEW",
          "PricingAccountFullName": "MATTHEW",
          "FeeRuleId": 1,
          "FeeRuleDescription": "NL/GAGO/D018/UP0.0120>1",
          "FeeRuleDateEffective": "20231223",
          "FeeRuleDateTerminated": "20231223",
          "BonusPaidTo": "1-Pay to Payer",
          "BonusPaidToAccountId": 123456,
          "BonusPaidToAccountNumber": "GB000000123",
          "BonusPaidToAccountShortName": "12345",
          "BonusPaidToAccountFullName": "GB000000123",
          "Frequency": "3-Weekly – Monday",
          "NextCalculationDate": "20231223",
          "PreviousCalculatedDate": "20231223",
          "FeeRuleBasis": "3-Lump Sum",
          "FeeRuleCurrencyCode": "GBP",
          "FeeRuleCurrencySymbol": "£",
          "FeeRuleAvailableFrom": "20231223",
          "FeeRuleAvailableTo": "20231223",
          "FeeRuleLocations": [
            {
              "DelcoId": 866,
              "Country": "United Kingdom",
              "CountryCode": "UK",
              "FuelNetworkId": 100007,
              "NetworkName": "VALERO",
              "SiteGroupId": 100007,
              "SiteGroupName": "VALERO ENERGY LTD",
              "SiteCode": 999493,
              "SiteId": 100007,
              "SiteName": "VALERO ENERGY LTD"
            }
          ],
          "FeeRuleProducts": [
            {
              "ProductGroupID": 3,
              "ProductGroupName": "Motor gasoline",
              "ProductCode": "30 for Diesel AGO",
              "ProductId": "30 for Diesel AGO",
              "ProductName": "Diesel AGO"
            }
          ],
          "FeeRuleTiers": [
            {
              "TierMinimum": 1234,
              "TierMaximum": 1234,
              "Value": 1234.12
            }
          ],
          "AssociatedAccounts": [
            {
              "AssociatedAccountId": 12345,
              "AssociatedAccountNumber": "GB000000123",
              "AssociatedAccountShortName": "Account short name",
              "AssociatedAccountFullName": "Account Full name"
            }
          ]
        }
      ],
      "CurrentPeriodConsumption": [
        {
          "FeeRuleId": 12345,
          "FeeRuleDescription": "NL/GAGO/D018/UP0.0120>1",
          "Month": 1,
          "Year": 2018,
          "TotalVolume": 10000.78
        }
      ],
      "HistoricalBonusPaid": [
        {
          "PayerId": 12345,
          "PayerNumber": "GB000000123",
          "PayerShortName": "Jorden",
          "PayerFullName": "MATTHEW",
          "AccountId": 123456,
          "AccountNumber": "GB000000123",
          "AccountShortName": "SALT",
          "AccountFullName": "ABCD1234",
          "InvoiceAccountId": 12345,
          "InvoiceAccountNumber": "GB000000123",
          "InvoiceAccountShortName": "DFE1234",
          "InvoiceAccountFullName": "AZAD PVT LMT",
          "FeeRuleId": 12345,
          "FeeRuleDescription": "NL/GAGO/D018/UP0.0120>1",
          "FromDate": "20231223",
          "ToDate": "20231223",
          "BonusPaidTo": "5-Pay to Associated Customers",
          "FeeItemId": 12345,
          "FeeRuleBasis": "2-Percentage of Uplift",
          "FeeItemCurrencyCode": "GBP",
          "FeeItemCurrencySymbol": "$",
          "ProratedVolume": 123.12,
          "TotalVolume": 123.12,
          "FeeProduct": "1562-Bonus diesel Shell",
          "InvoiceGrossAmount": 123.12,
          "InvoiceNetAmount": 123.12,
          "InvoiceVATAmount": 123.12,
          "IsFeeCancelled": true,
          "FeeItemTierProratedVolume": 123.12,
          "FeeItemTierTotalVolume": 123.12,
          "TierMinimum": 123,
          "TierRate": 123.12
        }
      ]
    }
  ],
  "Warnings": [
    {
      "Message": "System is down for upgradation.",
      "Type": "System Outage"
    }
  ]
}

Example 8: Get Fee Summary

Request:

POST /transaction-data/v1/feessummary

{
  "ColCoId": 1,
  "ColCoCode": 86,
  "PayerId": 12345,
  "PayerNumber": "GB000000123",
  "CardId": 275549,
  "InvoiceStatus": "I",
  "FromDate": "20240101",
  "ToDate": "20240131",
  "FeeTypeGroup": "Card Charges"
}

Response:

{
  "RequestId": "2b0cbe11-f109-4c43-9201-49af0370df1c",
  "Status": "SUCCESS",
  "Data": [
    {
      "FeeTypeGroup": "Card Charges",
      "FeeTypeId": 1,
      "FeeType": "Card Annual Fee",
      "ProductId": 1234,
      "ProductCode": "FEE",
      "ProductName": "Card Fee",
      "TotalFeeAmount": 125.00,
      "InvoiceCurrencyCode": "GBP",
      "InvoiceCurrencySymbol": "£"
    }
  ]
}

Example 9: Get Transaction Exceptions

Request:

POST /transaction-data/v1/exceptions

{
  "ColCoId": 1,
  "ColCoCode": 86,
  "PayerId": 12345,
  "PayerNumber": "GB000000123",
  "TransactionsFromDate": "20231223",
  "TransactionsToDate": "20240131",
  "Value": 100,
  "Condition": 5,
  "OutputType": "Transaction"
}

Response:

{
  "RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
  "Status": "SUCCESS",
  "Data": [
    {
      "CardsExceptions": [
        {
          "AccountId": 29484,
          "CardId": 1234,
          "PAN": "ABCD1234",
          "DriverName": "ANDREW GILBERRY",
          "VRN": "34235",
          "PayerId": 123455,
          "PayerNumber": "GB000000123",
          "AccountNumber": "GB99215176",
          "AccountShortName": "MATTHEW",
          "PayerShortName": "MATTHEW",
          "Day": 2,
          "Week": 2,
          "Month": 5,
          "Year": 2017,
          "TotalTransactions": 4,
          "TotalSalesItems": 4,
          "TotalQuantity": 261,
          "TotalAmount": 100.21,
          "CurrencyCode": "GBP",
          "CurrencySymbol": "$"
        }
      ],
      "TransactionsExceptions": [
        {
          "SalesItemId": 18315958002,
          "CardId": 1234,
          "ProductId": 2,
          "TransactionGUID": "ABCD1234",
          "TransactionDate": "20231223",
          "CustomerInvoiceValueTotalGross": 123.12,
          "CardPAN": "7002051006629891000",
          "CardExpiry": "20311223 12:12:12",
          "TransactionTime": "12:12:12",
          "UTCOffset": "+12:12:12",
          "FleetIdInput": "XYZ1234",
          "OdometerInput": 1234,
          "DriverName": "SALT",
          "VehicleRegistration": "MV65YLH",
          "InvoiceCurrencyCode": "GBP",
          "InvoiceCurrencySymbol": "$",
          "TransactionCurrencyCode": "GBP",
          "TransactionCurrencySymbol": "£",
          "TransactionNetAmount": 123.12,
          "TransactionTax": 123.12,
          "TransactionGrossAmount": 123.12,
          "InvoiceNetAmount": 123.12,
          "InvoiceTax": 123.12,
          "InvoiceGrossAmount": 123.1,
          "PurchasedInCountry": "France",
          "AccountId": 1234,
          "AccountNumber": "GB99215176",
          "AccountName": "MATTHEW ALGIE & COMPANY LIMITED",
          "AccountShortName": "MATTHEW ALGIE & COMPANY LIMITED",
          "Quantity": 123.12,
          "FuelProduct": true,
          "UnitPriceInTransactionCurrency": 123.12,
          "UnitPriceInInvoiceCurrency": 123.12,
          "UnitDiscountTransactionCurrency": 123.12,
          "UnitDiscountInvoiceCurrency": 123.12,
          "IsInvoiced": true,
          "InvoiceNumber": "S04500493",
          "InvoiceDate": "20231223",
          "SiteCode": "50001",
          "SiteName": "CHARNOCK RICHARD NTHBOUND MWSA 0755",
          "SiteCountry": "Germany",
          "Location": {
            "Lat": "37.4224764",
            "Lng": "122.0842499"
          },
          "CardGroupName": "006240 FIRE BRIGHT SOLUTIONS",
          "ReceiptNumber": "1234",
          "ProductCode": "TMF Charges",
          "ProductName": "Unleaded - High octane",
          "ProductGroupId": 1234,
          "ProductGroupName": "Parent Product Group",
          "DelCoExchangeRate": 123.12,
          "ColCoExchangeRate": 123.12,
          "IsShellSite": true,
          "Network": "Shell PH",
          "SiteGroupId": 202,
          "SiteGroupName": "CZ 9100 ECONOMY NETWORK",
          "PostingDate": "20231223 12:12:12",
          "IssuerCode": "7077 = CRT",
          "PurchasedInCountryCode": "NL",
          "CustomerCountryCode": "NL",
          "CustomerCountry": "Netherlands",
          "ReleaseCode": "8 for 702188",
          "CardGroupId": "200",
          "CardSequenceNumber": "2",
          "CheckDigit": "GHE1234",
          "FleetIDDescription": "Example description",
          "VATRate": 0.2,
          "VATCategory": "3-VAT exempt",
          "VATonNetAmount": 12.21,
          "VATCountry": "Netherlands",
          "EffectiveDiscountInTrxCurrency": 0,
          "TransactionType": "Purchase when Card is Present else Blank",
          "PINIndicator": "Y",
          "VATApplicable": "Y",
          "NetInvoiceIndicator": "Y",
          "CustomerCurrencyCode": "GBP",
          "CustomerCurrencySymbol": "£",
          "EffectiveUnitDiscountInCustomerCurrency": 123.12,
          "EffectiveDiscountInCustomerCurrency": 123.12,
          "VATonNetAmountInCustomerCurrency": 123.12,
          "DiscountType": "3-Percentage",
          "TransactionStatus": "U",
          "PayerGroup": "12119008",
          "RefundFlag": "N",
          "OriginalSalesItemId": "1231",
          "DelcoName": "SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV",
          "DelcoCode": "NL10042616",
          "PayerName": "V.M. LE COMTE",
          "CardExpiryPeriod": "1901",
          "AuthorisationCode": "11256",
          "TransactionId": "io9KVXk1UkW57XWKyeaHHg",
          "TransactionLine": "1",
          "AllowClearing": "Y",
          "CRMNumber": "ABCD1234",
          "DisputeStatus": "6\tCharged Back to Site",
          "RebateRate": 28.279,
          "DelCoToColCoExchangeRate": 1,
          "NetEuroAmount": 37.93,
          "EuroRebateAmount": 0,
          "EuroVATAmount": 7.96,
          "ParentCustomerNumber": "DRG1234"
        }
      ]
    }
  ]
}

Example 10: Get Card Usage Summary

Request:

POST /transaction-data/v1/cardusagesummary

{
  "ColCoId": 1,
  "ColCoCode": 86,
  "PayerId": 12345,
  "PayerNumber": "GB000000123",
  "AccountId": 1234,
  "AccountNumber": "GB000000123",
  "CardId": 1234,
  "PAN": "7882861007636000020",
  "CardExpiry": "20311223"
}

Response:

{
  "RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
  "Status": "SUCCESS",
  "Data": [
    {
      "UsageSummary": [
        {
          "Date": "20170930",
          "ProductId": 1,
          "ProductCode": "2",
          "ProductName": "Diesel AGO",
          "IsFuelProduct": true,
          "SiteGroupId": 1234,
          "SiteGroupName": "UK 9500 MOTORWAY NETWORK",
          "TotalVolume": 123.12,
          "TotalGross": 123.12,
          "TotalNet": 123.12,
          "CurrencyCode": "GBP",
          "CurrencySymbol": "£",
          "ProductGroupId": 1234,
          "ProductGroupName": "Motor gasoline"
        }
      ]
    }
  ]
}

Error Handling

Common Error Codes

HTTP Status Error Code Description Solution
200 N/A Status: SUCCESS N/A
200 E0001 Validation Error Check request parameters
401 E0003 Unauthorized Verify OAuth token is valid
403 E0003 Forbidden Check user permissions
404 E0005 Resource Not Found Verify endpoint URL and resource exists
500 E0002 Unknown Error / Internal Server Error Contact support

Best Practices

1. Adopt OAuth 2.0 Authentication

IMPORTANT: All customers should migrate to OAuth 2.0 authentication. Implement proper token management:

  • Cache access tokens and reuse until expiry
  • Refresh tokens before they expire (recommended 60 seconds before)
  • Store client credentials securely (use environment variables or secrets manager)
  • Never log or expose access tokens in client-side code

2. Use Request IDs

Always include a unique RequestId (GUID format) for end-to-end traceability

3. Implement Pagination

For large transaction datasets, use pagination to avoid timeouts:

  • Set appropriate PageSize (recommended: 50-100 records)
  • Process pages sequentially or in parallel
  • Handle TotalPages and TotalRecords in responses

4. Use Date Filters Wisely

When querying transaction data:

  • Limit date ranges to avoid large result sets
  • Use FromDate and ToDate filters consistently
  • Consider querying by month or week for better performance

5. Test in Sandbox Environment

Always test integration in the Test/Sandbox environment before moving to production

6. Cache Reference Data

Cache volume-based pricing and bonus rules to minimize API calls:

  • These rules change infrequently
  • Refresh cache periodically (e.g., daily)
  • Use IncludeHistory parameter only when needed

SDK & Code Examples

Shell provides official SDKs and comprehensive code examples to accelerate your integration with the Transaction Data API.

Available SDK Languages

  • Python - Full-featured SDK with OAuth 2.0 support
  • TypeScript - Type-safe SDK with full type definitions
  • Java - Enterprise-grade SDK
  • C#/.NET - Complete .NET integration
  • PHP - Easy-to-use PHP library
  • Ruby - Ruby gem for seamless integration

View Official SDKs & Documentation

Support & Resources

Technical Support

Documentation

Getting Help

When contacting support, provide:

  1. Your client_id (never share your client_secret or access tokens)
  2. RequestId from the API response
  3. Timestamp of the request
  4. Environment (Production/Test)

Last Updated: July 1, 2026
Document Version: 1.0
API Version: 2.3.5

About us

The Shell Developer Portal supports partners in onboarding to Shell APIs and turning ideas into production-ready solutions.

 

Shell logo

Contact

Login to your account

Ask AI Assistant about Shell APIs and API Products