This endpoint validates an API key to verify its current status, including whether it is valid, expired, or inactive. Use this endpoint to check the health and usability of your API key before making authenticated requests to other endpoints.
\nMethod: POST
\nEndpoint: https://api.epasscard.com/api/public/v1/validate-api-key
Send body parameters as JSON
\nExample:
\napiKey=a4ojJkox5OgRi6EpVrvimk5GxLGDFvXU5AxtLcmmUXkqI446ve\n\nThe endpoint returns a JSON response with the following structure:
\nstatus (integer): HTTP status code
message (string): Human-readable message describing the validation result
valid (boolean): Indicates if the API key format is valid
expire (boolean): Indicates if the API key has expired
activeStatus (boolean): Indicates if the API key is currently active
When the API key has expired but is otherwise valid:
\n{\n \"status\": 400,\n \"message\": \"API Key expired\",\n \"valid\": true,\n \"expire\": true,\n \"activeStatus\": true\n}\n\nWhen the API key has been deactivated:
\n{\n \"status\": 400,\n \"message\": \"API Key inactive\",\n \"valid\": true,\n \"expire\": false,\n \"activeStatus\": false\n}\n\nWhen the API key is valid and active:
\n{\n \"status\": 200,\n \"message\": \"API Key is valid\",\n \"valid\": true,\n \"expire\": false,\n \"activeStatus\": true\n}\n\nhttps://api.epasscard.com/api: Base URL for the API. This variable should be set in your environment to point to the appropriate API server (e.g., production, staging, or development).Before initiating a series of API calls, validate your API key to ensure it's active and not expired. This prevents unnecessary failed requests and helps with error handling.
\nAfter rotating or renewing an API key, use this endpoint to confirm the new key is active and the old key has been properly expired.
\nWhen experiencing authentication failures in other endpoints, validate the API key first to determine if the issue is related to key expiration or deactivation.
\nIntegrate this endpoint into monitoring systems to periodically check API key status and trigger alerts before keys expire.
\nThis endpoint does not require authentication headers since the API key is validated through the request body
\nA status code of 400 with specific messages helps distinguish between expired and inactive keys
\nConsider implementing automated key validation checks in your application startup or health check routines
\nThis endpoint regenerates an existing API key for the Epasscard Public API. When called, it invalidates the current API key and generates a new one with an updated expiration date.
\nThe following parameters must be sent in the request body as JSON data:
\nA successful response (HTTP 200) returns:
\n{\n \"message\": \"Api key regenerated\",\n \"data\": {\n \"api_key\": \"string\", // Your new API key - store this securely\n \"new_expire_date\": \"datetime\", // When the new key will expire\n \"next_refresh\": \"datetime\" // Recommended time to refresh the key again\n }\n}\n\napi_key: The newly generated API key. Replace your old key with this value in all subsequent requests.
\nnew_expire_date: The expiration timestamp for the new API key.
\nnext_refresh: The recommended time to refresh the key again (typically before expiration).
\nBefore Expiration: Refresh your API key before it expires to maintain uninterrupted service. Use the next_refresh timestamp from previous responses as a guide.
Security Rotation: Regularly rotate API keys as part of your security best practices.
\nCompromised Keys: Immediately refresh if you suspect your API key has been compromised.
\n⚠️ Important Security Practices:
\nStore Securely: Never expose API keys in client-side code, public repositories, or logs.
\nUpdate Immediately: After refreshing, update your API key in all systems and applications that use it.
\nOld Key Invalidation: The previous API key becomes invalid immediately after a successful refresh.
\nMonitor Usage: Track when keys are refreshed to detect unauthorized refresh attempts.
\nImplement automated key rotation before the next_refresh time
Store the new API key securely (e.g., environment variables, secrets manager)
\nUpdate all services using the old key to prevent authentication failures
\nLog refresh operations for audit purposes
\nThis endpoint generates an API key for authentication purposes. The API key is used to authenticate subsequent requests to the API and provides secure access to protected resources.
\nPOST
https://api.epasscard.com/api/public/v1/generate-api-key\n\nThe request requires a JSON payload with the following fields:
\nExample Request Body:
\n{\n \"email\": \"user@example.com\",\n \"password\": \"YourSecurePassword\"\n}\n\nWhen the API key is successfully generated, the endpoint returns a JSON response with the following structure:
\n{\n \"status\": 200,\n \"message\": \"API Key generated successfully\",\n \"data\": {\n \"api_key\": \"s9Kno6R47pelMffvgZiDdr0fneWczy9ZrjsRTxgk...\",\n \"expire_at\": \"2026-01-07 10:00:31\",\n \"created_at\": \"2025-12-08 10:00:31\"\n }\n}\n\nThe API key has a validity period of approximately 2 years from the creation date
\nMonitor the expire_at field to track when the key will expire
Generate a new API key before expiration to maintain uninterrupted access
\nStore the API key securely - Save it in a secure location immediately after generation
\nNever expose the API key in client-side code or public repositories
\nUse environment variables or secure vaults to store the API key
\nRegenerate the API key if you suspect it has been compromised
\nUse the generated API key in the Authorization header or as specified in the API documentation for subsequent requests
Keep track of the expiration date to avoid authentication failures
\nRetrieves a paginated list of all available pass templates in the system. This endpoint is useful for browsing, searching, or managing pass templates.
\nEndpoint:
\nGET https://api.epasscard.com/api/public/v1/get-pass-templates?page=1\n\nA successful response returns a JSON object with the following structure:
\n{\n \"templates\": [\n {\n \"id\": integer,\n \"uid\": string,\n \"name\": string,\n \"slug\": string,\n \"template_data\": string (JSON),\n \"status\": integer,\n \"published_at\": string (ISO 8601 datetime),\n \"org_id\": integer,\n \"description\": string,\n \"pass_org_name\": string,\n \"pass_limit\": integer,\n \"nfc\": string | null,\n \"is_public\": integer,\n \"google_wallet_status\": integer,\n \"total_pass\": integer,\n \"active\": integer,\n \"in_active\": integer\n },\n ...\n ],\n \"total\": {\n \"total_templates\": integer\n }\n}\n\ntemplates: Array of pass template objects.
\nid: Unique numeric identifier for the template.
\nuid: Unique string identifier (UUID) for the template.
\nname: Name of the pass template.
\nslug: URL-friendly identifier for the template.
\ntemplate_data: JSON string containing template configuration and fields.
\nstatus: Status of the template (e.g., 1 = active).
\npublished_at: Date and time when the template was published.
\norg_id: Organization ID associated with the template.
\ndescription: Description of the template.
\npass_org_name: Name of the organization for the pass.
\npass_limit: Maximum number of passes allowed for this template.
\nnfc: NFC configuration for enable and disable NFC feature.
\nis_public: Indicates if the template is public (1 = yes, 0 = no).
\ngoogle_wallet_status: Google Wallet integration status.
\ntotal_pass: Total number of passes created from this template.
\nactive: Number of active passes.
\nin_active: Number of inactive passes.
\ntotal: Object containing total count information.
\nThe page query parameter is required and must be a positive integer.
The endpoint returns paginated results. To retrieve additional pages, increment the page parameter.
The template_data field is a JSON string and may need to be parsed for further use.
Use this endpoint to list, search, or manage pass templates for your organization.
\nAuthentication required ensure you are authenticated as required by the API (e.g., Bearer token/x-api-key).
\nExample Request:
\nGET https://api.epasscard.com/api/public/v1/get-pass-templates?page=1\n\nExample Response:
\n{\n \"templates\": [\n {\n \"id\": 792,\n \"uid\": \"9b1de8b2-f007-4ecb-a355-de7c01c9d5d4\",\n \"name\": \"z\",\n \"slug\": \"z\",\n \"template_data\": \"{\\\"primarySettings\\\":{\\\"name\\\":\\\"Warrenty car...\",\n \"status\": 1,\n \"published_at\": \"2025-10-21T07:05:19.000Z\",\n \"org_id\": 401,\n \"description\": \"adasd\",\n \"pass_org_name\": \"asd\",\n \"pass_limit\": 3,\n \"nfc\": null,\n \"is_public\": 0,\n \"google_wallet_status\": 0,\n \"total_pass\": 0,\n \"active\": 0,\n \"in_active\": 0\n }\n ],\n \"total\": {\n \"total_templates\": 4\n }\n}\n\nEndpoint:
\nPOST https://api.epasscard.com/api/public/v1/create-template\n\nThis endpoint creates a new pass template for EpassCard (such as gift cards, store cards, loyalty cards, or coupons). A pass template defines the appearance, structure, and behavior of digital passes that can later be issued to users. Templates ensure consistency in branding, layout, and logic for all passes generated from them.
\nThe request body is a JSON object with the following main fields:
\nEach array contains objects with:
\n{\n \"passSettings\": { ... },\n \"templateInfo\": { ... },\n \"locations\": { ... },\n \"additionalFields\": [ ... ],\n \"advancedSettings\": { ... }\n}\n\nAll required fields must be provided; missing required fields will result in an error.
\nUse valid HEX color codes for color fields.
\nFor barcode, supported formats include CODE_128, QR, etc.
\nThe template can be used to issue multiple passes with consistent structure and branding.
\nAdvanced settings allow for fine-grained control over pass lifecycle, security, and user interactions.
\nA successful request returns details of the created template, including its unique identifier and configuration summary.
\nPurpose:
This endpoint allows you to update an existing pass template. It is typically used by administrators or systems to modify the core information, design, locations, additional fields, and settings of a digital pass template (such as for loyalty, membership, or similar programs).
HTTP Method:
\nPUTEndpoint URL:
\nhttps://api.epasscard.com/api/public/v1/update-pass-template/{template_uid}\n\nReplace {template_uid} with the unique identifier (UID) of the template you want to update.
template_uid should be like this b7290ec7-4ef7-482f-94d0-5ad14df396fe
\nPath Parameters:
\ntemplate_uid (string, required): The unique identifier of the pass template to update.Authentication:
\nThis endpoint requires authentication (e.g., Bearer token/Api key).
\nEnsure you have the necessary permissions to update templates.
\nRequest Body:
\nContent-Type: application/json
The body must include a template object with the updated details.
Request Body Structure:
\n{\n \"template\": {\n \"template_id\": <integer>,\n \"template_uid\": <string>,\n \"template_name\": <string>,\n \"locations\": { ... },\n \"beacons\": { ... },\n \"template_slug\": <string>,\n \"templateInformation\": { ... },\n \"template_design\": { ... },\n \"additionFields\": [ ... ],\n \"settings\": { ... },\n \"cardType\": <string>,\n \"google_wallet_status\": <integer>,\n \"total_pass\": <integer>\n }\n}\n\nRequest Body Fields:
\nNested Object Details:
\nlocations.settings: Object with location-specific settings (e.g., notification radius, initial message).
locations.locations: Array of location objects, each with uid, title, latitude, longitude, and altitude.
templateInformation: Contains fields like id, uid, name, slug, template_data, status, org_id, description, pass_org_name, pass_limit, nfc, google_wallet_status.
template_design: Contains design settings, fields for display, images, barcode configuration, and more.
additionFields: Array of objects, each defining a custom field (e.g., field_name, field_type, required).
settings: Contains template-level settings such as expiration, audit log, rechargeable, transaction log, etc.
Example Request Body:
\n{\n \"template\": {\n \"template_id\": 814,\n \"template_uid\": \"b7290ec7-4ef7-482f-94d0-5ad14df396fe\",\n \"template_name\": \"Amber IT\",\n \"locations\": {\n \"settings\": {\n \"id\": 267,\n \"is_active\": 1,\n \"initial_message\": \"\",\n \"notification_radius\": 100\n },\n \"locations\": [\n {\n \"uid\": \"27d387db-8e69-4f9e-95e5-6b99ab6284a5\",\n \"title\": \"Webcartisan LLC\",\n \"latitude\": \"23.86637341730371\",\n \"longitude\": \"90.3990027288355\",\n \"altitude\": \"\"\n }\n ]\n },\n \"beacons\": {},\n \"template_slug\": \"amber-it\",\n \"templateInformation\": { ... },\n \"template_design\": { ... },\n \"additionFields\": [ ... ],\n \"settings\": { ... },\n \"cardType\": \"loyalty\",\n \"google_wallet_status\": 1,\n \"total_pass\": 1\n }\n}\n\nImportant Notes:
\nAll required fields must be provided; missing or invalid fields may result in errors.
\nOnly users with appropriate permissions can update templates.
\nThe structure of nested objects (like templateInformation, template_design, additionFields, and settings) should match the expected schema for your system.
Use the correct template_uid in the URL to avoid updating the wrong template.
The endpoint returns a status and message indicating the result of the update operation.
\nSuccessful Response Example:
\n{\n \"status\": 200,\n \"message\": \"Templated updated successfully\"\n}\n\nSee Also:
\nThis endpoint allows you to permanently delete a pass template from the system using its unique template ID. It is typically used by administrators or authorized users to remove templates that are no longer needed or were created in error.
\nUse this endpoint to:
\nRemove a specific pass template from your account or organization.
\nEnsure that deleted templates cannot be used to issue new passes.
\nMaintain a clean and organized set of available templates.
\nMethod: DELETE
\nURL: https://api.epasscard.com/api/public/v1/delete-pass-template/{templateId}
{templateId} with the unique identifier of the pass template you wish to delete.Authentication: Required (ensure you provide a valid bearer token or other required authentication method).
\nRequest Body: None
\nIf the template exists and is successfully deleted, the API will return a success response (typically HTTP 200 or 204).
\nIf the template does not exist, the API will return a 404 Not Found error with a message indicating that the template was not found.
\nIf the user is not authorized or authenticated, the API may return a 401 Unauthorized or 403 Forbidden error.
\n200 OK or 204 No Content: The template was found and successfully deleted.
\n404 Not Found: The specified template ID does not exist. Example response:
\n{\n \"status\": 404,\n \"message\": \"Template not found\"\n}\n\n401 Unauthorized: Authentication is missing or invalid.
\n403 Forbidden: The user does not have permission to delete the template.
\n500 Internal Server Error: An unexpected error occurred on the server.
\nRequest:
\nDELETE https://api.epasscard.com/api/public/v1/delete-pass-template/{template_id}\n\nResponse (404 Not Found):
\n{\n \"status\": 404,\n \"message\": \"Template not found\"\n}\n\nNote: Deleting a template is irreversible. Ensure you have selected the correct template ID before proceeding.
\n","urlObject":{"path":["public","v1","delete-pass-template","{template_id}"],"host":["https://api.epasscard.com/api"],"query":[],"variable":[]}},"response":[{"id":"4729e5d6-4fd6-4f07-bcc6-d9d2af8a679e","name":"400","originalRequest":{"method":"DELETE","header":[],"url":"https://api.epasscard.com/api/public/v1/delete-pass-template/815"},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 28 Oct 2025 06:17:59 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"91"},{"key":"X-RateLimit-Reset","value":"1761632339"},{"key":"X-RateLimit-Reset-Date","value":"2025-10-28T06:18:59.500Z"},{"key":"X-Request-Type","value":"general"},{"key":"X-Current-Time","value":"2025-10-28T06:17:59.500Z"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"45"},{"key":"ETag","value":"W/\"2d-c8wnUmwijfwo3rOAFGN3gDDmEAs\""},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"message\": \"Template not found\"\n}"},{"id":"0f125ed5-8d2a-4827-89ae-2f61f9c1be99","name":"200","originalRequest":{"method":"DELETE","header":[],"url":"https://api.epasscard.com/api/public/v1/delete-pass-template/815"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 28 Oct 2025 06:20:20 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"X-RateLimit-Reset","value":"1761632480"},{"key":"X-RateLimit-Reset-Date","value":"2025-10-28T06:21:20.212Z"},{"key":"X-Request-Type","value":"general"},{"key":"X-Current-Time","value":"2025-10-28T06:20:20.212Z"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"56"},{"key":"ETag","value":"W/\"38-QfCvrQgFIXg7bhaxJBrsiqinwk4\""},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Template deleted successfully\"\n}"}],"_postman_id":"62f5b47c-7f71-491d-b062-18388e0e07cd"},{"name":"Template details","id":"3a442aa2-eabb-4af5-988a-c6c3298316b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"This endpoint retrieves the details of a specific template using its unique identifier (template_uid). Use this to fetch metadata and configuration for a template in your system.
GET https://api.epasscard.com/api/public/v1/template-details/:template_uid\n\nhttps://api.epasscard.com/api is an environment variable for your API base URL.
Replace :template_uid with the UUID of the template you want to retrieve.
This endpoint does not accept any query parameters.
\nThis is a GET request and does not require a request body.
\nReturns template details in JSON format.
\n{\n \"id\": \"d0f0d035-196c-4055-983b-f3d2618bfc71\",\n \"name\": \"Sample Template\",\n \"description\": \"A sample template description.\",\n \"createdAt\": \"2023-01-01T00:00:00Z\",\n \"updatedAt\": \"2023-01-02T00:00:00Z\"\n // ... other fields\n}\n\nSee the saved \"200\" example for the full schema.
\nReturned if the template does not exist.
\n{\n \"status\": 404,\n \"message\": \"Template not found\"\n}\n\nThere are currently no tests for this request.
\nSuggested checks:
\nStatus code is 200 for a valid template_uid; 404 for a non-existent template_uid.
For 200 responses, assert key fields based on the saved 200 example.
\nEnsure https://api.epasscard.com/api is set in the active environment.
Replace :template_uid with the template UUID you want to query.
Use the saved examples to understand the expected response structure.
\nIf you receive a 404, verify that the template_uid is correct and exists in the system.
Related Entities:
\n\nThis documentation is intended to help API consumers integrate and troubleshoot the template details endpoint effectively.
\n","urlObject":{"path":["public","v1","template-details","{template_uid}"],"host":["https://api.epasscard.com/api"],"query":[],"variable":[]}},"response":[{"id":"e6b11459-705d-4476-8423-9a2292a532a3","name":"200","originalRequest":{"method":"GET","header":[],"url":"https://api.epasscard.com/api/public/v1/template-details/d0f0d035-196c-4055-983b-f3d2618bfc71"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 28 Oct 2025 07:27:59 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"X-RateLimit-Reset","value":"1761636539"},{"key":"X-RateLimit-Reset-Date","value":"2025-10-28T07:28:59.082Z"},{"key":"X-Request-Type","value":"general"},{"key":"X-Current-Time","value":"2025-10-28T07:27:59.082Z"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"6501"},{"key":"ETag","value":"W/\"1965-S3OnhO24AsLdb4ChSIvd1Z2qv2c\""},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"template_id\": 816,\n \"template_uid\": \"d0f0d035-196c-4055-983b-f3d2618bfc71\",\n \"template_name\": \"aasd\",\n \"locations\": {},\n \"beacons\": {},\n \"template_slug\": \"aasd\",\n \"templateInformation\": {\n \"id\": 816,\n \"uid\": \"d0f0d035-196c-4055-983b-f3d2618bfc71\",\n \"name\": \"aasd\",\n \"slug\": \"aasd\",\n \"template_data\": \"{\\\"primarySettings\\\":{\\\"name\\\":\\\"Warrenty card\\\",\\\"cardType\\\":\\\"StoreCard\\\",\\\"organizationName\\\":\\\"\\\",\\\"description\\\":\\\"\\\",\\\"forgroundColor\\\":\\\"#ffffff\\\",\\\"backgroundColor\\\":\\\"#3A3740\\\",\\\"labelColor\\\":\\\"#ffffff\\\",\\\"stripColor\\\":\\\"\\\",\\\"expireType\\\":\\\"\\\",\\\"expireValue\\\":\\\"\\\",\\\"passTypeId\\\":\\\"pass.test.epasscard\\\",\\\"dateTimeFormat\\\":\\\"YYYY-MM-DD HH:mm:ss\\\",\\\"shareable\\\":false,\\\"googleWalletShareable\\\":\\\"STATUS_UNSPECIFIED\\\"},\\\"headerFields\\\":[{\\\"label\\\":\\\"Product name\\\",\\\"value\\\":\\\"{Product name}\\\",\\\"valueType\\\":\\\"fixed\\\",\\\"changeMsg\\\":\\\"Product name is updated to\\\",\\\"staticValueType\\\":\\\"text\\\"}],\\\"backFields\\\":[{\\\"label\\\":\\\"Customer name\\\",\\\"value\\\":\\\"{Customer name}\\\",\\\"valueType\\\":\\\"fixed\\\",\\\"changeMsg\\\":\\\"Customer name is updated to\\\",\\\"staticValueType\\\":\\\"textarea\\\"},{\\\"label\\\":\\\"Customer phone number\\\",\\\"value\\\":\\\"{Customer phone number}\\\",\\\"valueType\\\":\\\"fixed\\\",\\\"changeMsg\\\":\\\"Customer phone number is updated to\\\",\\\"staticValueType\\\":\\\"textarea\\\"},{\\\"label\\\":\\\"Customer care\\\",\\\"value\\\":\\\"{Customer care}\\\",\\\"valueType\\\":\\\"fixed\\\",\\\"changeMsg\\\":\\\"Customer phone number is updated to\\\",\\\"staticValueType\\\":\\\"textarea\\\"}],\\\"auxiliaryFields\\\":[],\\\"images\\\":{\\\"logo\\\":\\\"https://app.epasscard.com//assets/img/predefined-templates/assets/warrenty-logo.png\\\",\\\"icon\\\":\\\"https://app.epasscard.com//assets/img/predefined-templates/assets/warrenty-logo.png\\\",\\\"thumbnail\\\":\\\"\\\",\\\"strip\\\":\\\"https://app.epasscard.com//assets/img/predefined-templates/assets/warrenty-strip.png\\\",\\\"footer\\\":\\\"\\\"},\\\"primaryFields\\\":[{\\\"label\\\":\\\"\\\",\\\"value\\\":\\\"\\\",\\\"valueType\\\":\\\"fixed\\\",\\\"changeMsg\\\":\\\"\\\",\\\"staticValueType\\\":\\\"text\\\"}],\\\"barcode\\\":{\\\"format\\\":\\\"qrCode\\\",\\\"barcodeValueType\\\":\\\"\\\",\\\"value\\\":\\\"systemId\\\",\\\"altText\\\":\\\"\\\",\\\"showValue\\\":true},\\\"secondaryFields\\\":[{\\\"label\\\":\\\"Warrenty Till\\\",\\\"value\\\":\\\"{Warrenty till}\\\",\\\"valueType\\\":\\\"fixed\\\",\\\"changeMsg\\\":\\\"Warrenty period is updated to\\\",\\\"staticValueType\\\":\\\"text\\\"},{\\\"label\\\":\\\"Purchase date\\\",\\\"value\\\":\\\"{Purchase Date}\\\",\\\"valueType\\\":\\\"fixed\\\",\\\"changeMsg\\\":\\\"Purchase date is updated to\\\",\\\"staticValueType\\\":\\\"text\\\"}],\\\"googlePassLayout\\\":\\\"Custom\\\",\\\"googleDefaultLayout\\\":{\\\"loyaltyBalance\\\":\\\"\\\",\\\"loyaltyBalanceLabel\\\":\\\"\\\",\\\"giftCardBalance\\\":\\\"\\\",\\\"giftCardCurrencyCode\\\":\\\"\\\"},\\\"emailSettings\\\":{\\\"subject\\\":\\\"\\\",\\\"emailTemplate\\\":\\\"\\\",\\\"recipientEmail\\\":\\\"\\\"},\\\"pushNotificationContent\\\":{\\\"bodyForUpdate\\\":\\\"\\\"},\\\"smsContent\\\":{\\\"receiver\\\":\\\"\\\",\\\"content\\\":\\\"\\\"},\\\"status\\\":false}\",\n \"status\": 1,\n \"org_id\": 401,\n \"description\": \"asdasd\",\n \"pass_org_name\": \"asdsd\",\n \"pass_limit\": 4,\n \"nfc\": null,\n \"google_wallet_status\": 0\n },\n \"template_design\": {\n \"primarySettings\": {\n \"name\": \"Warrenty card\",\n \"cardType\": \"StoreCard\",\n \"organizationName\": \"\",\n \"description\": \"\",\n \"forgroundColor\": \"#ffffff\",\n \"backgroundColor\": \"#3A3740\",\n \"labelColor\": \"#ffffff\",\n \"stripColor\": \"\",\n \"expireType\": \"\",\n \"expireValue\": \"\",\n \"passTypeId\": \"pass.test.epasscard\",\n \"dateTimeFormat\": \"YYYY-MM-DD HH:mm:ss\",\n \"shareable\": false,\n \"googleWalletShareable\": \"STATUS_UNSPECIFIED\"\n },\n \"headerFields\": [\n {\n \"label\": \"Product name\",\n \"value\": \"{Product name}\",\n \"valueType\": \"fixed\",\n \"changeMsg\": \"Product name is updated to\",\n \"staticValueType\": \"text\"\n }\n ],\n \"backFields\": [\n {\n \"label\": \"Customer name\",\n \"value\": \"{Customer name}\",\n \"valueType\": \"fixed\",\n \"changeMsg\": \"Customer name is updated to\",\n \"staticValueType\": \"textarea\"\n },\n {\n \"label\": \"Customer phone number\",\n \"value\": \"{Customer phone number}\",\n \"valueType\": \"fixed\",\n \"changeMsg\": \"Customer phone number is updated to\",\n \"staticValueType\": \"textarea\"\n },\n {\n \"label\": \"Customer care\",\n \"value\": \"{Customer care}\",\n \"valueType\": \"fixed\",\n \"changeMsg\": \"Customer phone number is updated to\",\n \"staticValueType\": \"textarea\"\n }\n ],\n \"auxiliaryFields\": [],\n \"images\": {\n \"logo\": \"https://app.epasscard.com//assets/img/predefined-templates/assets/warrenty-logo.png\",\n \"icon\": \"https://app.epasscard.com//assets/img/predefined-templates/assets/warrenty-logo.png\",\n \"thumbnail\": \"\",\n \"strip\": \"https://app.epasscard.com//assets/img/predefined-templates/assets/warrenty-strip.png\",\n \"footer\": \"\"\n },\n \"primaryFields\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"valueType\": \"fixed\",\n \"changeMsg\": \"\",\n \"staticValueType\": \"text\"\n }\n ],\n \"barcode\": {\n \"format\": \"qrCode\",\n \"barcodeValueType\": \"\",\n \"value\": \"systemId\",\n \"altText\": \"\",\n \"showValue\": true\n },\n \"secondaryFields\": [\n {\n \"label\": \"Warrenty Till\",\n \"value\": \"{Warrenty till}\",\n \"valueType\": \"fixed\",\n \"changeMsg\": \"Warrenty period is updated to\",\n \"staticValueType\": \"text\"\n },\n {\n \"label\": \"Purchase date\",\n \"value\": \"{Purchase Date}\",\n \"valueType\": \"fixed\",\n \"changeMsg\": \"Purchase date is updated to\",\n \"staticValueType\": \"text\"\n }\n ],\n \"googlePassLayout\": \"Custom\",\n \"googleDefaultLayout\": {\n \"loyaltyBalance\": \"\",\n \"loyaltyBalanceLabel\": \"\",\n \"giftCardBalance\": \"\",\n \"giftCardCurrencyCode\": \"\"\n },\n \"emailSettings\": {\n \"subject\": \"\",\n \"emailTemplate\": \"\",\n \"recipientEmail\": \"\"\n },\n \"pushNotificationContent\": {\n \"bodyForUpdate\": \"\"\n },\n \"smsContent\": {\n \"receiver\": \"\",\n \"content\": \"\"\n },\n \"status\": false\n },\n \"additionFields\": [\n {\n \"id\": 2331,\n \"pass_id\": 816,\n \"uid\": \"555ca4e6-d55b-441e-a7b6-f40a58ae758e\",\n \"field_name\": \"Product name\",\n \"field_type\": \"text\",\n \"required\": 1,\n \"org_id\": 401\n },\n {\n \"id\": 2332,\n \"pass_id\": 816,\n \"uid\": \"fc4b60d3-eb1f-4c4c-b2b1-7e2eee925adf\",\n \"field_name\": \"Warrenty till\",\n \"field_type\": \"text\",\n \"required\": 1,\n \"org_id\": 401\n },\n {\n \"id\": 2333,\n \"pass_id\": 816,\n \"uid\": \"6b16f16c-9c93-407e-8577-fe386945699d\",\n \"field_name\": \"Purchase Date\",\n \"field_type\": \"text\",\n \"required\": 1,\n \"org_id\": 401\n },\n {\n \"id\": 2334,\n \"pass_id\": 816,\n \"uid\": \"fd2f73b9-ce18-4c9e-859f-3c5085b586cb\",\n \"field_name\": \"Customer name\",\n \"field_type\": \"text\",\n \"required\": 1,\n \"org_id\": 401\n },\n {\n \"id\": 2335,\n \"pass_id\": 816,\n \"uid\": \"74c244dd-1dfa-405b-8f6e-9420022d8a80\",\n \"field_name\": \"Customer phone number\",\n \"field_type\": \"text\",\n \"required\": 1,\n \"org_id\": 401\n },\n {\n \"id\": 2336,\n \"pass_id\": 816,\n \"uid\": \"9f9d0b65-5ca2-46f8-9294-730157715f06\",\n \"field_name\": \"Customer care\",\n \"field_type\": \"text\",\n \"required\": 1,\n \"org_id\": 401\n }\n ],\n \"settings\": {\n \"id\": 649,\n \"template_id\": 816,\n \"expire_type\": \"date\",\n \"expire_data_type\": \"\",\n \"expire_value\": \"2124-10-28 07:04:58\",\n \"audit_log\": \"0\",\n \"rechargeable\": \"0\",\n \"transaction_log\": \"0\",\n \"redeemable\": \"0\",\n \"reedem_field\": \"{}\",\n \"org_id\": 401,\n \"expire_settings\": \"0\",\n \"recharge_field\": \"\",\n \"card_type\": null,\n \"reciver_email\": \"{}\",\n \"batch_size\": null,\n \"serial_number_length\": 15,\n \"serial_number_prefix\": null,\n \"unique_code_length\": 15,\n \"unique_code_format\": \"\",\n \"unique_code_prefix\": \"\",\n \"unique_code_suffix\": \"\",\n \"transection_action\": \"null\"\n },\n \"cardType\": \"loyalty\",\n \"google_wallet_status\": 0,\n \"total_pass\": 0\n}"},{"id":"e5daa42f-5f2d-47fe-aa63-4ae9449fa2b7","name":"404","originalRequest":{"method":"GET","header":[],"url":"https://api.epasscard.com/api/public/v1/template-details/d0f0d035-196c-4055-983b-f3d2618bfc715"},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 28 Oct 2025 07:28:15 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"X-RateLimit-Reset","value":"1761636555"},{"key":"X-RateLimit-Reset-Date","value":"2025-10-28T07:29:15.055Z"},{"key":"X-Request-Type","value":"general"},{"key":"X-Current-Time","value":"2025-10-28T07:28:15.056Z"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"45"},{"key":"ETag","value":"W/\"2d-c8wnUmwijfwo3rOAFGN3gDDmEAs\""},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"message\": \"Template not found\"\n}"}],"_postman_id":"3a442aa2-eabb-4af5-988a-c6c3298316b9"}],"id":"9df2de32-b82f-47df-9adb-af8f108d05d5","_postman_id":"9df2de32-b82f-47df-9adb-af8f108d05d5","description":""},{"name":"Wallet pass","item":[{"name":"Pass fields","id":"83304410-361c-48b5-ac25-12c3196a55a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"This endpoint retrieves the list of pass fields associated with a specific pass template, identified by its unique templateId. It is designed to provide detailed metadata about each field that constitutes a pass template, enabling applications to dynamically display, validate, or configure passes based on the template structure.
Path Parameter:
\ntemplate_uid (string, required): The unique identifier of the pass template whose fields you want to retrieve.Authentication:
\nA successful response (200 OK) returns a JSON object with the following structure:
{\n \"passFields\": [\n {\n \"id\": 816,\n \"uid\": \"555ca4e6-d55b-441e-a7b6-f40a58ae758e\",\n \"field_name\": \"Product name\",\n \"field_type\": \"text\",\n \"required\": 1,\n \"name\": \"aasd\",\n },\n ...\n ],\n \"totalCreatedPass\": {\n \"total\": 0\n },\n}\n\npassFields: Array of objects, each representing a field in the pass template.
\nid: Numeric ID of the field (integer).
uid: Unique identifier for the field (string, UUID).
field_name: Display name of the field (string).
field_type: Data type of the field (e.g., \"text\") (string).
required: Indicates if the field is mandatory (1 for required, 0 for optional) (integer).
name: Internal name or label for the field (string).
pass_limit: Maximum number of passes allowed for this field (integer).
org_id: Organization ID associated with the field (integer).
totalCreatedPass: Object containing the total number of passes created for this template.
\ntotal: Total count (integer).templateDetails: Object with metadata about the template.
\ntemplate_data: JSON string with additional template configuration (string).
name: Name of the template (string).
Dynamic Form Generation: Use the passFields array to generate forms or UI components for pass creation or editing, ensuring required fields are enforced.
Validation: Check the required property to enforce mandatory fields in your application logic.
Display: Show field names and types to users for clarity when viewing or editing passes.
\nTemplate Management: Use templateDetails to display template metadata or for administrative purposes.
This endpoint is essential for applications that need to adapt to different pass templates and provide a flexible, data-driven user experience.
\n","urlObject":{"path":["public","v1","pass-fields",""],"host":["https://api.epasscard.com/api"],"query":[],"variable":[]}},"response":[{"id":"900cb2f5-4ffe-41c1-8197-2e8226c7b2ec","name":"200","originalRequest":{"method":"GET","header":[],"url":"https://api.epasscard.com/api/public/v1/pass-fields/d0f0d035-196c-4055-983b-f3d2618bfc71"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 28 Oct 2025 09:05:57 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"X-RateLimit-Reset","value":"1761642417"},{"key":"X-RateLimit-Reset-Date","value":"2025-10-28T09:06:57.025Z"},{"key":"X-Request-Type","value":"general"},{"key":"X-Current-Time","value":"2025-10-28T09:05:57.025Z"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"3529"},{"key":"ETag","value":"W/\"dc9-6k9CUdEdpmSnayRbKYoCzzNx5ME\""},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"passFields\": [\n {\n \"id\": 960,\n \"uid\": \"c16557e0-62f6-45c9-9452-0b99d33067c1\",\n \"field_name\": \"Product name\",\n \"field_type\": \"text\",\n \"required\": 1,\n \"name\": \"test\"\n },\n {\n \"id\": 960,\n \"uid\": \"b832d9e5-92d7-44a7-887b-d4eefadeab87\",\n \"field_name\": \"Warrenty till\",\n \"field_type\": \"text\",\n \"required\": 1,\n \"name\": \"test\"\n },\n {\n \"id\": 960,\n \"uid\": \"191feb10-05e7-42e8-ae8a-3d12d6cff04b\",\n \"field_name\": \"Purchase Date\",\n \"field_type\": \"text\",\n \"required\": 1,\n \"name\": \"test\"\n },\n {\n \"id\": 960,\n \"uid\": \"72c1e69f-68f3-434f-9588-6738724f3936\",\n \"field_name\": \"Customer name\",\n \"field_type\": \"text\",\n \"required\": 1,\n \"name\": \"test\"\n },\n {\n \"id\": 960,\n \"uid\": \"c56d1233-2d60-4435-aaf3-e19597d1f0d5\",\n \"field_name\": \"Customer phone number\",\n \"field_type\": \"text\",\n \"required\": 1,\n \"name\": \"test\"\n },\n {\n \"id\": 960,\n \"uid\": \"b9eb742d-70d7-4534-91a6-f393691570b0\",\n \"field_name\": \"Customer care\",\n \"field_type\": \"text\",\n \"required\": 1,\n \"name\": \"test\"\n }\n ],\n \"totalCreatedPass\": {\n \"total\": 2\n }\n}"}],"_postman_id":"83304410-361c-48b5-ac25-12c3196a55a8"},{"name":"Create wallet pass","id":"743a899d-1c43-461a-b88b-2df3844ca2ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"This request creates a single digital wallet pass for a customer using the Epasscard Public API. It is used to generate a pass with custom fields such as product details, warranty information, and customer contact data.
\nPOST https://api.epasscard.com/api/public/v1/create-single-pass/template_uid
The request body must be sent as raw JSON and should include an additionalFieldsValue array. Each object in this array represents a custom field to be included in the wallet pass.
{\n \"additionalFieldsValue\": [\n {\n \"uid\": \"555ca4e6-d55b-441e-a7b6-f40a58ae758e\",\n \"fieldValue\": \"dasd\"\n }\n ]\n}\n\nA successful request returns HTTP status code 200 and a JSON response with the following structure:
\n{\n \"status\": 200,\n \"message\": \"Pass created successfully\",\n \"passUid\": \"2a031428-ec2b-470f-8643-4915492a2c23\",\n \"passLink\": \"https://app.epasscard.com/p/2a031428-ec2b-470f-8643-4915492a2c23\"\n}\n\nEnsure all required fields are provided in the additionalFieldsValue array.
The passLink in the response can be shared with the customer for direct access to their wallet pass.
Use the api_url environment variable to easily switch between different API environments (e.g., production, staging).
For more details, refer to the Epasscard Public Api collection.
\n","urlObject":{"path":["public","v1","create-single-pass",""],"host":["https://api.epasscard.com/api"],"query":[],"variable":[]}},"response":[{"id":"4b8353ba-e030-4cce-8da3-a3c2e0bb3a40","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"additionalFieldsValue\": [\n {\n \"uid\": \"c16557e0-62f6-45c9-9452-0b99d33067c1\",\n \"fieldValue\": \"sdf\"\n },\n {\n \n \"uid\": \"b832d9e5-92d7-44a7-887b-d4eefadeab87\",\n \"fieldValue\": \"sdf\"\n },\n {\n \"uid\": \"191feb10-05e7-42e8-ae8a-3d12d6cff04b\",\n \"fieldValue\": \"fsdf\"\n },\n {\n \n \"uid\": \"72c1e69f-68f3-434f-9588-6738724f3936\",\n \"fieldValue\": \"fsdfsdf\"\n },\n {\n \n \"uid\": \"c56d1233-2d60-4435-aaf3-e19597d1f0d5\",\n \"fieldValue\": \"sdfsdf\"\n },\n {\n \n \"uid\": \"b9eb742d-70d7-4534-91a6-f393691570b0\",\n \"fieldValue\": \"sdfsdfdf\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.epasscard.com/api/public/v1/create-single-pass/d0f0d035-196c-4055-983b-f3d2618bfc71"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 28 Oct 2025 10:46:53 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"96"},{"key":"X-RateLimit-Reset","value":"1761648473"},{"key":"X-RateLimit-Reset-Date","value":"2025-10-28T10:47:53.302Z"},{"key":"X-Request-Type","value":"general"},{"key":"X-Current-Time","value":"2025-10-28T10:46:53.302Z"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"179"},{"key":"ETag","value":"W/\"b3-M1+gRo6m4yZvt3hXnn3s2EkXskU\""},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Pass created successfully\",\n \"passUid\": \"2a031428-ec2b-470f-8643-4915492a2c23\",\n \"passLink\": \"https://app.epasscard.com/p/2a031428-ec2b-470f-8643-4915492a2c23\"\n}"}],"_postman_id":"743a899d-1c43-461a-b88b-2df3844ca2ba"},{"name":"Update wallet pass","id":"cd22a344-c71f-426c-8163-123d7ecaaefc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"This request updates the details of a single wallet pass in the Epasscard system.
\nPUT https://api.epasscard.com/api/public/v1/update-single-pass
Use this endpoint to update information for an existing wallet pass, such as product details, warranty, purchase date, and customer information. The request requires the unique identifier (passUid) of the pass to be updated, along with the new field values.
The request body must be sent as raw JSON and should have the following structure:
\n{\n \"fields\": [\n {\n \"field_value\": \"<Value>\",\n \"uid\": \"<Field UID>\",\n },\n ...\n ],\n \"passUid\": \"<Pass UID>\"\n}\n\n{\n \"fields\": [\n { \"field_value\": \"Example Product\", \"uid\": \"...\"},\n { \"field_value\": \"2025-12-31\", \"uid\": \"...\"},\n { \"field_value\": \"2024-06-01\", \"uid\": \"...\"},\n {\"field_value\": \"John Doe\", \"uid\": \"...\"},\n {\"field_value\": \"1234567890\", \"uid\": \"...\"},\n {\"field_value\": \"support@example.com\", \"uid\": \"...\"}\n ],\n \"passUid\": \"2a031428-ec2b-470f-8643-4915492a2c23\"\n}\n\nAll fields in the fields array marked as required: 1 must be provided.
The passUid must correspond to an existing wallet pass.
If any required field is missing or empty, the API will return a 400 error with a message indicating the missing field.
\nEnsure that the uid for each field matches the expected field in the system.
200 OK: Pass updated successfully.
\n400 Bad Request: Missing required fields or invalid data.
\nFor more details, refer to the Epasscard Public Api collection documentation.
\n","urlObject":{"path":["public","v1","update-single-pass"],"host":["https://api.epasscard.com/api"],"query":[],"variable":[]}},"response":[{"id":"42fdc34d-7c12-4f75-a4f1-d29507dfcab7","name":"Success response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"fields\": [\n {\n \"field_name\": \"Product name\",\n \"field_value\": \"Walton\",\n \"uid\": \"c16557e0-62f6-45c9-9452-0b99d33067c1\",\n \"field_type\": \"text\",\n \"required\": 1\n },\n {\n \"field_name\": \"Warrenty till\",\n \"field_value\": \"20-12-2025\",\n \"uid\": \"b832d9e5-92d7-44a7-887b-d4eefadeab87\",\n \"field_type\": \"text\",\n \"required\": 1\n },\n {\n \"field_name\": \"Purchase Date\",\n \"field_value\": \"asdas\",\n \"uid\": \"191feb10-05e7-42e8-ae8a-3d12d6cff04b\",\n \"field_type\": \"text\",\n \"required\": 1\n },\n {\n \"field_name\": \"Customer name\",\n \"field_value\": \"dasd\",\n \"uid\": \"72c1e69f-68f3-434f-9588-6738724f3936\",\n \"field_type\": \"text\",\n \"required\": 1\n },\n {\n \"field_name\": \"Customer phone number\",\n \"field_value\": \"asdasd\",\n \"uid\": \"c56d1233-2d60-4435-aaf3-e19597d1f0d5\",\n \"field_type\": \"text\",\n \"required\": 1\n },\n {\n \"field_name\": \"Customer care\",\n \"field_value\": \"asdasd\",\n \"uid\": \"b9eb742d-70d7-4534-91a6-f393691570b0\",\n \"field_type\": \"text\",\n \"required\": 1\n }\n ],\n \"passUid\": \"94b4f8a4-d024-4b3b-bce3-aa49f3a087a3\",\n \"status\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://api.epasscard.com/api/public/v1/update-single-pass"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 05 Dec 2025 11:44:42 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"130"},{"key":"ETag","value":"W/\"82-QsGLyN2JdMa6k4uMFoNXsffoSyg\""},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Pass updated successfully\",\n \"passLink\": \"https://app.epasscard.com/p/94b4f8a4-d024-4b3b-bce3-aa49f3a087a3\"\n}"}],"_postman_id":"cd22a344-c71f-426c-8163-123d7ecaaefc"},{"name":"Delete wallet pass","id":"7a5d50a9-8ad2-4498-bcc9-8d4bf270efff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Deletes a single wallet pass by its unique ID.
\nEndpoint:DELETE https://api.epasscard.com/api/public/v1/delete-single-pass/:pass_uid
Path Parameter:
\npass_uid (string): The unique identifier of the pass to be deleted.Uid be like (05b9d6e0-8e8a-40de-a115-3bbd2d8901c0)Response:
\nOn success (HTTP 200), returns a JSON object:
\n{\n \"status\": 200,\n \"message\": \"Pass deleted successfully\"\n}\n\nUse this endpoint to permanently remove a wallet pass from the system.
\n","urlObject":{"path":["public","v1","delete-single-pass","{pass_uid}"],"host":["https://api.epasscard.com/api"],"query":[],"variable":[]}},"response":[{"id":"289f5ba3-b279-4e91-9e38-99fd3c5aaadc","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":"https://api.epasscard.com/api/public/v1/delete-single-pass/94b4f8a4-d024-4b3b-bce3-aa49f3a087a3"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 05 Dec 2025 11:46:03 GMT"},{"key":"Server","value":"Apache/2.4.58 (Ubuntu)"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"52"},{"key":"ETag","value":"W/\"34-4kwIfkTcf1aRSFrTafoX+fYwoQw\""},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Pass deleted successfully\"\n}"}],"_postman_id":"7a5d50a9-8ad2-4498-bcc9-8d4bf270efff"}],"id":"e29a57a0-1575-4519-93bb-9731f4a18c14","_postman_id":"e29a57a0-1575-4519-93bb-9731f4a18c14","description":""},{"name":"Transections","item":[{"name":"Get rechargeable pass data","id":"4f9aaf2a-c67c-4af2-b86a-26c219a05da6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Overview
Retrieve detailed data for a rechargeable pass by its unique pass ID. This endpoint is typically used by issuing portals, POS systems, or automation workflows to display current pass details (e.g., balance) and determine what actions (e.g., add/deduct) are available for the pass.
HTTP
\nMethod: GET
\nURL: https://api.epasscard.com/api/public/v1/get-rechargable-pass-data/:pass_uid
\nPath parameter
\nAuthentication
\nQuery parameters
\nRequest body
\nSuccess response (200)
Returns a JSON object describing the pass and its configurable fields. A representative example is shown below. The exact schema may evolve; avoid hard-coding field lists and prefer type checks.
Response fields
\ntemplate_id (number): Internal template identifier for the pass layout.
\ntemplate_uid (string, UUID): Template unique identifier.
\nname (string): Template or pass type name. Example: \"recharge\".
\ntemplate_data (string, JSON-as-string): A JSON string containing layout and primary settings for the pass. Parse if needed using JSON.parse.
\ndescription (string): Human-readable description of the pass template.
\npass_org_name (string): Organization name associated with the pass.
\nrecharge_field (string): The field in the pass that supports recharge operations (e.g., \"Balance\").
\npassId (number): Internal numeric identifier of the pass.
\ncard_number (string): The card or pass number associated with the pass.
\ntransection_action (string, JSON-as-string): A JSON string representing allowed transaction actions for fields (e.g., add/deduct). Parse with JSON.parse.
\nexpireStatus (boolean): Indicates whether the pass is expired (true) or active (false).
\nfields (array of objects): Dynamic field definitions and current values for the pass. Each item typically includes:
\nfield_name (string): Label or name of the field (e.g., \"Balance\").
\nfield_type (string): Data type (e.g., number, string).
\nfield_uid (string, UUID): Field unique identifier.
\nfield_value (string | number | boolean): Current value of the field.
\nactions (string, JSON-as-string): A JSON string representing configured actions allowed on fields. Often mirrors transection_action.
\nExample 200 response
{
\"template_id\": 821,
\"template_uid\": \"8371b227-afab-46fd-ae37-b5485c7a6ed1\",
\"name\": \"recharge\",
\"template_data\": \"{\"primarySettings\":{...}}\",
\"description\": \"dasd\",
\"pass_org_name\": \"asdad\",
\"recharge_field\": \"Balance\",
\"passId\": 162,
\"card_number\": \"t9drovdm0OSOezY\",
\"transection_action\": \"[{\"field\":\"Balance\",\"action\":\"add_deduct\"}]\",
\"expireStatus\": true,
\"fields\": [
{
\"field_name\": \"Balance\",
\"field_type\": \"number\",
\"field_uid\": \"8ae6b7b3-f5b8-4d18-858e-f3b5f766c6b4\",
\"field_value\": \"550\"
}
],
\"actions\": \"[{\"field\":\"Balance\",\"action\":\"add_deduct\"}]\"
}
Errors
\n400 Bad Request: Missing or invalid passId.
\n401/403 Unauthorized/Forbidden: Authentication missing or insufficient.
\n404 Not Found: No pass found for the given passId.
\n429 Too Many Requests: Rate limit exceeded.
\n5xx Server Errors: Temporary server issues.
\nUsage notes
\nJSON-as-string fields: template_data, transection_action, and actions are JSON-encoded strings. Use JSON.parse to consume them:
const data = pm.response.json();
const actions = JSON.parse(data.actions || \"[]\");
Balance and other dynamic values are provided under fields[]. Do not rely on a fixed index; search by field_name.
\nExpiration: Check expireStatus before allowing client-side recharge flows.
\nEnvironments: Ensure https://api.epasscard.com/api points to the correct environment (e.g., staging vs production).
\nSummary
Top up a wallet pass balance.
Method and URL
POST https://api.epasscard.com/api/public/v1/topup
Required Headers
\nRequest Body (JSON)
\nExample Request Body
{\"passUid\":\"89d99f9c-add7-49f7-9d07-e54840534459\",\"fieldName\":\"Balance\",\"amount\":\"25\",\"fields\":[{\"field_name\":\"Balance\",\"field_type\":\"number\",\"field_uid\":\"8ae6b7b3-f5b8-4d18-858e-f3b5f766c6b4\",\"field_value\":\"25\"}],\"templateId\":821,\"note\":\"\",\"passId\":162,\"cardNumber\":\"t9drovdm0OSOezY\",\"actions\":[{\"field\":\"Balance\",\"action\":\"add_deduct\"}]}
Example Successful Response
\nStatus: 200 OK
\nBody: Topup successfull
\nTesting Tips
\nSet environment variables:
\napi_url: Base URL for the API (Environment: api_url).
\nbearer_token: Your OAuth2/JWT token. Then set header Authorization: Bearer {{bearer_token}}.
\nEnsure the correct environment is selected before sending.
\nUsage Notes
\nUse a development/sandbox environment for safe testing to avoid affecting real balances.
\nTest with a known test cardNumber first.
\nEnsure your token has permissions to perform top-ups.
\nAvoid duplicate sends to prevent unintended double top-ups.
\nPurpose:\nRetrieves detailed information about a user from the Epasscard Public API.
\nEndpoint:\nGET https://api.epasscard.com/api/public/v1/get-user-data
Required Header:
\nx-api-key: Your API key for authentication. This header must be included in the request.Expected Successful Response (200):\nReturns a JSON object containing user details such as ID, name, email, phone number, company information, account status, and other profile attributes.
\nExample Response:
\n{\n \"status\": 200,\n \"message\": \"User data fetched successfully\",\n \"data\": {\n \"id\": 401,\n \"first_name\": \"Riad Khan\",\n ...\n }\n}\nThis endpoint validates a one-time password (OTP) for a specific template and field. Use this endpoint to verify that the OTP provided by a user matches the one generated for a particular field in a template.
\nAll parameters are required and should be sent as x-www-form-urlencoded:
template_uid (string): The unique identifier of the template containing the field to validate
\notp (string): The one-time password to validate against the system
\nfield_key (string): The unique identifier of the specific field being validated
\nvalue (string): The value associated with the field being validated
\n{\n \"validation\": true,\n \"status\": 200,\n \"message\": \"OTP validation success\"\n}\n\npass not found: The OTP provided does not match or was not found in the system
\nTemplate not found: The specified template_uid does not exist or is invalid
\nThis endpoint should be called after an OTP has been sent to the user (typically via SMS or email)
\nEnsure the template_uid and field_key are valid before attempting validation
\nOTPs typically have a time limit - validate them promptly after generation
\nFailed validation attempts may be rate-limited for security purposes
\n