Product Role: API
The API product role grants access to process transactions and manage tokens programmatically through Connected Payments' REST API.
What You Can Do
- Process Transactions
- Manage Tokens
- Other Services
Process Transactions
- Process purchases via API
- Create pre-authorisations
- Capture pre-authorised transactions
- Process refunds
- Void transactions
Manage Tokens
- Create and manage tokens
- Retrieve masked PAN data
- Store card details securely
- Process token-based payments
Other Services
- Set up notification services
- Query transaction data
- Bulk transaction queries
- Receive webhooks for events
Permissions
| Permission | Description |
|---|---|
| Process transactions | Process purchases, pre-auths, captures, refunds, voids via API |
| Manage tokens | Create tokens and retrieve masked PAN data |
| Notification services | Set up webhooks for transaction events |
| Query transactions | Retrieve transaction data programmatically |
| Bulk queries | Query multiple transactions by date range |
Available Services
Transaction Services
| Service | Description |
|---|---|
| Purchase | Immediate payment capture |
| Pre-Authorisation | Reserve funds for later capture |
| Capture | Capture pre-authorised funds |
| Void | Cancel transaction before settlement |
| Refund | Return funds after settlement |
For API endpoints, request/response formats, and code examples, see:
Tokenisation Services
| Service | Description |
|---|---|
| Create Token | Store card details securely |
| Retrieve Masked PAN | Query token details |
For API endpoints, request/response formats, and code examples, see:
Notification Services
Set up webhooks to receive real-time notifications for transaction events.
What You Can Do:
- Create notification endpoints
- Configure event triggers
- Set retry attempts
- Filter by transaction type
- Specify custom fields
For API endpoints, configuration options, and code examples, see:
Query Services
Retrieve transaction data programmatically for reporting and reconciliation.
- Single Transaction
- Bulk Transactions
Query Single Transaction
Retrieve details for a specific transaction by reference.
Returns:
- Transaction details
- Response codes
- Settlement information
- Card details (masked)
- Metadata
Query Bulk Transactions
Retrieve multiple transactions by date range.
Returns:
- Array of transactions
- Filtered by date range
- Non-sensitive data only
- Paginated results
Use Cases:
- Reconciliation
- Reporting
- Analytics
- Audit trails
For API endpoints, query parameters, and code examples, see:
Authentication
API users authenticate requests using their username and password in the request body.