---
updatedAt: 2026-05-29T13:25:42.000Z
agentTools:
  projectIndex: https://developer.eftcorp.com/llms.txt
---

# Update a customers cards on file

Update a customers card on file

# OpenAPI definition

```json
{
  "servers": [
    {
      "url": "https://eclipse-java-sandbox.ukheshe.rocks",
      "description": "Eclipse sandbox environment"
    },
    {
      "url": "https://ukheshe.live",
      "description": "Eclipse production environment"
    },
    {
      "url": "https://eclipse-java-develop.ukheshe.rocks",
      "description": "Eclipse development environment"
    },
    {
      "url": "https://zw.ukheshe.live",
      "description": "Zim Eclipse production environment"
    }
  ],
  "openapi": "3.1.0",
  "components": {
    "schemas": {
      "CardOnFileStatus": {
        "type": "string",
        "enum": [
          "ACTIVE",
          "SUSPENDED"
        ]
      },
      "EclipseCardOnFile": {
        "description": "A card on file",
        "type": "object",
        "properties": {
          "alias": {
            "type": "string",
            "description": "Alias chosen by the customer for the card"
          },
          "bin": {
            "type": "string",
            "description": "The bin of the card"
          },
          "cardArtUrl": {
            "type": "string",
            "description": "Optional. If provided then this url will provide access to the cardart content"
          },
          "cardOnFileId": {
            "type": "string",
            "description": "The unique identifier for this card on file"
          },
          "cryptogram": {
            "type": "string",
            "description": "The cryptogram of card if available"
          },
          "defaultCardOnFile": {
            "type": "boolean",
            "description": "Optional. If provided then this card on file mark as default for this customer Only one default cardOnFile is allowed for customer.)"
          },
          "deleteAt": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2022-03-10T12:15:50-04:00"
            ],
            "description": "Optional. If provided then the card will only remain on file up till this date after which it will be deleted permanently (hard delete)"
          },
          "expires": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2022-03-10T12:15:50-04:00"
            ],
            "description": "expiry date of the card on file"
          },
          "externalUniqueId": {
            "type": "string"
          },
          "last4Digits": {
            "type": "string",
            "description": "The last 4 digits of the card"
          },
          "reference": {
            "type": "string"
          },
          "schemeToken": {
            "type": "string",
            "description": "The scheme token reference if available"
          },
          "schemeTokenExpiry": {
            "type": "string",
            "description": "The schemeTokenExpiry"
          },
          "schemeTokenStatus": {
            "type": "string",
            "description": "The scheme token reference status"
          },
          "schemeTokenType": {
            "type": "string",
            "description": "The scheme token type if available"
          },
          "schemeTokenisedPan": {
            "type": "string",
            "description": "The schemeTokenisedPan. only applicable if tenant is pciCompliant"
          },
          "status": {
            "$ref": "#/components/schemas/CardOnFileStatus",
            "description": "The status of this card on file",
            "type": "string"
          },
          "tokenAssuranceLevel": {
            "type": "string"
          },
          "userId": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "UpdatedEclipseCardOnFile": {
        "description": "A card on file",
        "type": "object",
        "required": [
          "alias"
        ],
        "properties": {
          "alias": {
            "type": "string",
            "description": "Alias chosen by the customer for the card",
            "pattern": "\\S",
            "minLength": 1,
            "maxLength": 50
          },
          "cardOnFileId": {
            "type": "string",
            "description": "The unique identifier for this card on file"
          },
          "defaultCardOnFile": {
            "type": "boolean",
            "description": "Optional. If provided then this card on file mark as default for this customer Only one default cardOnFile is allowed for customer.)"
          },
          "deleteAt": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2022-03-10T12:15:50-04:00"
            ],
            "description": "Optional. If provided then the card will only remain on file up till this date after which it will be deleted permanently (hard delete)"
          },
          "status": {
            "$ref": "#/components/schemas/CardOnFileStatus",
            "description": "The status to set of this card on file. ACTIVE can change to SUSPENDED and SUSPENDED back to ACTIVE. SUSPENDED status diallows the card on file from being used",
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "JWTBearerAuthorisation": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "info": {
    "description": "A RESTful API using JSON as the data transfer model, covering all tenant-facing functionality in the Eclipse payments platform.",
    "title": "Eclipse ReST API",
    "version": "3.0.0"
  },
  "tags": [
    {
      "name": "d) Customer Management",
      "description": "Operations on an individual customer profile including identity management, addresses, documents, wallets, cards, beneficiaries, and KYC ratification."
    }
  ],
  "paths": {
    "/eclipse-conductor/rest/v1/tenants/{tenantId}/customers/{customerId}/cards-on-file/{cardOnFileId}": {
      "put": {
        "summary": "Update a customers cards on file",
        "description": "Update a customers card on file",
        "tags": [
          "d) Customer Management"
        ],
        "parameters": [
          {
            "name": "tenantId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "customerId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "cardOnFileId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdatedEclipseCardOnFile"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EclipseCardOnFile"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          }
        },
        "security": [
          {
            "JWTBearerAuthorisation": []
          }
        ]
      }
    }
  }
}
```