Getting Started

.

Product Overview

Visa Accept Service B2B APIs enable financial institutions and their partners to embed payment acceptance capabilities for small‑scale sellers directly into digital banking and other mobile apps.

Use these APIs to manage the seller lifecycle, from enrollment through payment processing.

Common use cases include seller onboarding and setup, activation of acceptance credentials, processing card transactions, and supporting refunds tied to prior transactions.

Integration Models

Visa Accept provides two supported integration models that rely on the Visa Accept Service B2B APIs as the technical foundation for onboarding, eligibility checks, device registration, and transaction processing.

You integrate the APIs directly in an API-Only model, where your application performs all credential-capture and encryption steps. Alternatively, you use a Hybrid model, where you combine the Visa-developed KiC Tap to Pay Ready Application SDK with the APIs to support secure card-present capture and the broader backend flow. These API-based options allow you to implement Visa Accept in a way that matches your technical architecture and security capabilities.

API-Only Model

In the API-Only model, your system performs all seller-side and device-side responsibilities, including capturing credentials, handling encryption, and implementing the steps required to accept a card payment. You call the Visa Accept Service B2B APIs for backend functions such as submitting card eligibility checks, seller enrollment, PAN or token registration, device registration, and payment processing.

This model supports clients that already have a secure method for capturing and protecting cardholder data, such as an existing wallet, payment app, or POS flow. Because you manage the capture and security steps directly, you select only the endpoints required for your use case. The modular structure of the APIs allows you to integrate specific Visa Accept lifecycle and payment flows without adopting SDK components.

Hybrid Model

In the Hybrid model, you integrate the Visa-developed Kernel in the Cloud (KiC) Tap to Pay Ready Application SDK into your mobile application and use the Visa Accept Service B2B APIs for the backend steps of the flow. The SDK handles the device-side operations required for Tap-to-Phone and other card-present scenarios, and it initiates the corresponding API calls when your application initializes or invokes SDK functions.

This model supports Tap-to-Phone interactions that require secure, SDK-managed credential capture and cryptographic processing, while the APIs support seller onboarding, eligibility checks, device registration, payment processing, and other lifecycle tasks.

This model also supports Pay-by-Link (PBL) independently of Tap-to-Phone. For card-not-present flows, sellers use PBL without enabling Tap-to-Phone. The SDK is embedded directly into your application, so sellers are not asked to download a separate third-party app. You rely on the SDK for sensitive data capture and rely on the APIs for the modular backend functions needed throughout the Visa Accept integration.

SDKs and related integration guides are made available through your Visa Developer project after required approvals.

Prerequisites

Complete these tasks before attempting any Visa Accept Service B2B API calls.

Standard Setup Requirements

Before you begin integration, complete the standard Visa Developer setup:

Product-Specific Requirements

Production use is limited to approved Visa clients (typically financial institutions) who have obtained the applicable solution approval from Visa. Access may also depend on regional Visa Accept availability and sponsor approval where applicable.

You must complete the following before production integration:

  • Obtain the applicable solution approval from Visa
  • Complete onboarding approval process
  • Confirm regional Visa Accept availability for your target markets
  • Confirm your solution complies with the Visa Developer Center Terms of Use (including the Visa Accept Product Terms and Documentation) and any region-specific Visa product requirements, configurations or restrictions
  • Secure sponsor approval (if applicable) where required by regional requirements

Environment Hosts and URL Structure

Environment Hosts

Production Environment:

https://api.visa.com
		

Sandbox Environment:

https://sandbox.api.visa.com
		

URL Structure

Visa Accept Service B2B API requests follow this URL pattern:

  • Environment host, such as sandbox, certification, or production
  • Product base path /va
  • Endpoint path, such as /appdetails

Example production request:

GET https://api.visa.com/va/appdetails
		

Headers and Authentication

Authentication Method

All requests require x-pay-token authentication and specify an application/json content type.

Required Headers

Include the following headers in your API requests:

x-pay-token: {your-x-pay-token-value}
Content-Type: application/json
		

The Content-Type header is required for requests with a body. GET requests typically do not require this header unless specified in the endpoint documentation.

Your First API Call

Make your first Visa Accept Service B2B API call to confirm authentication and retrieve application configuration details.

Recommended First Call

Use this call first to confirm authentication and retrieve application settings for integration mode and account policies.

Request

GET https://api.visa.com/va/appdetails

Headers:

x-pay-token: {your-x-pay-token-value}
		

This endpoint does not require a request body or Content-Type header.

Expected Responses

  • 200 OK returns application configuration details including integration mode settings and account policies.
  • 400 Bad Request indicates invalid request parameters or missing required headers.
  • 401 Unauthorized indicates authentication failure with x-pay-token.
  • 500 Internal Server Error indicates a server error. Retry the request or contact support.

Confirming Successful Integration

Validate your integration by testing key workflow endpoints and confirming expected responses.

Success Validation Steps

You have successfully integrated when you can enroll sellers, process transactions, retrieve transaction details, and process refunds using the defined API workflows.

Complete these validation steps in sequence:

  1. Application Configuration: Confirm /appdetails returns your application settings successfully.
  2. Card Eligibility Validation: Test /cardeligibility with a valid card number to confirm payment processing capability.
  3. Seller Enrollment Test: Complete a test seller enrollment using /sellers and verify ACTIVE status is returned.
  4. Transaction Processing Test: Process a small test transaction using /sellers/{sellerId}/transactions with status "Approve".

Key Success Indicators

  • Application details retrieved successfully (confirms app configuration)
  • Card eligibility validated (confirms payment processing capability)
  • Seller enrollment completed with ACTIVE status
  • Test transaction approved with status "Approve"
  • Transaction details retrievable for reconciliation