Unified object. In Yuno API v2, payment methods use a single unified object regardless of whether they were enrolled through the checkout flow or the direct enrollment flow. In v1, these were separate objects. If you are migrating, see Migration Guide.
Object Fields
The unique identifier for this payment method (UUID).Example:
pm_3f4e5d6c-7b8a-9012-3456-789abcdef012The ID of the Customer Object this payment method belongs to.Example:
c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4fThe payment method type.Values:
CARD, PIX, BOLETO, OXXO, PSE, BANK_TRANSFER, WALLET, BNPL, NEQUI, SPEIExample: CARDCurrent status of the payment method.Values:
ACTIVE, DISABLEDExample: ACTIVECard-specific details. Present only when
type is CARD.The token reference for this vaulted payment method. Use this token in payment requests to charge the saved method without collecting card details again.Example:
vtok_9f8e7d6c-5b4a-3210-fedc-ba9876543210Country associated with this payment method. For cards, this is the issuer country. ISO 3166-1 alpha-2 code.Example:
USISO 8601 timestamp of when the payment method was enrolled.Example:
2026-02-15T09:30:00.000ZExample
Enrollment Contexts
Payment methods can be enrolled in two contexts:| Context | Description | How |
|---|---|---|
| Checkout flow | Customer saves their method during a payment. Set vault_on_success: true in the checkout session. | Via Checkout Session |
| Direct enrollment | Customer enrolls a method without making a payment (e.g., account settings page). | Via Customer Session + SDK |
vaulted_token can be used interchangeably regardless of how it was created.
Related Endpoints
- Enroll Payment Method.
POST /v1/customers/{customer_id}/payment-methods - List Payment Methods.
GET /v1/customers/{customer_id}/payment-methods - Get Payment Method.
GET /v1/customers/{customer_id}/payment-methods/{payment_method_id} - Unenroll Payment Method.
DELETE /v1/customers/{customer_id}/payment-methods/{payment_method_id}
Related Concepts
- Tokens. How vaulted tokens work and their lifecycle
- One-Click Checkout. Using vaulted methods for returning customers
- Enrollment Guide. Step-by-step guide to payment method vaulting
- Migration Guide. Differences between v1 and v2 payment method objects