> 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 # GetTransaction # Package: benefitPrograms # Namespace: TransactionService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/transactions/get-transaction.md ## Permission Scopes: SCOPE.BENEFIT_PROGRAMS.READ (PII): SCOPE.BENEFIT_PROGRAMS.READ_LIMITED ## Introduction Retrieves a transaction. --- ## REST API ### Schema ``` Method: getTransaction Description: Retrieves a transaction. URL: https://www.wixapis.com/benefit-programs/v1/transactions/{transactionId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: transactionId Method parameters: param name: transactionId | type: none | required: true Return type: GetTransactionResponse - name: transaction | type: Transaction | description: Retrieved transaction. - 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. ``` ### Examples ### GetTransaction ```curl ~~~cURL curl https://www.wixapis.com/benefit-programs/v1/transactions/9fc6cade-d8b9-46c0-8255-4703afc01ce0 \ -H 'Content-type: application/json' \ -H 'Authorization: ' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.benefitPrograms.TransactionService.getTransaction(transactionId) Description: Retrieves a transaction. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: transactionId Method parameters: param name: transactionId | type: string | description: GUID of the transaction to retrieve. | required: true Return type: PROMISE - 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. ``` ### Examples ### getTransaction ```javascript import { transactions } from '@wix/benefit-programs'; async function getTransaction(transactionId) { const response = await transactions.getTransaction(transactionId); }; ``` ### getTransaction (with elevated permissions) ```javascript import { transactions } from '@wix/benefit-programs'; import { auth } from '@wix/essentials'; async function myGetTransactionMethod(transactionId) { const elevatedGetTransaction = auth.elevate(transactions.getTransaction); const response = await elevatedGetTransaction(transactionId); } ``` ### getTransaction (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 getTransaction(transactionId) { const response = await myWixClient.transactions.getTransaction(transactionId); }; ``` ---