v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB

e) Organisation Management

Get an organisation's card on file by ID

Returns a specific card on file. Pass fields=cryptogram to include cryptogram and schemeTokenisedPan data; these fields are only returned for PCI-DSS compliant tenants.

get/eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/cards-on-file/{cardOnFileId}

Path parameters

tenantIdinteger required

organisationIdinteger required

cardOnFileIdstring required

Query parameters

fieldsstring

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

Response

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"
}