Overview

The Visa Click to Pay APIs enable merchants and platforms to:

• retrieve Click to Pay merchant configuration,
• retrieve frontend encryption keys,
• process Click to Pay transactions,
• process Direct Wallet transactions,
• enable Visa Click to Pay on Platform and Tenant levels.

These endpoints support Hosted Session, Hosted Payment Page, Direct API, and Mobile SDK integration flows.

This page lists the currently identified Visa Click to Pay endpoints based on the feature design and implementation architecture. Full request and response schemas will be added once final API specifications and collections become available.

Base URL

https://api-gateway.sandbox.ngenius-payments.com

Authentication

All Visa Click to Pay endpoints require authentication using a Bearer token.

Example:

Authorization: Bearer {{access_token}}

Some endpoints may additionally require specific token permissions.

Available Endpoints

• HTTP method to be confirmed.

Retrieve Merchant Configuration

Retrieves the onboarded Visa Click to Pay configuration for a merchant.

Endpoint

GET /config/merchants/:merchantRef/configs/vctp

Purpose

This endpoint:

• retrieves merchant onboarding configuration,
• returns Click to Pay configuration values,
• provides values required by frontend SDK integrations,
• provides dpaId and dpaClientId values.

Path Parameters

Authentication

Bearer Token required.

Notes

This endpoint is commonly used during:

• Hosted Session integrations,
• Direct API integrations,
• frontend SDK initialization flows.

Retrieve Encryption Keys

Retrieves the public encryption key used by the frontend during Click to Pay checkout operations.

Endpoint

GET /config/configs/vctp/encryption-keys

Purpose

This endpoint:

• retrieves the payload encryption public key,
• retrieves the encryption key ID,
• supports frontend-side payload encryption,
• supports SDK checkout flows.

Required Permissions

VIEW_UCTP_WALLET_CERTIFICATE

Authentication

Bearer Token required.

Notes

The retrieved values are used by the frontend during the checkout() flow.

Process Click to Pay Payment

Processes a Visa Click to Pay payment after a successful frontend checkout() response.

Endpoint

POST /transactions/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/click-to-pay

Purpose

This endpoint:

• accepts the Click to Pay checkout response,
• validates the checkout response signature,
• decrypts the payload,
• processes the payment flow.

Path Parameters

Query Parameters

Authentication

Bearer Token required.

Required Permissions

CREATE_AUTHORIZATION

Notes

The checkoutResponse object should be passed exactly as returned by the Visa Click to Pay SDK without modification.

Process Direct Wallet Payment

Processes Direct Wallet Click to Pay transactions using decrypted tokenized payment data.

Endpoint

POST /transactions/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/click-to-pay/direct

Purpose

This endpoint:

• processes direct wallet transactions,
• accepts decrypted payment token data,
• supports tokenized wallet payment flows,
• supports advanced Direct API integrations.

Path Parameters

Authentication

Bearer Token required.

Required Permissions

CREATE_AUTHORIZATION

Notes

This endpoint requires the Direct Wallet proposition service to be enabled.

Enable Visa Click to Pay on Platform Level

Enables Visa Click to Pay as a payment method on the Platform level.

Endpoint

/config/platform/configs/payment-methods

Purpose

This endpoint:

• enables Visa Click to Pay at Platform level,
• allows Tenant-level enablement,
• supports Mobile SDK and Direct API integrations.

Authentication

Platform-level access token required.

Notes

This step is required for:

• Mobile SDK integrations,
• Direct API integrations.

Enable Visa Click to Pay on Tenant Level

Enables Visa Click to Pay as a payment method on the Tenant level.

Endpoint

/config/tenants/{tenantRef}/configs/payment-methods

Purpose

This endpoint:

• enables Visa Click to Pay on the Tenant level,
• allows payment methods to be returned during order creation,
• enables Direct API payment link generation.

Path Parameters

Authentication

Platform-level access token required.

Related Documentation

• Overview
• Integration Options
• Payment Flow
• Merchant Onboarding APIs
• Platform & Tenant Enablement
• Security & Encryption
• Hosted Session Integration
• Direct API Integration

Additional Notes

The current implementation documentation is based on:

• architectural design documentation,
• onboarding workflows,
• SDK integration requirements,
• payment processing flows,
• internal enablement requirements.