> 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/bulk-operation-api/bulkwalletoperations/bulkwalletstatus.md).

# Retrieve bulk wallet operation status

## Retrieve bulk wallet operation status

> This endpoint retrieves the status of a bulk wallet operation using its bulk ID. It has been enhanced to support pagination (default: 20 items per page) and status-based filtering, for improved performance and targeted data retrieval. Use this endpoint to check the progress and completion status of bulk update operations.

```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":{"v2BulkWalletStatusResponse":{"properties":{"bulkId":{"description":"Unique identifier for the bulk operation.","type":"string"},"createdAt":{"description":"Timestamp when the bulk operation was created.","format":"date-time","type":"string"},"failureCount":{"description":"Number of items that failed processing.","format":"int64","type":"string"},"items":{"items":{"$ref":"#/components/schemas/citrusbillingv2BulkOperationItem"},"type":"array"},"nextPageToken":{"description":"Token to retrieve the next page of results.","type":"string"},"operationType":{"$ref":"#/components/schemas/v1BulkOperationType"},"resource":{"$ref":"#/components/schemas/v1BulkOperationResource"},"status":{"$ref":"#/components/schemas/v1BulkOperationStatus"},"successCount":{"description":"Number of items processed successfully.","format":"int64","type":"string"},"totalCount":{"description":"Total number of items in the bulk operation.","format":"int64","type":"string"},"updatedAt":{"description":"Timestamp when the bulk operation was last updated.","format":"date-time","type":"string"}},"type":"object"},"citrusbillingv2BulkOperationItem":{"properties":{"createWalletRequest":{"$ref":"#/components/schemas/v2Wallet"},"errorResponse":{"$ref":"#/components/schemas/v1ErrorResponse"},"status":{"$ref":"#/components/schemas/v1BulkItem"},"successResponse":{"$ref":"#/components/schemas/citrusbillingv2SuccessResponse"},"updateWalletRequest":{"$ref":"#/components/schemas/billingv2UpdateWallet"}},"type":"object"},"v2Wallet":{"properties":{"archived":{"description":"Whether the wallet is archived.","type":"boolean"},"creditLimit":{"description":"The maximum credit limit for the wallet.","type":"string"},"currencyCode":{"description":"The wallet currency code using the 3-letter ISO 4217 standard.","type":"string"},"dailyBudget":{"description":"The daily spending limit for the wallet.","type":"string"},"externalId":{"description":"The optional external ID field for storing custom identifiers such as Placement IO numbers, purchase order numbers, or Salesforce numbers for tracking purposes. Partners can use this field to associate external identifiers with the wallet. Must be shorter than 255 characters.","type":"string"},"id":{"description":"The wallet identifier.","readOnly":true,"type":"string"},"name":{"description":"The wallet name.","type":"string"},"namespaceId":{"description":"The namespace identifier that associates the wallet with a team.","type":"string"},"teamId":{"description":"The unique team identifier assigned for the wallet.","type":"string"}},"type":"object"},"v1ErrorResponse":{"properties":{"details":{"description":"Error details describing what went wrong during the operation.","type":"string"}},"type":"object"},"v1BulkItem":{"default":"BULK_ITEM_UNSPECIFIED","enum":["BULK_ITEM_UNSPECIFIED","BULK_ITEM_SUCCESS","BULK_ITEM_FAILED"],"type":"string"},"citrusbillingv2SuccessResponse":{"properties":{"message":{"description":"Success message for the operation.","type":"string"},"walletId":{"description":"The unique identifier of the wallet that was processed.","type":"string"}},"type":"object"},"billingv2UpdateWallet":{"properties":{"archived":{"description":"Whether the wallet is archived.","type":"boolean"},"creditLimit":{"description":"The maximum credit limit for the wallet.","type":"string"},"currencyCode":{"description":"The wallet currency code using the 3-letter ISO 4217 standard.","type":"string"},"dailyBudget":{"description":"The daily spending limit for the wallet.","type":"string"},"externalId":{"description":"The optional external ID field for storing custom identifiers such as Placement IO numbers, purchase order numbers, or Salesforce numbers for tracking purposes. Partners can use this field to associate external identifiers with the wallet. Must be shorter than 255 characters.","type":"string"},"id":{"description":"The wallet identifier.","type":"string"},"name":{"description":"The wallet name.","type":"string"},"namespaceId":{"description":"The namespace identifier that associates the wallet with a team. ","type":"string"},"teamId":{"description":"The unique team identifier assigned for the wallet.","type":"string"}},"required":["id"],"type":"object"},"v1BulkOperationType":{"default":"BULK_OPERATION_TYPE_UNSPECIFIED","enum":["BULK_OPERATION_TYPE_UNSPECIFIED","BULK_OPERATION_TYPE_CAMPAIGN_UPDATE","BULK_OPERATION_TYPE_CAMPAIGN_STATE_UPDATE","BULK_OPERATION_TYPE_WALLET_UPDATE","BULK_OPERATION_TYPE_TEAM_UPDATE","BULK_OPERATION_TYPE_WALLET_CREATE","BULK_OPERATION_TYPE_TEAM_CREATE","BULK_OPERATION_TYPE_CAMPAIGN_CREATE"],"type":"string"},"v1BulkOperationResource":{"default":"BULK_OPERATION_RESOURCE_UNSPECIFIED","enum":["BULK_OPERATION_RESOURCE_UNSPECIFIED","BULK_OPERATION_RESOURCE_BILLING","BULK_OPERATION_RESOURCE_CAMPAIGN","BULK_OPERATION_RESOURCE_AUTH"],"type":"string"},"v1BulkOperationStatus":{"default":"BULK_OPERATION_UNSPECIFIED","enum":["BULK_OPERATION_UNSPECIFIED","BULK_OPERATION_SUBMITTED","BULK_OPERATION_IN_PROGRESS","BULK_OPERATION_COMPLETED","BULK_OPERATION_FAILED"],"type":"string"},"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/bulk/status/{id}":{"get":{"description":"This endpoint retrieves the status of a bulk wallet operation using its bulk ID. It has been enhanced to support pagination (default: 20 items per page) and status-based filtering, for improved performance and targeted data retrieval. Use this endpoint to check the progress and completion status of bulk update operations.","operationId":"bulkWalletStatus","parameters":[{"description":"The unique identifier of the bulk operation.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Pagination token to retrieve the next page of results.","in":"query","name":"pageToken","required":false,"schema":{"type":"string"}},{"description":"The number of items to retrieve per page.","in":"query","name":"pageSize","required":false,"schema":{"format":"int64","type":"string"}},{"description":"Filter items by status (e.g., BULK_ITEM_SUCCESS, BULK_ITEM_FAILED).","in":"query","name":"status","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2BulkWalletStatusResponse"}}},"description":"Details of the bulk operation status and progress."},"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":"Retrieve bulk wallet operation status","tags":["BulkWalletOperations"]}}}}
```


---

# 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/bulk-operation-api/bulkwalletoperations/bulkwalletstatus.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.