API Reference
API Documentation
Payblr provides RESTful APIs that allow clients to integrate with the platform for card lifecycle management, transaction-related activity, event-driven integrations, and other supported payment capabilities.
Overview
This page explains how Payblr API documentation is organized and how clients should use it during implementation.
Use this page to understand the general API structure, authentication expectations, request format, and available capability areas. Use the API Explorer when you need endpoint-level details, request and response examples, and interactive testing.
API Explorer
Open the API Explorer to review endpoint details, request and response examples, and interactively test Payblr APIs in the UAT environment.
API capability areas
Payblr APIs support different capability areas. Availability may vary depending on the client program, environment, and enabled integration scope.
Cards
Card creation, card status management, card detail updates, secure card data, renewals, and replacements.
Transactions
Transaction history, transaction details and related transaction activity.
Events
Event-driven integration areas such as webhooks and real-time activity notifications.
Digital wallet-related operations
Supported Apple Pay, Google Pay, and related payment tokenization capabilities when configured.
General request format
Regardless of the API being used, requests should follow the same general format and authentication requirements.
The exact resource path, request body, response body, and required fields depend on the endpoint. Review the API Explorer for endpoint-specific details.
Example API request pattern
[HTTP_METHOD] [PAYBLR_API_BASE_URL]/[RESOURCE_PATH]
Authorization: Bearer [ACCESS_TOKEN]
Content-Type: application/jsonAuthentication
Payblr APIs require authentication before protected resources can be accessed. Clients should obtain an access token using the process described in the Get Started page.
The access token must be included as a bearer token in the Authorization header of API requests.
Complete the authentication steps before testing APIs in the API Explorer or calling Payblr APIs from your own system.
Next steps
If this is your first implementation, start with Get Started to confirm authentication. Then use API Explorer to review and test the specific endpoints required for your integration.