v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB

i) Card Management

Set or deliver a new card PIN

PCI-compliant tenants may supply a PIN directly; it will be set and SMSed to the customer. Non-PCI-compliant tenants will have a random PIN generated and delivered. Use type LINK to return a URL the cardholder can open to self-serve their PIN using their CAP.

post/eclipse-conductor/rest/v1/tenants/{tenantId}/cards/{cardId}/pin-sets

Path parameters

tenantIdinteger required

cardIdinteger required

Request body

landingUrlstring

Where the customers iFrame/Browser should be navigated to after the pin set has completed

pinstring

The PIN to set on the card (for PCI compliant tenants). Dont pass this parameter to generate random PIN or if using LINK as the pin-set mechanism

pinDeliveryMechanism'EMAIL' | 'LINK' | 'SMS'

Supported ways of delivering a PIN to a customer. SMS:Send an SMS, LINK: Get a link to send the customer to set their PIN using CAP

Response

completionUrlstring

URL for setting new PIN to Non pciCompliant tenant