{"items":[{"type":"link","fsPath":"apis/index.md","metadata":{"type":"markdown"},"label":"API reference","link":"/apis","routeSlug":"/apis"},{"type":"group","fsPath":"apis/bin-lookup.json","link":"/apis/bin-lookup","routeSlug":"/apis/bin-lookup","label":"BIN lookup","items":[{"label":"BIN lookup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/bin-lookup/other/bin-lookup","routeSlug":"/apis/bin-lookup/other/bin-lookup","metadata":{"seo":{"title":"BIN lookup","description":"Perform a BIN (Bank Identification Number) lookup using a card's PAN (Primary Account Number). This will return high-level data about the card, such as the issuer, card type, and funding source. For more details, use the extended endpoint."}},"httpPath":"/bin-recognition/bin-range-lookup"},{"label":"BIN lookup (extended)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/bin-lookup/other/bin-lookup-extended","routeSlug":"/apis/bin-lookup/other/bin-lookup-extended","metadata":{"seo":{"title":"BIN lookup (extended)","description":"Perform an extended BIN (Bank Identification Number) lookup using a card's PAN (Primary Account Number). This will return detailed information about the card, including the issuer, card type, and funding source. For high-level data, use the standard endpoint."}},"httpPath":"/bin-recognition/bin-range-lookup/extended"}],"metadata":{"type":"openapi","title":"BIN lookup service API","version":"1.0.0","description":"This is an API reference for the BIN lookup service."}},{"type":"group","fsPath":"apis/dcc.json","link":"/apis/dcc","routeSlug":"/apis/dcc","label":"DCC","items":[{"label":"Get DCC rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dcc/other/get-dcc-rate","routeSlug":"/apis/dcc/other/get-dcc-rate","metadata":{"seo":{"title":"Get DCC rate","description":"Retrieve the Dynamic Currency Conversion (DCC) rate for a transaction from various providers."}},"httpPath":"/dcc/rate"}],"metadata":{"type":"openapi","title":"DCC rate service API","version":"1.0.0","description":"This is an API reference for the DCC (Dynamic Currency Conversion) rate service."}},{"type":"group","fsPath":"apis/merchant-webhook.json","link":"/apis/merchant-webhook","routeSlug":"/apis/merchant-webhook","label":"Merchant webhooks","items":[{"label":"Process a merchant webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/merchant-webhook/other/process-merchant-webhook","routeSlug":"/apis/merchant-webhook/other/process-merchant-webhook","metadata":{"seo":{"title":"Process a merchant webhook","description":"The /merchant-webhooks endpoint is designed for real-time notifications about transaction events, enabling you to automatically receive updates on transaction statuses such as authorisations, captures, and cancellations. Supported products include card payments, PayPal (including Pay Later and Venmo), Aeropay pay-by-bank events (including user suspended and user activated), and SPEI pay-by-bank events (purchase, payout, and refund outcomes)."}},"httpPath":"/merchant-webhooks"}],"metadata":{"type":"openapi","title":"Merchant webhooks service API","version":"1.0.0","description":"This is an API reference for the merchant webhooks service."}},{"type":"group","fsPath":"apis/soft-pos-transaction.json","link":"/apis/soft-pos-transaction","routeSlug":"/apis/soft-pos-transaction","label":"Tap+ transactions","items":[{"label":"Initiate a POS transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/soft-pos-transaction/other/initiate-pos-transaction","routeSlug":"/apis/soft-pos-transaction/other/initiate-pos-transaction","metadata":{"seo":{"title":"Initiate a POS transaction","description":"The /soft-pos-transactions endpoint enables you to initiate instore transactions for Tap+. It supports various transaction methods, including card and alternative payments."}},"httpPath":"/soft-pos-transactions"},{"label":"Create a POS modification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/soft-pos-transaction/other/modify-pos-transaction","routeSlug":"/apis/soft-pos-transaction/other/modify-pos-transaction","metadata":{"seo":{"title":"Create a POS modification","description":"This endpoint enables the processing of modifications on previously initiated transactions that have not yet been fully processed or captured. Upon successful execution, it returns a unique reference for the modification request, allowing for easy tracking and reconciliation."}},"httpPath":"/soft-pos-transactions/{systemTransactionId}/modifications"}],"metadata":{"type":"openapi","title":"Tap+ transactions API","version":"1.0.0","description":"This is an API reference for Tap+ transactions. [Learn more about Tap+](../guides/tap-plus)."}},{"type":"group","fsPath":"apis/point-of-sale-transaction.json","link":"/apis/point-of-sale-transaction","routeSlug":"/apis/point-of-sale-transaction","label":"POS+ transactions","items":[{"label":"Initiate a POS transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale-transaction/other/initiate-pos-transaction","routeSlug":"/apis/point-of-sale-transaction/other/initiate-pos-transaction","metadata":{"seo":{"title":"Initiate a POS transaction","description":"The /pos-transactions endpoint enables you to initiate instore transactions. It supports various transaction methods including card and alternative payments."}},"httpPath":"/pos-transactions"},{"label":"Initiate a POS transaction (legacy)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale-transaction/other/initiate-pos-transaction-legacy","routeSlug":"/apis/point-of-sale-transaction/other/initiate-pos-transaction-legacy","metadata":{"seo":{"title":"Initiate a POS transaction (legacy)","description":"The /pos-transactions endpoint enables the initiation of instore transactions, supporting various transaction methods, including card and alternative payments."}},"httpPath":"/pos-transactions/legacy"},{"label":"Create a POS modification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale-transaction/other/modify-pos-transaction","routeSlug":"/apis/point-of-sale-transaction/other/modify-pos-transaction","metadata":{"seo":{"title":"Create a POS modification","description":"This endpoint facilitates the processing of modifications on previously initiated transactions that have not yet been fully processed or captured. Supported modification actions include refunds, captures, incremental authorisations, and voids. Upon successful execution, it returns a unique reference for the modification request, allowing for easy tracking and reconciliation."}},"httpPath":"/pos-transactions/{systemTransactionId}/modifications"}],"metadata":{"type":"openapi","title":"POS transaction service API","version":"1.0.0","description":"This is an API reference for the Point of Sale transaction service."}},{"type":"group","fsPath":"apis/point-of-sale.json","link":"/apis/point-of-sale","routeSlug":"/apis/point-of-sale","label":"Point-of-sale devices","items":[{"type":"group","label":"Manage POS devices","link":"/apis/point-of-sale/manage-pos-devices","routeSlug":"/apis/point-of-sale/manage-pos-devices","items":[{"label":"Add a POS device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/manage-pos-devices/add-pos-device","routeSlug":"/apis/point-of-sale/manage-pos-devices/add-pos-device","metadata":{"seo":{"title":"Add a POS device","description":"This endpoint is used to initiate a new point of sale device for a specific site. It creates the device with the provided configuration settings."}},"httpPath":"/point-of-sales/{site}"},{"label":"Retrieve a POS device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/manage-pos-devices/retrieve-pos-device","routeSlug":"/apis/point-of-sale/manage-pos-devices/retrieve-pos-device","metadata":{"seo":{"title":"Retrieve a POS device","description":"This endpoint retrieves the details of a specific point of sale device by its merchant ID."}},"httpPath":"/point-of-sales/{site}/{merchantPointOfSaleId}"},{"label":"Delete a POS device","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/manage-pos-devices/delete-pos-device","routeSlug":"/apis/point-of-sale/manage-pos-devices/delete-pos-device","metadata":{"seo":{"title":"Delete a POS device","description":"This endpoint deletes a specific point of sale device."}},"httpPath":"/point-of-sales/{site}/{merchantPointOfSaleId}"},{"label":"Update a POS device","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/manage-pos-devices/update-pos-device","routeSlug":"/apis/point-of-sale/manage-pos-devices/update-pos-device","metadata":{"seo":{"title":"Update a POS device","description":"This endpoint updates the details of a specific point of sale device."}},"httpPath":"/point-of-sales/{site}/{merchantPointOfSaleId}"},{"label":"Activate a POS device","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/manage-pos-devices/activate-pos-device","routeSlug":"/apis/point-of-sale/manage-pos-devices/activate-pos-device","metadata":{"seo":{"title":"Activate a POS device","description":"This endpoint activates a point of sale device using its serial number."}},"httpPath":"/point-of-sales/{serialNumber}/activate"},{"label":"Retrieve all POS devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/manage-pos-devices/retrieve-all-pos-devices","routeSlug":"/apis/point-of-sale/manage-pos-devices/retrieve-all-pos-devices","metadata":{"seo":{"title":"Retrieve all POS devices","description":"This endpoint retrieves all point of sale devices for a specific owner (site, merchant, or merchant group)."}},"httpPath":"/point-of-sales/{ownerType}/{ownerId}/all"}]},{"type":"group","label":"Authentication settings","link":"/apis/point-of-sale/authentication-settings","routeSlug":"/apis/point-of-sale/authentication-settings","items":[{"label":"Create authentication settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/authentication-settings/create-authentication-settings","routeSlug":"/apis/point-of-sale/authentication-settings/create-authentication-settings","metadata":{"seo":{"title":"Create authentication settings","description":"This endpoint creates authentication settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/authentication-settings"},{"label":"Get authentication settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/authentication-settings/get-authentication-settings","routeSlug":"/apis/point-of-sale/authentication-settings/get-authentication-settings","metadata":{"seo":{"title":"Get authentication settings","description":"This endpoint retrieves the authentication settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/authentication-settings"},{"label":"Update authentication settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/authentication-settings/update-authentication-settings","routeSlug":"/apis/point-of-sale/authentication-settings/update-authentication-settings","metadata":{"seo":{"title":"Update authentication settings","description":"This endpoint updates the authentication settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/authentication-settings"}]},{"type":"group","label":"Feature settings","link":"/apis/point-of-sale/feature-settings","routeSlug":"/apis/point-of-sale/feature-settings","items":[{"label":"Create feature settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/feature-settings/create-feature-settings","routeSlug":"/apis/point-of-sale/feature-settings/create-feature-settings","metadata":{"seo":{"title":"Create feature settings","description":"This endpoint creates feature settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/feature-settings"},{"label":"Get feature settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/feature-settings/get-feature-settings","routeSlug":"/apis/point-of-sale/feature-settings/get-feature-settings","metadata":{"seo":{"title":"Get feature settings","description":"This endpoint retrieves the feature settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/feature-settings"},{"label":"Update feature settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/feature-settings/update-feature-settings","routeSlug":"/apis/point-of-sale/feature-settings/update-feature-settings","metadata":{"seo":{"title":"Update feature settings","description":"This endpoint updates the feature settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/feature-settings"}]},{"type":"group","label":"General settings","link":"/apis/point-of-sale/general-settings","routeSlug":"/apis/point-of-sale/general-settings","items":[{"label":"Create general settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/general-settings/create-general-settings","routeSlug":"/apis/point-of-sale/general-settings/create-general-settings","metadata":{"seo":{"title":"Create general settings","description":"This endpoint creates general settings for a specific site."}},"httpPath":"/point-of-sales/{site}/general-settings"},{"label":"Get general settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/general-settings/get-general-settings","routeSlug":"/apis/point-of-sale/general-settings/get-general-settings","metadata":{"seo":{"title":"Get general settings","description":"This endpoint retrieves the general settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/general-settings"},{"label":"Update general settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/general-settings/update-general-settings","routeSlug":"/apis/point-of-sale/general-settings/update-general-settings","metadata":{"seo":{"title":"Update general settings","description":"This endpoint updates the general settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/general-settings"}]},{"type":"group","label":"Log settings","link":"/apis/point-of-sale/log-settings","routeSlug":"/apis/point-of-sale/log-settings","items":[{"label":"Create log settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/log-settings/create-log-settings","routeSlug":"/apis/point-of-sale/log-settings/create-log-settings","metadata":{"seo":{"title":"Create log settings","description":"This endpoint creates log settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/log-settings"},{"label":"Get log settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/log-settings/get-log-settings","routeSlug":"/apis/point-of-sale/log-settings/get-log-settings","metadata":{"seo":{"title":"Get log settings","description":"This endpoint retrieves the log settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/log-settings"},{"label":"Update log settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/log-settings/update-log-settings","routeSlug":"/apis/point-of-sale/log-settings/update-log-settings","metadata":{"seo":{"title":"Update log settings","description":"This endpoint updates the log settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/log-settings"}]},{"type":"group","label":"Store and Forward settings","link":"/apis/point-of-sale/store-and-forward-settings","routeSlug":"/apis/point-of-sale/store-and-forward-settings","items":[{"label":"Create Store and Forward settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/store-and-forward-settings/create-store-and-forward-settings","routeSlug":"/apis/point-of-sale/store-and-forward-settings/create-store-and-forward-settings","metadata":{"seo":{"title":"Create Store and Forward settings","description":"This endpoint creates store and forward settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/store-and-forward-settings"},{"label":"Get Store and Forward settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/store-and-forward-settings/get-store-and-forward-settings","routeSlug":"/apis/point-of-sale/store-and-forward-settings/get-store-and-forward-settings","metadata":{"seo":{"title":"Get Store and Forward settings","description":"This endpoint retrieves the store and forward settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/store-and-forward-settings"},{"label":"Update Store and Forward settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/store-and-forward-settings/update-store-and-forward-settings","routeSlug":"/apis/point-of-sale/store-and-forward-settings/update-store-and-forward-settings","metadata":{"seo":{"title":"Update Store and Forward settings","description":"This endpoint updates the store and forward settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/store-and-forward-settings"}]},{"type":"group","label":"URL settings","link":"/apis/point-of-sale/url-settings","routeSlug":"/apis/point-of-sale/url-settings","items":[{"label":"Create host URL settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/url-settings/create-host-url-settings","routeSlug":"/apis/point-of-sale/url-settings/create-host-url-settings","metadata":{"seo":{"title":"Create host URL settings","description":"This endpoint creates host URL settings for a specific point of sale device."}},"httpPath":"/point-of-sales/{pointOfSaleId}/host-url-settings"},{"label":"Get host URL settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/url-settings/get-host-url-settings","routeSlug":"/apis/point-of-sale/url-settings/get-host-url-settings","metadata":{"seo":{"title":"Get host URL settings","description":"This endpoint retrieves specific host URL settings for a point of sale device by URL type."}},"httpPath":"/point-of-sales/{pointOfSaleId}/{urlType}/host-url-settings"},{"label":"Update host URL settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale/url-settings/update-host-url-settings","routeSlug":"/apis/point-of-sale/url-settings/update-host-url-settings","metadata":{"seo":{"title":"Update host URL settings","description":"This endpoint updates specific host URL settings for a point of sale device by URL type."}},"httpPath":"/point-of-sales/{pointOfSaleId}/{urlType}/host-url-settings"}]}],"metadata":{"type":"openapi","title":"POS service API","version":"1.0.0","description":"This is an API reference for the Point of Sale service, which allows you to manage point of sale devices, including their settings, activation, and configuration."}},{"type":"group","fsPath":"apis/session.json","link":"/apis/session","routeSlug":"/apis/session","label":"Sessions","items":[{"label":"Create a session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/session/other/create-session","routeSlug":"/apis/session/other/create-session","metadata":{"seo":{"title":"Create a session","description":"The Session service API enables the creation of transaction sessions, supporting various transaction methods such as card payments and alternative payment methods (APMs). It facilitates seamless integration for payment processing by generating a session that securely collects payment details and initiates transactions. This service ensures secure and efficient payment flows, improving the user experience across multiple payment channels."}},"httpPath":"/sessions"},{"label":"Modify a session","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/session/other/modify-session","routeSlug":"/apis/session/other/modify-session","metadata":{"seo":{"title":"Modify a session","description":"This endpoint allows updating session details after creation, including intent modification, amount updates, authentication decision, transaction decision, and 3DS external data."}},"httpPath":"/session-details/{sessionId}"}],"metadata":{"type":"openapi","title":"Session service API","version":"1.0.0","description":"This is an API reference for the Session service."}},{"type":"group","fsPath":"apis/three-d-secure-authentication.json","link":"/apis/three-d-secure-authentication","routeSlug":"/apis/three-d-secure-authentication","label":"3DS authentication","items":[{"type":"group","label":"Standalone authentication","link":"/apis/three-d-secure-authentication/standalone-authentication","routeSlug":"/apis/three-d-secure-authentication/standalone-authentication","items":[{"label":"Pre-initiate a standalone authentication request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/standalone-authentication/pre-initiate-standalone-auth-request","routeSlug":"/apis/three-d-secure-authentication/standalone-authentication/pre-initiate-standalone-auth-request","metadata":{"seo":{"title":"Pre-initiate a standalone authentication request","description":"Pre-initiates a stand-alone 3D Secure authentication request for a transaction. This endpoint is for merchants who use PXP's service solely for authentication purposes. The pre-initiation step gathers necessary information and ensures that all required data is available and valid before proceeding with the actual authentication request. This process helps to streamline the authentication process and enhance security."}},"httpPath":"/threedsecure/standalone/authentications"},{"label":"Initiate a standalone authentication request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/standalone-authentication/initiate-standalone-auth-request","routeSlug":"/apis/three-d-secure-authentication/standalone-authentication/initiate-standalone-auth-request","metadata":{"seo":{"title":"Initiate a standalone authentication request","description":"Initiates a standalone 3D Secure authentication request for a transaction. This endpoint is for merchants who use PXP's service solely for authentication purposes. The process involves verifying the cardholder's identity through a browser-based interaction. The request payload must include comprehensive details about the transaction, card information, merchant information, and additional contextual data necessary for the 3D Secure authentication flow. This ensures a secure and efficient authentication process."}},"httpPath":"/threedsecure/standalone/authentications/{authenticationId}/browser-authentication"},{"label":"Get 3DS authentication by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/standalone-authentication/retrieve-auth-by-id","routeSlug":"/apis/three-d-secure-authentication/standalone-authentication/retrieve-auth-by-id","metadata":{"seo":{"title":"Get 3DS authentication by ID","description":"This endpoint retrieves the details of a specific 3DS standalone authentication using the authenticationId provided in the path. The service is designed for retrieving authentication records that were created as part of a 3DS verification process."}},"httpPath":"/threedsecure/standalone/authentications/{authenticationId}"}]},{"type":"group","label":"Integrated authentication","link":"/apis/three-d-secure-authentication/integrated-authentication","routeSlug":"/apis/three-d-secure-authentication/integrated-authentication","items":[{"label":"Pre-initiate an integrated authentication request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/integrated-authentication/pre-initiate-integrated-auth-request","routeSlug":"/apis/three-d-secure-authentication/integrated-authentication/pre-initiate-integrated-auth-request","metadata":{"seo":{"title":"Pre-initiate an integrated authentication request","description":"Pre-initiates an integrated 3D Secure authentication request for a transaction. In integrated mode, PXP processes the transaction in a separate initiate transaction request using the 3D Secure supplied data. This step ensures that all required data is gathered and validated before the full authentication process, facilitating a smoother and more secure transaction flow."}},"httpPath":"/threedsecure/integrated/authentications"},{"label":"Initiate an integrated authentication request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/integrated-authentication/initiate-integrated-auth-request","routeSlug":"/apis/three-d-secure-authentication/integrated-authentication/initiate-integrated-auth-request","metadata":{"seo":{"title":"Initiate an integrated authentication request","description":"Authenticates an integrated 3D Secure transaction request. In integrated mode, PXP processes the transaction in conjunction with the 3D Secure authentication data. This ensures that the transaction is authenticated securely, leveraging the full authentication data collected during the pre-initiation phase. The request payload must include comprehensive details about the transaction, card information, merchant information, and additional contextual data necessary for the 3D Secure authentication flow."}},"httpPath":"/threedsecure/integrated/authentications/{authenticationId}/browser-authentication"},{"label":"Get 3DS pre-initiate authentication details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/integrated-authentication/get-preinitiate-authentication-details","routeSlug":"/apis/three-d-secure-authentication/integrated-authentication/get-preinitiate-authentication-details","metadata":{"seo":{"title":"Get 3DS pre-initiate authentication details","description":"Retrieves the details of a specific 3DS pre-initiate authentication using the authenticationId provided in the path. Note: This endpoint is intended for use with the Components SDKs."}},"httpPath":"/threedsecure/integrated/authentications/{authenticationId}/assessment"},{"label":"Get 3DS authentication details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/integrated-authentication/get-authentication-details","routeSlug":"/apis/three-d-secure-authentication/integrated-authentication/get-authentication-details","metadata":{"seo":{"title":"Get 3DS authentication details","description":"Retrieves the complete details of a specific 3DS authentication using the authenticationId provided in the path.  Note: This endpoint is intended for use with the Components SDKs."}},"httpPath":"/threedsecure/integrated/authentications/{authenticationId}/outcome"}]}],"metadata":{"type":"openapi","title":"3D Secure authentication service API","version":"1.0.0","description":"This is an API reference for the 3D Secure authentication service."}},{"type":"group","fsPath":"apis/token-vault.json","link":"/apis/token-vault","routeSlug":"/apis/token-vault","label":"Token Vault","items":[{"label":"Create gateway token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/token-vault/other/create-gateway-token","routeSlug":"/apis/token-vault/other/create-gateway-token","metadata":{"seo":{"title":"Create gateway token","description":"Request to create a gateway token, which is used to represent sensitive payment data in a secure and tokenised form."}},"httpPath":"/token-vault/{ownerType}/{ownerId}/vaults/gateway-tokens"},{"label":"Create scheme token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/token-vault/other/create-scheme-token","routeSlug":"/apis/token-vault/other/create-scheme-token","metadata":{"seo":{"title":"Create scheme token","description":"Request to create a scheme token, representing payment data according to scheme rules."}},"httpPath":"/token-vault/{ownerType}/{ownerId}/vaults/scheme-tokens"},{"label":"Get scheme token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/token-vault/other/get-scheme-token","routeSlug":"/apis/token-vault/other/get-scheme-token","metadata":{"seo":{"title":"Get scheme token","description":"Request to get a scheme token and its status"}},"httpPath":"/token-vault/{ownerType}/{ownerId}/vaults/scheme-tokens/{schemeTokenId}"},{"label":"Create scheme token cryptogram","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/token-vault/other/create-scheme-token-cryptogram","routeSlug":"/apis/token-vault/other/create-scheme-token-cryptogram","metadata":{"seo":{"title":"Create scheme token cryptogram","description":"Request to create a scheme token cryptogram, a secure cryptographic representation of the token."}},"httpPath":"/token-vault/{ownerType}/{ownerId}/vaults/scheme-tokens/{schemeTokenId}/cryptograms"},{"label":"Get masked card data related to gateway token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/token-vault/other/get-masked-card-related-to-gateway-token","routeSlug":"/apis/token-vault/other/get-masked-card-related-to-gateway-token","metadata":{"seo":{"title":"Get masked card data related to gateway token","description":"Request to get card data related to the gateway token. The returned sensitive data is unencrypted but masked to ensure security."}},"httpPath":"/token-vault/{ownerType}/{ownerId}/vaults/gateway-tokens/{gatewayTokenId}/card-data"},{"label":"Get encrypted card data related to gateway token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/token-vault/other/get-encrypted-card-related-to-gateway-token","routeSlug":"/apis/token-vault/other/get-encrypted-card-related-to-gateway-token","metadata":{"seo":{"title":"Get encrypted card data related to gateway token","description":"Request to get card data related to the gateway token. The returned sensitive data is encrypted for enhanced security."}},"httpPath":"/token-vault/{ownerType}/{ownerId}/vaults/gateway-tokens/{gatewayTokenId}/card-data/encrypted"},{"label":"Store card verification code for card","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/token-vault/other/store-security-code","routeSlug":"/apis/token-vault/other/store-security-code","metadata":{"seo":{"title":"Store card verification code for card","description":"Request to store the card verification code (CVC) for a card associated with a gateway token."}},"httpPath":"/token-vault/{ownerType}/{ownerId}/vaults/gateway-tokens/{gatewayTokenId}/card-verification-code"},{"label":"Revoke gateway token consent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/token-vault/other/revoke-gateway-token-consent","routeSlug":"/apis/token-vault/other/revoke-gateway-token-consent","metadata":{"seo":{"title":"Revoke gateway token consent","description":"Revokes user consent for a specific gateway token associated with a merchant shopper. This action prevents the token from being used for future transactions until consent is granted again."}},"httpPath":"/token-vault/{ownerType}/{ownerId}/vaults/gateway-tokens/{gatewayTokenId}/user-consents/{merchantId}/{merchantShopperId}"},{"label":"Revoke scheme token consent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/token-vault/other/revoke-scheme-token-consent","routeSlug":"/apis/token-vault/other/revoke-scheme-token-consent","metadata":{"seo":{"title":"Revoke scheme token consent","description":"Revokes user consent for a specific scheme token associated with a merchant shopper. This action prevents the token from being used for future transactions until consent is granted again."}},"httpPath":"/token-vault/{ownerType}/{ownerId}/vaults/scheme-tokens/{schemeTokenId}/user-consents/{merchantId}/{merchantShopperId}"}],"metadata":{"type":"openapi","title":"Token Vault service API","version":"1.0.0","description":"This is an API reference for the Token Vault service, which provides endpoints to create and manage tokens and related cryptographic data."}},{"type":"group","fsPath":"apis/transaction.json","link":"/apis/transaction","routeSlug":"/apis/transaction","label":"Transactions","items":[{"label":"Initiate a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/transaction/other/initiate-a-transaction","routeSlug":"/apis/transaction/other/initiate-a-transaction","metadata":{"seo":{"title":"Initiate a transaction","description":"The /transactions endpoint enables the initiation of transactions, supporting various transaction methods, including card and alternative payments. It facilitates authoristions, tokenisation, recurring payments, and incorporates security enhancements, offering a versatile solution for payment processing across both online and instore."}},"httpPath":"/transactions"},{"label":"Create a modification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/transaction/other/modify-a-transaction","routeSlug":"/apis/transaction/other/modify-a-transaction","metadata":{"seo":{"title":"Create a modification","description":"Process modifications on previously initiated transactions. Supported operations include captures, refunds, incremental authorisations, and voids. This endpoint returns a unique reference for the modification request, allowing for easy tracking and reconciliation."}},"httpPath":"/transactions/{systemTransactionId}/modifications"},{"label":"Get transaction details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/transaction/other/get-transaction-details","routeSlug":"/apis/transaction/other/get-transaction-details","metadata":{"seo":{"title":"Get transaction details","description":"Looks up a transaction by identifier. Provide at least one of merchantTransactionId or systemTransactionId. The response is a JSON array containing zero or one transaction object. This endpoint isn't a list or search API."}},"httpPath":"/transactions/{merchant}/{site}"},{"label":"Get order details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/transaction/other/get-order-details","routeSlug":"/apis/transaction/other/get-order-details","metadata":{"seo":{"title":"Get order details","description":"Get order details"}},"httpPath":"/transactions/{merchant}/{site}/order-details"}],"metadata":{"type":"openapi","title":"Transactions service","version":"1.0.0","description":"This is an API reference for the Transaction service API."}},{"type":"group","fsPath":"apis/risk-screening.json","link":"/apis/risk-screening","routeSlug":"/apis/risk-screening","label":"Transaction risk screening","items":[{"label":"Initiate standalone fraud screening","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/risk-screening/other/request-standalone-fraud-screening","routeSlug":"/apis/risk-screening/other/request-standalone-fraud-screening","metadata":{"seo":{"title":"Initiate standalone fraud screening","description":"Performs a standalone fraud screening analysis for a transaction. All fields are optional."}},"httpPath":"/transaction-risk-screenings/standalone"}],"metadata":{"type":"openapi","title":"Transaction risk screening service API","version":"1.0.0","description":"This is an API reference for the Transaction Risk Screening service."}},{"type":"group","fsPath":"apis/links.json","link":"/apis/links","routeSlug":"/apis/links","label":"Links","items":[{"label":"Create a payment link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/links/other/create-payment-link","routeSlug":"/apis/links/other/create-payment-link","metadata":{"seo":{"title":"Create a payment link","description":"Generate a secure payment link for customers. Supports both single-use and multi-use payment links with comprehensive configuration options for payment methods, customer data collection, and post-payment behaviours."}},"httpPath":"/links"}],"metadata":{"type":"openapi","title":"Links API","version":"1.0.0","description":"This is an API reference for the Links service. The Links API enables you to programmatically generate secure payment links for your customers with comprehensive configuration options for payment methods, customer data collection, and post-payment behaviours."}},{"type":"group","fsPath":"apis/wallets.json","link":"/apis/wallets","routeSlug":"/apis/wallets","label":"Wallets","items":[{"type":"link","label":"Use cases","link":"/apis/wallets/section/use-cases","routeSlug":"/apis/wallets/section/use-cases"},{"label":"Decrypt a wallet payment token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/wallets/other/decrypt-wallet-token","routeSlug":"/apis/wallets/other/decrypt-wallet-token","metadata":{"seo":{"title":"Decrypt a wallet payment token","description":"Decrypts an encrypted payment token from Apple Pay or Google Pay. This endpoint allows you to process wallet payment tokens on your backend, extracting the necessary payment and authentication data required for transaction authorisation. The decryption process validates the token integrity and returns structured payment information specific to the wallet provider."}},"httpPath":"/wallets/{wallet}/decrypt-token"}],"metadata":{"type":"openapi","title":"Wallet token decryption API","version":"1.0.0","description":"This API enables you to decrypt Apple Pay and Google Pay payment tokens on your backend systems. The decryption service processes encrypted wallet tokens and returns the decrypted payment data, including card details, cryptograms, and authentication information necessary for transaction processing.\n\n## Use cases\n\nYou may want to decrypt wallet token payloads for several reasons:\n\n- **Transaction processing**: Extract the payment account number (PAN/DPAN) and cryptogram required to authorise transactions through payment processors.\n- **Fraud detection and risk assessment**: Access device identifiers, authentication data, and assurance details to perform custom fraud screening and risk analysis.\n- **Compliance and audit requirements**: Retrieve transaction amounts, currency codes, and authentication responses for regulatory reporting and record-keeping.\n- **Custom payment workflows**: Implement specialised payment logic, such as split payments, conditional routing, or multi-step authorisation processes.\n- **Token vault integration**: Store decrypted payment credentials in a secure token vault for recurring payments or subscription management.\n- **3D Secure processing**: Access cryptograms and ECI indicators for transactions requiring additional authentication steps."}}]}