> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/partner/fr/billing-api/wallet/listwallets.md).

# Lister tous les portefeuilles

## List all wallets

> This endpoint retrieves a list of wallets based on specified filters and parameters, including team ID, wallet name, wallet ID, external ID, and more. Supports pagination and sorting to manage large sets of data effectively.

```json
{"openapi":"3.0.0","info":{"title":"Citrus Billing API","version":"v2"},"tags":[],"servers":[{"url":"https://billing.<env>.citrusad.com"}],"security":[{"TokenSecurity":[]}],"components":{"securitySchemes":{"TokenSecurity":{"description":"For accessing the API a valid JWT must be passed in all queries in the 'Authorization' header. The following syntax must be used in the 'Authorization' header. (Bearer xxx.yyy.zzz)","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"v2ListWalletsResponse":{"properties":{"nextPageToken":{"description":"The page token for requesting the next page of the pagination. Should be used as \"pageToken\" in the request.","type":"string"},"totalCount":{"description":"The total number of wallets that meet the specified criteria.","format":"int64","type":"string"},"wallets":{"description":"The list of wallets that match the criteria specified in the request.","items":{"$ref":"#/components/schemas/v2ListWallet"},"type":"array"}},"type":"object"},"v2ListWallet":{"properties":{"archived":{"description":"Indicates whether the wallet is archived.","type":"boolean"},"availableBalance":{"description":"Shows the amount available in the wallet for spending.","type":"string"},"cappedAvailableBalance":{"description":"Reflects the remaining amount available for spending under daily or monthly caps. If no caps are set, this equals the available balance, and unspent funds roll over to the next day.","type":"string"},"creditLimit":{"description":"Specifies the maximum credit limit assigned to the wallet.","type":"string"},"currencyCode":{"description":"Indicates the currency code of the wallet, using the 3-letter ISO 4217 standard.","type":"string"},"currentBalance":{"description":"Displays the total amount currently in the wallet.","type":"string"},"dailyBudget":{"description":"The limit amount that determines the daily spend of the wallet.","type":"string"},"externalId":{"description":"Specifies the optional external ID field to store custom identifiers, such as Placement IO numbers, purchase order numbers, or Salesforce numbers, for tracking purposes. This field is available for partners to associate external identifiers with the wallet. Ensure the external ID is shorter than 255 characters, as no other validation is applied.","type":"string"},"id":{"description":"Represents the identifier of the wallet.","type":"string"},"name":{"description":"The name of the wallet.","type":"string"},"namespaceId":{"description":"Specifies the unique identifier of the team that the wallet will be associated with. ","type":"string"},"teamId":{"description":"The unique identifier of the team to which the wallet is assigned.","type":"string"}},"type":"object"},"rpcStatus":{"description":"The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).","properties":{"code":{"description":"The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details.  There is a common set of\nmessage types for APIs to use.","items":{"$ref":"#/components/schemas/protobufAny"},"type":"array"},"message":{"description":"A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.","type":"string"}},"type":"object"},"protobufAny":{"additionalProperties":{},"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n    // or ...\n    if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n      foo = any.unpack(Foo.getDefaultInstance());\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := anypb.New(foo)\n     if err != nil {\n       ...\n     }\n     ...\n     foo := &pb.Foo{}\n     if err := any.UnmarshalTo(foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"@type":{"description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.","type":"string"}},"type":"object"}}},"paths":{"/v2/wallets":{"get":{"description":"This endpoint retrieves a list of wallets based on specified filters and parameters, including team ID, wallet name, wallet ID, external ID, and more. Supports pagination and sorting to manage large sets of data effectively.","operationId":"listWallets","parameters":[{"description":"Use this token to paginate through the list of wallets. Pass it in subsequent requests to continue from where the previous call left off.","in":"query","name":"pageToken","required":false,"schema":{"type":"string"}},{"description":"Define the number of wallets to return per page. Defaults to 20 if not specified.","in":"query","name":"pageSize","required":false,"schema":{"default":"20","format":"int64","type":"string"}},{"description":"Filter the list to include only wallets that belong to the specified team.","in":"query","name":"teamId","required":false,"schema":{"type":"string"}},{"description":"Filters results to show only archived wallets when set to true.","in":"query","name":"archived","required":false,"schema":{"type":"boolean"}},{"description":"Filters wallets by the specified wallet name.","in":"query","name":"name","required":false,"schema":{"type":"string"}},{"description":"Defines the key for sorting wallets, enabling you to tailor wallet organization to your needs. You can sort by keys such as name and available balance, and set the order to either ascending (ASC) or descending (DESC). Specify both the key and order to achieve precise sorting results.","in":"query","name":"sortOptions.key","required":false,"schema":{"enum":["SORT_OPTION_KEY_NAME","SORT_OPTION_KEY_AVAILABLE_BALANCE"],"type":"string"}},{"description":"Specifies the order in which the wallets are sorted. Choose from ascending (SORT_OPTION_ORDER_ASC) or descending (SORT_OPTION_ORDER_DESC) order.","in":"query","name":"sortOptions.order","required":false,"schema":{"default":"SORT_OPTION_ORDER_ASC","enum":["SORT_OPTION_ORDER_ASC","SORT_OPTION_ORDER_DESC"],"type":"string"}},{"description":"Filter wallets using specified wallet IDs. You can include up to 50 wallet IDs in your request, separated by commas.","in":"query","name":"id","required":false,"schema":{"type":"string"}},{"description":"Filters wallets using the specified external ID. This field allows the storage of custom identifiers for tracking purposes, such as Placement IO numbers, purchase order numbers, or Salesforce numbers. It is available for partners to associate external identifiers with the wallet. Ensure the external ID is less than 255 characters, as no additional validation is applied.","in":"query","name":"externalId","required":false,"schema":{"type":"string"}},{"description":"The team ID used to verify access. Recommended for all requests.","in":"query","name":"requestTeamId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2ListWalletsResponse"}}},"description":"A list of wallets and a pagination token."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"There was a problem with input."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"Login failed or token not valid."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"Access denied due to insufficient permissions."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"An unexpected error response."}},"summary":"List all wallets","tags":["wallet"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.citrusad.com/retail-media-interface/partner/fr/billing-api/wallet/listwallets.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.