openapi: 3.0.1 info: title: Internal Referential WS Admin description: Rest Referential Admin Config Operations version: "25R1.0" paths: /admin/card: post: tags: - card description: Add new card in db operationId: addCard parameters: - name: Api-Key in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CardRequest' responses: default: description: default response content: application/json: { } /admin/card/detokenizePan: post: tags: - card description: "Returns the encrypted PAN if keyTag is present in the request,\ \ otherwise returns the plain PAN" operationId: detokenizePan parameters: - name: Api-Key in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DetokenizePanRequest' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/DetokenizePanResponse' /admin/card/tokenPan: post: tags: - card description: Get token pan operationId: getTokenPans parameters: - name: Api-Key in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TokenPanRequest' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/TokenPanResponse' /admin/cardData: put: tags: - cardData summary: DEPRECATED description: "DEPRECATED, use addOrUpdateCardData(CreateCredentialsRequest)\ \ instead. Add or Update Card Data." operationId: addOrUpdateCardData_1 parameters: - name: Api-Key in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CardDataUpdate' responses: default: description: default response content: application/json: { } deprecated: true delete: tags: - cardData description: Delete Card operationId: deleteCardData parameters: - name: Api-Key in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CardDataDelete' responses: default: description: default response content: application/json: { } /admin/cardData/new: put: tags: - cardData description: Add or Update Card Data operationId: addOrUpdateCardData parameters: - name: Api-Key in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCredentialsRequest' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/CreateCredentialsResponse' /admin/cards/details: post: tags: - card summary: DEPRECATED. Get details of a card. description: "DEPRECATED - use getCardDetailsNew(CardDetailRequest) instead.\ \ Get information about a card, tokenPan, credentials,..." operationId: getCardDetails parameters: - name: Api-Key in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CardDetailRequest' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/CardDetailResponse' deprecated: true /admin/cards/details/new: post: tags: - card summary: Get details of a card description: "Get information about a card,tokenPan,credentials,.." operationId: getCardDetailsNew parameters: - name: Api-Key in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CardDetailRequest' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/CardDetailResponse' /admin/cards/search: post: tags: - card description: Search Card operationId: searchCards parameters: - name: Api-Key in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchCardRequest' responses: default: description: default response content: application/json: schema: type: array items: $ref: '#/components/schemas/SearchCardResponse' /admin/cards/{rid}/details: get: tags: - card summary: DEPRECATED. Get details of a card. description: "DEPRECATED - use getCardDetailsNew(CardDetailRequest) instead.\ \ Get informations about a card, tokenPan, credentials,.." operationId: getCardDetails_1 parameters: - name: Api-Key in: header required: true schema: type: string - name: rid in: path description: Card RID required: true schema: type: string - name: service in: query description: Service required: true schema: type: string - name: customerCode in: query description: Customer code schema: type: string - name: providePan in: query description: provided PAN schema: type: boolean - name: encryptPan in: query description: encrypted PAN schema: type: boolean - name: keyTag in: query description: key tag schema: type: string - name: bcf in: query description: Issuer Code schema: type: string - name: bdom in: query description: SubIssuer Code schema: type: string responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/CardDetailResponse' deprecated: true /admin/customer: post: tags: - customer description: Add new customer operationId: addCustomer parameters: - name: Api-Key in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerRequest' responses: default: description: default response content: application/json: { } /admin/getcard: post: tags: - card description: Get Card operationId: getCard parameters: - name: Api-Key in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CardDataGet' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/GetCardResponse' /admin/virtualCards: post: tags: - card summary: Get virtual cards of a card description: Get list of virtual cards for the card operationId: getVirtualCards parameters: - name: Api-Key in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CardDetailRequest' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/VirtualCardsResponse' components: schemas: CardBrand: type: object properties: code: type: string description: Brand code format: String example: "VI, MC, …" label: type: string description: Brand description format: String example: "Visa, MasterCard, …" description: CardBrand DTO resource representation format: list of CardBrand business objects CardCustomer: type: object properties: code: type: string description: Customer code format: String of 5 digits label: type: string description: Customer label format: String of 1 to 255 characters description: Parent customer format: An object representing parent customer of current card customer CardDataDelete: required: - issuerCode - service - subIssuerCode type: object properties: cardHolderId: maxLength: 36 minLength: 2 type: string description: Cardholder ID credentials: type: array description: credentials format: List of strings items: type: string description: credentials format: List of strings issuerCode: maxLength: 5 minLength: 5 type: string description: Issuer code format: The issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) principal: $ref: '#/components/schemas/RefPrincipal' psns: type: array description: list of psns format: List of strings items: type: string description: list of psns format: List of strings requestId: type: string description: Request ID format: String resetProfileSetName: type: boolean description: 'reset the card label ' format: "Boolean\n If true, the card label is reset" service: maxLength: 255 minLength: 1 type: string description: Calling service sessionId: type: string description: Session ID subIssuerCode: maxLength: 5 minLength: 5 type: string description: sub issuer code format: The sub issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) tokenPan: type: string description: token of PAN format: String of 15 to 50 characters transactionId: type: string description: CardDataDelete DTO resource representation CardDataGet: required: - issuerCode - service - subIssuerCode type: object properties: binShared: type: boolean description: boolean indicating if this is a BIN Shared transaction format: boolean cardHolderId: maxLength: 36 minLength: 2 type: string description: Cardholder ID issuerCode: maxLength: 5 minLength: 5 type: string description: Issuer code format: The issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) principal: $ref: '#/components/schemas/RefPrincipal' psns: type: array description: list of psns format: List of strings items: type: string description: list of psns format: List of strings requestId: type: string description: Request ID format: String service: maxLength: 255 minLength: 1 type: string description: Calling service sessionId: type: string description: Session ID subIssuerCode: maxLength: 5 minLength: 5 type: string description: sub issuer code format: The sub issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) tokenPan: type: string description: token of PAN format: String of 15 to 50 characters transactionId: type: string description: CardDataGet DTO resource representation CardDataUpdate: required: - issuerCode - service - subIssuerCode type: object properties: cardHolderId: maxLength: 36 minLength: 2 type: string description: Cardholder ID cardId: type: string description: card ID format: String of 1 to 64 characters credentials: type: object additionalProperties: type: array description: list of credentials. String on key/value json format format: "Key = String, Mean Code (METHOD:EMAIL, METHOD:PHONE, …).\nValue\ \ = List of data (List>). " example: "'[{\"email\":\"e1@em.fr\"},{\"email\":\"e2@em.fr\"}]','[{\"\ phoneNumber\":\"+33622113333\", \"ignoreForSms\":\"true\"}]'" items: type: object additionalProperties: type: string description: list of credentials. String on key/value json format format: "Key = String, Mean Code (METHOD:EMAIL, METHOD:PHONE, …).\n\ Value = List of data (List>). " example: "'[{\"email\":\"e1@em.fr\"},{\"email\":\"e2@em.fr\"}]','[{\"\ phoneNumber\":\"+33622113333\", \"ignoreForSms\":\"true\"}]'" description: list of credentials. String on key/value json format format: "Key = String, Mean Code (METHOD:EMAIL, METHOD:PHONE, …).\n\ Value = List of data (List>). " example: "'[{\"email\":\"e1@em.fr\"},{\"email\":\"e2@em.fr\"}]','[{\"\ phoneNumber\":\"+33622113333\", \"ignoreForSms\":\"true\"}]'" description: list of credentials. String on key/value json format format: "Key = String, Mean Code (METHOD:EMAIL, METHOD:PHONE, …).\nValue\ \ = List of data (List>). " example: "'[{\"email\":\"e1@em.fr\"},{\"email\":\"e2@em.fr\"}]','[{\"phoneNumber\"\ :\"+33622113333\", \"ignoreForSms\":\"true\"}]'" deletedTime: type: string description: deleted Time format: date-time issuerCode: maxLength: 5 minLength: 5 type: string description: Issuer code format: The issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) principal: $ref: '#/components/schemas/RefPrincipal' profileSetName: type: string description: name of profile set psns: type: array description: list of psns format: List of strings items: type: string description: list of psns format: List of strings requestId: type: string description: Request ID format: String service: maxLength: 255 minLength: 1 type: string description: Calling service sessionId: type: string description: Session ID status: type: string description: card status format: "String : 'ACTIVE' or 'INACTIVE' or 'DELETED'" subIssuerCode: maxLength: 5 minLength: 5 type: string description: sub issuer code format: The sub issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) tokenPan: type: string description: token of PAN format: String of 15 to 50 characters transactionId: type: string description: CardDataUpdate DTO resource representation CardDetailRequest: required: - issuerCode - service - subIssuerCode type: object properties: bcf: type: string writeOnly: true bdom: type: string writeOnly: true cardHolderId: maxLength: 36 minLength: 2 type: string description: Cardholder ID customerCode: type: string description: customer Code format: String of 5 characters encryptPan: type: boolean writeOnly: true issuerCode: maxLength: 5 minLength: 5 type: string description: Issuer code format: The issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) keyTag: type: string description: key indicator shared between client and server (if encryption is used) format: |- String of 2 characters '01' for the first tag to use providePan: type: boolean description: provide clear PAN requestId: type: string description: Request ID format: String rid: type: string description: Card RID service: maxLength: 255 minLength: 1 type: string description: Calling service sessionId: type: string description: Session ID subIssuerCode: maxLength: 5 minLength: 5 type: string description: sub issuer code format: The sub issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) transactionId: type: string description: CardDetailRequest DTO resource representation CardDetailResponse: type: object properties: card: $ref: '#/components/schemas/SearchCardResponse' credentialList: type: array description: list of credentials. String on type/value json format format: "Type = String, Mean Code (EMAIL, SMS, IVR, …).Value = Value of\ \ Mean). " example: "{ \"type\": \"SMS\", \"value\": \"+33606060606\" }, \ \ { \"type\": \"PWD\", \"value\": \"4b358ed84b7940619235a22328c584c7bc4508d4524e75231d6f450521d16a17\"\ , \"algorithm\": \"SHA-256\" }" items: $ref: '#/components/schemas/Credential' credentials: type: object additionalProperties: type: array description: List of credentials format: "Key = String, Mean Code (METHOD:EMAIL, METHOD:PHONE, …).\nValue\ \ = List of data (List>). " example: "'[{\"email\":\"e1@em.fr\"},{\"email\":\"e2@em.fr\"}]','[{\"\ phoneNumber\":\"+33622113333\", \"ignoreForSms\":\"true\"}]'" items: type: object additionalProperties: type: string description: List of credentials format: "Key = String, Mean Code (METHOD:EMAIL, METHOD:PHONE, …).\n\ Value = List of data (List>). " example: "'[{\"email\":\"e1@em.fr\"},{\"email\":\"e2@em.fr\"}]','[{\"\ phoneNumber\":\"+33622113333\", \"ignoreForSms\":\"true\"}]'" description: List of credentials format: "Key = String, Mean Code (METHOD:EMAIL, METHOD:PHONE, …).\n\ Value = List of data (List>). " example: "'[{\"email\":\"e1@em.fr\"},{\"email\":\"e2@em.fr\"}]','[{\"\ phoneNumber\":\"+33622113333\", \"ignoreForSms\":\"true\"}]'" description: List of credentials format: "Key = String, Mean Code (METHOD:EMAIL, METHOD:PHONE, …).\nValue\ \ = List of data (List>). " example: "'[{\"email\":\"e1@em.fr\"},{\"email\":\"e2@em.fr\"}]','[{\"phoneNumber\"\ :\"+33622113333\", \"ignoreForSms\":\"true\"}]'" user: $ref: '#/components/schemas/CardUser' virtualCards: type: integer format: int64 description: CardDetailResponse DTO resource representation CardRequest: required: - issuerCode - service - subIssuerCode type: object properties: binShared: type: boolean description: BIN shared cardHolderId: maxLength: 36 minLength: 2 type: string description: Cardholder ID cardId: type: string description: card ID format: "String of 36 characters, standard representation of a UUID ( {time_low}-{time_mid}-{time_high_and_version}-{variant_and_sequence}-{node}\ \ )" createdTime: type: string format: date-time deletedTime: type: string format: date-time firstName: type: string description: First name issuerCode: maxLength: 5 minLength: 5 type: string description: Issuer code format: The issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) language: type: string description: language of the customer format: String of 1 to 2 characters lastName: type: string description: Last name principal: $ref: '#/components/schemas/RefPrincipal' profileSetName: type: string description: profile set name of customer psns: type: array description: list of psns format: List of strings items: type: string description: list of psns format: List of strings requestId: type: string description: Request ID format: String rid: type: string description: request ID service: maxLength: 255 minLength: 1 type: string description: Calling service sessionId: type: string description: Session ID subIssuerCode: maxLength: 5 minLength: 5 type: string description: sub issuer code format: The sub issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) tokenPan: type: string description: token of PAN format: String of 15 to 50 characters transactionId: type: string description: CardRequest DTO resource representation CardUser: type: object properties: firstName: type: string description: Card holder fist name format: String of 4 to 64 characters id: type: string description: Card holder ID language: type: string description: Card holder language format: String of 2 characters lastName: type: string description: Card holder last name format: String of 4 to 64 characters description: CardUser DTO resource representation format: CardUser object CipherableTypedDataCipherablePrincipalType: type: object properties: keyTag: type: string type: type: string description: Ciphered principal enum: - CARD_HOLDER_ID - PAN - ENCRYPTED_PAN - TOKEN_PAN - CARD_ID value: type: string description: Ciphered data CreateCredentialsRequest: required: - issuerCode - service - subIssuerCode type: object properties: cardHolderId: maxLength: 36 minLength: 2 type: string description: Cardholder ID cardId: type: string description: card ID format: String of 1 to 64 characters credentialList: uniqueItems: true type: array description: list of credentials. String on type/value json format format: "Type = String, Mean Code (EMAIL, SMS, IVR, …).Value = Value of\ \ Mean). " example: "{ \"type\": \"SMS\", \"value\": \"+33606060606\" }, \ \ { \"type\": \"PWD\", \"value\": \"4b358ed84b7940619235a22328c584c7bc4508d4524e75231d6f450521d16a17\"\ , \"algorithm\": \"SHA-256\" }" items: $ref: '#/components/schemas/Credential' deletedTime: type: string description: deleted Time format: date-time issuerCode: maxLength: 5 minLength: 5 type: string description: Issuer code format: The issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) keyTag: type: string description: Dedicated keyTag must be defined for each sensitive data encrypted format: String of 2 characters “01” for the first tag to use modifier: type: string description: "An optional field , who made changes" principal: $ref: '#/components/schemas/RefPrincipal' profileSetName: type: string description: name of profile set psns: type: array description: list of psns format: List of strings items: type: string description: list of psns format: List of strings requestId: type: string description: Request ID format: String service: maxLength: 255 minLength: 1 type: string description: Calling service sessionId: type: string description: Session ID status: type: string description: card status format: "String : 'ACTIVE' or 'INACTIVE' or 'DELETED'" subIssuerCode: maxLength: 5 minLength: 5 type: string description: sub issuer code format: The sub issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) tokenPan: type: string description: token of PAN format: String of 15 to 50 characters transactionId: type: string description: CreateCredentialsRequest DTO resource representation CreateCredentialsResponse: type: object properties: cardId: type: string description: card ID format: "String of 36 characters, standard representation of a UUID ( {time_low}-{time_mid}-{time_high_and_version}-{variant_and_sequence}-{node}\ \ )" cardholderId: type: string description: cardholder ID credentialList: type: array description: list of credentials. String on type/value json format format: "Type = String, Mean Code (EMAIL, SMS, IVR, …).Value = Value of\ \ Mean). " example: "{ \"type\": \"SMS\", \"value\": \"+33606060606\" }, \ \ { \"type\": \"PWD\", \"value\": \"4b358ed84b7940619235a22328c584c7bc4508d4524e75231d6f450521d16a17\"\ , \"algorithm\": \"SHA-256\" }" items: $ref: '#/components/schemas/Credential' issuerCode: type: string description: Issuer Code format: String of 5 digits subIssuerCode: type: string description: Sub Issuer Code format: String of 5 digits tokenPan: type: string description: token of PAN description: CreateCredentialsResponse DTO resource representation Credential: required: - type - value type: object properties: algorithm: type: string description: "Credential algorithm, only for PWD means" creationDate: type: string description: "Credential creation date, deserialization ignored" format: date-time deletedTime: type: string description: "Credential deleted time in future date, deserialization ignored" format: date-time modifier: type: string description: "Credential modifier, deserialization ignored" pattern: type: string description: "Credential pattern, only for DDN means" type: type: string description: Credential type format: CredentialType enum enum: - PWD - DDN - SSN - PAM - TOKEN - TA - EMAIL - SMS - IVR - CCP - SVI - PHONE - OTRC - USERCODE - OPENID updatedTime: type: string description: "Credential updated time, deserialization ignored" format: date-time value: type: string description: Credential value description: Credential DTO resource representation format: "Type = String, Mean Code (EMAIL, SMS, IVR, …).Value = Value of Mean). " example: "{ \"type\": \"SMS\", \"value\": \"+33606060606\" }, { \ \ \"type\": \"PWD\", \"value\": \"4b358ed84b7940619235a22328c584c7bc4508d4524e75231d6f450521d16a17\"\ , \"algorithm\": \"SHA-256\" }" CustomerRequest: required: - issuerCode - service - subIssuerCode type: object properties: bcf: type: string writeOnly: true bdom: type: string writeOnly: true cardHolderId: maxLength: 36 minLength: 2 type: string description: Cardholder ID code: type: string description: Customer code format: String of 5 digits codeParent: type: string description: Parent customer code format: String of 5 digits image: type: string description: image issuerCode: maxLength: 5 minLength: 5 type: string description: Issuer code format: The issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) label: type: string description: Customer label language: type: string description: Customer language format: String of 1 or 2 characters requestId: type: string description: Request ID format: String service: maxLength: 255 minLength: 1 type: string description: Calling service sessionId: type: string description: Session ID subIssuerCode: maxLength: 5 minLength: 5 type: string description: sub issuer code format: The sub issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) transactionId: type: string description: CustomerRequest DTO resource representation DetokenizePanRequest: required: - issuerCode - service - subIssuerCode - tokenPan type: object properties: cardHolderId: maxLength: 36 minLength: 2 type: string description: Cardholder ID issuerCode: maxLength: 5 minLength: 5 type: string description: Issuer code format: The issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) keyTag: type: string description: Detokenize pan request key tag requestId: type: string description: Request ID format: String service: maxLength: 255 minLength: 1 type: string description: Calling service sessionId: type: string description: Session ID subIssuerCode: maxLength: 5 minLength: 5 type: string description: sub issuer code format: The sub issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) tokenPan: type: string description: Detokenize pan request token pan transactionId: type: string description: DetokenizePanRequest resource representation DetokenizePanResponse: type: object properties: principal: $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType' description: DetokenizePanResponse resource representation GetCardResponse: type: object properties: cardId: type: string description: card ID format: "String of 36 characters, standard representation of a UUID ( {time_low}-{time_mid}-{time_high_and_version}-{variant_and_sequence}-{node}\ \ )" cardholderId: type: string description: cardholder ID issuerCode: type: string description: Issuer Code format: String of 5 digits subIssuerCode: type: string format: String of 5 digits tokenPan: type: string description: token of PAN description: GetCardResponse DTO resource representation RefPrincipal: type: object properties: keyTag: type: string description: "key tag, useful in case of encrypted pan for decryption" format: |- String of 2 characters '01' for the first tag to use type: type: string description: "Principal type : 'cardId', 'Pan', 'encryptedPan', 'tokenPan',\ \ 'vPan', 'tokenVPan' or 'cardHolderId'" format: PrincipalType object enum: - tokenPan - securePan - cardHolderId - maskedPan - pan - tokenVPan - secureVPan - encryptedVPan - vPan - maskedVPan - encryptedPan - cardId value: type: string description: Principal value format: "String of 1 to 255 characters\nFor « pan or vPan » type : String\ \ of 15 to 19 digits.\n\nFor « encryptedPan » type, the keyTag is mandatory\n\ \ntokenPan or tokenVPan : String of 15 to 50 characters\n\ncardHolderId:\ \ String of 10 to 30 characters\n" values: type: array description: list of Principal values items: type: string description: list of Principal values description: principal format: RefPrincipal object SearchCardRequest: required: - issuerCode - service - subIssuerCode type: object properties: cardHolderId: maxLength: 36 minLength: 2 type: string description: Cardholder ID customerCode: type: string description: Customer code format: String of 5 digits issuerCode: maxLength: 5 minLength: 5 type: string description: Issuer code format: The issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) principal: $ref: '#/components/schemas/RefPrincipal' provideDeletedCards: type: boolean description: provide deleted cards format: "boolean\n if true, search also deleted cards" providePan: type: boolean description: PAN provided format: boolean requestId: type: string description: Request ID format: String service: maxLength: 255 minLength: 1 type: string description: Calling service sessionId: type: string description: Session ID subIssuerCode: maxLength: 5 minLength: 5 type: string description: sub issuer code format: The sub issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) description: SearchCardRequest DTO resource representation SearchCardResponse: type: object properties: brands: type: array description: Brands format: list of CardBrand business objects items: $ref: '#/components/schemas/CardBrand' cardId: type: string description: card ID format: "String of 36 characters, standard representation of a UUID ( {time_low}-{time_mid}-{time_high_and_version}-{variant_and_sequence}-{node}\ \ )" cardholderId: type: string description: cardholder ID createdTime: type: string description: UTC Datetime of the creation format: date-time customer: $ref: '#/components/schemas/CardCustomer' customerParent: $ref: '#/components/schemas/CardCustomer' data: type: string description: data deletedTime: type: string description: UTC Datetime of the deletion format: date-time expiryDate: type: string description: expiration Date format: String of characters complying with date format (YYYY-MM) id: type: string description: card ID format: String maskedPan: type: string description: masked PAN format: String of 15 to 19 characters example: 497670xxxxxxxx15 pan: type: string description: PAN format: String of 15 to 19 digits profileSetName: type: string description: profileSetName rid: type: string description: Card RID statusCard: type: string description: Card status format: "String : 'ACTIVE', 'INACTIVE'" enum: - ACTIVE - INACTIVE token: type: string description: token of PAN format: String of 15 to 50 characters updatedTime: type: string description: UTC Datetime of the last update format: date-time description: SearchCardResponse DTO resource representation format: SearchCardResponse object TokenPanRequest: required: - issuerCode - service - subIssuerCode type: object properties: cardHolderId: maxLength: 36 minLength: 2 type: string description: Cardholder ID issuerCode: maxLength: 5 minLength: 5 type: string description: Issuer code format: The issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) principal: $ref: '#/components/schemas/RefPrincipal' requestId: type: string description: Request ID format: String service: maxLength: 255 minLength: 1 type: string description: Calling service sessionId: type: string description: Session ID subIssuerCode: maxLength: 5 minLength: 5 type: string description: sub issuer code format: The sub issuer code is mandatory on all Admin WS endpoints except for searchCards() and getCardDetails(CardDetailRequest) transactionId: type: string description: TokenPanRequest DTO resource representation TokenPanResponse: type: object properties: oldTokenPans: type: array description: list of old tokens format: list of Strings items: type: string description: list of old tokens format: list of Strings tokenPan: type: string description: token of PAN VirtualCard: type: object properties: createdTime: type: string description: VirtualCard createdTime format: date-time getvDeletedTime: type: string description: VirtualCard vDeletedTime format: date-time getvExpiryDate: type: string description: VirtualCard vExpiryDate getvMaskedPan: type: string description: VirtualCard vMaskedPan getvPan: type: string description: VirtualCard vPan getvToken: type: string description: VirtualCard vToken updatedTime: type: string description: VirtualCard updatedTime format: date-time description: VirtualCard resource representation VirtualCardsResponse: type: object properties: virtualCards: type: array description: VirtualCardsResponse virtualCards items: $ref: '#/components/schemas/VirtualCard' description: VirtualCardsResponse resource representation