> ## Documentation Index
> Fetch the complete documentation index at: https://docs.canton.network/llms.txt
> Use this file to discover all available pages before exploring further.

# Splice.Wallet.BuyTrafficRequest

> Documentation for Splice.Wallet.BuyTrafficRequest

## Templates

<div id="type-splice-wallet-buytrafficrequest-buytrafficrequest-65116">
  **template** BuyTrafficRequest
</div>

> A request by an end-user to the wallet's automation to buy traffic for a sequencer member
>
> Signatory: endUserParty
>
> | Field          | Type                                                                                     | Description                       |
> | -------------- | ---------------------------------------------------------------------------------------- | --------------------------------- |
> | dso            | [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932) |                                   |
> | endUserParty   | [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932) |                                   |
> | expiresAt      | [Time](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-time-63886)   | Buy the traffic before this time. |
> | trackingId     | [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952)        | Used to deduplicate requests      |
> | trafficAmount  | [Int](/appdev/reference/daml-standard-library/prelude#type-ghc-types-int-37261)          |                                   |
> | memberId       | [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952)        |                                   |
> | synchronizerId | [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952)        |                                   |
> | migrationId    | [Int](/appdev/reference/daml-standard-library/prelude#type-ghc-types-int-37261)          |                                   |
>
> * **Choice** Archive
>
>   Controller: endUserParty
>
>   Returns: ()
>
>   (no fields)
>
> * <div id="type-splice-wallet-buytrafficrequest-buytrafficrequestcancel-52564">
>     **Choice** BuyTrafficRequest\_Cancel
>   </div>
>
>   Controller: endUserParty
>
>   Returns: BuyTrafficRequest\_CancelResult
>
>   | Field  | Type                                                                              | Description |
>   | ------ | --------------------------------------------------------------------------------- | ----------- |
>   | reason | [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952) |             |
>
> * <div id="type-splice-wallet-buytrafficrequest-buytrafficrequestcomplete-61949">
>     **Choice** BuyTrafficRequest\_Complete
>   </div>
>
>   Controller: endUserParty, walletProvider
>
>   Returns: BuyTrafficRequest\_CompleteResult
>
>   | Field          | Type                                                                                     | Description |
>   | -------------- | ---------------------------------------------------------------------------------------- | ----------- |
>   | inputs         | \[TransferInput]                                                                         |             |
>   | context        | PaymentTransferContext                                                                   |             |
>   | walletProvider | [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932) |             |
>
> * <div id="type-splice-wallet-buytrafficrequest-buytrafficrequestexpire-77595">
>     **Choice** BuyTrafficRequest\_Expire
>   </div>
>
>   Controller: endUserParty
>
>   Returns: BuyTrafficRequest\_ExpireResult
>
>   (no fields)

## Data Types

<div id="type-splice-wallet-buytrafficrequest-buytrafficrequesttrackinginfo-63943">
  **data** BuyTrafficRequestTrackingInfo
</div>

> <div id="constr-splice-wallet-buytrafficrequest-buytrafficrequesttrackinginfo-4476">
>   BuyTrafficRequestTrackingInfo
> </div>
>
> > | Field        | Type                                                                                     | Description                                           |
> > | ------------ | ---------------------------------------------------------------------------------------- | ----------------------------------------------------- |
> > | trackingId   | [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952)        | used to deduplicate requests and query for the status |
> > | endUserParty | [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932) | used in UserWalletTxLogParser's filterByParty         |
>
> **instance** [Eq](/appdev/reference/daml-standard-library/prelude#class-ghc-classes-eq-22713) BuyTrafficRequestTrackingInfo
>
> **instance** [Show](/appdev/reference/daml-standard-library/prelude#class-ghc-show-show-65360) BuyTrafficRequestTrackingInfo
>
> **instance** GetField "endUserParty" BuyTrafficRequestTrackingInfo [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932)
>
> **instance** GetField "trackingId" BuyTrafficRequestTrackingInfo [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952)
>
> **instance** GetField "trackingInfo" BuyTrafficRequest\_CancelResult BuyTrafficRequestTrackingInfo
>
> **instance** GetField "trackingInfo" BuyTrafficRequest\_CompleteResult BuyTrafficRequestTrackingInfo
>
> **instance** GetField "trackingInfo" BuyTrafficRequest\_ExpireResult BuyTrafficRequestTrackingInfo
>
> **instance** GetField "trackingInfo" WalletAppInstall\_BuyTrafficRequest\_CancelResult BuyTrafficRequestTrackingInfo
>
> **instance** GetField "trackingInfo" WalletAppInstall\_BuyTrafficRequest\_ExpireResult BuyTrafficRequestTrackingInfo
>
> **instance** SetField "endUserParty" BuyTrafficRequestTrackingInfo [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932)
>
> **instance** SetField "trackingId" BuyTrafficRequestTrackingInfo [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952)
>
> **instance** SetField "trackingInfo" BuyTrafficRequest\_CancelResult BuyTrafficRequestTrackingInfo
>
> **instance** SetField "trackingInfo" BuyTrafficRequest\_CompleteResult BuyTrafficRequestTrackingInfo
>
> **instance** SetField "trackingInfo" BuyTrafficRequest\_ExpireResult BuyTrafficRequestTrackingInfo
>
> **instance** SetField "trackingInfo" WalletAppInstall\_BuyTrafficRequest\_CancelResult BuyTrafficRequestTrackingInfo
>
> **instance** SetField "trackingInfo" WalletAppInstall\_BuyTrafficRequest\_ExpireResult BuyTrafficRequestTrackingInfo

<div id="type-splice-wallet-buytrafficrequest-buytrafficrequestcancelresult-81241">
  **data** BuyTrafficRequest\_CancelResult
</div>

> <div id="constr-splice-wallet-buytrafficrequest-buytrafficrequestcancelresult-28380">
>   BuyTrafficRequest\_CancelResult
> </div>
>
> > | Field        | Type                          | Description |
> > | ------------ | ----------------------------- | ----------- |
> > | trackingInfo | BuyTrafficRequestTrackingInfo |             |
>
> **instance** GetField "trackingInfo" BuyTrafficRequest\_CancelResult BuyTrafficRequestTrackingInfo
>
> **instance** SetField "trackingInfo" BuyTrafficRequest\_CancelResult BuyTrafficRequestTrackingInfo
>
> **instance** [HasExercise](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hasexercise-70422) BuyTrafficRequest BuyTrafficRequest\_Cancel BuyTrafficRequest\_CancelResult
>
> **instance** [HasFromAnyChoice](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hasfromanychoice-81184) BuyTrafficRequest BuyTrafficRequest\_Cancel BuyTrafficRequest\_CancelResult
>
> **instance** [HasToAnyChoice](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hastoanychoice-82571) BuyTrafficRequest BuyTrafficRequest\_Cancel BuyTrafficRequest\_CancelResult

<div id="type-splice-wallet-buytrafficrequest-buytrafficrequestcompleteresult-44764">
  **data** BuyTrafficRequest\_CompleteResult
</div>

> <div id="constr-splice-wallet-buytrafficrequest-buytrafficrequestcompleteresult-27129">
>   BuyTrafficRequest\_CompleteResult
> </div>
>
> > | Field              | Type                                                                                                                                                                                                            | Description |
> > | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
> > | purchasedTraffic   | [ContractId](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-contractid-95282) MemberTraffic                                                                                                |             |
> > | trackingInfo       | BuyTrafficRequestTrackingInfo                                                                                                                                                                                   |             |
> > | senderChangeAmulet | [Optional](/appdev/reference/daml-standard-library/prelude#type-da-internal-prelude-optional-37153) ([ContractId](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-contractid-95282) Amulet) |             |
>
> **instance** GetField "purchasedTraffic" BuyTrafficRequest\_CompleteResult ([ContractId](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-contractid-95282) MemberTraffic)
>
> **instance** GetField "senderChangeAmulet" BuyTrafficRequest\_CompleteResult ([Optional](/appdev/reference/daml-standard-library/prelude#type-da-internal-prelude-optional-37153) ([ContractId](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-contractid-95282) Amulet))
>
> **instance** GetField "trackingInfo" BuyTrafficRequest\_CompleteResult BuyTrafficRequestTrackingInfo
>
> **instance** SetField "purchasedTraffic" BuyTrafficRequest\_CompleteResult ([ContractId](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-contractid-95282) MemberTraffic)
>
> **instance** SetField "senderChangeAmulet" BuyTrafficRequest\_CompleteResult ([Optional](/appdev/reference/daml-standard-library/prelude#type-da-internal-prelude-optional-37153) ([ContractId](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-contractid-95282) Amulet))
>
> **instance** SetField "trackingInfo" BuyTrafficRequest\_CompleteResult BuyTrafficRequestTrackingInfo
>
> **instance** [HasExercise](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hasexercise-70422) BuyTrafficRequest BuyTrafficRequest\_Complete BuyTrafficRequest\_CompleteResult
>
> **instance** [HasFromAnyChoice](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hasfromanychoice-81184) BuyTrafficRequest BuyTrafficRequest\_Complete BuyTrafficRequest\_CompleteResult
>
> **instance** [HasToAnyChoice](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hastoanychoice-82571) BuyTrafficRequest BuyTrafficRequest\_Complete BuyTrafficRequest\_CompleteResult

<div id="type-splice-wallet-buytrafficrequest-buytrafficrequestexpireresult-25706">
  **data** BuyTrafficRequest\_ExpireResult
</div>

> <div id="constr-splice-wallet-buytrafficrequest-buytrafficrequestexpireresult-5207">
>   BuyTrafficRequest\_ExpireResult
> </div>
>
> > | Field        | Type                          | Description |
> > | ------------ | ----------------------------- | ----------- |
> > | trackingInfo | BuyTrafficRequestTrackingInfo |             |
>
> **instance** GetField "trackingInfo" BuyTrafficRequest\_ExpireResult BuyTrafficRequestTrackingInfo
>
> **instance** SetField "trackingInfo" BuyTrafficRequest\_ExpireResult BuyTrafficRequestTrackingInfo
>
> **instance** [HasExercise](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hasexercise-70422) BuyTrafficRequest BuyTrafficRequest\_Expire BuyTrafficRequest\_ExpireResult
>
> **instance** [HasFromAnyChoice](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hasfromanychoice-81184) BuyTrafficRequest BuyTrafficRequest\_Expire BuyTrafficRequest\_ExpireResult
>
> **instance** [HasToAnyChoice](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hastoanychoice-82571) BuyTrafficRequest BuyTrafficRequest\_Expire BuyTrafficRequest\_ExpireResult
