Enrollment statuses apply to both Full SDK and Lite checkout implementations. These are distinct from payment statuses. They track the credential vaulting lifecycle, not a payment transaction.
Enrollment Status Values
Initial state at the time of creating a payment method. The enrollment process has not yet started.
The payment method is available for enrollment. The customer can proceed with the enrollment flow in the SDK.
The payment method enrollment is being processed. Yuno is communicating with the provider to complete the enrollment.
The payment method enrollment has been successful. A
vaulted_token is now available for future payments.Removal of the enrolled payment method is underway. The unenrollment request has been sent to the provider.
The payment method has been unenrolled. The
vaulted_token is no longer valid for future payments.The payment method enrollment failed processing at the provider level.
Yuno has declined the enrollment request. This may occur due to risk rules or validation failures.
The enrollment was terminated by the user or system before completion.
The payment method or enrollment session has reached its expiration date before completing enrollment.
There was an error in the enrollment of the payment method. This is typically a transient issue. Retry the enrollment.
Status Lifecycle
Enrollment statuses progress through the following phases:| Phase | Statuses | Description |
|---|---|---|
| Initial | CREATED | Payment method record created, enrollment not started |
| Ready | READY_TO_ENROLL | Awaiting customer action in the SDK |
| Processing | ENROLL_IN_PROCESS, UNENROLL_IN_PROCESS | Provider communication in progress |
| Success | ENROLLED, UNENROLLED | Terminal success states |
| Failure | DECLINED, REJECTED, CANCELED, EXPIRED, ERROR | Terminal failure states |
Enrollment Flow
A typical enrollment follows these steps:- Create a Customer Session. Generates an
sdk_tokenscoped to the customer. - Initialize the SDK. Use the
sdk_tokento render the enrollment UI on the client. - Customer submits credentials. The SDK tokenizes the card and begins enrollment.
- Monitor status. The payment method transitions through
CREATED→READY_TO_ENROLL→ENROLL_IN_PROCESS→ENROLLED. - Use the vaulted token. Once
ENROLLED, thevaulted_tokencan be used in Checkout Sessions for one-click payments.
Related Pages
- Customer Session Object. The session used to initiate enrollment
- Create Customer Session.
POST /v1/customers/{customer_id}/sessions - Payment Method Object. The enrolled payment method record
- Enroll Payment Method.
POST /v1/customers/{customer_id}/payment-methods - Unenroll Payment Method.
DELETE /v1/customers/{customer_id}/payment-methods/{id} - Enrollment Guide. Step-by-step SDK enrollment guide