---
schema_version: "1"
id: f91b774d4c478c2e29ec0ce7af4a2d6378735f99a073aaabbde862b5b715fdfa
title: Issued Device Tracking
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/financial_services/references/generated-api-specs/issued_device_tracking.md
canonical_url: https://developer.salesforce.com/docs/industries/fsc/references/issued_device_tracking
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6adb2431dd932029c8f99753753f762b2225ce826e42679e06e2db66c88d218d
products:
  - Agentforce Financial Services
  - Industries Integrations
---
Issued Device Tracking

# Issued Device Tracking

Use the Issued Device Tracking API to manage and track the lifecycle of devices such as debit and credit cards that are issued to customers.

**Version:** v1

Protocols: HTTPS.

## Operations

### GET Get tracking details

`GET /IssuedDeviceTracking/{issuedDeviceTrackingId}/Retrieve`

Get tracking details of the issued device for the specified tracking ID. You can also filter the details of a single shipment by the tracking number.

#### Parameters

*   `issuedDeviceTrackingId` (path, string, required) Unique identifier that's assigned to the specific device tracking transaction record.  
    Example: `123456789`.
*   `trackingNumber` (query, string) Filter results to the card matching this tracking number. If not specified, all cards on the tracking record are returned.  
    Example: `TRACK10001`.
*   `requestId` (query, string) The unique tracking ID of the request.  
    Example: `006E0000004TquXIAS`.
*   `flowRefId` (query, string) The unique reference ID of the flow from the source system of the request.  
    Example: `006E0077774TquXIAS`.

#### Responses

*   **200** Issued device tracking details retrieved.
    
    Media type: `application/json`. Schema: `RetrieveIssuedDeviceTrackingResponse`.
    
*   **400** The server couldn’t process the request due to a client error.
    
    Media type: `application/json`. Schema: `ErrorResponse`.
    
    _Example_
    
    ```
    errorCode: "400"
    errorMessage: Invalid request message.
    transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b
    timeStamp: 2019-09-30T15:27:49.274Z
    ```
    
*   **401** The server couldn't find any valid credentials to access the requested resource.
    
    Media type: `application/json`. Schema: `ErrorResponse`.
    
    _Example_
    
    ```
    errorCode: "401"
    errorMessage: Required credentials are missing or invalid.
    transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b
    timeStamp: 2019-09-30T15:27:49.274Z
    ```
    
*   **403** The server denied access to the requested resource.
    
    Media type: `application/json`. Schema: `ErrorResponse`.
    
    _Example_
    
    ```
    errorCode: "403"
    errorMessage: Access to the requested resource was denied.
    transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b
    timeStamp: 2019-09-30T15:27:49.274Z
    ```
    
*   **404** The server couldn’t find the requested resource.
    
    Media type: `application/json`. Schema: `ErrorResponse`.
    
    _Example_
    
    ```
    errorCode: "404"
    errorMessage: Requested resource was not found.
    transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b
    timeStamp: 2019-09-30T15:27:49.274Z
    ```
    
*   **405** The request method isn't supported for the requested resource.
    
    Media type: `application/json`. Schema: `ErrorResponse`.
    
    _Example_
    
    ```
    errorCode: "405"
    errorMessage: The target resource does not support the requested method.
    transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b
    timeStamp: 2019-09-30T15:27:49.274Z
    ```
    
*   **406** The target resource didn't have a current representation that was acceptable to the user agent.
    
    Media type: `application/json`. Schema: `ErrorResponse`.
    
    _Example_
    
    ```
    errorCode: "406"
    errorMessage: The requested resource cannot generate acceptable content according to the Accept headers sent in the request.
    transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b
    timeStamp: 2019-09-30T15:27:49.274Z
    ```
    
*   **415** The Accept header specified an unsupported media type.
    
    Media type: `application/json`. Schema: `ErrorResponse`.
    
    _Example_
    
    ```
    errorCode: "415"
    errorMessage: The server denied the request because it was not in a format supported by the target resource.
    transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b
    timeStamp: 2019-09-30T15:27:49.274Z
    ```
    
*   **429** The server exceeded the API request rate limit.
    
    Media type: `application/json`. Schema: `ErrorResponse`.
    
    _Example_
    
    ```
    errorCode: "429"
    errorMessage: The server denied the request due to exceeding rate limits.
    transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b
    timeStamp: 2019-09-30T15:27:49.274Z
    ```
    
*   **500** An internal error occurred while processing the API request.
    
    Media type: `application/json`. Schema: `ErrorResponse`.
    
    _Example_
    
    ```
    errorCode: "500"
    errorMessage: The server was unable to process the request due to an internal error.
    transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b
    timeStamp: 2019-09-30T15:27:49.274Z
    ```
    

## Schemas

### RetrieveIssuedDeviceTrackingResponse

Response details for retrieving issued device tracking information.

*   `IssuedDeviceTrackingId` (_string_, required) Unique identifier of the issued device tracking record.  
    Example: `123456789`.
*   `Cards` (_array of IssuedDeviceCardType_, required) List of cards that are associated with the issued device tracking record.

_Example_

```
{
  "IssuedDeviceTrackingId": "123456789",
  "Cards": [
    {
      "IssuedDeviceAllocationInstanceReference": {
        "ExternalCardReferenceId": "CARD10001",
        "DispatchDateTime": "2026-03-01T10:00:00.000-05:00",
        "ExpectedDeliveryDateTime": "2026-03-05T18:00:00.000-05:00"
      },
      "IssuedDeviceAllocationStatus": {
        "DeliveryStatus": "Delivered",
        "DeliveryDateTime": "2026-03-05T14:30:00.000-05:00"
      },
      "CardName": "Gold Debit Card",
      "Last4Digits": "5678",
      "CardType": "Debit",
      "FinancialAccountName": "Savings Account",
      "DeliveryAddress": "Flat 302, Green Heights, Pune",
      "ReceiverName": "Rahul Sharma",
      "DeliveryFailureReason": null,
      "TrackingNumber": "TRACK10001",
      "ProofOfDelivery": "POD123456"
    },
    {
      "IssuedDeviceAllocationInstanceReference": {
        "ExternalCardReferenceId": "CARD10002",
        "DispatchDateTime": "2026-03-01T10:00:00.000-05:00",
        "ExpectedDeliveryDateTime": "2026-03-10T18:00:00.000-05:00"
      },
      "IssuedDeviceAllocationStatus": {
        "DeliveryStatus": "DeliveryFailed",
        "DeliveryDateTime": null
      },
      "CardName": "Platinum Credit Card",
      "Last4Digits": "9012",
      "CardType": "Credit",
      "FinancialAccountName": "Primary Credit Account",
      "DeliveryAddress": "Flat 302, Green Heights, Pune",
      "ReceiverName": null,
      "DeliveryFailureReason": "Address Incorrect",
      "TrackingNumber": "TRACK10002",
      "ProofOfDelivery": null
    }
  ]
}
```

### ErrorResponse

Represents a standard message body to be returned with the error responses.

*   `errorCode` (_string_, required) The short code to identify the error.  
    Example: `INVALID_PARAMETER`.
*   `errorMessage` (_string_, required) The verbose, human-readable error message.  
    Example: `The value you entered is out of bounds`.
*   `transactionId` (_string_, required) The request identifier.  
    Example: `dd960082-abbf-47c2-8c65-f18eeb35848b`.
*   `timeStamp` (_datetime_, required) The event date and time.  
    Example: `2019-09-23T11:46:44.256-05:00`.

### IssuedDeviceCardType

Specifies the details of a single issued device (card).

*   `IssuedDeviceAllocationInstanceReference` (_object_, required) Metadata that contains the dispatch timestamp, business reference ID, and target delivery date.
    
    Includes all fields of `IssuedDeviceAllocationInstanceReferenceType`.
    
*   `IssuedDeviceAllocationStatus` (_object_, required) Current allocation status of the card and the actual delivery date.
    
    Includes all fields of `IssuedDeviceAllocationStatusType`.
    
*   `CardName` (_string_, required) Display name of the card, such as Rubix, Visa.  
    Example: `Gold Debit Card`.
*   `Last4Digits` (_string_, required) Last four digits of the card number.  
    Example: `5678`.
*   `CardType` (_string_, required)
    
    Type of card. Valid values:
    
    *   `Credit`
    *   `Debit`
    
      
    Example: `Debit`.
*   `FinancialAccountName` (_string_, required) Name of the financial account that's associated with the card.  
    Example: `Savings Account`.
*   `DeliveryAddress` (_string_, required) Delivery address of the card.  
    Example: `Flat 302, Green Heights, Pune`.
*   `ReceiverName` (_string | any_, required) Name of the person who received the card. Null if not yet delivered.
    
    _Example_
    
    ```
    Rahul Sharma
    ```
    
    One of: `string`, `any`.
    
    _Example_
    
    ```
    Rahul Sharma
    ```
    
*   `DeliveryFailureReason` (_string | any_, required) Reason of unsuccessful delivery. Null if delivery hasn't failed.
    
    _Example_
    
    ```
    Address Incorrect
    ```
    
    One of: `string`, `any`.
    
    _Example_
    
    ```
    Address Incorrect
    ```
    
*   `TrackingNumber` (_string_, required) Unique tracking number for the card shipment.  
    Example: `TRACK10001`.
*   `ProofOfDelivery` (_string | any_, required) Proof of delivery for reference, such as a picture showing customer received, or signature or acknowledgement from customer who received the card. Null if not yet delivered.
    
    _Example_
    
    ```
    POD123456
    ```
    
    One of: `string`, `any`.
    
    _Example_
    
    ```
    POD123456
    ```
    

### IssuedDeviceAllocationInstanceReferenceType

Identifier of the card together with its dispatch and expected delivery dates.

*   `ExternalCardReferenceId` (_string_, required) Card identifier that's assigned by an external system, such as a core banking system, card processor, issuer system, or client application. This parameter is used to correlate the card in this API with the corresponding card record in the external system.  
    Example: `CARD10001`.
*   `DispatchDateTime` (_datetime | any_, required) Specifies the date and time when the card was dispatched. Null or empty if unknown.
    
    _Example_
    
    ```
    2026-03-01T10:00:00.000-05:00
    ```
    
    One of: `datetime`, `any`.
    
    _Example_
    
    ```
    2026-03-01T10:00:00.000-05:00
    ```
    
*   `ExpectedDeliveryDateTime` (_datetime | any_, required) Specifies the date and time when the card is expected to be delivered. This parameter is used to track delivery delays. Null or empty if unknown.
    
    _Example_
    
    ```
    2026-03-05T18:00:00.000-05:00
    ```
    
    One of: `datetime`, `any`.
    
    _Example_
    
    ```
    2026-03-05T18:00:00.000-05:00
    ```
    

### IssuedDeviceAllocationStatusType

Current allocation status of the card and the date on which the card was delivered.

*   `DeliveryStatus` (_string_, required)
    
    Current allocation status of the card. Valid values are:
    
    *   `Delivered`
    *   `DeliveryFailed`
    *   `InTransit`
    
      
    Example: `Delivered`.
*   `DeliveryDateTime` (_datetime | any_, required) Specifies the date and time when the card was delivered. Null if the card has not been delivered.
    
    _Example_
    
    ```
    2026-03-05T14:30:00.000-05:00
    ```
    
    One of: `datetime`, `any`.
    
    _Example_
    
    ```
    2026-03-05T14:30:00.000-05:00
    ```