Set up Yuno on VTEX

Documentation Index

Fetch the complete documentation index at: https://docs.y.uno/llms.txt

Use this file to discover all available pages before exploring further.

​

Before you start

• A user with administrator access to your VTEX dashboard.
• Your Yuno credentials, which you can find in your Yuno dashboard under Developers → API Credentials: Account ID, Public API Key, and Private Secret Key.

1

Configure Yuno as a payment provider

1. In the VTEX dashboard, open the left-hand menu and go to Store Settings → Payment → Providers, then click New Provider at the top right.

2. In the Select a provider dialog, type Yuno in the search box and select Yuno from the results.

3. Fill in the provider configuration form and save. Once saved, the provider is registered, but no payment methods are active yet.

Field reference

Field	Required	What it does
Application Key / Application Token	Yes	VTEX admin credentials the plugin uses to interact with VTEX on your behalf. See VTEX’s guide on generating Application Keys.
Automatic Settlement	Yes	Defines when the payment is captured automatically after authorization. Applies to card and wallet payments only.
Affiliation Name	Yes	A human-readable name for this Yuno integration.
Account ID	Yes	Your Yuno Account ID, available in your Yuno dashboard.
Public API Key	Yes	Your Yuno Public API Key. The prefix determines the environment.
Private Secret Key	Yes	Your Yuno Private Secret Key.
Main Account Name	Optional	For multi-account setups.
Main Account App key	Optional	Application Key of the main VTEX account.
Main Account App token	Optional	Application Token of the main VTEX account.
Soft Descriptor	Optional	Custom text that appears on the shopper’s card statement.
Create Customer	Optional	When set to Yes, the plugin creates a corresponding customer record in Yuno.
VTEX IO orderPlaced page URL	Optional	A custom URL where shoppers should be redirected after payment.
Payment Mode	Optional	Payment App (modern) or Legacy (redirect).
Transaction Identification From	Optional	Yuno TID or Provider TID.

Settlement Options

The Automatic Settlement field determines the timing of the capture for card and wallet payments.

Option	Practical Behavior
Use behavior recommended by payment processor	Immediate Capture: The transaction is captured immediately after authorization. (Default)
Automatic capture immediately after payment authorization	Immediate Capture: Same as default.
Automatic capture immediately after anti-fraud analysis	Immediate Capture: Behaves the same as immediate capture.
Disabled	Authorize Only: The transaction is only authorized. Capture happens later when the order is invoiced.

Environments: The Yuno environment is determined by the prefix of your Public API Key: dev_, staging_, sandbox_, or prod_.

We suggest using Use behavior recommended by payment processor unless your business specifically requires capture after invoicing.

2

Install the Yuno Payment App

After saving the provider configuration, install the Yuno Payment App from your VTEX dashboard.

1. In the VTEX dashboard, go to Apps → App Management.
2. Search for Yuno and select the Yuno Payment App in the list of available apps and open its Settings.

3. Click Install to complete the setup.

Once installed, the Payment App takes care of rendering the Yuno checkout experience inside your VTEX checkout.

3

Activate payment methods

Now choose which payment methods you want to offer to your shoppers and route them through Yuno.

1. In the VTEX dashboard, go to Store Settings → Payment → Settings → Payment Conditions. Click the + button to add a payment condition.

2. Select the payment method you want to activate (for example, Visa, Mastercard, Pix, Apple Pay, or any of the Yuno * generic methods).

3. In the Process with provider field, select the Yuno affiliation you configured in Step 1. Set the Status to Active and save.

Repeat for every method you want to offer. You can review the full list of available methods in the Overview page.

4

Configure the webhook in your Yuno dashboard

The webhook keeps your VTEX orders in sync with Yuno’s payment status updates.

1. In the Yuno dashboard, open Developers → Webhooks and click Add webhook.
2. Fill in the form:
   • Name: For example VTEX webhook.
   • Endpoint URL: https://{store_name}.myvtex.com/_v/yunopartnerbr.yuno/v4/webhook, replacing {store_name} with your VTEX account name.
   • x-api-key and x-secret: Enter any placeholder value (e.g., VTEX).
3. Select all events and click Add.

​

Advanced Scenarios

​

Multi-affiliation

​

Multi-account

• Main Account Name: The name of the main VTEX account.
• Main Account App key and Main Account App token: Application credentials of that main account.