Navigate to...

How to Use

API Capabilities

Visa Accept Service B2B APIs support seller onboarding, transaction processing, and ongoing management through a set of integration stages. Each stage requires specific APIs that must be executed in sequence to ensure correct processing.

Your backend orchestrates these APIs to validate data, manage seller profiles, and process transactions. Seller onboarding and activation must be completed before transaction processing, and most operations depend on identifiers returned from earlier steps.

This table groups APIs by integration stage and maps each stage to its corresponding endpoints.

Visa Accept API Capabilities by Lifecycle Stage

Lifecycle Stage	Description	APIs / Endpoints
Application Configuration	Retrieves application configuration settings including integration mode (API-Only or Hybrid), account closure period, and other app-specific properties. This should be the first API call to understand how your application is configured.	`GET /appdetails`
Pre-Eligibility Validation	Validates prerequisites required before creating a seller profile. These checks confirm that the payment instrument is supported and that the seller identifier is available, helping prevent enrollment failures.	`POST /cardeligibility` `GET /nametags/{sellerNameTag}`
Seller Onboarding	Creates the seller profile and establishes the identity used for all subsequent operations. This stage returns the sellerId, which must be stored and reused for transaction processing and lifecycle operations.	`POST /sellers` `POST /sellers/search`
Device Registration (Hybrid only)	Registers devices used for payment acceptance in Hybrid integrations. This stage applies only when using SDK-based Tap-to-Phone or card-present scenarios that require device-level configuration.	`POST /sellers/{sellerId}/devices`
Payment Initiation	Initiates payment or refund transactions for an active seller. Supports direct transaction processing where your backend submits transaction requests, and hosted payment links where customers complete checkout on a Visa-hosted page.	`POST /sellers/{sellerId}/transactions` `POST /sellers/{sellerId}/transaction-links`
Transaction Lifecycle Management	Provides access to transaction history and detailed transaction data for reconciliation, reporting, and refund workflows. These APIs allow you to retrieve individual transaction records and related transaction information.	`GET /sellers/{sellerId}/transactions/{transactionId}` `GET /sellers/{sellerId}/transactions`
Seller Lifecycle Management	Supports ongoing maintenance of seller profiles after onboarding. These APIs allow you to update seller details, search for existing sellers, manage account closure, and report compliance status (KYB/TnC completion) to Visa Accept.	`POST /sellers/search` `PUT /sellers/{sellerId}` `DELETE /sellers/{sellerId}` `POST /notification/seller/status`

Complete seller onboarding and confirm an ACTIVE seller status before invoking transaction APIs. Transaction processing requests for inactive or incomplete seller profiles will fail.

Seller Enrollment and Lifecycle Flow

This diagram illustrates the seller onboarding and lifecycle management flow across pre-enrolment, enrollment, and post-onboarding operations

Payment and Transaction Flow

This diagram illustrates payment initiation and transaction processing flows after the seller has been onboarded and activated.

Workflow Overview

This section describes the end-to-end API usage flow for integrating Visa Accept Service B2B APIs across the full seller lifecycle, from enrollment through transaction processing and ongoing management.

End-to-End API Workflow Mapping

Workflow Stage	Endpoints
Application setup	GET /v1/apps/{appId}/appdetails
Eligibility validation	POST /v1/apps/{appId}/cardeligibility GET /v1/apps/{appId}/sellers/nametags/{sellerNameTag}
Seller enrollment	POST /v1/apps/{appId}/sellers
Transaction processing	POST /v1/apps/{appId}/sellers/{sellerId}/transactions
Lifecycle management	PUT /v1/apps/{appId}/sellers/{sellerId} DELETE /v1/apps/{appId}/sellers/{sellerId}

This workflow defines the end-to-end sequence of API calls required to enable seller acceptance capabilities across the full lifecycle.

The primary business workflows include:

Seller Enrollment and Setup: Register new sellers and configure their acceptance capabilities
Activation of Acceptance Capabilities: Enable payment processing for enrolled sellers
Transaction Processing: Handle sales and refunds for active sellers
Lifecycle Management: Update seller profiles and manage account status

The workflow sequence ensures that seller onboarding and activation are completed before transaction processing begins, with transaction processing workflows depending on an active seller profile and refund workflows depending on previously processed transactions.

Standard Workflow Steps

The Main Workflow

To enable seller acceptance capabilities, follow this specific sequence of API calls.

Application Configuration: Retrieve application settings using GET /v1/apps/{appId}/appdetails. Use the response to determine integration mode and applicable account policies before calling other APIs.
Card Eligibility Validation: Validate payment instruments before enrollment using POST /v1/apps/{appId}/cardeligibility. Confirm the card is eligible before proceeding with seller enrollment.
Seller Name Tag Check: Verify seller identifier availability using GET /v1/apps/{appId}/sellers/nametags/{sellerNameTag}. If the name tag is already in use, select a different value before enrolling the seller.
Seller Enrollment: Register new sellers using POST /v1/apps/{appId}/sellers. This call returns a sellerId. Store this value and use it in all subsequent seller-related API calls.
Transaction Processing: Process payments and refunds using POST /v1/apps/{appId}/sellers/{sellerId}/transactions. Store the transactionId from successful responses and use it for refunds and reconciliation.

Optional Workflow Extensions

Device Registration: For Hybrid mode integrations, register additional devices using POST /v1/apps/{appId}/sellers/{sellerId}/devices.
Compliance Reporting: Submit KYB/TnC data using POST /v1/apps/{appId}/notification/seller/status when required.
Transaction History: Retrieve transaction details using GET /v1/apps/{appId}/sellers/{sellerId}/transactions for reconciliation.

Avoiding Product Configuration Errors

Common Integration Challenges

Common challenges when integrating with Visa Accept:

Seller Onboarding and Activation: Transactions are attempted before onboarding or activation is complete. Always verify seller status is ACTIVE before processing payments.
Incomplete or Inconsistent Configuration: Required setup steps are not completed across all systems prior to use. Complete application configuration, card eligibility validation, and seller enrollment in sequence.
Sandbox to Production Readiness: Prerequisites or validations are not fully completed before production go-live. Ensure all required agreements, approvals, and regional validations are in place.

Preventing Common Mistakes

During integrations, avoid these common errors:

Transaction Timing: Do not attempt payment or refund calls before sellers are fully onboarded and activated. Always check seller status first.
Reference Management: Retain original transaction identifiers required for refunds or reconciliation. Missing transaction references prevent refund processing.
Flow Assumptions: Do not treat the APIs as single-step payment actions. Follow the complete sequence: onboarding, activation, transaction, and post-transaction steps.
Configuration Dependencies: Verify application settings using /appdetails before beginning integration workflows. Integration mode affects available endpoints and required parameters.