### GET /core/countries Source: https://context7.com/bpdu/pondapidoc/llms.txt Retrieves a paginated list of available countries and their respective ISO codes. ```APIDOC ## GET /core/countries ### Description Returns a paginated list of available countries with their ISO codes for use in package configurations and network whitelists. ### Method GET ### Endpoint /v2.1/core/countries ### Parameters #### Query Parameters - **count** (integer) - Optional - Number of items to return - **offset** (integer) - Optional - Number of items to skip ### Response #### Success Response (200) - **total** (integer) - Total count of countries - **countries** (array) - List of country objects ### Response Example { "total": 195, "offset": 0, "count": 10, "countries": [ { "name": "United States", "iso2": "US", "iso3": "USA" } ] } ``` -------------------------------- ### GET /v2.1/esim-rsp/EUICC-profiles/{iccid} Source: https://context7.com/bpdu/pondapidoc/llms.txt Returns eSIM profile information including activation code for QR code generation. ```APIDOC ## GET /v2.1/esim-rsp/EUICC-profiles/{iccid} ### Description Returns eSIM profile information including activation code for QR code generation. ### Method GET ### Endpoint /v2.1/esim-rsp/EUICC-profiles/{iccid} ### Parameters #### Path Parameters - **iccid** (string) - Required - The ICCID of the eSIM profile. ### Response #### Success Response (200 OK) - **iccid** (string) - The ICCID of the eSIM profile. - **imsi** (string) - The IMSI associated with the eSIM profile. - **state** (string) - The current state of the eSIM profile (e.g., "AVAILABLE"). - **last_operation_date** (integer) - The timestamp of the last operation on the profile. - **activation_code** (string) - The activation code (SMDP+ address and confirmation code) for QR code generation. - **reuse_remaining_count** (integer) - The number of remaining times the profile can be reused. - **reuse_enabled** (boolean) - Indicates if profile reuse is enabled. - **profile_reuse_policy** (object) - Details about the profile reuse policy. - **reuse_type** (string) - The type of reuse allowed (e.g., "SAME_EID_MID"). - **max_count** (integer) - The maximum number of times the profile can be reused. - **cc_required** (boolean) - Indicates if a certificate is required for this profile. - **eid** (string) - The EID of the device associated with the eSIM profile. #### Response Example ```json { "iccid": "8901234567890123456", "imsi": "310260123456789", "state": "AVAILABLE", "last_operation_date": 1704067200000, "activation_code": "LPA:1$smdp.pondmobile.com$ABCD1234", "reuse_remaining_count": 3, "reuse_enabled": true, "profile_reuse_policy": { "reuse_type": "SAME_EID_MID", "max_count": 5 }, "cc_required": false, "eid": "" } ``` ``` -------------------------------- ### GET /session-management/open-data-sessions Source: https://context7.com/bpdu/pondapidoc/llms.txt Lists active data sessions for a specific SIM card. ```APIDOC ## GET /session-management/open-data-sessions ### Description Returns currently active data sessions for a SIM with connection details. ### Method GET ### Endpoint https://api.pondmobile.com/v2.1/session-management/open-data-sessions ### Parameters #### Query Parameters - **iccid** (string) - Required - The ICCID of the SIM card. ### Response #### Success Response (200) - **data_sessions** (array) - List of active sessions. ### Response Example { "data_sessions": [ { "data_session_id": "sess-abc123", "usage_kb": 52480, "private_ip": "10.0.0.45" } ] } ``` -------------------------------- ### GET /v2.1/inventory/sim-registries/{iccid} Source: https://context7.com/bpdu/pondapidoc/llms.txt Returns detailed information for a specific SIM card by ICCID. ```APIDOC ## GET /v2.1/inventory/sim-registries/{iccid} ### Description Returns detailed information for a specific SIM card by ICCID. ### Method GET ### Endpoint /v2.1/inventory/sim-registries/{iccid} ### Parameters #### Path Parameters - **iccid** (string) - Required - The ICCID of the SIM card to retrieve. ### Response #### Success Response (200 OK) - **iccid** (string) - The ICCID of the SIM card. - **sim_status** (string) - The status of the SIM card. - **group** (integer) - The ID of the group the SIM belongs to. - **inventory** (integer) - The ID of the inventory the SIM belongs to. - **company** (integer) - The ID of the company the SIM belongs to. - **created_date** (integer) - The creation timestamp. - **modified_date** (integer) - The last modification timestamp. - **imsis** (array) - An array of IMSI mappings. - **sponsor_id** (integer) - The sponsor ID for the IMSI. - **imsi** (integer) - The IMSI number. #### Response Example ```json { "iccid": "8901234567890123456", "sim_status": "ACTIVE", "group": 6001, "inventory": 5001, "company": 1001, "created_date": 1609459200000, "modified_date": 1704067200000, "imsis": [ {"sponsor_id": 1, "imsi": 310260123456789} ] } ``` ``` -------------------------------- ### GET /pcr/wallets/{id} Source: https://context7.com/bpdu/pondapidoc/llms.txt Retrieve specific wallet details including current balance and overdraft limits. ```APIDOC ## GET /pcr/wallets/{id} ### Description Returns wallet details including balance and overdraft limit. ### Method GET ### Endpoint https://api.pondmobile.com/v2.1/pcr/wallets/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The unique identifier of the wallet. ### Response #### Success Response (200) - **id** (integer) - Wallet ID - **wallet_type** (string) - Type of wallet - **owner** (object) - Owner details - **balance** (float) - Current balance - **overdraft** (float) - Overdraft limit ### Response Example { "id": 8101, "wallet_type": "GROUP", "owner": {"group": 6001}, "balance": 150.50, "overdraft": 50.00 } ``` -------------------------------- ### GET /v2.1/inventory/sim-transfers/{transferId}/report Source: https://context7.com/bpdu/pondapidoc/llms.txt Retrieves detailed status for each SIM in a transfer request. ```APIDOC ## GET /v2.1/inventory/sim-transfers/{transferId}/report ### Description Retrieves detailed status for each SIM in a transfer request. ### Method GET ### Endpoint /v2.1/inventory/sim-transfers/{transferId}/report ### Parameters #### Path Parameters - **transferId** (string) - Required - The ID of the SIM transfer request. ### Response #### Success Response (200 OK) - **iccid** (string) - The ICCID of the SIM. - **status** (string) - The status of the SIM transfer for this specific SIM (e.g., "COMPLETED"). - **completed_date** (integer) - The timestamp when the transfer for this SIM was completed (milliseconds since epoch). #### Response Example ```json { "iccid": "8901234567890123456", "status": "COMPLETED", "completed_date": 1704068000000 } ``` ``` -------------------------------- ### GET /v2.1/inventory/sim-registries Source: https://context7.com/bpdu/pondapidoc/llms.txt Returns SIM cards filtered by inventory or group with full details including IMSI mappings. ```APIDOC ## GET /v2.1/inventory/sim-registries ### Description Returns SIM cards filtered by inventory or group with full details including IMSI mappings. ### Method GET ### Endpoint /v2.1/inventory/sim-registries ### Parameters #### Query Parameters - **inventory** (integer) - Optional - Filter by inventory ID. - **group** (integer) - Optional - Filter by group ID. - **count** (integer) - Optional - The number of SIMs to return per page (default: 50). - **offset** (integer) - Optional - The number of SIMs to skip (for pagination). ### Response #### Success Response (200 OK) - **total** (integer) - The total number of SIMs matching the filter. - **offset** (integer) - The current offset. - **count** (integer) - The number of SIMs returned in this response. - **sims** (array) - An array of SIM objects. - **iccid** (string) - The ICCID of the SIM card. - **sim_status** (string) - The status of the SIM card (e.g., "ACTIVE"). - **group** (integer) - The ID of the group the SIM belongs to. - **inventory** (integer) - The ID of the inventory the SIM belongs to. - **company** (integer) - The ID of the company the SIM belongs to. - **created_date** (integer) - The creation timestamp (milliseconds since epoch). - **imsis** (array) - An array of IMSI mappings. - **sponsor_id** (integer) - The sponsor ID for the IMSI. - **imsi** (integer) - The IMSI number. - **mapped_imsi** (integer) - The currently mapped IMSI. #### Response Example ```json { "total": 150, "offset": 0, "count": 50, "sims": [ { "iccid": "8901234567890123456", "sim_status": "ACTIVE", "group": 6001, "inventory": 5001, "company": 1001, "created_date": 1609459200000, "imsis": [ {"sponsor_id": 1, "imsi": 310260123456789} ], "mapped_imsi": 310260123456789 } ] } ``` ``` -------------------------------- ### Create Package Template Source: https://context7.com/bpdu/pondapidoc/llms.txt Creates a new package template defining service allowances and activation rules. Requires a JSON payload containing name, inventory, and usage limits. ```bash curl -X POST "https://api.pondmobile.com/v2.1/pcr/package-templates" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Europe IoT 500MB Weekly", "inventory": 5001, "traffic_policy": 4001, "supported_countries": ["DEU", "FRA", "ITA", "ESP"], "data_usage_allowance": 524288000, "sms_usage_allowance": 50, "voice_usage_allowance": 0, "activation_type": "Auto", "activation_time_allowance": 604800, "time_allowance": {"duration": 604800, "unit": "SECOND"}, "earliest_available_date": 1704067200000, "latest_available_date": 1735689600000, "notes": "Weekly plan for European IoT devices" }' ``` -------------------------------- ### List Package Templates Source: https://context7.com/bpdu/pondapidoc/llms.txt Retrieves a list of available package templates that define data, voice, and SMS allowances. Supports pagination via count and offset parameters. ```bash curl -X GET "https://api.pondmobile.com/v2.1/pcr/package-templates?inventory=5001&count=20&offset=0" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` -------------------------------- ### Create Package Template Source: https://context7.com/bpdu/pondapidoc/llms.txt Creates a new package template with specified service allowances (data, voice, SMS) and activation rules. Requires details like name, inventory, traffic policy, and time allowances. ```APIDOC ## POST /v2.1/pcr/package-templates ### Description Creates a new package template with defined service allowances and activation rules. ### Method POST ### Endpoint /v2.1/pcr/package-templates #### Request Body - **name** (string) - Required - Name of the package template. - **inventory** (integer) - Required - Inventory ID. - **traffic_policy** (integer) - Required - ID of the traffic policy. - **supported_countries** (array of strings) - Required - List of country codes. - **data_usage_allowance** (integer) - Required - Data allowance in bytes. - **sms_usage_allowance** (integer) - Optional - SMS allowance. - **voice_usage_allowance** (integer) - Optional - Voice allowance. - **activation_type** (string) - Required - Type of activation (e.g., 'Auto'). - **activation_time_allowance** (integer) - Required - Time allowance for activation in seconds. - **time_allowance** (object) - Required - Duration and unit for the package validity. - **duration** (integer) - The duration value. - **unit** (string) - The unit of time (e.g., 'SECOND'). - **earliest_available_date** (integer) - Optional - Timestamp for earliest availability. - **latest_available_date** (integer) - Optional - Timestamp for latest availability. - **notes** (string) - Optional - Additional notes for the template. ### Request Example ```json { "name": "Europe IoT 500MB Weekly", "inventory": 5001, "traffic_policy": 4001, "supported_countries": ["DEU", "FRA", "ITA", "ESP"], "data_usage_allowance": 524288000, "sms_usage_allowance": 50, "voice_usage_allowance": 0, "activation_type": "Auto", "activation_time_allowance": 604800, "time_allowance": {"duration": 604800, "unit": "SECOND"}, "earliest_available_date": 1704067200000, "latest_available_date": 1735689600000, "notes": "Weekly plan for European IoT devices" } ``` ### Response #### Success Response (200 or 201) - **id** (integer) - The unique identifier of the created package template. - **name** (string) - The name of the package template. - **status** (string) - The status of the created template (e.g., 'ACTIVE'). - **created_date** (integer) - Timestamp when the template was created. #### Response Example ```json { "id": 3002, "name": "Europe IoT 500MB Weekly", "status": "ACTIVE", "created_date": 1704067200000 } ``` ``` -------------------------------- ### List Packages Source: https://context7.com/bpdu/pondapidoc/llms.txt Fetches a list of active or historical packages filtered by SIM ID, status, or inventory. Useful for auditing current service states. ```bash curl -X GET "https://api.pondmobile.com/v2.1/pcr/packages?sim=8901234567890123456&status=ACTIVE&count=20" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` -------------------------------- ### Create Package for SIM Source: https://context7.com/bpdu/pondapidoc/llms.txt Assigns a specific service package to a SIM card using an existing package template ID. Returns the newly created package details including status and remaining usage. ```bash curl -X POST "https://api.pondmobile.com/v2.1/pcr/packages" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "sim": "8901234567890123456", "package_template": 3001, "time_allowance": 2592000 }' ``` -------------------------------- ### Retrieve eSIM Profile Source: https://context7.com/bpdu/pondapidoc/llms.txt Fetches eSIM profile details, including the activation code required for QR code generation and profile reuse policy settings. ```bash curl -X GET "https://api.pondmobile.com/v2.1/esim-rsp/EUICC-profiles/8901234567890123456" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` -------------------------------- ### Create Package for SIM Source: https://context7.com/bpdu/pondapidoc/llms.txt Creates a new service package (plan) for a specific SIM card, utilizing a predefined package template. Requires SIM identifier and package template ID. ```APIDOC ## POST /v2.1/pcr/packages ### Description Creates a new package (service plan) for a specific SIM using a package template. ### Method POST ### Endpoint /v2.1/pcr/packages #### Request Body - **sim** (string) - Required - The SIM card identifier (e.g., ICCID). - **package_template** (integer) - Required - The ID of the package template to use. - **time_allowance** (integer) - Optional - Overrides the time allowance from the template, in seconds. ### Request Example ```json { "sim": "8901234567890123456", "package_template": 3001, "time_allowance": 2592000 } ``` ### Response #### Success Response (200 or 201) - **id** (string) - The unique identifier for the created package. - **sim** (string) - The SIM card identifier. - **status** (string) - The initial status of the package (e.g., 'NOT_ACTIVE'). - **created_date** (integer) - Timestamp when the package was created. - **window_activation_start** (integer) - Timestamp for the start of the activation window. - **window_activation_end** (integer) - Timestamp for the end of the activation window. - **data_usage_remaining** (integer) - Remaining data allowance in bytes. - **sms_usage_remaining** (integer) - Remaining SMS allowance. - **voice_usage_remaining** (integer) - Remaining voice allowance. - **package_template** (object) - Details of the package template used. - **id** (integer) - Package template ID. - **name** (string) - Package template name. #### Response Example ```json { "id": "pkg-12345", "sim": "8901234567890123456", "status": "NOT_ACTIVE", "created_date": 1704067200000, "window_activation_start": 1704067200000, "window_activation_end": 1706745600000, "data_usage_remaining": 1073741824, "sms_usage_remaining": 100, "voice_usage_remaining": 0, "package_template": { "id": 3001, "name": "Global IoT 1GB Monthly" } } ``` ``` -------------------------------- ### List Package Templates Source: https://context7.com/bpdu/pondapidoc/llms.txt Retrieves a list of available package templates, which define data, voice, and SMS allowances for SIM plans. Supports filtering by inventory and pagination. ```APIDOC ## GET /v2.1/pcr/package-templates ### Description Returns available package templates that define data, voice, and SMS allowances for SIM plans. ### Method GET ### Endpoint /v2.1/pcr/package-templates #### Query Parameters - **inventory** (integer) - Optional - Filter by inventory ID. - **count** (integer) - Optional - Number of results to return per page. Defaults to 20. - **offset** (integer) - Optional - Number of results to skip. Defaults to 0. ### Request Example ```bash curl -X GET "https://api.pondmobile.com/v2.1/pcr/package-templates?inventory=5001&count=20&offset=0" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` ### Response #### Success Response (200) - **total** (integer) - Total number of package templates available. - **offset** (integer) - The current offset. - **count** (integer) - The number of package templates returned in this response. - **package_templates** (array) - An array of package template objects. - **id** (integer) - Unique identifier for the package template. - **name** (string) - Name of the package template. - **traffic_policy** (integer) - ID of the associated traffic policy. - **supported_countries** (array of strings) - List of country codes supported by this template. - **data_usage_allowance** (integer) - Data allowance in bytes. - **voice_usage_allowance** (integer) - Voice allowance (e.g., in seconds). - **sms_usage_allowance** (integer) - SMS allowance. - **activation_type** (string) - Type of activation (e.g., 'Auto'). - **activation_time_allowance** (integer) - Time allowance for activation in seconds. - **time_allowance** (object) - Duration and unit for the package validity. - **duration** (integer) - The duration value. - **unit** (string) - The unit of time (e.g., 'CALENDAR_MONTH', 'SECOND'). - **status** (string) - Status of the package template (e.g., 'ACTIVE'). #### Response Example ```json { "total": 5, "offset": 0, "count": 5, "package_templates": [ { "id": 3001, "name": "Global IoT 1GB Monthly", "traffic_policy": 4001, "supported_countries": ["USA", "DEU", "GBR", "FRA"], "data_usage_allowance": 1073741824, "voice_usage_allowance": 0, "sms_usage_allowance": 100, "activation_type": "Auto", "activation_time_allowance": 2592000, "time_allowance": {"duration": 1, "unit": "CALENDAR_MONTH"}, "status": "ACTIVE" } ] } ``` ``` -------------------------------- ### POST /inventory/inventories Source: https://context7.com/bpdu/pondapidoc/llms.txt Creates a new inventory for a sub-company with optional template-based configuration. ```APIDOC ## POST /inventory/inventories ### Description Creates a new inventory for a sub-company with optional template-based configuration. ### Method POST ### Endpoint /v2.1/inventory/inventories ### Parameters #### Request Body - **name** (string) - Required - Name of the inventory - **company** (integer) - Required - ID of the sub-company - **display_currency** (string) - Optional - Currency code - **template** (integer) - Optional - Configuration template ID ### Request Example { "name": "Europe Fleet Inventory", "company": 1002, "display_currency": "EUR", "template": 101 } ### Response #### Success Response (200) - **id** (integer) - Unique inventory ID - **wallet** (integer) - Associated wallet ID ### Response Example { "id": 5002, "name": "Europe Fleet Inventory", "wallet": 8002 } ``` -------------------------------- ### Authenticate API Requests Source: https://context7.com/bpdu/pondapidoc/llms.txt Demonstrates how to authenticate requests using a Bearer token in the Authorization header. This is required for all API interactions. ```bash curl -X GET "https://api.pondmobile.com/v2.1/core/countries" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" ``` -------------------------------- ### POST /core/companies Source: https://context7.com/bpdu/pondapidoc/llms.txt Creates a new sub-company under the organization for multi-tenant SIM management. ```APIDOC ## POST /core/companies ### Description Creates a new sub-company under your organization for multi-tenant SIM management. ### Method POST ### Endpoint /v2.1/core/companies ### Parameters #### Request Body - **name** (string) - Required - Name of the sub-company - **email** (string) - Required - Contact email - **note** (string) - Optional - Additional notes ### Request Example { "name": "Fleet Management Division", "email": "fleet@company.com", "note": "Vehicle tracking SIMs" } ### Response #### Success Response (200) - **ID** (integer) - Unique identifier for the new company - **status** (string) - Current status of the company ### Response Example { "ID": 1002, "name": "Fleet Management Division", "status": "ACTIVE" } ``` -------------------------------- ### Manage Core API Resources Source: https://context7.com/bpdu/pondapidoc/llms.txt Operations for listing countries, retrieving sub-companies, and creating or updating company entities. These endpoints facilitate multi-tenant organization management. ```bash # List Countries curl -X GET "https://api.pondmobile.com/v2.1/core/countries?count=10&offset=0" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "request-id: req-12345" # List Sub-Companies curl -X GET "https://api.pondmobile.com/v2.1/core/companies?count=20&offset=0" \ -H "Authorization: Bearer YOUR_API_TOKEN" # Create Sub-Company curl -X POST "https://api.pondmobile.com/v2.1/core/companies" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Fleet Management Division", "email": "fleet@company.com", "note": "Vehicle tracking SIMs" }' # Update Sub-Company curl -X PUT "https://api.pondmobile.com/v2.1/core/companies/1002" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Fleet Management - Europe", "email": "fleet-eu@company.com" }' ``` -------------------------------- ### List Packages Source: https://context7.com/bpdu/pondapidoc/llms.txt Retrieves a list of packages associated with SIM cards. Supports filtering by SIM, template, status, and inventory, along with pagination. ```APIDOC ## GET /v2.1/pcr/packages ### Description Returns packages filtered by inventory, template, SIM, or status. ### Method GET ### Endpoint /v2.1/pcr/packages #### Query Parameters - **inventory** (integer) - Optional - Filter by inventory ID. - **template** (integer) - Optional - Filter by package template ID. - **sim** (string) - Optional - Filter by SIM card identifier. - **status** (string) - Optional - Filter by package status (e.g., 'ACTIVE', 'INACTIVE'). - **count** (integer) - Optional - Number of results to return per page. Defaults to 20. - **offset** (integer) - Optional - Number of results to skip. Defaults to 0. ### Request Example ```bash curl -X GET "https://api.pondmobile.com/v2.1/pcr/packages?sim=8901234567890123456&status=ACTIVE&count=20" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` ### Response #### Success Response (200) - **total** (integer) - Total number of packages matching the criteria. - **offset** (integer) - The current offset. - **count** (integer) - The number of packages returned in this response. - **packages** (array) - An array of package objects. - **id** (string) - Unique identifier for the package. - **sim** (string) - The SIM card identifier. - **status** (string) - The current status of the package. - **activated_date** (integer) - Timestamp when the package was activated. - **expiry_date** (integer) - Timestamp when the package expires. - **data_usage_remaining** (integer) - Remaining data allowance in bytes. - **package_template** (object) - Details of the package template used. - **id** (integer) - Package template ID. - **name** (string) - Package template name. #### Response Example ```json { "total": 2, "offset": 0, "count": 2, "packages": [ { "id": "pkg-12345", "sim": "8901234567890123456", "status": "ACTIVE", "activated_date": 1704070000000, "expiry_date": 1706745600000, "data_usage_remaining": 856432100, "package_template": {"id": 3001, "name": "Global IoT 1GB Monthly"} } ] } ``` ``` -------------------------------- ### Manage Inventory and Groups Source: https://context7.com/bpdu/pondapidoc/llms.txt Endpoints for managing inventories and SIM groups. These allow for organization of SIMs, pooled billing, and shared balances. ```bash # List Inventories curl -X GET "https://api.pondmobile.com/v2.1/inventory/inventories?count=20&offset=0&company=1001" \ -H "Authorization: Bearer YOUR_API_TOKEN" # Create Inventory curl -X POST "https://api.pondmobile.com/v2.1/inventory/inventories" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Europe Fleet Inventory", "note": "SIMs for European vehicle tracking", "company": 1002, "display_currency": "EUR", "template": 101 }' # List Groups curl -X GET "https://api.pondmobile.com/v2.1/inventory/groups?inventory=5001&count=20&offset=0" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` -------------------------------- ### Create Inventory Group Source: https://context7.com/bpdu/pondapidoc/llms.txt Creates a new group within an inventory to organize SIMs with shared configurations. Requires inventory ID and template ID in the request body. ```bash curl -X POST "https://api.pondmobile.com/v2.1/inventory/groups" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Sensor Network Alpha", "inventory": 5001, "template": 201 }' ``` -------------------------------- ### Manage SIM Transfers Source: https://context7.com/bpdu/pondapidoc/llms.txt Initiates a transfer of SIMs between inventories and retrieves the status report for a specific transfer request. Supports webhook callbacks for completion notifications. ```bash curl -X POST "https://api.pondmobile.com/v2.1/inventory/sim-transfers" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "source_inventory": 5001, "dest_inventory": 5002, "dest_whitelist": 9002, "dest_group": 6003, "wallet_mode": "SIM", "sims": { "iccids": [ {"id": "8901234567890123456"}, {"id": "8901234567890123457"} ] }, "callback": { "url": "https://webhook.example.com/transfer-complete", "headers": [ {"header": "X-API-Key", "value": "secret123"} ] } }' ``` ```bash curl -X GET "https://api.pondmobile.com/v2.1/inventory/sim-transfers/transfer-789/report" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` -------------------------------- ### POST /v2.1/inventory/groups Source: https://context7.com/bpdu/pondapidoc/llms.txt Creates a new group within an inventory for organizing SIMs with shared configurations. ```APIDOC ## POST /v2.1/inventory/groups ### Description Creates a new group within an inventory for organizing SIMs with shared configurations. ### Method POST ### Endpoint /v2.1/inventory/groups ### Parameters #### Request Body - **name** (string) - Required - The name of the new group. - **inventory** (integer) - Required - The ID of the inventory to create the group in. - **template** (integer) - Optional - The ID of the template to use for the group. ### Request Example ```json { "name": "Sensor Network Alpha", "inventory": 5001, "template": 201 } ``` ### Response #### Success Response (201 Created) - **id** (integer) - The ID of the newly created group. - **name** (string) - The name of the group. - **inventory** (object) - Information about the inventory the group belongs to. - **id** (integer) - The inventory ID. - **name** (string) - The inventory name. - **wallet** (integer) - The wallet associated with the group. - **created_date** (integer) - The creation timestamp (milliseconds since epoch). #### Response Example ```json { "id": 6002, "name": "Sensor Network Alpha", "inventory": {"id": 5001, "name": "Production SIMs"}, "wallet": 8102, "created_date": 1704067200000 } ``` ``` -------------------------------- ### List Traffic Policies Source: https://context7.com/bpdu/pondapidoc/llms.txt Retrieves a list of available traffic policies that define data throttling rules for SIM plans. ```bash curl -X GET "https://api.pondmobile.com/v2.1/pcr/traffic-policies?count=20&offset=0" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` -------------------------------- ### List Open Data Sessions via cURL Source: https://context7.com/bpdu/pondapidoc/llms.txt Retrieves active data sessions for a specific SIM identified by its ICCID. Returns details such as session ID, usage, and network connection parameters. ```bash curl -X GET "https://api.pondmobile.com/v2.1/session-management/open-data-sessions?iccid=8901234567890123456" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` -------------------------------- ### List and Retrieve SIMs Source: https://context7.com/bpdu/pondapidoc/llms.txt Endpoints to list SIM cards filtered by inventory or group, and to retrieve detailed information for a specific SIM using its ICCID. ```bash curl -X GET "https://api.pondmobile.com/v2.1/inventory/sim-registries?inventory=5001&group=6001&count=50&offset=0" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` ```bash curl -X GET "https://api.pondmobile.com/v2.1/inventory/sim-registries/8901234567890123456" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` -------------------------------- ### POST /v2.1/inventory/sim-transfers Source: https://context7.com/bpdu/pondapidoc/llms.txt Transfers SIMs from a parent inventory to a sub-company inventory with webhook callback support. ```APIDOC ## POST /v2.1/inventory/sim-transfers ### Description Transfers SIMs from a parent inventory to a sub-company inventory with webhook callback support. ### Method POST ### Endpoint /v2.1/inventory/sim-transfers ### Parameters #### Request Body - **source_inventory** (integer) - Required - The ID of the source inventory. - **dest_inventory** (integer) - Required - The ID of the destination inventory. - **dest_whitelist** (integer) - Required - The ID of the destination whitelist. - **dest_group** (integer) - Optional - The ID of the destination group. - **wallet_mode** (string) - Required - The wallet mode for the transfer (e.g., "SIM"). - **sims** (object) - Required - Details of the SIMs to transfer. - **iccids** (array) - Required - An array of SIM objects to transfer. - **id** (string) - Required - The ICCID of the SIM. - **callback** (object) - Optional - Callback configuration for transfer completion. - **url** (string) - Required - The URL to send the callback notification to. - **headers** (array) - Optional - Custom headers for the callback request. - **header** (string) - Required - The header name. - **value** (string) - Required - The header value. ### Request Example ```json { "source_inventory": 5001, "dest_inventory": 5002, "dest_whitelist": 9002, "dest_group": 6003, "wallet_mode": "SIM", "sims": { "iccids": [ {"id": "8901234567890123456"}, {"id": "8901234567890123457"} ] }, "callback": { "url": "https://webhook.example.com/transfer-complete", "headers": [ {"header": "X-API-Key", "value": "secret123"} ] } } ``` ### Response #### Success Response (202 Accepted) - **id** (string) - The ID of the transfer request. - **number_of_sims** (integer) - The number of SIMs included in the transfer. - **created_date** (integer) - The creation timestamp. - **status** (string) - The initial status of the transfer (e.g., "PENDING"). - **source_inventory** (object) - Information about the source inventory. - **id** (integer) - The inventory ID. - **name** (string) - The inventory name. - **dest_inventory** (object) - Information about the destination inventory. - **id** (integer) - The inventory ID. - **name** (string) - The inventory name. #### Response Example ```json { "id": "transfer-789", "number_of_sims": 2, "created_date": 1704067200000, "status": "PENDING", "source_inventory": {"id": 5001, "name": "Production SIMs"}, "dest_inventory": {"id": 5002, "name": "Europe Fleet Inventory"} } ``` ``` -------------------------------- ### Manage Network Whitelists via cURL Source: https://context7.com/bpdu/pondapidoc/llms.txt Provides endpoints to list network whitelists, view assigned SIMs, and assign new SIMs to a whitelist. These operations are essential for controlling network access at the SIM level. ```bash # List whitelists curl -X GET "https://api.pondmobile.com/v2.1/network-access/whitelists?count=20&offset=0" \ -H "Authorization: Bearer YOUR_API_TOKEN" # List SIMs in a whitelist curl -X GET "https://api.pondmobile.com/v2.1/network-access/whitelists/9001/assigned-sims?count=50&offset=0" \ -H "Authorization: Bearer YOUR_API_TOKEN" # Assign SIMs to a whitelist curl -X POST "https://api.pondmobile.com/v2.1/network-access/whitelists/9001/assigned-sims" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "sim": [ {"id": "8901234567890123458"}, {"id": "8901234567890123459"} ] }' ``` -------------------------------- ### Retrieve Wallet Details via cURL Source: https://context7.com/bpdu/pondapidoc/llms.txt Fetches current balance and overdraft limits for a specific wallet ID. Requires a valid API token in the Authorization header. ```bash curl -X GET "https://api.pondmobile.com/v2.1/pcr/wallets/8101" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` -------------------------------- ### Retrieve SIM PCR Profile Source: https://context7.com/bpdu/pondapidoc/llms.txt Retrieves the Policy and Charging Rules profile for a specific SIM, including service states for data, voice, and SMS, and wallet configurations. ```bash curl -X GET "https://api.pondmobile.com/v2.1/pcr/sim-pcr-profiles/8901234567890123456" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` -------------------------------- ### Retrieve SIM PCR Profile Source: https://context7.com/bpdu/pondapidoc/llms.txt Fetches the Policy and Charging Rules (PCR) profile for a given SIM card, including service states (data, voice, SMS) and wallet configuration. ```APIDOC ## GET /v2.1/pcr/sim-pcr-profiles/{simId} ### Description Returns the Policy and Charging Rules profile with service states and wallet configuration. ### Method GET ### Endpoint /v2.1/pcr/sim-pcr-profiles/{simId} #### Path Parameters - **simId** (string) - Required - The SIM card identifier (e.g., ICCID). ### Request Example ```bash curl -X GET "https://api.pondmobile.com/v2.1/pcr/sim-pcr-profiles/8901234567890123456" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` ### Response #### Success Response (200) - **sim** (string) - The SIM card identifier. - **data** (object) - Data service state and throttling information. - **state** (string) - Current state (e.g., 'ENABLED', 'DISABLED'). - **active_throttling** (string) - Current active throttling rule. - **voice** (object) - Voice service state. - **state** (string) - Current state (e.g., 'ENABLED', 'DISABLED'). - **sms** (object) - SMS service state. - **state** (string) - Current state (e.g., 'ENABLED', 'DISABLED'). - **wallet_mode** (string) - The mode for wallet usage (e.g., 'GROUP', 'SIM'). - **wallets** (array) - List of associated wallets. - **id** (integer) - Wallet identifier. - **wallet_type** (string) - Type of wallet (e.g., 'GROUP'). - **balance** (number) - Current balance in the wallet. - **overdraft** (number) - Allowed overdraft amount. #### Response Example ```json { "sim": "8901234567890123456", "data": { "state": "ENABLED", "active_throttling": "NO_LIMIT" }, "voice": {"state": "DISABLED"}, "sms": {"state": "ENABLED"}, "wallet_mode": "GROUP", "wallets": [ {"id": 8101, "wallet_type": "GROUP", "balance": 150.50, "overdraft": 0} ] } ``` ``` -------------------------------- ### Update Package Status Source: https://context7.com/bpdu/pondapidoc/llms.txt Activates or terminates an existing package for a SIM card. Requires the package ID and the desired new status. ```APIDOC ## PUT /v2.1/pcr/packages/{packageId} ### Description Activates or terminates a package for a SIM card. ### Method PUT ### Endpoint /v2.1/pcr/packages/{packageId} #### Path Parameters - **packageId** (string) - Required - The ID of the package to update. #### Request Body - **package_status** (string) - Required - The new status for the package (e.g., 'TERMINATED', 'ACTIVE'). ### Request Example ```json { "package_status": "TERMINATED" } ``` ### Response #### Success Response (204 No Content) Indicates the package status was successfully updated. ``` -------------------------------- ### Update SIM PCR Profile Source: https://context7.com/bpdu/pondapidoc/llms.txt Modifies the PCR profile for a SIM, allowing updates to data throttling, service states, and wallet modes. ```bash curl -X PUT "https://api.pondmobile.com/v2.1/pcr/sim-pcr-profiles/8901234567890123456" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "data": { "state": "ENABLED", "active_throttling": "SPEED_1000_KBPS" }, "voice": {"state": "DISABLED"}, "sms": {"state": "ENABLED"}, "wallet_mode": "SIM" }' ``` -------------------------------- ### Update Package Status Source: https://context7.com/bpdu/pondapidoc/llms.txt Updates the status of a specific package (e.g., to 'TERMINATED'). Requires the package ID in the URL path. ```bash curl -X PUT "https://api.pondmobile.com/v2.1/pcr/packages/pkg-12345" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "package_status": "TERMINATED" }' ```