Co-badged cards guide
A quick guide to implementing co-badged card support in Recurly.js, enabling customers to choose their preferred network at checkout.
Overview
Prerequisites & limitations
- You must have a working Recurly.js card integration to use this guide effectively.
- See Recurly.js documentation for setup details.
- For more information on co-badged card compliance, refer to our Recurly Docs.
This guide explains how to support co-badged cards in a Recurly.js environment, allowing customers to choose which network to use at checkout.
Step 1: Listen for the coBadge Event
coBadge EventSet up an event listener for coBadge on your Recurly.js CardElement. For more on handling events, see the Recurly.js events documentation.
const elements = recurly.Elements();
const cardElement = elements.CardElement();
cardElement.on('coBadge', handleCoBadgeEvent);
function handleCoBadgeEvent(payload) {
// handle event, e.g., show selection UI if coBadgeSupport is true
}Step 2: Handle the coBadge Event Payload
coBadge Event PayloadWhen the coBadge event fires, you’ll receive a payload with:
| Field | Type | Description |
|---|---|---|
coBadgeSupport | Boolean | Indicates whether the card supports co-badged options. |
supportedBrands | Array | List of brands the customer can choose from (e.g., ["visa", "cartes_bancaires"]). Empty if coBadgeSupport is false. |
Step 3: Display Brand Selection to the Customer
Use the supportedBrands array to present a UI that allows the customer to select one brand. This could be radio buttons, a dropdown, or a toggle.
Include the data-recurly="card_network_preference" attribute so Recurly.js can capture the customer’s selection:
<div id="co-badge-div">
<input
type="radio"
value="brand1"
id="co-badge-id-0"
name="co-badge"
data-recurly="card_network_preference"
/>
<label for="co-badge-id-0">brand1</label>
<input
type="radio"
value="brand2"
id="co-badge-id-1"
name="co-badge"
data-recurly="card_network_preference"
/>
<label for="co-badge-id-1">brand2</label>
</div>Warning
Ensure the customer chooses a brand before you proceed to tokenize or submit the form.
Step 4: Tokenize the Payment Information
After the customer selects a brand, follow the Getting a Token guide to tokenize their card details with Recurly.js. The card network preference is automatically included during tokenization, allowing Recurly to process the customer’s chosen brand.
Updated about 4 hours ago
