Skip to main content
The Payment Method object represents a payment credential that has been enrolled (vaulted) for a customer. Vaulted methods enable one-click checkout, recurring payments, and subscription billing without requiring the customer to re-enter their details.
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

id
string
The unique identifier for this payment method (UUID).Example: pm_3f4e5d6c-7b8a-9012-3456-789abcdef012
customer_id
string
The ID of the Customer Object this payment method belongs to.Example: c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f
type
string
The payment method type.Values: CARD, PIX, BOLETO, OXXO, PSE, BANK_TRANSFER, WALLET, BNPL, NEQUI, SPEIExample: CARD
status
string
Current status of the payment method.Values: ACTIVE, DISABLEDExample: ACTIVE
card
object
Card-specific details. Present only when type is CARD.
vaulted_token
string
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-ba9876543210
country
string
Country associated with this payment method. For cards, this is the issuer country. ISO 3166-1 alpha-2 code.Example: US
created_at
string
ISO 8601 timestamp of when the payment method was enrolled.Example: 2026-02-15T09:30:00.000Z

Example

{
  "id": "pm_3f4e5d6c-7b8a-9012-3456-789abcdef012",
  "customer_id": "c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
  "type": "CARD",
  "status": "ACTIVE",
  "card": {
    "first_six": "411111",
    "last_four": "1111",
    "brand": "VISA",
    "type": "CREDIT",
    "expiration_month": 12,
    "expiration_year": 2028,
    "holder_name": "JOHN A SMITH"
  },
  "vaulted_token": "vtok_9f8e7d6c-5b4a-3210-fedc-ba9876543210",
  "country": "US",
  "created_at": "2026-02-15T09:30:00.000Z"
}

Enrollment Contexts

Payment methods can be enrolled in two contexts:
ContextDescriptionHow
Checkout flowCustomer saves their method during a payment. Set vault_on_success: true in the checkout session.Via Checkout Session
Direct enrollmentCustomer enrolls a method without making a payment (e.g., account settings page).Via Customer Session + SDK
Both contexts produce the same Payment Method object. The vaulted_token can be used interchangeably regardless of how it was created.