Path A: Non-PCI with Opal (Recommended)
Most commerce teams use this path. Opal Card Connect handles the sensitive card entry and verification UI, while you use the API for enrichment and tokenization.Card Discovery with Opal
Opal’s Card Connect mode provides a drop-in UI that walks users through identity verification and card discovery in a single flow. After the user completes the Opal flow, their connected card accounts are available via the API — the same accounts returned by Entity-Connect.Opal Card Connect
Full documentation for Opal’s Card Connect mode.
Card Brand Enrichment
For card linking and rewards experiences, display the actual card product name and art instead of a generic “Visa ending in 1234.” Request a Card Brand for any connected credit card account. Here’s a card brand request for Emily’s Chase Sapphire Preferred (acc_LxwEqNicr66yP):
brands array contains the card product details — use name for display, url for the card art image, issuer for the bank name, and network / network_tier for routing decisions.
Card Brand is an asynchronous operation. The response above shows a completed request; in practice, subscribe to the
card_brand.completed webhook to know when brand data is ready.Card Brand Subscriptions
To stay notified when a user’s card product changes (e.g., upgraded from Sapphire Preferred to Sapphire Reserve), enroll the account in acard_brand subscription:
Checkout & Card-on-File
For checkout, card-on-file, or recurring billing, create a Payment Instrument to tokenize a connected card’s credentials. This returns the card number, expiration, and billing zip code — ready for use in your payment flow. Here’s a Payment Instrument request for Emily’s Capital One Venture X (acc_GAzrD99cUqGEN):
Network Tokens as an Alternative
Network Tokens as an Alternative
For merchants that support network tokenization, you can request a
network_token type instead of card. Network tokens provide better authorization rates and reduced fraud risk by replacing the actual card number with a token provisioned through the card network.Path B: PCI Compliant (API-Only)
For PCI-compliant teams, the entire flow is API-driven without Opal:Entity Creation & Connect
Use the Entities API to create and verify the user, then call Entity-Connect to discover their credit cards programmatically. This is the same flow described in Getting Started, but you build the UI yourself.Card Brand Enrichment
Card Brand works identically to Path A. Request card brand data for any connected account:brands array with name, issuer, network, url, and other card product details.
Payment Instruments & Sensitive Data
PCI-compliant teams can also use the Sensitive API to retrieve raw card credentials including the CVV:What’s Next
Expense Tracking
Stream transactions, manage spend, and handle manual card entry for unsupported networks.
Card Brand API Reference
Full API documentation for Card Brand.
Payment Instruments API Reference
Full API documentation for Payment Instruments.
Sensitive API Reference
Full API documentation for Sensitive.