vaulted_token that references the payment details without exposing sensitive information. This enables recurring payments, subscriptions, and retries across providers while maintaining PCI compliance.
Vaulted TokenA Vaulted Token is created once a payment method is enrolled and stored with the customer information. You can use the created Vaulted Token to identify the payment method in future payments.
Available payment methods for enrollment
| Payment method | Type |
|---|---|
| Cards | CARD |
| Nupay | NU_PAY_ENROLLMENT |
| PayPal | PAYPAL_ENROLLMENT |
| Daviplata | DAVIPLATA_ENROLLMENT |
| MercadoPago Wallet | WALLET_CONNECT |
| dLocal Yape | YAPE_ENROLLMENT |
| dLocal Smart PIX | SMART_PIX |
| Astropay | ASTROPAY_ENROLLABLE |
| Nequi* | NEQUI |
| Bancolombia Tokenbox* | BANCOLOMBIA_TOKENBOX |
| Adyen PIX Biométrico | PIX_BIOMETRICO |
Requirements
- Gather your API credentials from the Yuno Dashboard:
public-api-keyprivate-secret-keyaccount_id
- Set up connections on your Yuno Dashboard. Add a payment method that requires enrollment.
- Build a route for the payment method to define how it will be processed.
- Configure the checkout builder to make your connected payments available.
Steps summary
To enroll a payment method into a customer account:- Create a Customer
- Create Customer Session (Only for Checkout workflow)
- (Optional) Retrieve Payment Methods Available to Enroll - Checkout workflow
- Enroll Payment Method Checkout workflow/Direct workflow
- Retrieve Payment Methods - Direct workflow
Enroll a payment method
Step 1: Create a customer
Register customer info through the Create Customer endpoint. Also, supply themerchant_customer_id, a unique identifier for the customer used on your system.
Customer complementary informationProviding optional details like phone, billing address, and shipping address enhances the payment experience. If you include these fields, certain sub-fields become required.
id that identifies them in Yuno. If your customer already has an id, skip this step.
Step 2: Create a customer session
Create a customer session to store the customer’s payment preferences using the Create Customer Session endpoint. Use theid from Step 1 as the customer_id.
The response returns a customer_session, which you’ll use to enroll the payment method.
Step 3: Retrieve payment methods to enroll
This optional step lists all available payment methods the customer can enroll. If you already know which payment method to enroll, proceed to Step 4. To list available payment methods, use the Retrieve Payment Methods To Enroll endpoint. For the Checkout workflow, include thecustomer_session in the request. The Direct workflow doesn’t currently support retrieving payment methods to enroll.
The response returns a payment_methods array containing all available payment methods to enroll. Use the type field from this response in the next step.
Available Payment MethodsOnly payment methods that you’ve connected, routed, and added to your checkout will appear in the response.
Step 4: Enroll a payment method
Enroll the payment method using one of the following endpoints:- Checkout workflow: Pass the payment method
typeto thepayment_method_typeparameter. Supported types include:CARD,NU_PAY_ENROLLMENT,PAYPAL_ENROLLMENT,DAVIPLATA_ENROLLMENT,WALLET_CONNECT,YAPE_ENROLLMENT,SMART_PIX,ASTROPAY_ENROLLABLE,PIX_BIOMETRICO. - Direct workflow: Pass the payment method
typeto thetypeparameter. (Only available forCARDpayment methods used by PCI compliant merchants) - SDK workflow: Payment methods like
NEQUIandBANCOLOMBIA_TOKENBOXrequire SDK implementation.WALLET_CONNECT(MercadoPago) supports both SDK and Checkout workflows.
Step 5: Retrieve payment methods
The customer must provide authorization on the payment provider page. Retrieve the authorization URL based on your workflow:- Checkout workflow: The enrollment URL appears in the enrollment response from Step 4. Find it in
provider.redirect.init_url. - Direct workflow: You’ll receive the final status in Step 4 (cards only).
status is ENROLLED.
FingerprintWhen a credit card is enrolled, the response includes a
fingerprint field that represents your customer’s card across your organization. If a customer enrolls the same card multiple times, multiple vaulted_token values are generated, but the fingerprint remains the same, allowing you to deduplicate on your side. See Card Fingerprint.The fingerprint is available after enrollment but can be null for some providers. Always check for its presence before using it for deduplication.The fingerprint also appears in payment responses when a transaction uses an enrolled credit card.