Wallet

List the saved payment methods of the customer, and add a new one.

subbly.wallet.list(currencyCode)

Gets the payment methods the signed-in customer saved for one currency. A payment method belongs to a gateway, and a gateway belongs to a currency, so a customer who pays in two currencies has two sets. Needs an authenticated customer.

Method parameters

currencyCodeRequiredstring

Currency to list, such as USD. Take it from shop.currencies[].abbreviation.

ReturnsPromise<PaymentMethod[]>

The saved payment methods.


List the payment methods
const paymentMethods = await subbly.wallet.list('USD')

await subbly.cart.update({ paymentMethodId: paymentMethods[0].id })

subbly.wallet.setup(payload)

Gets the token a gateway widget needs before it can collect card details. Run it first, hand the token to the gateway's own SDK, then save what the gateway gives back with subbly.wallet.store.

Method parameters

payloadRequiredWalletSetupPayload

The gateway to set up.

ReturnsPromise<WalletSetupResponse>

The token for the gateway widget.


Start a Stripe card setup
const [gateway] = subbly.shop.currencies[0].gateways
const { token } = await subbly.wallet.setup({ gatewayId: gateway.id })

const { setupIntent } = await stripe.confirmCardSetup(token, {
  payment_method: { card: cardElement }
})

subbly.wallet.store(payload)

Saves a payment source for the customer from the token the gateway widget returned. The saved method can then be set on the cart or on a subscription. Needs an authenticated customer.

Method parameters

payloadRequiredPaymentMethodStorePayload

The source to save.

ReturnsPromise<PaymentMethod>

The payment method saved.


Save a Stripe card
const paymentMethod = await subbly.wallet.store({
  gatewayId: gateway.id,
  token: setupIntent.id
})

await subbly.cart.update({ paymentMethodId: paymentMethod.id })

subbly.wallet.setupIntent(payload)

Gets a Subbly-hosted page where Stripe runs 3-D Secure on a new card. Send the customer to subblyUrl; Stripe returns them to the redirectUrl you gave. Needs an authenticated customer.

Method parameters

payloadRequiredWalletSetupIntentPayload

The gateway to verify with, and where to come back to.

ReturnsPromise<WalletSetupIntentResponse>

Where to send the customer, and how long the link lasts.


Verify a card with 3-D Secure
const { subblyUrl } = await subbly.wallet.setupIntent({
  gatewayId: gateway.id,
  redirectUrl: `https://your-shop.com/checkout/${subbly.cart.id}`
})

window.location.assign(subblyUrl)

Last modified on September 15, 2026

Wallet

List the saved payment methods of the customer, and add a new one.

subbly.wallet.list(currencyCode)

Method parameters

currencyCodeRequiredstring

Currency to list, such as USD. Take it from shop.currencies[].abbreviation.

ReturnsPromise<PaymentMethod[]>

The saved payment methods.


List the payment methods
const paymentMethods = await subbly.wallet.list('USD')

await subbly.cart.update({ paymentMethodId: paymentMethods[0].id })

subbly.wallet.setup(payload)

Gets the token a gateway widget needs before it can collect card details. Run it first, hand the token to the gateway's own SDK, then save what the gateway gives back with subbly.wallet.store.

Method parameters

payloadRequiredWalletSetupPayload

The gateway to set up.

gatewayIdRequirednumber

ID of the gateway, from shop.currencies[].gateways[].id.

ReturnsPromise<WalletSetupResponse>

The token for the gateway widget.

tokenstring

What the token is depends on the gateway. Stripe gives a client secret for stripe.confirmCardSetup. Braintree gives a client token that starts the Braintree SDK. PayPal gives an order ID for createOrder in paypal.Buttons.


Start a Stripe card setup
const [gateway] = subbly.shop.currencies[0].gateways
const { token } = await subbly.wallet.setup({ gatewayId: gateway.id })

const { setupIntent } = await stripe.confirmCardSetup(token, {
  payment_method: { card: cardElement }
})

subbly.wallet.store(payload)

Saves a payment source for the customer from the token the gateway widget returned. The saved method can then be set on the cart or on a subscription. Needs an authenticated customer.

Method parameters

payloadRequiredPaymentMethodStorePayload

The source to save.

gatewayIdRequirednumber

The gateway the token came from.

tokenRequiredstring

The token the gateway widget returned. Stripe gives a setup intent ID. Braintree gives a payment method nonce. PayPal gives an order ID. Authorize.net gives the encrypted payment data, Base64-encoded.

ReturnsPromise<PaymentMethod>

The payment method saved.


Save a Stripe card
const paymentMethod = await subbly.wallet.store({
  gatewayId: gateway.id,
  token: setupIntent.id
})

await subbly.cart.update({ paymentMethodId: paymentMethod.id })

subbly.wallet.setupIntent(payload)

Gets a Subbly-hosted page where Stripe runs 3-D Secure on a new card. Send the customer to subblyUrl; Stripe returns them to the redirectUrl you gave. Needs an authenticated customer.

Method parameters

payloadRequiredWalletSetupIntentPayload

The gateway to verify with, and where to come back to.

gatewayIdRequirednumber

ID of the Stripe gateway.

redirectUrlRequiredstring

Page of yours that Stripe sends the customer back to, such as https://your-shop.com/checkout/CART_ID.

ReturnsPromise<WalletSetupIntentResponse>

Where to send the customer, and how long the link lasts.

idstring

ID of the setup intent.

redirectUrlstring

The page you asked Stripe to return to.

expiresAtstring

When the hosted page stops working.

subblyUrlstring

The Subbly-hosted page to send the customer to.


Verify a card with 3-D Secure
const { subblyUrl } = await subbly.wallet.setupIntent({
  gatewayId: gateway.id,
  redirectUrl: `https://your-shop.com/checkout/${subbly.cart.id}`
})

window.location.assign(subblyUrl)

Last modified on September 15, 2026