Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
d) Customer Management

Get a customers cards on file by cardOnFileId

Returns a cards on file held by the customer. This has nothing to do with Eclipse issued cards. This is for any card the customer wants to store on file with Eclipse. The field data should be included as comma-delimited strings, specifically cryptogram. However, the behavior of the cryptogram and schemeTokenisedPan fields depends on whether the tenant is pciCompliant. If the tenant is pciCompliant, they will receive the actual cryptogram and schemeTokenisedPan. On the other hand, if the tenant is not pciCompliant, the cryptogram and schemeTokenisedPan field will not be included in the response.

get/eclipse-conductor/rest/v1/tenants/{tenantId}/customers/{customerId}/cards-on-file/{cardOnFileId}

Path parameters

tenantIdinteger required
customerIdinteger required
cardOnFileIdstring required

Query parameters

fieldsstring

Field data to be include. Support a comma-delimited strings. i.e cryptogram

Response

OK

aliasstring

Alias chosen by the customer for the card

binstring

The bin of the card

cardArtUrlstring

Optional. If provided then this url will provide access to the cardart content

cardOnFileIdstring

The unique identifier for this card on file

cryptogramstring

The cryptogram of card if available

defaultCardOnFileboolean

Optional. If provided then this card on file mark as default for this customer Only one default cardOnFile is allowed for customer.)

deleteAtstring date-time

Optional. If provided then the card will only remain on file up till this date after which it will be deleted permanently (hard delete)

expiresstring date-time

expiry date of the card on file

externalUniqueIdstring
last4Digitsstring

The last 4 digits of the card

referencestring
schemeTokenstring

The scheme token reference if available

schemeTokenExpirystring

The schemeTokenExpiry

schemeTokenStatusstring

The scheme token reference status

schemeTokenTypestring

The scheme token type if available

schemeTokenisedPanstring

The schemeTokenisedPan. only applicable if tenant is pciCompliant

status'ACTIVE' | 'SUSPENDED'
tokenAssuranceLevelstring
userIdinteger

Example response

{
  "deleteAt": "2022-03-10T12:15:50-04:00",
  "expires": "2022-03-10T12:15:50-04:00"
}