# Wpay

- [Build with Wpay](https://integration.wpay.com.au/guides/get-started.md): Connect, build, and scale payments using the Wpay payments platform.
- [Accept payments on the web](https://integration.wpay.com.au/guides/payments/web.md): Choose the right web integration for your checkout: Embed or Secure Fields.
- [Accept payments on mobile](https://integration.wpay.com.au/guides/payments/mobile.md): Choose the right mobile integration for your app: Embed SDKs or Native SDKs.
- [Embed](https://integration.wpay.com.au/guides/payments/embed/quick-start/overview.md): Get set up with Embed as your web checkout experience.
- [Creating an API key for use with Embed](https://integration.wpay.com.au/guides/payments/embed/quick-start/key.md)
- [Generating tokens for authentication](https://integration.wpay.com.au/guides/payments/embed/quick-start/sdks.md)
- [Adding Embed](https://integration.wpay.com.au/guides/payments/embed/quick-start/embed.md)
- [Inspecting transactions](https://integration.wpay.com.au/guides/payments/embed/quick-start/inspect.md)
- [Going live](https://integration.wpay.com.au/guides/payments/embed/quick-start/live.md)
- [Digital wallets in Embed](https://integration.wpay.com.au/guides/payments/embed/digital-wallets.md)
- [Embed events](https://integration.wpay.com.au/guides/payments/embed/events.md)
- [Embed localization](https://integration.wpay.com.au/guides/payments/embed/locale.md)
- [Embed Theming](https://integration.wpay.com.au/guides/payments/embed/theming.md)
- [Embed options](https://integration.wpay.com.au/guides/payments/embed/options.md)
- [In-app browsers with Embed](https://integration.wpay.com.au/guides/payments/embed/in-app-browsers.md)
- [Common issues with Embed](https://integration.wpay.com.au/guides/payments/embed/common-issues.md)
- [Android SDK](https://integration.wpay.com.au/guides/payments/android/quick-start/overview.md): Get set up with the Android SDK for your checkout experience.
- [Creating an API key for use with Android](https://integration.wpay.com.au/guides/payments/android/quick-start/key.md)
- [Generating tokens for authentication](https://integration.wpay.com.au/guides/payments/android/quick-start/sdks.md)
- [Installing the Android SDK](https://integration.wpay.com.au/guides/payments/android/quick-start/android.md)
- [Creating transactions](https://integration.wpay.com.au/guides/payments/android/quick-start/transact.md)
- [Google Pay on Android](https://integration.wpay.com.au/guides/payments/android/google-pay.md)
- [Android events](https://integration.wpay.com.au/guides/payments/android/events.md)
- [Android options](https://integration.wpay.com.au/guides/payments/android/options.md)
- [iOS SDK](https://integration.wpay.com.au/guides/payments/ios/quick-start/overview.md): Get set up with the iOS SDK for your checkout experience.
- [Creating an API key for use with iOS](https://integration.wpay.com.au/guides/payments/ios/quick-start/key.md)
- [Generating tokens for authentication](https://integration.wpay.com.au/guides/payments/ios/quick-start/sdks.md)
- [Installing the iOS SDK](https://integration.wpay.com.au/guides/payments/ios/quick-start/ios.md)
- [Creating transactions](https://integration.wpay.com.au/guides/payments/ios/quick-start/transact.md)
- [Apple Pay on iOS](https://integration.wpay.com.au/guides/payments/ios/apple-pay.md)
- [iOS events](https://integration.wpay.com.au/guides/payments/ios/events.md)
- [iOS options](https://integration.wpay.com.au/guides/payments/ios/options.md)
- [React Native SDK](https://integration.wpay.com.au/guides/payments/react-native/quick-start/overview.md): Get set up with the React Native mobile SDK for your checkout experience.
- [Creating an API key for use with React Native](https://integration.wpay.com.au/guides/payments/react-native/quick-start/key.md)
- [Generating tokens for authentication](https://integration.wpay.com.au/guides/payments/react-native/quick-start/sdks.md)
- [Installing the React Native SDK](https://integration.wpay.com.au/guides/payments/react-native/quick-start/embed.md)
- [Creating transactions](https://integration.wpay.com.au/guides/payments/react-native/quick-start/transact.md)
- [Apple Pay on React Native](https://integration.wpay.com.au/guides/payments/react-native/apple-pay.md)
- [Google Pay on React Native](https://integration.wpay.com.au/guides/payments/react-native/google-pay.md)
- [React Native events](https://integration.wpay.com.au/guides/payments/react-native/events.md)
- [React Native options](https://integration.wpay.com.au/guides/payments/react-native/options.md)
- [Secure Fields](https://integration.wpay.com.au/guides/payments/secure-fields/quick-start/overview.md): Get set up with Secure Fields to vault and process cards.
- [Creating an API key for use with Secure Fields](https://integration.wpay.com.au/guides/payments/secure-fields/quick-start/key.md)
- [Creating checkout sessions](https://integration.wpay.com.au/guides/payments/secure-fields/quick-start/sdks.md)
- [Adding secure fields](https://integration.wpay.com.au/guides/payments/secure-fields/quick-start/embed.md)
- [Creating transactions](https://integration.wpay.com.au/guides/payments/secure-fields/quick-start/transact.md)
- [Secure Fields and 3DS](https://integration.wpay.com.au/guides/payments/secure-fields/three-d-secure.md): Handling 3DS in Secure Fields.
- [Secure Fields with stored cards](https://integration.wpay.com.au/guides/payments/secure-fields/stored-cards.md): Use Secure Fields to collect the CVV for cards previously stored.
- [Secure Fields theming](https://integration.wpay.com.au/guides/payments/secure-fields/theming.md): Each field can be customized to match the brand using the `styles` property when adding the field.
- [Secure Fields events](https://integration.wpay.com.au/guides/payments/secure-fields/events.md)
- [Direct API](https://integration.wpay.com.au/guides/payments/direct-api/quick-start/overview.md): Get set up with a direct API integration.
- [Authentication](https://integration.wpay.com.au/guides/payments/direct-api/quick-start/key.md)
- [Listing payment options](https://integration.wpay.com.au/guides/payments/direct-api/quick-start/payment-options.md)
- [Creating transactions](https://integration.wpay.com.au/guides/payments/direct-api/quick-start/transaction.md)
- [Handling redirects](https://integration.wpay.com.au/guides/payments/direct-api/quick-start/handle-redirect.md)
- [Getting transaction results](https://integration.wpay.com.au/guides/payments/direct-api/quick-start/status.md)
- [PayPal via the API](https://integration.wpay.com.au/guides/payments/direct-api/paypal.md)
- [Native Mobile SDKs](https://integration.wpay.com.au/guides/payments/native/overview.md)
- [Create an API key](https://integration.wpay.com.au/guides/payments/native/key.md)
- [Generating tokens for authentication](https://integration.wpay.com.au/guides/payments/native/sdks.md)
- [Vaulting card data](https://integration.wpay.com.au/guides/payments/native/vault.md)
- [Adding 3DS authentication](https://integration.wpay.com.au/guides/payments/native/3ds.md)
- [Card details](https://integration.wpay.com.au/guides/payments/native/get-card-details.md)
- [List payment options](https://integration.wpay.com.au/guides/payments/native/list-payment-options.md)
- [List buyer payment methods](https://integration.wpay.com.au/guides/payments/native/list-buyer-payment-methods.md)
- [SDK Response Reference](https://integration.wpay.com.au/guides/payments/native/responses.md)
- [Agentic Development Kit (ADK)](https://integration.wpay.com.au/guides/payments/adk/overview.md): Build AI-native storefronts within conversational AI platforms using Gr4vy.
- [ChatGPT ADK](https://integration.wpay.com.au/guides/payments/chatgpt-app/overview.md): Build an e-commerce ChatGPT app with product browsing, cart, and Gr4vy Embed checkout.
- [Architecture](https://integration.wpay.com.au/guides/payments/chatgpt-app/architecture.md): How MCP, tools, resources, and widgets fit together in a ChatGPT app.
- [Set up the project](https://integration.wpay.com.au/guides/payments/chatgpt-app/setup.md): Scaffold a ChatGPT app project with dependencies and Gr4vy configuration.
- [Build the MCP server](https://integration.wpay.com.au/guides/payments/chatgpt-app/mcp-server.md): Define data types, product catalog, HTTP transport, and MCP tools and resources.
- [Build the widgets](https://integration.wpay.com.au/guides/payments/chatgpt-app/widgets.md): Build the widget bridge, self-contained HTML widgets, and the build pipeline.
- [Integrate Gr4vy Embed](https://integration.wpay.com.au/guides/payments/chatgpt-app/gr4vy-embed.md): Generate embed tokens, load Gr4vy Embed in the checkout widget, and verify webhooks.
- [Deploy to ChatGPT](https://integration.wpay.com.au/guides/payments/chatgpt-app/deployment.md): Expose your MCP server over HTTPS, connect to ChatGPT, and go live.
- [Vaulting](https://integration.wpay.com.au/guides/features/vault-forwarding/overview.md)
- [Enable a Vault Forward endpoint](https://integration.wpay.com.au/guides/features/vault-forwarding/enable.md)
- [Vault Forward card data to API endpoint](https://integration.wpay.com.au/guides/features/vault-forwarding/forward.md)
- [Vault Forward card data from a checkout session](https://integration.wpay.com.au/guides/features/vault-forwarding/checkout-sessions.md)
- [Forward network tokens via Vault Forward](https://integration.wpay.com.au/guides/features/vault-forwarding/network-tokens.md)
- [Advanced authentication for Vault Forward](https://integration.wpay.com.au/guides/features/vault-forwarding/authentication.md)
- [Advanced authentication for Visa](https://integration.wpay.com.au/guides/features/vault-forwarding/visa.md)
- [commercetools Integration](https://integration.wpay.com.au/guides/payments/commercetools/overview.md): Bring Embed right into your commercetools ecommerce experience.
- [commercetools Installation](https://integration.wpay.com.au/guides/payments/commercetools/installation.md)
- [commercetools Configuration](https://integration.wpay.com.au/guides/payments/commercetools/configuration.md)
- [commercetools Administration](https://integration.wpay.com.au/guides/payments/commercetools/backend.md)
- [commercetools Frontend](https://integration.wpay.com.au/guides/payments/commercetools/frontend.md)
- [Magento Plugin](https://integration.wpay.com.au/guides/payments/magento/overview.md): Bring Embed right into your Magento ecommerce experience.
- [Magento Installation](https://integration.wpay.com.au/guides/payments/magento/installation.md)
- [Magento Configuration](https://integration.wpay.com.au/guides/payments/magento/configuration.md)
- [Magento Administration](https://integration.wpay.com.au/guides/payments/magento/backend.md)
- [Magento Frontend](https://integration.wpay.com.au/guides/payments/magento/frontend.md)
- [Salesforce Commerce Cloud Cartridge](https://integration.wpay.com.au/guides/payments/sfcc/overview.md): Bring Embed right into your Salesforce Commerce Cloud ecommerce experience.
- [Salesforce Commerce Cloud Installation](https://integration.wpay.com.au/guides/payments/sfcc/installation.md)
- [Salesforce Commerce Cloud Configuration](https://integration.wpay.com.au/guides/payments/sfcc/configuration.md)
- [Salesforce Commerce Cloud Administration](https://integration.wpay.com.au/guides/payments/sfcc/backend.md)
- [Salesforce Commerce Cloud Frontend](https://integration.wpay.com.au/guides/payments/sfcc/frontend.md)
- [Best practices](https://integration.wpay.com.au/guides/best-practices/overview.md): A list of best practices for integrating.
- [Identifiers & reconciliation](https://integration.wpay.com.au/guides/ids.md)
- [Idempotent requests](https://integration.wpay.com.au/guides/api/idempotent-requests.md): Best practices on handling retries in an idempotent way.
- [Handling transaction timeout](https://integration.wpay.com.au/guides/timeouts.md): Find the final status of a transaction or refund after a timeout and retry safely.
- [Command Line Interface (CLI)](https://integration.wpay.com.au/guides/tools/cli.md)
- [Postman Collection](https://integration.wpay.com.au/guides/tools/postman.md)
- [OpenAPI 3.1.0 Specification](https://integration.wpay.com.au/guides/api/openapi.md)
- [3-D Secure](https://integration.wpay.com.au/guides/features/3ds/overview.md)
- [3-D Secure Setup](https://integration.wpay.com.au/guides/features/3ds/setup.md): Configure 3-D Secure for your merchant account, turn it on for your connections, and learn how Gr4vy picks a scheme profile for each transaction.
- [Setup 3DS card schemes](https://integration.wpay.com.au/guides/features/3ds/schemes.md): Configure a 3-D Secure scheme profile for each card scheme, and learn what to enter in each field.
- [3-D Secure with multiple connections](https://integration.wpay.com.au/guides/features/3ds/multiple-connections.md): Learn how 3-D Secure works when a transaction can be routed to more than one connection, and how to set up 3DS configurations for multiple acquirers.
- [3-D Secure in Embed](https://integration.wpay.com.au/guides/features/3ds/embed.md)
- [Hosted 3-D Secure](https://integration.wpay.com.au/guides/features/3ds/hosted.md)
- [Native 3-D Secure](https://integration.wpay.com.au/guides/features/3ds/native.md)
- [Pass-through External 3-D Secure data](https://integration.wpay.com.au/guides/features/3ds/external.md)
- [3-D Secure testing](https://integration.wpay.com.au/guides/features/3ds/testing.md)
- [3DS Scenarios](https://integration.wpay.com.au/guides/features/3ds/scenarios.md)
- [Account Updater](https://integration.wpay.com.au/guides/features/account-updater/overview.md): Keep stored card details up to date automatically with batch and real-time account updates.
- [Manual account updates](https://integration.wpay.com.au/guides/features/account-updater/integration.md): Submit stored cards to the batch account updater through the API and handle the updated details.
- [Scheduled account updates](https://integration.wpay.com.au/guides/features/account-updater/scheduler.md)
- [Real time account updates](https://integration.wpay.com.au/guides/features/account-updater/real-time.md): Update stored card details automatically when a merchant-initiated payment is declined, and test it with the simulator.
- [Anti-fraud](https://integration.wpay.com.au/guides/features/anti-fraud/overview.md): Use decisions and scores from anti-fraud services in Flow rules to manage risk in your transaction flow.
- [Anti-fraud setup](https://integration.wpay.com.au/guides/features/anti-fraud/setup.md): Setting up an anti-fraud service
- [Silent mode](https://integration.wpay.com.au/guides/features/anti-fraud/silent-mode.md): Run additional anti-fraud services in Silent mode alongside your Primary service to compare and migrate without enforcing their decisions
- [Automatic anti-fraud device fingerprinting](https://integration.wpay.com.au/guides/features/anti-fraud/fingerprint.md): Enabling automatic device fingerprinting
- [Anti-fraud simulator](https://integration.wpay.com.au/guides/features/anti-fraud/simulator.md)
- [Apple Pay](https://integration.wpay.com.au/guides/features/apple-pay/overview.md)
- [Apple Pay on web with Embed](https://integration.wpay.com.au/guides/features/apple-pay/web.md)
- [Apple Pay on web without Embed](https://integration.wpay.com.au/guides/features/apple-pay/web-without-sdk.md)
- [Apple Pay on iOS with the SDK](https://integration.wpay.com.au/guides/features/apple-pay/ios.md)
- [Apple Pay on iOS without the SDK](https://integration.wpay.com.au/guides/features/apple-pay/ios-without-sdk.md)
- [Decrypted Apple Pay tokens](https://integration.wpay.com.au/guides/features/apple-pay/decrypted-tokens.md)
- [Click to Pay](https://integration.wpay.com.au/guides/features/click-to-pay/overview.md)
- [Click to Pay Setup](https://integration.wpay.com.au/guides/features/click-to-pay/setup.md)
- [Customer Authentication Module (CAM)](https://integration.wpay.com.au/guides/features/click-to-pay/cam.md)
- [Token Authentication Service (TAS)](https://integration.wpay.com.au/guides/features/click-to-pay/tas.md)
- [Gift Cards](https://integration.wpay.com.au/guides/features/gift-cards/overview.md)
- [Gift card simulator](https://integration.wpay.com.au/guides/features/gift-cards/simulator.md)
- [Split tender](https://integration.wpay.com.au/guides/features/gift-cards/split-tender.md)
- [Google Pay](https://integration.wpay.com.au/guides/features/google-pay/overview.md)
- [Google Pay on web with Embed](https://integration.wpay.com.au/guides/features/google-pay/web.md)
- [Google Pay on web without Embed](https://integration.wpay.com.au/guides/features/google-pay/web-without-sdk.md)
- [Google Pay on Android with the SDK](https://integration.wpay.com.au/guides/features/google-pay/mobile.md)
- [Google Pay on Android without the SDK](https://integration.wpay.com.au/guides/features/google-pay/mobile-without-sdk.md)
- [Decrypted Google Pay tokens](https://integration.wpay.com.au/guides/features/google-pay/decrypted-tokens.md)
- [Guest checkout](https://integration.wpay.com.au/guides/features/guest-checkout/overview.md): Create transactions without a creating a buyer first
- [Linking guests buyer details](https://integration.wpay.com.au/guides/features/guest-checkout/linking.md): Use guest buyer details in combination with stored buyer records and their payment methods
- [Vault token import](https://integration.wpay.com.au/guides/features/token-import/overview.md): Migrate stored cards, digital wallets, and other payment data from your current provider into the vault.
- [Token import file creation](https://integration.wpay.com.au/guides/features/token-import/token-import-file.md): Create a token import file with the column definitions for cards, digital wallets, non-card tokens, bank accounts, and gift cards.
- [Token import file upload](https://integration.wpay.com.au/guides/features/token-import/token-file-transmission.md)
- [Creating buyers & payment methods on import](https://integration.wpay.com.au/guides/features/token-import/buyer-payment-creation.md)
- [Incremental authorization](https://integration.wpay.com.au/guides/features/incremental-authorization/overview.md): Increase the amount of an existing card authorization when the final order total turns out higher than the amount you first authorized.
- [Multi captures](https://integration.wpay.com.au/guides/features/multi-captures/overview.md): Capture a single authorization in more than one step, drawing down the balance as you fulfill an order over time.
- [Network tokens](https://integration.wpay.com.au/guides/features/network-tokens/overview.md): Using scheme tokens with payment orchestration
- [Network token implementation](https://integration.wpay.com.au/guides/features/network-tokens/implementation.md): How to use scheme tokens with or without payment orchestration
- [Network token lifecycle management](https://integration.wpay.com.au/guides/features/network-tokens/lifecycle.md): Managing the full lifecycle of network tokens
- [Network Token Testing](https://integration.wpay.com.au/guides/features/network-tokens/testing.md)
- [Network token pass through](https://integration.wpay.com.au/guides/features/network-tokens/passthrough.md): Pass network tokens that you provision yourself through to a connection when you create a transaction.
- [Payment facilitators](https://integration.wpay.com.au/guides/features/payment-facilitators/overview.md): Process card payments as a payment facilitator (PayFac) by sending sub-merchant details to supported payment services.
- [Payment links](https://integration.wpay.com.au/guides/features/payment-links/overview.md): Set up payment links to accept payments from your customers.
- [Sharing the payment link](https://integration.wpay.com.au/guides/features/payment-links/sharing.md)
- [Payment link expiration and statuses](https://integration.wpay.com.au/guides/features/payment-links/statuses.md)
- [Paze](https://integration.wpay.com.au/guides/features/paze/overview.md): Understand how Paze works and how to add the bank-led US digital wallet to your checkout with Gr4vy.
- [Set up Paze](https://integration.wpay.com.au/guides/features/paze/setup.md): Activate Paze in the Gr4vy dashboard and configure your merchant details and domains.
- [Paze on web](https://integration.wpay.com.au/guides/features/paze/web.md): Add Paze to a web checkout using the Paze JavaScript SDK and the Gr4vy server SDK.
- [Paze on mobile](https://integration.wpay.com.au/guides/features/paze/mobile.md): Add Paze to native iOS and Android apps using the Paze mobile SDK and the Gr4vy server SDK.
- [Recurring payments](https://integration.wpay.com.au/guides/features/recurring-payments/overview.md): Flag recurring card payments correctly, and learn how Gr4vy stores and sends scheme transaction IDs for stored cards.
- [Common scenarios](https://integration.wpay.com.au/guides/features/recurring-payments/scenarios.md): Set the recurring payment flags for common checkout scenarios, from one-off payments to subscriptions and installments.
- [Recurring transactions with Embed](https://integration.wpay.com.au/guides/features/recurring-payments/embed.md)
- [Mastercard Transaction Link Identifier (TLID)](https://integration.wpay.com.au/guides/features/recurring-payments/mastercard-tlid.md): How Gr4vy captures and sends the Mastercard Transaction Link Identifier on recurring and other merchant-initiated card payments, and which connectors support it.
- [Card fingerprints](https://integration.wpay.com.au/guides/features/cards/fingerprints.md): A unique hash for every card in the vault
- [Payment account references](https://integration.wpay.com.au/guides/features/cards/payment-account-reference.md): A unique ID for the account behind the card
- [Shipment tracking](https://integration.wpay.com.au/guides/features/shipment-tracking/overview.md): Attach shipment tracking details to a capture and forward them to payment services that support them.
- [Transaction simulators](https://integration.wpay.com.au/guides/features/simulators/overview.md)
- [Transaction simulator webhooks](https://integration.wpay.com.au/guides/features/simulators/webhooks.md): Post webhook payloads to move simulated transactions, payouts, and refunds to their next state.
- [Webhooks](https://integration.wpay.com.au/guides/features/webhooks/overview.md)
- [Webhook payload](https://integration.wpay.com.au/guides/features/webhooks/payload.md)
- [Webhook events](https://integration.wpay.com.au/guides/features/webhooks/events.md)
- [Technical webhook considerations](https://integration.wpay.com.au/guides/features/webhooks/technical-considerations.md)
- [Webhook signatures](https://integration.wpay.com.au/guides/features/webhooks/signatures.md)
- [Transaction statuses](https://integration.wpay.com.au/guides/api/statuses/transactions.md): A list of all statuses for transactions.
- [Payment method statuses](https://integration.wpay.com.au/guides/api/statuses/payment-methods.md): Learn what each payment method status means, which stored payment methods you can charge, and how a stored payment method can fail.
- [Authentication](https://integration.wpay.com.au/guides/api/authentication.md): API authentication basics and best practices.
- [API Compatibility](https://integration.wpay.com.au/guides/api/compatibility.md): Learn how Gr4vy keeps the API backward compatible and how to keep your integration forward compatible.
- [Connectivity and TLS](https://integration.wpay.com.au/guides/api/connectivity.md): Review the TLS and security requirements for integrating with the Gr4vy API.
- [Authentication with JWTs](https://integration.wpay.com.au/guides/api/jwts.md)
- [Environments](https://integration.wpay.com.au/guides/api/environments.md): Sandbox and Production environments within an instance.
- [Error handling](https://integration.wpay.com.au/guides/api/errors.md): Best practices on handling errors and other exceptions.
- [Idempotent requests](https://integration.wpay.com.au/guides/api/idempotent-requests.md): Best practices on handling retries in an idempotent way.
- [IP address forwarding](https://integration.wpay.com.au/guides/api/ip-address-forwarding.md): Best practices on handling the original IP address for a transaction.
- [OpenAPI 3.1.0 Specification](https://integration.wpay.com.au/guides/api/openapi.md)
- [Pagination](https://integration.wpay.com.au/guides/api/pagination.md): Best practices on handling pagination in the API.
- [Prefer header](https://integration.wpay.com.au/guides/api/prefer-header.md)
- [Rate limiting](https://integration.wpay.com.au/guides/api/rate-limiting.md): Rate limits and enumeration prevention
- [Handling transaction timeout](https://integration.wpay.com.au/guides/timeouts.md): Find the final status of a transaction or refund after a timeout and retry safely.
- [Transaction error codes](https://integration.wpay.com.au/guides/api/error-codes.md): A list of all error codes for transactions.
- [List transactions](https://integration.wpay.com.au/reference/transactions/list-transactions.md): Returns a paginated list of transactions for the merchant account, sorted by most recently updated. You can filter, sort, and search transactions using query parameters.
- [Create transaction](https://integration.wpay.com.au/reference/transactions/new-transaction.md): Create a new transaction using a supported payment method. If additional buyer authorization is required, an approval URL will be returned. Duplicated gift card numbers are not supported.
- [Get transaction](https://integration.wpay.com.au/reference/transactions/get-transaction.md): Retrieve the details of a transaction by its unique identifier.
- [Capture transaction](https://integration.wpay.com.au/reference/transactions/capture-transaction.md): Captures a previously authorized transaction. You can capture the full or a partial amount, as long as it does not exceed the authorized amount (unless over-capture is enabled).
- [Void transaction](https://integration.wpay.com.au/reference/transactions/void-transaction.md): Voids a previously authorized transaction. If the transaction was not yet successfully authorized, or was already captured, the void will not be processed. This operation releases the hold on the buyer's funds. Captured transactions can be refunded instead.
- [Increment transaction authorization](https://integration.wpay.com.au/reference/transactions/increment-transaction-authorization.md): Increment the transaction authorization amount of a given transaction_id.
- [List transaction events](https://integration.wpay.com.au/reference/transactions/list-transaction-events.md): Retrieve a paginated list of events related to processing a transaction, including status changes, API requests, and webhook delivery attempts. Events are listed in chronological order, with the most recent events first.
- [List transaction Flow rules](https://integration.wpay.com.au/reference/transactions/list-transaction-actions.md): Retrieve the list of Flow rule actions that have been triggered for a transaction.
- [Sync transaction](https://integration.wpay.com.au/reference/transactions/sync-transaction.md): Synchronizes the status of a transaction with the underlying payment service provider. This is useful for transactions in a pending state to check if they've been completed or failed. Only available for some payment service providers.
- [Update a transaction](https://integration.wpay.com.au/reference/transactions/update-transaction.md): Manually updates a transaction.
- [Cancel a transaction](https://integration.wpay.com.au/reference/transactions/cancel-transaction.md): Cancels a pending transaction. If the transaction was successfully authorized, or was already captured, the cancel will not be processed.
- [Get or update transaction session](https://integration.wpay.com.au/reference/transactions/get-transaction-session.md): Gets and/or updates a transaction's session, where the connector supports this feature. Updates are often optional or not supported. Please refer to connector documentation.
- [List all buyers](https://integration.wpay.com.au/reference/buyers/list-buyers.md): List all buyers or search for a specific buyer.
- [Add a buyer](https://integration.wpay.com.au/reference/buyers/new-buyer.md): Create a new buyer record.
- [Get a buyer](https://integration.wpay.com.au/reference/buyers/get-buyer.md): Fetches a buyer by its ID.
- [Update a buyer](https://integration.wpay.com.au/reference/buyers/update-buyer.md): Updates a buyer record.
- [Delete a buyer](https://integration.wpay.com.au/reference/buyers/delete-buyer.md): Permanently removes a buyer record.
- [List a buyer's shipping details](https://integration.wpay.com.au/reference/buyers/get-buyer-shipping-details.md): List all the shipping details associated to a specific buyer.
- [Add buyer shipping details](https://integration.wpay.com.au/reference/buyers/new-buyer-shipping-detail.md): Associate shipping details to a buyer.
- [Update a buyer's shipping details](https://integration.wpay.com.au/reference/buyers/update-buyer-shipping-detail.md): Update the shipping details associated to a specific buyer.
- [Delete a buyer's shipping details](https://integration.wpay.com.au/reference/buyers/delete-buyer-shipping-detail.md): Delete the shipping details associated to a specific buyer.
- [Create checkout session](https://integration.wpay.com.au/reference/checkout-sessions/new-checkout-session.md): Create a new checkout session.
- [Get checkout session](https://integration.wpay.com.au/reference/checkout-sessions/get-checkout-session.md)
- [Update checkout session](https://integration.wpay.com.au/reference/checkout-sessions/update-checkout-session.md)
- [Delete checkout session](https://integration.wpay.com.au/reference/checkout-sessions/delete-checkout-session.md)
- [Update checkout session fields](https://integration.wpay.com.au/reference/checkout-sessions/update-checkout-session-fields.md)
- [List all payment links](https://integration.wpay.com.au/reference/payment-links/list-payment-links.md): List all created payment links.
- [Add a payment link](https://integration.wpay.com.au/reference/payment-links/new-payment-link.md): Create a new payment link.
- [Get payment link](https://integration.wpay.com.au/reference/payment-links/get-payment-link.md): Fetch the details for a payment link.
- [Expire a payment link](https://integration.wpay.com.au/reference/payment-links/expire-payment-link.md): Expire an existing payment link.
- [List payment options](https://integration.wpay.com.au/reference/payment-options/list-payment-options.md): List the payment options available at checkout. filtering by country, currency, and additional fields passed to Flow rules.
- [List transaction refunds](https://integration.wpay.com.au/reference/transactions/list-transaction-refunds.md): List refunds for a transaction.
- [Create transaction refund](https://integration.wpay.com.au/reference/transactions/refund-transaction.md): Create a refund for a transaction.
- [Create batch transaction refund](https://integration.wpay.com.au/reference/transactions/refund-all.md): Create a refund for all instruments on a transaction.
- [Get refund](https://integration.wpay.com.au/reference/transactions/get-refund.md): Fetch a refund.
- [Create a session for a payment service definition](https://integration.wpay.com.au/reference/payment-service-sessions/create-payment-service-session.md): Creates a session for a payment service that supports sessions.
- [Create a session for a payment service definition](https://integration.wpay.com.au/reference/payment-service-sessions/create-payment-service-session-by-id.md): Creates a session for a payment service that supports sessions.
- [List card scheme definitions](https://integration.wpay.com.au/reference/card-schemes/list-card-scheme-definitions.md): Fetch a list of the definitions of each card scheme.
- [Get card details](https://integration.wpay.com.au/reference/card-details/get-card-details.md): Gets details about a particular card based on the BIN. Use the currency, amount, and other fields to apply any Flow rules that may put requirements on the card.
- [Create a Apple Pay session](https://integration.wpay.com.au/reference/digital-wallets/get-apple-pay-session.md): Create a session for use with Apple Pay.
- [Create a Google Pay session](https://integration.wpay.com.au/reference/digital-wallets/get-google-pay-session.md): Create a session for use with Google Pay.
- [Create a Click to Pay session](https://integration.wpay.com.au/reference/digital-wallets/get-click-to-pay-session.md): Create a session for use with Click to Pay.
- [List gift cards for a buyer](https://integration.wpay.com.au/reference/gift-cards/list-buyer-gift-cards.md): List all the stored gift cards for a specific buyer.
- [List gift cards](https://integration.wpay.com.au/reference/gift-cards/list-gift-cards.md): Browser all gift cards.
- [Verify and get gift card balances](https://integration.wpay.com.au/reference/gift-cards/list-gift-card-balances.md): Fetch the balances for one or more gift cards.
- [Create gift card](https://integration.wpay.com.au/reference/gift-cards/new-gift-card.md): Store a new gift card in the vault.
- [Get gift card](https://integration.wpay.com.au/reference/gift-cards/get-gift-card.md): Fetch details about a gift card.
- [Delete a gift card](https://integration.wpay.com.au/reference/gift-cards/delete-gift-card.md): Removes a gift card from our system.
- [Issue a gift card](https://integration.wpay.com.au/reference/gift-cards/issue-gift-card.md): Issue a new virtual gift card through the primary gift card service.
- [Activate a gift card](https://integration.wpay.com.au/reference/gift-cards/activate-gift-card.md): Activate a physical gift card through the primary gift card service. Set `store` to `true` to also store the activated gift card.
- [List payment methods for a buyer](https://integration.wpay.com.au/reference/payment-methods/list-buyer-payment-methods.md): List all the stored payment methods for a specific buyer.
- [List all payment methods](https://integration.wpay.com.au/reference/payment-methods/list-payment-methods.md): List all stored payment method.
- [Create payment method](https://integration.wpay.com.au/reference/payment-methods/new-payment-method.md): Store a new payment method.
- [Get payment method](https://integration.wpay.com.au/reference/payment-methods/get-payment-method.md): Retrieve a payment method.
- [Update payment method](https://integration.wpay.com.au/reference/payment-methods/update-payment-method.md): Update the details of a stored payment method.
- [Delete payment method](https://integration.wpay.com.au/reference/payment-methods/delete-payment-method.md): Delete a payment method.
- [List payment method definitions](https://integration.wpay.com.au/reference/payment-method-definitions/list-payment-method-definitions.md): Returns a list of all available payment method definitions.
- [Create account updater job](https://integration.wpay.com.au/reference/account-updater/new-account-updater-job.md): Schedule one or more stored cards for an account update.
- [List network tokens](https://integration.wpay.com.au/reference/network-tokens/list-network-tokens.md): List all network tokens stored for a payment method.
- [Provision network token](https://integration.wpay.com.au/reference/network-tokens/provision-network-token.md): Provision a network token for a payment method.
- [Provision network token cryptogram](https://integration.wpay.com.au/reference/network-tokens/get-network-token-cryptogram.md): Provision a cryptogram for a network token.
- [Suspend network token](https://integration.wpay.com.au/reference/network-tokens/suspend-network-token.md): Suspend a network token for a payment method.
- [Resume network token](https://integration.wpay.com.au/reference/network-tokens/resume-network-token.md): Resume a suspended network token for a payment method.
- [Delete network token](https://integration.wpay.com.au/reference/network-tokens/delete-network-token.md): Delete a network token for a payment method.
- [List payment service tokens](https://integration.wpay.com.au/reference/payment-service-tokens/list-payment-service-tokens.md): List all gateway tokens stored for a payment method.
- [Create payment service token](https://integration.wpay.com.au/reference/payment-service-tokens/provision-payment-service-token.md): Create a gateway tokens for a payment method.
- [Delete payment service token](https://integration.wpay.com.au/reference/payment-service-tokens/delete-payment-service-token.md): Delete a gateway tokens for a payment method.
- [Forward PCI data](https://integration.wpay.com.au/reference/vault-forwarding/make-vault-forward.md): Forward an API call to a PCI endpoint. The request body is evaluated and any template fields are replaced by the card data before the request is sent to the given destination.
- [List configured Vault Forward endpoints](https://integration.wpay.com.au/reference/vault-forwarding/list-vault-forward-configs.md): Lists the currently configured Vault Forward endpoints that can be used to forward PCI data to.
- [Get configured Vault Forward endpoints](https://integration.wpay.com.au/reference/vault-forwarding/get-vault-forward-config.md): Gets a configured Vault Forward endpoints that can be used to forward PCI data to.
- [List configured Vault Forward authentication methods](https://integration.wpay.com.au/reference/vault-forwarding/list-vault-forward-authentications.md): Lists the configured Vault Forward authentication methods that can be applied in Vault Forward requests for the given configuration.
- [Get Vault Forward authentication method](https://integration.wpay.com.au/reference/vault-forwarding/get-vault-forward-authentication.md): Gets a configured Vault Forward authentication method.
- [Adds new Vault Forward authentication method](https://integration.wpay.com.au/reference/vault-forwarding/add-vault-forward-authentication.md): Configures a new Vault Forward authentication method. This allows the authentication method to be be applied in Vault Forward requests.
- [Update Vault Forward authentication method](https://integration.wpay.com.au/reference/vault-forwarding/update-vault-forward-authentication.md): Updates an existing Vault Forward authentication method.
- [Remove a Vault Forward authentication method](https://integration.wpay.com.au/reference/vault-forwarding/delete-vault-forward-authentication.md): Removes a configured Vault Forward authentication method, disallowing it from being applied in Vault Forward requests.
- [List connections](https://integration.wpay.com.au/reference/connections/list-connections.md): Returns a list of all configured connections.
- [List connection definitions](https://integration.wpay.com.au/reference/connections/list-connection-definitions.md)
- [Get a payment service definition](https://integration.wpay.com.au/reference/payment-service-definitions/get-payment-service-definition.md): Get the definition of a payment service that can be configured.
- [List payment services](https://integration.wpay.com.au/reference/payment-services/list-payment-services.md): List the configured payment services.
- [Configure a payment service](https://integration.wpay.com.au/reference/payment-services/new-payment-service.md): Configures a new payment service for use by merchants.
- [Get payment service](https://integration.wpay.com.au/reference/payment-services/get-payment-service.md): Get the details of a configured payment service.
- [Update a configured payment service](https://integration.wpay.com.au/reference/payment-services/update-payment-service.md): Updates the configuration of a payment service.
- [Delete a configured payment service](https://integration.wpay.com.au/reference/payment-services/delete-payment-service.md): Deletes all the configuration of a payment service.
- [Verify payment service credentials](https://integration.wpay.com.au/reference/payment-services/verify-payment-service.md): Verify the credentials of a configured payment service
- [List digital wallets](https://integration.wpay.com.au/reference/digital-wallets/list-digital-wallets.md): List configured digital wallets.
- [Get digital wallet](https://integration.wpay.com.au/reference/digital-wallets/get-digital-wallet.md): Fetch the details a digital wallet.
- [Register digital wallet](https://integration.wpay.com.au/reference/digital-wallets/register-digital-wallet.md): Register a digital wallet like Apple Pay, Google Pay, or Click to Pay.
- [Update digital wallet](https://integration.wpay.com.au/reference/digital-wallets/update-digital-wallet.md): Update a digital wallet.
- [Delete digital wallet](https://integration.wpay.com.au/reference/digital-wallets/deregister-digital-wallet.md): Delete a configured digital wallet.
- [Register a digital wallet domain](https://integration.wpay.com.au/reference/digital-wallets/new-digital-wallet-domain.md): Register a digital wallet domain (Apple Pay only).
- [Remove a digital wallet domain](https://integration.wpay.com.au/reference/digital-wallets/delete-digital-wallet-domain.md): Remove a digital wallet domain (Apple Pay only).
- [List Apple Pay certificates](https://integration.wpay.com.au/reference/digital-wallets/list-apple-pay-certificates.md): Returns a list of Apple Pay certificate records.
- [New Apple Pay certificate](https://integration.wpay.com.au/reference/digital-wallets/create-apple-pay-certificate.md): Starts a new Apple Pay payment processing certificate registration. The Apple digital wallet must be registered before you can register an Apple Pay certificate.
- [Update Apple Pay certificate](https://integration.wpay.com.au/reference/digital-wallets/update-apple-pay-certificate.md): Update the Apple Pay certificate record with the payment processing certificate received from Apple.
- [Remove Apple Pay certificate](https://integration.wpay.com.au/reference/digital-wallets/delete-apple-pay-certificate.md): Deletes an Apple Pay certificate record.
- [Get anti fraud service definition](https://integration.wpay.com.au/reference/anti-fraud-services/get-anti-fraud-service-definition.md): Gets the definition for an anti fraud service.
- [New anti-fraud service](https://integration.wpay.com.au/reference/anti-fraud-services/new-anti-fraud-service.md): Adds an anti-fraud service, enabling merchants to determine risky transactions and prevent chargebacks.
- [Get anti-fraud service](https://integration.wpay.com.au/reference/anti-fraud-services/get-anti-fraud-service.md): Gets information about an anti-fraud service.
- [Update anti-fraud service](https://integration.wpay.com.au/reference/anti-fraud-services/update-anti-fraud-service.md): Update an anti-fraud service, enabling merchants to determine risky transactions and prevent chargebacks.
- [Delete anti-fraud service](https://integration.wpay.com.au/reference/anti-fraud-services/delete-anti-fraud-service.md): Removes an anti-fraud service. Any associated credentials will also be deleted.
- [Client-side errors (4XX)](https://integration.wpay.com.au/reference/errors/client-errors.md)
- [Server-side errors (5XX)](https://integration.wpay.com.au/reference/errors/server-errors.md)
- [List 4XX errors](https://integration.wpay.com.au/reference/logs/list-api-error-logs.md): Returns a list of API 4XX and 5XX logs.
- [List 3DS configuration](https://integration.wpay.com.au/reference/merchant-accounts/three-ds-configurations/list-three-ds-configurations.md): List all 3DS configurations for a merchant account.
- [Add 3DS configuration](https://integration.wpay.com.au/reference/merchant-accounts/three-ds-configurations/new-three-ds-configuration.md): Create a new 3DS configuration for a merchant account.
- [Update 3DS configuration](https://integration.wpay.com.au/reference/merchant-accounts/three-ds-configurations/update-three-ds-configuration.md): Update the 3DS configuration for a merchant account.
- [Delete 3DS configuration](https://integration.wpay.com.au/reference/merchant-accounts/three-ds-configurations/delete-three-ds-configuration.md): Delete a 3DS configuration for a merchant account.
- [List 3DS scenario](https://integration.wpay.com.au/reference/three-ds-scenarios/list-three-ds-scenarios.md): List all 3DS scenarios for a merchant account. Only available in sandbox environments.
- [Create a 3DS scenario](https://integration.wpay.com.au/reference/three-ds-scenarios/new-three-ds-scenario.md): Create a new 3DS scenario for a merchant account. Only available in sandbox environments.
- [Update a 3DS scenario](https://integration.wpay.com.au/reference/three-ds-scenarios/update-three-ds-scenario.md): Update a 3DS scenario. Only available in sandbox environments.
- [Delete a 3DS scenario](https://integration.wpay.com.au/reference/three-ds-scenarios/delete-three-ds-scenario.md): Removes a 3DS scenario from our system. Only available in sandbox environments.
- [List flow rules](https://integration.wpay.com.au/reference/flow/list-rules.md): Returns a list of rules for a given flow. Each rule has an associated action, conditions, and outcome.
- [Get rule](https://integration.wpay.com.au/reference/flow/get-rule.md): Returns a configured rule that triggers an action in a flow.
- [Create flow rule](https://integration.wpay.com.au/reference/flow/new-rule.md): Adds a rule for a given flow and action.
- [Update flow rule](https://integration.wpay.com.au/reference/flow/update-rule.md): Updates a given flow rule.
- [Delete flow rule](https://integration.wpay.com.au/reference/flow/delete-rule.md): Deletes a given rule from the system.
- [List flow outcomes](https://integration.wpay.com.au/reference/flow/list-outcomes.md): Returns a list of possible outcomes for a given flow action.
- [List configured reports](https://integration.wpay.com.au/reference/reports/list-reports.md): List all configured reports that can be generated.
- [Get a report](https://integration.wpay.com.au/reference/reports/get-report.md): Fetches a report by its ID.
- [Add a report](https://integration.wpay.com.au/reference/reports/new-report.md): Create a new report.
- [Update a report](https://integration.wpay.com.au/reference/reports/update-report.md): Updates the configuration of a report.
- [List executed reports](https://integration.wpay.com.au/reference/reports/list-all-report-executions.md): List all executed reports that have been generated.
- [List executions for report](https://integration.wpay.com.au/reference/reports/list-executions-for-report.md): List all executions of a specific report.
- [Get executed report](https://integration.wpay.com.au/reference/reports/get-report-execution.md): Fetch a specific executed report.
- [Create URL for executed report](https://integration.wpay.com.au/reference/reports/generate-download-url.md): Creates a download URL for a specific execution of a report.
- [List all roles](https://integration.wpay.com.au/reference/roles/list-roles.md): List all roles available in the instance.
- [List audit log entries](https://integration.wpay.com.au/reference/audit-logs/list-audit-logs.md): Returns a list of activity by dashboard users.
- [List webhook subscriptions](https://integration.wpay.com.au/reference/webhook-subscriptions/list-webhook-subscriptions.md): Retrieve a paginated list of all webhook subscriptions for your account. This endpoint returns subscription details including URLs, authentication methods, and active status. Use pagination parameters to navigate through large collections of subscriptions. Results are sorted by creation date, with t…
- [Create webhook subscription](https://integration.wpay.com.au/reference/webhook-subscriptions/new-webhook-subscription.md): Create a new webhook subscription to receive event notifications. Subscriptions allow you to specify a URL where webhook events will be delivered and configure authentication credentials to secure the webhook communication.
- [Get webhook subscription](https://integration.wpay.com.au/reference/webhook-subscriptions/get-webhook-subscription.md): Retrieve detailed information about a specific webhook subscription. This endpoint returns the full configuration of a subscription including its URL, authentication details, active status, and signing secret information. Use this to verify your webhook subscription settings or retrieve details need…
- [Update webhook subscription](https://integration.wpay.com.au/reference/webhook-subscriptions/update-webhook-subscription.md): Update an existing webhook subscription's properties. You can modify the subscription URL, authentication details, or toggle the active status. Only the fields you include in your request will be updated, and all other properties will remain unchanged.
- [Delete webhook subscription](https://integration.wpay.com.au/reference/webhook-subscriptions/delete-webhook-subscription.md): Permanently removes a webhook subscription from your account. Once deleted, you will no longer receive event notifications at the subscription's URL. This action cannot be undone, and you'll need to create a new subscription if you want to receive webhooks at this endpoint again in the future.

## OpenAPI Specs

- [openapi.custom-connectors](/openapi.custom-connectors.json)
- [openapi.speakeasy](/openapi.speakeasy.json)
- [openapi.v1](/openapi.v1.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.