Product Role: iFrame
The iFrame product role grants access to authenticate and load Connected Payments' secure payment iFrames.
What You Can Do
- Authenticate iFrames
- Process Transactions
- Customise Forms
Authenticate iFrames
- Authenticate iFrame URLs
- Load hosted payment pages
- Embed payment forms
Process Transactions
- Process purchases via iFrame
- Create pre-authorisations
- Process captures, refunds, voids
- Create tokens during payment
- Retrieve masked PAN from tokens
Customise Forms
- Customise payment form fields
- Configure iFrame appearance
- Add business-specific fields
- Match your website design
Permissions
| Permission | Description |
|---|---|
| Authenticate iFrame URLs | Load payment iFrames using username |
| Process transactions | Process purchases, pre-auths, captures, refunds, voids |
| Create tokens | Store card details securely during payment |
| Retrieve masked PAN | Query token details via API |
| Customise fields | Configure custom fields and appearance |
iFrame Types
- Hosted iFrame
- Embedded iFrame
Hosted iFrame
Full-page payment form hosted by Connected Payments.
Features:
- Redirect customer to Connected Payments-hosted page
- Complete payment experience
- Return to your site after payment
- Minimal integration required
Embedded iFrame
Payment form embedded directly in your page.
Features:
- Seamless customer experience
- Matches your site design
- No redirect required
- Stays on your domain
Loading iFrames
Authentication
iFrame users authenticate iFrame URLs using their username in the URL parameters.
How It Works:
- Generate iFrame URL with your username
- Customer navigates to URL or loads embedded iFrame
- Connected Payments validates username
- Payment form loads
- Customer completes payment
- Transaction processed
- Customer redirected to return URL (if applicable)
For detailed integration instructions, URL parameters, and code examples, see:
Tokenisation
Create Tokens During Payment
iFrame users can create tokens during payment to securely store card details for future use.
How It Works:
- Customer enters card details in iFrame
- Option to save card for future use
- Token created automatically
- Secure compliant storage
For detailed tokenisation instructions and API integration, see:
Retrieve Token Details
iFrame users can retrieve non-sensitive token information (masked PAN) through Connected Payments' API using their username and password.
What You Can Retrieve:
- Masked card number
- Card type and expiry
- Cardholder name
- Token metadata
Common Use Cases:
- Display saved cards to customers
- Verify token before processing
- Customer account management
- One-click checkout display
For API endpoints, request/response formats, and code examples, see:
Customisation
Custom Fields
What You Can Customise:
| Feature | Description |
|---|---|
| Custom Fields | Add business-specific fields |
| Field Validation | Configure validation rules |
| Appearance | Customise colours and branding |
| Company Logo | Add your logo |
| Field Labels | Use customer-friendly names |
To Configure:
Contact [email protected] with your requirements:
- Custom fields needed
- Branding and colours
- Field validation rules
- Return URL behaviour