> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # QueryTransactions # Package: benefitPrograms # Namespace: TransactionService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/transactions/query-transactions.md ## Permission Scopes: SCOPE.BENEFIT_PROGRAMS.READ (PII): SCOPE.BENEFIT_PROGRAMS.READ_LIMITED ## Introduction Retrieves a list of transactions, given the provided paging, filtering, and sorting. Query Transactions has a default paging limit of 50, which you can override. For field support for filters and sorting, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/transactions/filtering-and-sorting.md). To learn how to query transactions, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). --- ## REST API ### Schema ``` Method: queryTransactions Description: Retrieves a list of transactions, given the provided paging, filtering, and sorting. Query Transactions has a default paging limit of 50, which you can override. For field support for filters and sorting, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/transactions/filtering-and-sorting.md). To learn how to query transactions, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). URL: https://www.wixapis.com/benefit-programs/v1/transactions/query Method: POST Method parameters: param name: query | type: CursorQuery - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Maximum number of items to return. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md) for more information. - name: sort | type: array | description: List of sort objects. - name: fieldName | type: string | description: Field to sort by. - name: order | type: SortOrder | description: Sort order. Use `ASC` for ascending order or `DESC` for descending order. Default: `ASC` - enum: - ASC: Ascending sort order. - DESC: Descending sort order. Return type: QueryTransactionsResponse - name: transactions | type: array | description: List of retrieved transactions. - name: id | type: string | description: Transaction GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the transaction is updated. - name: createdDate | type: string | description: Date and time the transaction was created. - name: updatedDate | type: string | description: Date and time the transaction was updated. - name: pool | type: PoolInfo | description: Pool associated with this transaction. - name: id | type: string | description: Pool GUID. - name: poolDefinitionId | type: string | description: GUID of the pool definition the pool was created from. - name: programDefinitionId | type: string | description: GUID of the program definition containing the pool definition the pool was created from. - name: externalProgramDefinitionId | type: string | description: External GUID of the program definition the pool was created from. - name: programId | type: string | description: GUID of the program that contains the pool. - name: externalProgramId | type: string | description: External GUID of the program that contains the pool. - name: creditAmount | type: string | description: Available credits. - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. - name: displayName | type: string | description: Pool name - name: benefitDisplayName | type: string | description: Benefit name - name: amount | type: string | description: Amount the balance was adjusted in this transaction. - name: source | type: BalanceType | description: Where the credits came from. - enum: - AVAILABLE: In a pool's balance. - EXTERNAL: Outside a pool's balance. - name: target | type: BalanceType | description: Where the credits went to. - name: idempotencyKey | type: string | description: Unique identifier, generated by the client. Used to recognize repeated attempts to make the same request. - name: relatedTransactionId | type: string | description: GUID of the related transaction. For example, if this transaction is a refund for a benefit redemption, the related transaction is the benefit redemption transaction. - name: beneficiary | type: IdentificationData | description: Beneficiary of the pool associated with this transaction. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site member. - name: wixUserId | type: string | description: GUID of a Wix user. - name: instructingParty | type: IdentificationData | description: Identity that created the transaction. - name: status | type: TransactionStatus | description: Transaction status. - enum: - PENDING: Transaction is pending. This is the initial transaction status. - COMPLETED: Transaction completed successfully. - FAILED: Transaction failed. - name: details | type: TransactionDetails | description: Additional transaction details. - name: item | type: Item | description: Item associated with the transaction. - name: id | type: string | description: Item GUID. - name: externalId | type: string | description: Item external GUID. - name: category | type: string | description: Item category. - name: itemSetId | type: string | description: Item set GUID. - name: displayName | type: string | description: Item name. - name: providerAppId | type: string | description: Provider app id - name: itemCount | type: integer | description: Amount of items associated with the transaction. - name: effectiveDate | type: string | description: Date and time the transaction was created. - name: reason | type: string | description: Reason for the transaction. For example, `Redemption`. - name: benefitKey | type: string | description: Benefit key associated with the transaction. - name: extendedFields | type: ExtendedFields | description: Custom field data for the transaction object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: externalId | type: string | description: External transaction GUID. - name: metadata | type: CursorPagingMetadata | description: Metadata for paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### QueryTransactions ```curl ~~~cURL curl https://www.wixapis.com/benefit-programs/v1/transactions/query \ -H 'Content-type: application/json' \ -H 'Authorization: ' --data '{ "query": { "filter": { "beneficiary.memberId": { "$eq": "d8f4a6c2-0e6a-4b89-bc3a-15e2dfe3c7a1" } } } }' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.benefitPrograms.TransactionService.queryTransactions(query) Description: Retrieves a list of transactions, given the provided paging, filtering, and sorting. Query Transactions has a default paging limit of 50, which you can override. For field support for filters and sorting, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/transactions/filtering-and-sorting.md). To learn how to query transactions, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: query Method parameters: param name: query | type: TransactionQuery | required: true - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Maximum number of items to return. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md) for more information. - name: sort | type: array | description: List of sort objects. - name: fieldName | type: string | description: Field to sort by. - name: order | type: SortOrder | description: Sort order. Use `ASC` for ascending order or `DESC` for descending order. Default: `ASC` - enum: - ASC: Ascending sort order. - DESC: Descending sort order. Return type: PROMISE - name: transactions | type: array | description: List of retrieved transactions. - name: _id | type: string | description: Transaction GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the transaction is updated. - name: _createdDate | type: Date | description: Date and time the transaction was created. - name: _updatedDate | type: Date | description: Date and time the transaction was updated. - name: pool | type: PoolInfo | description: Pool associated with this transaction. - name: _id | type: string | description: Pool GUID. - name: poolDefinitionId | type: string | description: GUID of the pool definition the pool was created from. - name: programDefinitionId | type: string | description: GUID of the program definition containing the pool definition the pool was created from. - name: externalProgramDefinitionId | type: string | description: External GUID of the program definition the pool was created from. - name: programId | type: string | description: GUID of the program that contains the pool. - name: externalProgramId | type: string | description: External GUID of the program that contains the pool. - name: creditAmount | type: string | description: Available credits. - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. - name: displayName | type: string | description: Pool name - name: benefitDisplayName | type: string | description: Benefit name - name: amount | type: string | description: Amount the balance was adjusted in this transaction. - name: source | type: BalanceType | description: Where the credits came from. - enum: - AVAILABLE: In a pool's balance. - EXTERNAL: Outside a pool's balance. - name: target | type: BalanceType | description: Where the credits went to. - name: idempotencyKey | type: string | description: Unique identifier, generated by the client. Used to recognize repeated attempts to make the same request. - name: relatedTransactionId | type: string | description: GUID of the related transaction. For example, if this transaction is a refund for a benefit redemption, the related transaction is the benefit redemption transaction. - name: beneficiary | type: IdentificationData | description: Beneficiary of the pool associated with this transaction. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site member. - name: wixUserId | type: string | description: GUID of a Wix user. - name: instructingParty | type: IdentificationData | description: Identity that created the transaction. - name: status | type: TransactionStatus | description: Transaction status. - enum: - PENDING: Transaction is pending. This is the initial transaction status. - COMPLETED: Transaction completed successfully. - FAILED: Transaction failed. - name: details | type: TransactionDetails | description: Additional transaction details. - name: item | type: Item | description: Item associated with the transaction. - name: _id | type: string | description: Item GUID. - name: externalId | type: string | description: Item external GUID. - name: category | type: string | description: Item category. - name: itemSetId | type: string | description: Item set GUID. - name: displayName | type: string | description: Item name. - name: providerAppId | type: string | description: Provider app id - name: itemCount | type: integer | description: Amount of items associated with the transaction. - name: effectiveDate | type: Date | description: Date and time the transaction was created. - name: reason | type: string | description: Reason for the transaction. For example, `Redemption`. - name: benefitKey | type: string | description: Benefit key associated with the transaction. - name: extendedFields | type: ExtendedFields | description: Custom field data for the transaction object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: externalId | type: string | description: External transaction GUID. - name: metadata | type: CursorPagingMetadata | description: Metadata for paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### queryTransactions ```javascript import { transactions } from '@wix/benefit-programs'; async function queryTransactions(query) { const response = await transactions.queryTransactions(query); }; ``` ### queryTransactions (with elevated permissions) ```javascript import { transactions } from '@wix/benefit-programs'; import { auth } from '@wix/essentials'; async function myQueryTransactionsMethod(query) { const elevatedQueryTransactions = auth.elevate(transactions.queryTransactions); const response = await elevatedQueryTransactions(query); } ``` ### queryTransactions (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { transactions } from '@wix/benefit-programs'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { transactions }, // Include the auth strategy and host as relevant }); async function queryTransactions(query) { const response = await myWixClient.transactions.queryTransactions(query); }; ``` ---