@ampeco/public-api-mcp 3.245.3 → 3.247.0

package/dist/generated/build-stats.json

@@ -1,13 +1,13 @@
 {
   "totalEndpoints": 640,
-  "originalSize": 5796134,
-  "optimizedSize": 1619628,
-  "reductionPercent": 72.06,
-  "buildDuration": 1555,
+  "originalSize": 5828593,
+  "optimizedSize": 1631472,
+  "reductionPercent": 72.01,
+  "buildDuration": 1591,
   "responseSchemas": {
     "total": 640,
     "withSchemas": 640,
-    "totalSchemaSize": 3303477,
-    "averageSchemaSize": 5162
+    "totalSchemaSize": 3317461,
+    "averageSchemaSize": 5184
   }
 }

package/dist/generated/endpoints.json

@@ -48645,9 +48645,10 @@
                   "type": "string",
                   "enum": [
                     "policy",
-                    "charge_point"
+                    "charge_point",
+                    "integration"
                   ],
-                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy."
+                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy. - **integration**: An integration resolves the electricity rate — for example by the charge point's region. The integration and its region-to-rate bindings are configured in the admin panel. `electricityRateId` is not set on the policy."
                 }
               }
             }
@@ -48695,14 +48696,6 @@
                   "type": "string",
                   "maxLength": 255
                 },
-                "electricityRateSource": {
-                  "type": "string",
-                  "enum": [
-                    "policy",
-                    "charge_point"
-                  ],
-                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy."
-                },
                 "validityStartsOn": {
                   "type": "string",
                   "format": "date",
@@ -48725,6 +48718,14 @@
                   "format": "date",
                   "description": "Uses the YYYY-MM-DD date format."
                 },
+                "electricityRateSource": {
+                  "type": "string",
+                  "enum": [
+                    "policy",
+                    "charge_point"
+                  ],
+                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy. The `integration` source is not writable through this API: it cannot be submitted on create or update. Policies using it are configured in the admin panel."
+                },
                 "operatorId": {
                   "type": "integer",
                   "example": 1,
@@ -48791,7 +48792,7 @@
       "method": "DELETE",
       "operationId": "reimbursementPolicyDelete",
       "summary": "Reimbursement policy / Delete",
-      "description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed. Delete a reimbursement policy. Deletion is rejected while the policy is attached to partner invites.",
+      "description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed. Delete a reimbursement policy. Deletion is rejected only while the policy is attached to partner invites. A policy is deletable whatever its `electricityRateSource` is, `integration` included; the restrictions on submitting `electricityRateSource` are described on the create and update operations and do not apply here.",
       "tags": [
         "resource / reimbursement policies"
       ],
@@ -48824,7 +48825,7 @@
       "method": "PATCH",
       "operationId": "reimbursementPolicyUpdate",
       "summary": "Reimbursement policy / Update",
-      "description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed. Update a reimbursement policy. The update is rejected with 409 while the requested change conflicts with the rate the policy resolves — selecting the `charge_point` rate source while an attached charge point has no electricity rate. That conflict clears only when the configuration changes: give the charge point a rate, or detach it from the policy. Every other rejection of the request body is reported as 422, keyed by the offending field — malformed or invalid field values, and changing `partnerId` on a policy that is already assigned to partner invites or has active charge point attachments, which returns a `partnerId` validation error rather than a 409. Deactivated attachments do not block the change.",
+      "description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed. Update a reimbursement policy. The update is rejected with 409 while the requested change conflicts with the rate the policy resolves — selecting the `charge_point` rate source while an attached charge point has no electricity rate. That conflict clears only when the configuration changes: give the charge point a rate, or detach it from the policy. A policy whose stored `electricityRateSource` is `integration` is updated through this API like any other policy, except that its rate source cannot be changed: a request that submits `electricityRateSource` on such a policy is rejected with 409, because the integration that resolves its rate is configured in the admin panel and the binding could not be restored through this API. Omit `electricityRateSource` to update `name`, the validity dates or the partner scope. Every other rejection of the request body is reported as 422, keyed by the offending field — malformed or invalid field values, and changing `partnerId` on a policy that is already assigned to partner invites or has active charge point attachments, which returns a `partnerId` validation error rather than a 409. Deactivated attachments do not block the change.",
       "tags": [
         "resource / reimbursement policies"
       ],
@@ -48839,18 +48840,18 @@
                   "type": "string",
                   "maxLength": 255
                 },
+                "validityStartsOn": {
+                  "type": "string",
+                  "format": "date",
+                  "description": "Uses the YYYY-MM-DD date format."
+                },
                 "electricityRateSource": {
                   "type": "string",
                   "enum": [
                     "policy",
                     "charge_point"
                   ],
-                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy."
-                },
-                "validityStartsOn": {
-                  "type": "string",
-                  "format": "date",
-                  "description": "Uses the YYYY-MM-DD date format."
+                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy. The `integration` source is not writable through this API: it cannot be submitted on create or update. Policies using it are configured in the admin panel."
                 },
                 "partnerId": {
                   "type": "integer",
@@ -52495,7 +52496,7 @@
       "method": "GET",
       "operationId": "subOperatorsListing",
       "summary": "Sub-operators / Listing",
-      "description": "Get all sub-operators. Returns sub-operators ordered by businessName ascending by default. Uses cursor-based pagination.",
+      "description": "Get all sub-operators. Returns sub-operators ordered by their English (en) name ascending. The order is fixed and cannot be changed. Uses cursor-based pagination.",
       "tags": [
         "resource / sub operators"
       ],
@@ -52555,7 +52556,7 @@
                 },
                 "name": {
                   "type": "string",
-                  "description": "Filter by sub-operator name (partial match)"
+                  "description": "Filter by sub-operator name (partial match against the English (en) name only)"
                 },
                 "businessName": {
                   "type": "string",
@@ -52563,7 +52564,7 @@
                 },
                 "region": {
                   "type": "string",
-                  "description": "Filter by region for countries without predefined states (partial match)"
+                  "description": "Filter by region for countries without predefined states (partial match against the English (en) region only)"
                 },
                 "lastUpdatedAfter": {
                   "type": "string",
@@ -52615,11 +52616,6 @@
             "schema": {
               "type": "object",
               "properties": {
-                "name": {
-                  "type": "string",
-                  "maxLength": 255,
-                  "description": "Display name of the sub-operator"
-                },
                 "businessName": {
                   "type": "string",
                   "maxLength": 255,
@@ -52896,11 +52892,6 @@
                   ],
                   "description": "ISO 3166-1 alpha-2 country code"
                 },
-                "city": {
-                  "type": "string",
-                  "maxLength": 255,
-                  "description": "City name"
-                },
                 "state": {
                   "anyOf": [
                     {
@@ -53074,21 +53065,11 @@
                   ],
                   "description": "When the selected country is one of US, AU, CA, UM or RO"
                 },
-                "region": {
-                  "type": "string",
-                  "nullable": true,
-                  "description": "When country is not in US, AU, CA, UM or RO, you can provide the region"
-                },
                 "postcode": {
                   "type": "string",
                   "maxLength": 255,
                   "description": "Postal/ZIP code"
                 },
-                "address": {
-                  "type": "string",
-                  "maxLength": 255,
-                  "description": "Street address"
-                },
                 "contactPerson": {
                   "type": "string",
                   "maxLength": 255,
@@ -53145,12 +53126,117 @@
                     "type": "integer"
                   },
                   "description": "List of associated partner IDs"
+                },
+                "translatedName": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "locale": {
+                        "type": "string",
+                        "description": "valid locale configured for the tenant"
+                      },
+                      "translation": {
+                        "type": "string",
+                        "maxLength": 255
+                      }
+                    },
+                    "required": [
+                      "locale",
+                      "translation"
+                    ]
+                  },
+                  "minItems": 1,
+                  "description": "Display name of the sub-operator per locale. Whenever this field is submitted — on both create and update — the array must contain an `en` entry. Only locales configured for the tenant are accepted. Submitting this field replaces the whole locale set for the name: locales absent from the array are cleared. Omit the field to leave every existing locale untouched. An empty array is rejected on both create and update — the name cannot be cleared. Cannot be provided together with the deprecated `name`."
+                },
+                "translatedAddress": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "locale": {
+                        "type": "string",
+                        "description": "valid locale configured for the tenant"
+                      },
+                      "translation": {
+                        "type": "string",
+                        "maxLength": 255
+                      }
+                    },
+                    "required": [
+                      "locale",
+                      "translation"
+                    ]
+                  },
+                  "description": "Street address of the sub-operator per locale. Only locales configured for the tenant are accepted. Submitting this field replaces the whole locale set for the address: locales absent from the array are cleared. Omit the field to leave every existing locale untouched; submit an empty array to clear them all. Cannot be provided together with the deprecated `address`."
+                },
+                "translatedCity": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "locale": {
+                        "type": "string",
+                        "description": "valid locale configured for the tenant"
+                      },
+                      "translation": {
+                        "type": "string",
+                        "maxLength": 255
+                      }
+                    },
+                    "required": [
+                      "locale",
+                      "translation"
+                    ]
+                  },
+                  "description": "City of the sub-operator per locale. Only locales configured for the tenant are accepted. Submitting this field replaces the whole locale set for the city: locales absent from the array are cleared. Omit the field to leave every existing locale untouched; submit an empty array to clear them all. Cannot be provided together with the deprecated `city`."
+                },
+                "translatedRegion": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "locale": {
+                        "type": "string",
+                        "description": "valid locale configured for the tenant"
+                      },
+                      "translation": {
+                        "type": "string",
+                        "maxLength": 255
+                      }
+                    },
+                    "required": [
+                      "locale",
+                      "translation"
+                    ]
+                  },
+                  "description": "Region of the sub-operator per locale. Only locales configured for the tenant are accepted. Submitting this field replaces the whole locale set for the region: locales absent from the array are cleared. Omit the field to leave every existing locale untouched; submit an empty array to clear them all. Rejected when the sub-operator's country supports states (US, CA, AU, UM, RO) — `state` applies instead and is not translatable. Cannot be provided together with the deprecated `region`."
+                },
+                "name": {
+                  "type": "string",
+                  "maxLength": 255,
+                  "description": "**This property is deprecated. Use `translatedName` instead.** The value is written to the English (`en`) locale only. Cannot be provided together with `translatedName`. Display name of the sub-operator."
+                },
+                "city": {
+                  "type": "string",
+                  "maxLength": 255,
+                  "description": "**This property is deprecated. Use `translatedCity` instead.** The value is written to the English (`en`) locale only. Cannot be provided together with `translatedCity`. City name"
+                },
+                "region": {
+                  "type": "string",
+                  "nullable": true,
+                  "description": "When country is not in US, AU, CA, UM or RO, you can provide the region"
+                },
+                "address": {
+                  "type": "string",
+                  "maxLength": 255,
+                  "description": "**This property is deprecated. Use `translatedAddress` instead.** The value is written to the English (`en`) locale only. Cannot be provided together with `translatedAddress`. Street address"
                 }
               },
               "required": [
-                "name",
                 "businessName"
-              ]
+              ],
+              "description": "At least one of `name` or `translatedName` must be provided. Supplying both is rejected with a `422` response. When `translatedName` is used it must carry an `en` entry. A deprecated field and its `translated` sibling are mutually exclusive: `name`/`translatedName`, `address`/`translatedAddress`, `city`/`translatedCity` and `region`/`translatedRegion` may each be sent one at a time, never both."
             }
           }
         }
@@ -53258,10 +53344,95 @@
             "schema": {
               "type": "object",
               "properties": {
+                "translatedName": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "locale": {
+                        "type": "string",
+                        "description": "valid locale configured for the tenant"
+                      },
+                      "translation": {
+                        "type": "string",
+                        "maxLength": 255
+                      }
+                    },
+                    "required": [
+                      "locale",
+                      "translation"
+                    ]
+                  },
+                  "minItems": 1,
+                  "description": "Display name of the sub-operator per locale. Whenever this field is submitted — on both create and update — the array must contain an `en` entry. Only locales configured for the tenant are accepted. Submitting this field replaces the whole locale set for the name: locales absent from the array are cleared. Omit the field to leave every existing locale untouched. An empty array is rejected on both create and update — the name cannot be cleared. Cannot be provided together with the deprecated `name`."
+                },
+                "translatedAddress": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "locale": {
+                        "type": "string",
+                        "description": "valid locale configured for the tenant"
+                      },
+                      "translation": {
+                        "type": "string",
+                        "maxLength": 255
+                      }
+                    },
+                    "required": [
+                      "locale",
+                      "translation"
+                    ]
+                  },
+                  "description": "Street address of the sub-operator per locale. Only locales configured for the tenant are accepted. Submitting this field replaces the whole locale set for the address: locales absent from the array are cleared. Omit the field to leave every existing locale untouched; submit an empty array to clear them all. Cannot be provided together with the deprecated `address`."
+                },
+                "translatedCity": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "locale": {
+                        "type": "string",
+                        "description": "valid locale configured for the tenant"
+                      },
+                      "translation": {
+                        "type": "string",
+                        "maxLength": 255
+                      }
+                    },
+                    "required": [
+                      "locale",
+                      "translation"
+                    ]
+                  },
+                  "description": "City of the sub-operator per locale. Only locales configured for the tenant are accepted. Submitting this field replaces the whole locale set for the city: locales absent from the array are cleared. Omit the field to leave every existing locale untouched; submit an empty array to clear them all. Cannot be provided together with the deprecated `city`."
+                },
+                "translatedRegion": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "locale": {
+                        "type": "string",
+                        "description": "valid locale configured for the tenant"
+                      },
+                      "translation": {
+                        "type": "string",
+                        "maxLength": 255
+                      }
+                    },
+                    "required": [
+                      "locale",
+                      "translation"
+                    ]
+                  },
+                  "description": "Region of the sub-operator per locale. Only locales configured for the tenant are accepted. Submitting this field replaces the whole locale set for the region: locales absent from the array are cleared. Omit the field to leave every existing locale untouched; submit an empty array to clear them all. Rejected when the sub-operator's country supports states (US, CA, AU, UM, RO) — `state` applies instead and is not translatable. Cannot be provided together with the deprecated `region`."
+                },
                 "name": {
                   "type": "string",
                   "maxLength": 255,
-                  "description": "Display name of the sub-operator. Must be unique within the operator scope."
+                  "description": "**This property is deprecated. Use `translatedName` instead.** The value is written to the English (`en`) locale only. Cannot be provided together with `translatedName`. Display name of the sub-operator."
                 },
                 "businessName": {
                   "type": "string",
@@ -53548,7 +53719,7 @@
                   "type": "string",
                   "maxLength": 255,
                   "nullable": true,
-                  "description": "City name. Send null to clear."
+                  "description": "**This property is deprecated. Use `translatedCity` instead.** The value is written to the English (`en`) locale only. Cannot be provided together with `translatedCity`. City name. Send null to clear the English (`en`) value only — every other locale is left untouched. Use `translatedCity` to clear other locales."
                 },
                 "state": {
                   "anyOf": [
@@ -53738,7 +53909,7 @@
                   "type": "string",
                   "maxLength": 255,
                   "nullable": true,
-                  "description": "Street address. Send null to clear."
+                  "description": "**This property is deprecated. Use `translatedAddress` instead.** The value is written to the English (`en`) locale only. Cannot be provided together with `translatedAddress`. Street address. Send null to clear the English (`en`) value only — every other locale is left untouched. Use `translatedAddress` to clear other locales."
                 },
                 "contactPerson": {
                   "type": "string",
@@ -53802,7 +53973,8 @@
                   },
                   "description": "List of partner IDs to associate. Replaces existing associations."
                 }
-              }
+              },
+              "description": "A deprecated field and its `translated` sibling are mutually exclusive: `name`/`translatedName`, `address`/`translatedAddress`, `city`/`translatedCity` and `region`/`translatedRegion` may each be sent one at a time, never both. Supplying both is rejected with a `422` response."
             }
           }
         }
@@ -62823,6 +62995,45 @@
                 "paymentMethod": {
                   "type": "object",
                   "properties": {
+                    "cardType": {
+                      "type": "string",
+                      "enum": [
+                        "credit",
+                        "debit",
+                        "prepaid"
+                      ],
+                      "description": "Card category. Allowed values: - `credit` - Credit card. - `debit` - Debit card. - `prepaid` - Prepaid card."
+                    },
+                    "bin": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 255,
+                      "description": "Bank identification number recorded for this transaction (first 6-8 digits). A value consisting only of whitespace or invisible characters is rejected."
+                    },
+                    "fingerprint": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 255,
+                      "description": "Unique card fingerprint recorded for this transaction for cross-channel and cross-PSP card identification. Carries the Payment Account Reference (PAR) where the PSP provides it. A value consisting only of whitespace or invisible characters is rejected."
+                    },
+                    "acquirerName": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 255,
+                      "description": "Name of the acquiring bank recorded for this transaction. A value consisting only of whitespace or invisible characters is rejected."
+                    },
+                    "issuerName": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 255,
+                      "description": "Name of the card issuing bank recorded for this transaction. A value consisting only of whitespace or invisible characters is rejected."
+                    },
+                    "issuerCode": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 255,
+                      "description": "Code of the card issuing bank recorded for this transaction. A value consisting only of whitespace or invisible characters is rejected."
+                    },
                     "methodType": {
                       "type": "string",
                       "enum": [
@@ -63422,6 +63633,51 @@
                 "paymentMethod": {
                   "type": "object",
                   "properties": {
+                    "cardType": {
+                      "type": "string",
+                      "enum": [
+                        "credit",
+                        "debit",
+                        "prepaid"
+                      ],
+                      "nullable": true,
+                      "description": "Card category. Allowed values: - `credit` - Credit card. - `debit` - Debit card. - `prepaid` - Prepaid card."
+                    },
+                    "bin": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 255,
+                      "nullable": true,
+                      "description": "Bank identification number recorded for this transaction (first 6-8 digits). Send a value to replace the stored one, omit the property to keep it, or send `null` to clear it. A value consisting only of whitespace or invisible characters is rejected - use `null` to clear."
+                    },
+                    "fingerprint": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 255,
+                      "nullable": true,
+                      "description": "Unique card fingerprint recorded for this transaction for cross-channel and cross-PSP card identification. Carries the Payment Account Reference (PAR) where the PSP provides it. Send a value to replace the stored one, omit the property to keep it, or send `null` to clear it. A value consisting only of whitespace or invisible characters is rejected - use `null` to clear."
+                    },
+                    "acquirerName": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 255,
+                      "nullable": true,
+                      "description": "Name of the acquiring bank recorded for this transaction. Send a value to replace the stored one, omit the property to keep it, or send `null` to clear it. A value consisting only of whitespace or invisible characters is rejected - use `null` to clear."
+                    },
+                    "issuerName": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 255,
+                      "nullable": true,
+                      "description": "Name of the card issuing bank recorded for this transaction. Send a value to replace the stored one, omit the property to keep it, or send `null` to clear it. A value consisting only of whitespace or invisible characters is rejected - use `null` to clear."
+                    },
+                    "issuerCode": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 255,
+                      "nullable": true,
+                      "description": "Code of the card issuing bank recorded for this transaction. Send a value to replace the stored one, omit the property to keep it, or send `null` to clear it. A value consisting only of whitespace or invisible characters is rejected - use `null` to clear."
+                    },
                     "methodType": {
                       "type": "string",
                       "enum": [
@@ -63488,7 +63744,8 @@
                     "expYear": {
                       "type": "string"
                     }
-                  }
+                  },
+                  "description": "Card and payment method details recorded for this transaction. Omitting the whole `paymentMethod` object leaves every stored card value unchanged. When the object is present, each of its properties is applied independently: a property that is present is written, and a property that is absent from the object keeps its stored value."
                 },
                 "status": {
                   "type": "string",
@@ -67360,7 +67617,7 @@
       "method": "POST",
       "operationId": "paymentMethodCreate",
       "summary": "Payment Method / Create",
-      "description": "Initiate a new payment method registration, or finalize it. Note that this is a two step process! # For payment processors with web view integration You will need to initiate a call with no parameters to this endpoint to get a new request to add payment method (Step 1). Then you will have to redirect to an endpoint and wait for the client to enter his credit card details there. Once he/she is done (and reaches the successURL) you must then issue another call to this endpoint with the transactionID that was returned from the first call to finalize the process and retrieve the newly added payment method data (Step 2). ## Step 1 POST with request body, containing `tokenizedType` to determine the type of the method and `bankTransferType` if applicable. This will create a new request to the payment processor for adding a new payment method. As response you will get the `transactionId` to track the payment method registration process, the `redirectUrl` and `successUrl`, to redirect your user to, along with any other attributes that the payment processor requires for tracking. Just pass those additional parameters to Step 2. ### Example request for tokenizedType = card Request: ```json { \"tokenizedType\": \"card\" } ``` ### Example request for tokenizedType = bank_transfer Request: ```json { \"tokenizedType\": \"bank_transfer\", \"bankTransferType\": \"sepa\" } ``` Response: ```json { \"transactionId\": 1234, \"successUrl\": \"http://example.com/payment-processor/success\", \"redirectUrl\": \"http://example.com/payment-processor/web-form/123abc\", \"additionalProcessorArguments\": \"just pass them all top the step 2\" } ``` ## Step 2 POST with request body, containing the `transactionId` along with any other attributes, that were in the response of Step 1 (other then the `transactionId`, `successUrl` and `redirectUrl`). This will finalize the payment method registration and will retrieve the newly added payment method for you. Note that you can also receive the payment methods using the payment methods listing endpoints. ### Example Request: ```json { \"transactionId\": 1234, \"successUrl\": \"http://example.com/payment-processor/success\", \"redirectUrl\": \"http://example.com/payment-processor/web-form/123abc\", \"additionalProcessorArguments\": \"just pass them all top the step 2\" } ``` Response for card: ```json { \"data\": { \"id\": 1234, \"name\": \"**** 1111\", \"type\": \"tokenized\", \"tokenizedType\": \"card\", \"issuer\": \"visa\", \"cardNetwork\": \"visa\", \"cardType\": \"credit\", \"bin\": \"411111\", \"fingerprint\": \"CjhjhUJ7EaIGzKuYpHGTLLsG6pNs5\", \"acquirerName\": \"Worldline\", \"expireYear\": 2026, \"expireMonth\": 5, \"default\": true, } } ``` Response for bank transfer: ```json { \"data\": { \"id\": 1234, \"name\": \"**** 1111\", \"type\": \"tokenized\", \"tokenizedType\": \"bank_transfer\", \"bankTransferType\": \"sepa\", \"issuer\": null, \"expireYear\": null, \"expireMonth\": null, \"default\": true, } } ``` # For payment processors with in-app integration Braintree and Stripe integrations DO NOT count out `redirectUrl` as these processors should have an ip-app integration and therefore the app itself should use the appropriate SDK to complete the credit-card tokenization process with the processor. ## Braintree The first step is not required for braintree as the full integration is done in-app. Step 2 needs to pass the `paymentMethodNonce` so that it can be exchanged for the payment method token. ### Example Step 2 Request: ```json {\"paymentMethodNonce\": \"abc123\"} ``` Response for card: ```json { \"data\": { \"id\": 1234, \"name\": \"**** 1111\", \"type\": \"tokenized\", \"tokenizedType\": \"card\", \"issuer\": \"visa\", \"cardNetwork\": \"visa\", \"cardType\": \"credit\", \"bin\": \"411111\", \"fingerprint\": \"CjhjhUJ7EaIGzKuYpHGTLLsG6pNs5\", \"acquirerName\": \"Worldline\", \"expireYear\": 2026, \"expireMonth\": 5, \"default\": true, } } ``` Response for bank transfer: ```json { \"data\": { \"id\": 1234, \"name\": \"**** 1111\", \"type\": \"tokenized\", \"tokenizedType\": \"bank_transfer\", \"bankTransferType\": \"sepa\", \"issuer\": null, \"expireYear\": null, \"expireMonth\": null, \"default\": true, } } ``` ## Stripe Step 1 with stripe will initialize a setup intent, that your app should complete. You will get the details you need in order to do that from the response of that call. Call step 2 once you have completed the setup intent. ### Example Step 1 - when tokenizing card ```json { \"tokenizedType\": \"card\" } ``` ### Example Step 1 - when tokenizing bank transfer Request: ```json { \"tokenizedType\": \"bank_transfer\", \"bankTransferType\": \"sepa\" } ``` Response: ```json { \"publishableKey\": \"345678986543\", \"clientSecret\": \"jyt37hgsv63\", \"setupIntentReference\": \"1234ABC\" } ``` ### Example Step 2 Request: ```json { \"publishableKey\": \"345678986543\", \"clientSecret\": \"jyt37hgsv63\", \"setupIntentReference\": \"1234ABC\" } ``` Response for card: ```json { \"data\": { \"id\": 1234, \"name\": \"**** 1111\", \"type\": \"tokenized\", \"tokenizedType\": \"card\", \"issuer\": \"visa\", \"cardNetwork\": \"visa\", \"cardType\": \"credit\", \"bin\": \"411111\", \"fingerprint\": \"CjhjhUJ7EaIGzKuYpHGTLLsG6pNs5\", \"acquirerName\": \"Worldline\", \"expireYear\": 2026, \"expireMonth\": 5, \"default\": true, } } ``` Response for bank transfer: ```json { \"data\": { \"id\": 1234, \"name\": \"**** 1111\", \"type\": \"tokenized\", \"tokenizedType\": \"bank_transfer\", \"bankTransferType\": \"sepa\", \"issuer\": null, \"expireYear\": null, \"expireMonth\": null, \"default\": true, } } ```",
+      "description": "Initiate a new payment method registration, or finalize it. Note that this is a two step process! # For payment processors with web view integration You will need to initiate a call with no parameters to this endpoint to get a new request to add payment method (Step 1). Then you will have to redirect to an endpoint and wait for the client to enter his credit card details there. Once he/she is done (and reaches the successURL) you must then issue another call to this endpoint with the transactionID that was returned from the first call to finalize the process and retrieve the newly added payment method data (Step 2). ## Step 1 POST with request body, containing `tokenizedType` to determine the type of the method and `bankTransferType` if applicable. This will create a new request to the payment processor for adding a new payment method. As response you will get the `transactionId` to track the payment method registration process, the `redirectUrl` and `successUrl`, to redirect your user to, along with any other attributes that the payment processor requires for tracking. Just pass those additional parameters to Step 2. ### Example request for tokenizedType = card Request: ```json { \"tokenizedType\": \"card\" } ``` ### Example request for tokenizedType = bank_transfer Request: ```json { \"tokenizedType\": \"bank_transfer\", \"bankTransferType\": \"sepa\" } ``` Response: ```json { \"transactionId\": 1234, \"successUrl\": \"http://example.com/payment-processor/success\", \"redirectUrl\": \"http://example.com/payment-processor/web-form/123abc\", \"additionalProcessorArguments\": \"just pass them all top the step 2\" } ``` ## Step 2 POST with request body, containing the `transactionId` along with any other attributes, that were in the response of Step 1 (other then the `transactionId`, `successUrl` and `redirectUrl`). This will finalize the payment method registration and will retrieve the newly added payment method for you. Note that you can also receive the payment methods using the payment methods listing endpoints. The finalized payment method is returned in a `data` wrapper. Depending on the payment processor, the status is `200` or `201`; the body is the same in both cases. The optional `token` and `registrationTransactionId` properties are omitted when they are not set rather than returned as `null`; the card example includes both properties, while the bank transfer example omits `registrationTransactionId`. ### Example Request: ```json { \"transactionId\": 1234, \"successUrl\": \"http://example.com/payment-processor/success\", \"redirectUrl\": \"http://example.com/payment-processor/web-form/123abc\", \"additionalProcessorArguments\": \"just pass them all top the step 2\" } ``` Response: see the `Step 2 - card payment method` and `Step 2 - bank transfer payment method` response examples. # For payment processors with in-app integration Braintree and Stripe integrations DO NOT count out `redirectUrl` as these processors should have an ip-app integration and therefore the app itself should use the appropriate SDK to complete the credit-card tokenization process with the processor. ## Braintree The first step is not required for braintree as the full integration is done in-app. Step 2 needs to pass the `paymentMethodNonce` so that it can be exchanged for the payment method token. ### Example Step 2 Request: ```json {\"paymentMethodNonce\": \"abc123\"} ``` Response: see the `Step 2 - card payment method` and `Step 2 - bank transfer payment method` response examples. ## Stripe Step 1 with stripe will initialize a setup intent, that your app should complete. You will get the details you need in order to do that from the response of that call. Call step 2 once you have completed the setup intent. ### Example Step 1 - when tokenizing card ```json { \"tokenizedType\": \"card\" } ``` ### Example Step 1 - when tokenizing bank transfer Request: ```json { \"tokenizedType\": \"bank_transfer\", \"bankTransferType\": \"sepa\" } ``` Response: ```json { \"publishableKey\": \"345678986543\", \"clientSecret\": \"jyt37hgsv63\", \"setupIntentReference\": \"1234ABC\" } ``` ### Example Step 2 Request: ```json { \"publishableKey\": \"345678986543\", \"clientSecret\": \"jyt37hgsv63\", \"setupIntentReference\": \"1234ABC\" } ``` Response: see the `Step 2 - card payment method` and `Step 2 - bank transfer payment method` response examples.",
       "tags": [
         "resource / users"
       ],
@@ -67444,10 +67701,10 @@
       },
       "responses": {
         "200": {
-          "description": "Request succeeded"
+          "description": "Request succeeded. Step 1 returns one of the shapes below. Depending on the payment processor, step 2 may also return `200` with the finalized payment method body documented under the `201` response."
         },
         "201": {
-          "description": "Request succeeded"
+          "description": "The registration created a new payment method. The finalized payment method is returned in a `data` wrapper."
         },
         "401": {
           "description": "Access token is missing or invalid"
@@ -67455,8 +67712,14 @@
         "403": {
           "description": "You do not have permission to perform the action"
         },
+        "404": {
+          "description": "The record is not found"
+        },
         "422": {
           "description": "The payload you provided is invalid or problem with processing the request has occurred"
+        },
+        "429": {
+          "description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
         }
       }
     },
@@ -71665,7 +71928,7 @@
   ],
   "info": {
     "title": "Public API",
-    "version": "3.245.3",
+    "version": "3.247.0",
     "description": "The Public API provides server-to-server integration capabilities for your EV charging platform.\n\n**Authentication.** Existing integrations continue to work unchanged — long-lived UUID admin tokens are sent in `Authorization: Bearer ...` with no exchange required. Two security schemes are documented for OpenAPI client tooling, both resulting in the same Bearer header at the wire level:\n   - `bearerAuth` — the token in the `Authorization: Bearer ...` header is either a long-lived UUID admin token (issued via the admin UI, used directly) or a short-lived access token previously obtained via OAuth.\n   - `oauth2ClientCredentials` - a `client_id` / `client_secret` pair should be exchanged for a short-lived access token at `/public-api/oauth/token` per RFC 6749 Section 4.4 (Client Credentials Grant), and the short-lived token should be used in the `Authorization: Bearer ...` header. The OAuth `client_secret` itself cannot be sent directly as a bearer token — it must be exchanged first.\n"
   },
   "servers": [
@@ -71679,18 +71942,18 @@
       }
     }
   ],
-  "buildTimestamp": "2026-09-09T11:19:50.047Z",
+  "buildTimestamp": "2026-09-10T10:39:01.246Z",
   "stats": {
     "totalEndpoints": 640,
-    "originalSize": 5796134,
-    "optimizedSize": 1619628,
-    "reductionPercent": 72.06,
-    "buildDuration": 1555,
+    "originalSize": 5828593,
+    "optimizedSize": 1631472,
+    "reductionPercent": 72.01,
+    "buildDuration": 1591,
     "responseSchemas": {
       "total": 640,
       "withSchemas": 640,
-      "totalSchemaSize": 3303477,
-      "averageSchemaSize": 5162
+      "totalSchemaSize": 3317461,
+      "averageSchemaSize": 5184
     }
   }
 }