Visa Accept Service B2B APIs
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](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1appdetails/get_v1%20-%20Latest) |
| 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](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1cardeligibility/post_v1%20-%20Latest)[GET /nametags/{sellerNameTag}](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1sellers~1nametags~1{sellerNameTag}/get_v1%20-%20Latest) |
| 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](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1sellers/post_v1%20-%20Latest)[POST /sellers/search](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1sellers~1search/post_v1%20-%20Latest) |
| 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](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1sellers~1{sellerId}~1devices/post_v1%20-%20Latest) |
| 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](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API/operation/createTransaction_v1%20-%20Latest)[POST /sellers/{sellerId}/transaction-links](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API/operation/Creates%20hosted%20payment%20links%20for%20card-not-present%20transactions%20where%20customers%20complete%20payment%20on%20a%20Visa-hosted%20checkout%20page%20instead%20of%20providing%20card%20details%20directly%20to%20the%20merchant._v1%20-%20Latest) |
| 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}](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1sellers~1{sellerId}~1transactions~1{transactionId}/get_v1%20-%20Latest)[GET /sellers/{sellerId}/transactions](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1sellers~1{sellerId}~1transactions/get_v1%20-%20Latest) |
| 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](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1sellers~1search/post_v1%20-%20Latest)[PUT /sellers/{sellerId}](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1sellers~1{sellerId}/put_v1%20-%20Latest)[DELETE /sellers/{sellerId}](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1sellers~1{sellerId}/delete_v1%20-%20Latest)[POST /notification/seller/status](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1notification~1seller~1status/post_v1%20-%20Latest) |
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](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1appdetails%20/get_v1%20-%20Latest). 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](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1cardeligibility/post_v1%20-%20Latest). 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}](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1sellers~1nametags~1{sellerNameTag}/get_v1%20-%20Latest). 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](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1sellers/post_v1%20-%20Latest). This call returns asellerId. 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](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API/operation/Creates%20hosted%20payment%20links%20for%20card-not-present%20transactions%20where%20customers%20complete%20payment%20on%20a%20Visa-hosted%20checkout%20page%20instead%20of%20providing%20card%20details%20directly%20to%20the%20merchant._v1%20-%20Latest). Store thetransactionIdfrom 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](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1sellers~1{sellerId}~1devices/post_v1%20-%20Latest). - Compliance Reporting: Submit KYB/TnC data using
[POST /v1/apps/{appId}/notification/seller/status](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1notification~1seller~1status/post_v1%20-%20Latest)when required. - Transaction History: Retrieve transaction details using
[GET /v1/apps/{appId}/sellers/{sellerId}/transactions](https://developer.visa.com/capabilities/visa-accept/reference#tag/Visa-Accept-API_/paths/~1va~1v1~1apps~1{appId}~1sellers~1{sellerId}~1transactions~1{transactionId}/get_v1%20-%20Latest)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
/appdetailsbefore beginning integration workflows. Integration mode affects available endpoints and required parameters.