Initiate adding a card on file for the customer

post

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/customers/{customerId}/cards-on-file

There are 3 scenarios. First is where a cardId and alias are provided. In this case the card must be added as a CoF on the card holder and the Eclipse issued card will be added to Card on file and will return the cardOnFileId. The second scenario is where cardId is not provided and nor is any card data. A completion URL will be returned which can be opened in an iFrame for the customer to add card details. Once completed, the CardOnFile will be POSTED to the callbackUrl. The third scenario is where the tenant is PCI-DSS compliant and directly sends the card data. The CoF will be created and returned immediately with no completion URL necessary.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

customerId

int64

required

Body Params

alias

string

length between 1 and 50

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.

authenticated

boolean

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.

callbackUrl

string

length between 10 and 2000

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

cardData

object

The card data

cardId

int64

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

defaultCardOnFile

boolean

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

deleteAt

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)

externalUniqueId

string

landingUrl

string

length between 10 and 2000

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.

reference

string

templateId

string

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

Responses

400

Bad Request

200OK

500Internal Server error