Visa AR Manager

How To Use

Visa AR Manager provides comprehensive API workflows that support both onboarding processes and payment capabilities, working together to deliver complete virtual card payment solutions.

If you are onboarding suppliers yourself, follow this sequential process to implement a complete Visa AR Manager integration:

1. Supplier Profile API– Register new suppliers with complete business profile information including company details, addresses, and business contacts using the /varm/v1/onboarding/supplier endpoint.

2. Supplier Onboarding Status API– Track the progress of supplier setup through various provisioning stages including registration, consent, configuration, and customer creation using the /varm/v1/onboardingstatus endpoint.

3. Supplier Participation Agreement API– Submit supplier's consent to the participation agreement terms using the /varm/v1/participationagreement endpoint.

4. Supplier Customer Onboarding API– Onboard customer relationships for onboarded suppliers using the /varm/v1/onboarding/customer endpoint.

5. Supplier Relationship Details API– Query and manage established supplier-customer relationships for ongoing operational needs using the /varm/v1/relationshipinfo endpoint.

6. Payment Request API – Transmit virtual card transactions using the /varm/v1/payment endpoint. This API can also be used to initiate a penny test to validate account details during supplier onboarding.

7. Supplier Deposit Confirmation API – Validate account details during supplier onboarding by providing confirmation of penny test using the /varm/v1/deposit endpoint.

8. Retrieve Payment Status API– Monitor and retrieve virtual card transaction status using the /varm/v1/paymentinfo endpoint.

Make Your First API Call

Making your first API call helps verify that your authentication is properly configured and that you can successfully communicate with the Visa AR Manager API. Choose your starting point based on whether you need onboarding or payment capabilities.

Before making your first API call, ensure you have completed the authentication setup and have access to the development environment.

1. Select the appropriate endpoint for your first call based on your integration workflow. Onboarding APIs (typically called first):
   • Supplier Profile – Use POST /varm/v1/onboarding/supplier to register new suppliers with business profile information.
   • Supplier Onboarding Status – Use GET /varm/v1/onboardingstatus to track supplier provisioning progress if you have a request ID.
   • Supplier Participation Agreement – Use POST /varm/v1/participationagreement to submit suppliers consent to the participation agreement.

Payment APIs (used after onboarding is complete):

• Payment Request – Use POST /varm/v1/payment if you need to relay virtual card details to processors.
• Supplier Deposit Confirmation – Use POST /varm/v1/deposit to process deposit transactions and confirm penny test.
• Status Inquiry – Use GET /varm/v1/paymentinfo if you have existing request IDs to query.

2. Set up the required headers based on your chosen endpoint.
3. Build the complete URL using the certification environment base URL.
4. Prepare your request body (if applicable).
5. Make the HTTP request using your preferred HTTP client or programming language and send your API request. Ensure you:
   • Use HTTPS for secure communication.
   • Include all required headers.
6. Examine the API response to verify successful communication.

Supplier Profile API

Onboard a new supplier to Visa AR Manager with complete company details, address, business contact, and notification recipient information using the Supplier Profile API endpoint ( /varm/v1/onboarding/supplier).

1. Prepare the supplier company information with all required business details.
2. Structure the complete business address information.
3. Configure the primary business contact information.
4. Set up reconciliation and exception notification recipients.
5. Configure payment preferences (optional).
6. Make a POST request to the /varm/v1/onboarding/supplier endpoint and send the supplier profile request.
7. Process the response and extract key information.

Supplier Onboarding Status API

Retrieve the current status of a supplier onboarding request and track provisioning progress using the Visa AR Manager Supplier Onboarding Status API endpoint ( /varm/v1/onboardingstatus).

1. Prepare the request ID from the initial supplier onboarding response.
2. Configure the status inquiry request with proper query parameters.
3. Make a GET request to the /varm/v1/onboardingstatus endpoint and send the supplier onboarding status request.
4. Analyze the onboarding status response for comprehensive status tracking.

Supplier Participation Agreement API

Submit the supplier participation agreement consent with authorized signer details after supplier onboarding completion using the Visa AR Manager Supplier Participation Agreement API endpoint ( /varm/v1/participationagreement).

1. Prepare the authorized signer details and collect the required signer information for the participation agreement.
2. Retrieve and use the participation agreement link returned from the supplier onboarding API response.
3. Provide supplier identification using one or both identifiers.
4. Validate signer information and agreement link.
5. Make a POST request to the /varm/v1/participationagreement endpoint and send the participation agreement request.
6. Process the participation agreement response.

Supplier Customer Onboarding API

Create new customer relationships and link them to existing suppliers in Visa AR Manager using the Supplier Customer Onboarding API endpoint ( /varm/v1/onboarding/customer).

1. Prepare the customer identification and basic information with all required customer details.
2. Provide the supplier identification using one or both identifiers.
3. Make a POST request to the /varm/v1/onboarding/customer endpoint and send the customer onboarding request.
4. Process the customer onboarding response.

Supplier Relationship Details API

Retrieve information about established customer–supplier relationships using the Visa AR Manager Supplier Relationship Details API endpoint ( /varm/v1/relationshipinfo).

1. Determine the scope of relationship information to retrieve.
2. Configure filtering parameters to narrow the relationship results based on your requirements.
3. Make a GET request to the /varm/v1/relationshipinfo endpoint and send the relationship information query request.

Payment Request API

Transmit virtual card details to an acquirer's designated payment gateway using the Visa AR Manager Payment Request API endpoint ( /varm/v1/payment).

1. Create a unique request_id for the payment transaction.
2. Structure the supplier_id object with the supplier identification information.
3. Set up the required authentication headers.
4. Make a POST request to the /varm/v1/payment endpoint and send the payment request.

Supplier Deposit Confirmation API

Validate penny test deposits were successfully received by suppliers using the Visa AR Manager Supplier Deposit Confirmation API endpoint ( /varm/v1/deposit).

1. Provide the supplier identification using one or both identifiers for the deposit confirmation.
2. Structure the payment details array for deposit confirmations.
3. Make a POST request to the /varm/v1/deposit endpoint and send the deposit confirmation request.

Retrieve Payment Status API

Monitor and retrieve payment transaction status using the Visa AR Manager Retrieve Payment Status API endpoint ( /varm/v1/paymentinfo).

1. Use the request_id from your payment request.
2. Make a GET request to the /varm/v1/paymentinfo endpoint and send the status inquiry request.

Best Practices

Implementing these best practices will help ensure reliable, secure, and efficient integration with the Visa AR Manager APIs.