Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
e) Organisation Management

Initiate adding a card on file for the organisation

Three scenarios are supported: (1) provide a cardId and alias to add an Eclipse-issued card as a Card on File; (2) provide neither cardId nor card data to receive an iFrame completion URL for the organisation to enter card details; (3) PCI-DSS compliant tenants may send card data directly to create the Card on File immediately.

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

Path parameters

tenantIdinteger required
organisationIdinteger required

Request body

aliasstring

Alias (some friendly name e.g. HSBC Gold Card) chosen by the customer for the card they are about to add. Required if cardId or cardData is provided directly as the customer wont be asked for a card alias in those cases.

authenticatedboolean

Optional. If provided and set to true, Eclipse will try to do a zero-based authenticated payment, expect to receive a completionUrl to complete 3DS flow.

callbackUrlstring

The URL Eclipse must post the EclipseCardOnFile to when the card is registered successfully

cardIdinteger

Used to add an existing Eclipse issued card as a card on file

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)

externalUniqueIdstring
landingUrlstring

Where the customers iFrame/Browser should be navigated to after adding the card on file. If the URL contains <cardOnFileId> then it will be replaced with the cardOnFileId before the redirect.

referencestring
templateIdstring

Optional. If provided then card ui will be rendered based on the provided templateId else fallback to default tenant template.

Example request

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

Response

OK

cardOnFileIdstring

The unique identifier for this card on file.

completionUrlstring

URL to open in an iFrame or browser where customer can securely capture then card details for saving in an encrypted format within Eclipse. This will be set if the customer needs to capture the card details. If the request to add a card on file was for a cardId, then Eclipse knows the details and a completionUrl will not be returned

schemeTokenstring

The scheme token reference if available

schemeTokenExpirystring date-time

The scheme token reference expiry if available

schemeTokenStatusstring

The scheme token reference status

schemeTokenTypestring

The scheme token type if available

Example response

{
  "schemeTokenExpiry": "2022-03-10T12:15:50-04:00"
}