openapi: 3.1.0 info: title: Internal Referential WS Admin description: Rest Referential Admin Config Operations version: "25R2_1.0" paths: /admin/card: post: tags: - card summary: Add Card or Get card if exists 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: "200": description: If the card exist already content: application/json: schema: $ref: '#/components/schemas/CardResponse' examples: - { "cardHolderId": "dcca4f99-c8ef-42a0-a555-fc80c5454e49", "tokenPan": "mckNDkyOTA0MTkxNzM5MDY1NA==", "language": "fr", "profileSetName": "Profile set name ", "statusCard": "ACTIVE", "status": "OK" } "201": description: If the card is created content: application/json: schema: $ref: '#/components/schemas/CardResponse' examples: - { "cardHolderId": "dcca4f99-c8ef-42a0-a555-fc80c5454e49", "tokenPan": "mckNDkyOTA0MTkxNzM5MDY1NA==", "language": "fr", "profileSetName": "Profile set name ", "statusCard": "ACTIVE", "status": "CREATED" } "400": description: Bad Request. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 400010007 - 400010008 - 400010009 - 400010013 - 400010010 - 400010011 - 400100025 description: | | Code | Label | | ---- | ----- | | 400010007 | Bad parameter : principal | | 400010008 | Bad parameter : principal type | | 400010009 | Bad parameter : principal value | | 400010013 | Bad parameter : principal.keyTag | | 400010010 | Bad Parameter : Issuer Code | | 400010011 | Bad Parameter : Sub Issuer Code | | 400100025 | Bad Paramater : Profile Set Name | examples: - 400010007 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" subIssuerCode: type: string examples: - 66666 "403": description: The provider Api-Key is invalid or expired content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 403000000 description: | | Code | Label | | ---- | ----- | | 403000000 | The provider Api-Key is invalid or expired | examples: - 403000000 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" subIssuerCode: type: string examples: - 66666 "404": description: Issuer not found content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 404030003 description: | | Code | Label | | ---- | ----- | | 404030003 | Issuer not found | examples: - 404030003 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" subIssuerCode: type: string examples: - 66666 /admin/card/detokenizePan: post: tags: - card summary: Detokenize Pan 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: "200": description: "OK." content: application/json: schema: $ref: '#/components/schemas/DetokenizePanResponse' examples: principalExample1: $ref: '#/components/examples/principalExample1' principalExample2: $ref: '#/components/examples/principalExample2' "400": description: Bad Request. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 400010034 - 400010026 - 400010010 - 400010011 - 400010005 description: | | Code | Label | | ---- | ----- | | 400010034 | Bad parameter : token pan | | 400010026 | Bad parameter : Key tag | | 400010010 | Bad parameter : issuer code | | 400010011 | Bad parameter : subIssuer code | | 400010005 | Bad parameter : session.service | examples: - 400010034 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" /admin/card/tokenPan: post: tags: - card summary: Call the tokenizer to get the tokenPan 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: "200": description: "OK." content: application/json: schema: $ref: '#/components/schemas/TokenPanResponse' "400": description: Bad Request. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 400010010 - 400010013 description: | | Code | Label | | ---- | ----- | | 400010010 | Bad parameter : Invalid format of customer code | | 400010013 | Bad parameter : principal;keyTag | examples: - 400010010 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "403": description: 403 Forbidden. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 403000000 description: | | Code | Label | | ---- | ----- | | 403000000 | Bad parameter : The provider Api-Key is invalid or expired | examples: - 403000000 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "500": description: Unexpected. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 500000298 description: | | Code | Label | | ---- | ----- | | 500000298 | Tokenisation : error from the third-party service | examples: - 500000298 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" /admin/cardData/new: put: tags: - cardData summary: Add or update card data and credentials 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: "200": description: "OK." content: application/json: schema: $ref: '#/components/schemas/CreateCredentialsResponse' "400": description: Bad Request. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 400010008 - 400010010 - 400030002 - 400030003 - 400110029 - 400110030 - 400080001 description: | | Code | Label | | ---- | ----- | | 400010008 | Bad Parameter – Principal Type | | 400010010 | Bad parameter : issuer code | | 400030002 | Bad parameter : cardinfo.pan | | 400030003 | Bad parameter : cardinfo.service | | 400110029 | PWD credential is not allowed to be updated | | 400110030 | PWD credential is not compliant to PCI requirements | | 400080001 | Bad parameter : cardId | examples: - 400010008 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "403": description: 403 Forbidden. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 403000000 description: | | Code | Label | | ---- | ----- | | 403000000 | Bad parameter : The provider Api-Key is invalid or expired | examples: - 403000000 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "404": description: Not found. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 404020001 - 404030000 - 404030003 description: | | Code | Label | | ---- | ----- | | 404020001 | Mean Unavailable | | 404030000 | Card not found | | 404030003 | Issuer not found | examples: - 404020001 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "500": description: Unexpected. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 500000298 description: | | Code | Label | | ---- | ----- | | 500000298 | Tokenisation : error from the third-party service | examples: - 500000298 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" /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: "200": description: "OK." content: application/json: schema: $ref: '#/components/schemas/CardDetailResponse' "400": description: Bad Request. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 400010001 - 400010010 - 400010005 - 400100014 - 400010026 - 400080000 description: | | Code | Label | | ---- | ----- | | 400010001 | Bad parameter : session.id | | 400010010 | Bad parameter : issuer code | | 400010005 | Bad parameter : session.service | | 400100014 | Bad parameter : Customer already exists | | 400010026 | Bad parameter : Key tag | | 400080000 | Found invalid property in CardDetailRequest: rid=[null], This parameter is null or a blank value. | examples: - 400010008 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "403": description: 403 Forbidden. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 403000000 description: | | Code | Label | | ---- | ----- | | 403000000 | Bad parameter : The provider Api-Key is invalid or expired | examples: - 403000000 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "404": description: Not found. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 404000000 - 404030000 description: | | Code | Label | | ---- | ----- | | 404020001 | Service not found | | 404030000 | Card not found | examples: - 404000000 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "500": description: Unexpected. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 500000298 description: | | Code | Label | | ---- | ----- | | 500000298 | Tokenisation : error from the third-party service | examples: - 500000298 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" /admin/cards/search: post: tags: - card summary: Search cards by list of pans, token pan or cardholder identifier 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' examples: - { "principal": { "type": "pan", "values": [ 4976700000000015 ] }, "providePan": true, "service": "HUB_NRT", "issuerCode": "66666", "subIssuerCode": "66666", "customerCode": "*" } responses: "200": description: "OK." content: application/json: schema: type: array items: $ref: '#/components/schemas/SearchCardResponse' "400": description: Bad Request. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 400010010 - 400030003 - 400010013 description: | | Code | Label | | ---- | ----- | | 400010010 | Bad parameter : issuer code | | 400030003 | Invalid Service | | 400010013 | Bad parameter, principal.keyTag | examples: - 400010010 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "403": description: 403 Forbidden. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 403000000 description: | | Code | Label | | ---- | ----- | | 403000000 | Bad parameter : The provider Api-Key is invalid or expired | examples: - 403000000 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "404": description: Not found. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 404030000 - 404030003 description: | | Code | Label | | ---- | ----- | | 404030000 | Card not found | | 404030003 | Issuer not found | examples: - 404030000 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "500": description: Unexpected. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 500000298 description: | | Code | Label | | ---- | ----- | | 500000298 | Tokenisation : error from the third-party service | examples: - 500000298 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" /admin/customer: post: tags: - customer summary: Add 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: "204": description: "Ok." "400": description: Bad Request. content: application/json: schema: type: object properties: lastEventCode: type: string enum: - 400010010 - 400010014 - 400010015 - 400010016 description: | | Code | Label | | ---- | ----- | | 400010010 | Bad parameter : issuer code | | 400010014 | Bad Parameter : Issuer Label | | 400010015 | Bad Parameter : Issuer Parent | | 400010016 | Bad Parameter : Issuer already exists | examples: - 400010010 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 "403": description: 403 Forbidden. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 403000000 description: | | Code | Label | | ---- | ----- | | 403000000 | Bad parameter : The provider Api-Key is invalid or expired | examples: - 403000000 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" /admin/getcard: post: tags: - card summary: Get card details by rid 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: "200": description: "OK." content: application/json: schema: $ref: '#/components/schemas/GetCardResponse' "400": description: Bad Request. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 400010007 - 400010008 - 400010009 - 400010013 - 400010010 - 400010011 description: | | Code | Label | | ---- | ----- | | 400010007 | Bad parameter : principal | | 400010008 | Bad parameter : principal type | | 400010009 | Bad parameter : principal value | | 400010013 | Bad parameter : principal;keyTag | | 400010010 | Bad parameter : issuer code | | 400010011 | Bad parameter : subIssuer code | examples: - 400010007 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "403": description: 403 Forbidden. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 403000000 description: | | Code | Label | | ---- | ----- | | 403000000 | Bad parameter : The provider Api-Key is invalid or expired | examples: - 403000000 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "404": description: Not found. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 404000000 - 404030000 description: | | Code | Label | | ---- | ----- | | 404000000 | Service not found | | 404030000 | Card not found | examples: - 404000000 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "500": description: Unexpected. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 500000298 description: | | Code | Label | | ---- | ----- | | 500000298 | Tokenisation : error from the third-party service | examples: - 500000298 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" /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: required: - service - rid type: object properties: issuerCode: length: 5 type: string description: Issuer code examples: - 66666 providePan: type: boolean description: boolean variable, ‘false’ by default (when the value is not provided in the request body) default: false deprecated: true rid: maxLength: 36 description: Card technical identifier, provided by IS Bank via Batch, WS STD API or UUID generated by HUB. examples: - 1609039243305 service: maxLength: 255 minLength: 1 type: string description: Calling service examples: - "HUB_NRT" subIssuerCode: length: 5 type: string description: sub issuer code examples: - 66666 requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 description: CardDetailRequest DTO resource representation examples: - { "rid": "0150f247-a108-4b20-afc9-3ea7d74857a4", "providePan": true, "service": "HUB_NRT", "issuerCode": "66666", "subIssuerCode": "66666" } responses: "200": description: "OK." content: application/json: schema: $ref: '#/components/schemas/VirtualCardsResponse' examples: - [ { "createdTime": "2024-10-05T22:49:51.472", "updatedTime": "2024-10-05T23:02:55.097", "vToken": "mckNDcxNjYzNjY5Nzg1NzIwNw==", "vPan": "4716636697857207", "vMaskedPan": "471663xxxxxxxx07", "vExpiryDate": "2024-12", "vDeletedTime": "2024-12-03T10:15:30" } ] "400": description: Bad Request. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 400010005 - 400010010 - 400010011 - 400080000 description: | | Code | Label | | ---- | ----- | | 400010005 | Bad parameter : session.service | | 400010010 | Bad parameter : issuer code | | 400010011 | Bad parameter : subIssuer code | | 400080000 | Bad parameter : rid | examples: - 400010005 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" "403": description: 403 Forbidden. content: application/json: schema: type: object properties: issuerCode: type: string examples: - 66666 lastEventCode: type: string enum: - 403000000 description: | | Code | Label | | ---- | ----- | | 403000000 | Bad parameter : The provider Api-Key is invalid or expired | examples: - 403000000 origin: type: string examples: - REFCLIENT originHost: type: string examples: - 9dd4df36ceda originVersion: type: string examples: - 25R1Q-P-03-SNAPSHOT requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 service: type: string examples: - "HUB_NRT" components: schemas: CardBrand: type: object properties: code: type: string description: Brand code format: String examples: - "VI" label: type: string description: Brand description format: String examples: - "VISA" 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 examples: - "66666" label: type: string description: Customer label format: String of 1 to 255 characters examples: - "NRT" description: Parent customer format: An object representing parent customer of current card customer CardDataDelete: required: - issuerCode - service - subIssuerCode type: object properties: credentials: type: array description: credentials format: List of strings items: type: string description: credentials format: List of strings examples: - [ "EMAIL", "SMS", "PWD" ] issuerCode: length: 5 type: string description: issuer code examples: - 66666 principal: type: object properties: type: type: string description: "Principal type : 'pan', 'cardId', 'tokenPan' or 'cardHolderId' " enum: - pan - cardId - tokenPan - cardHolderId value: type: string description: "For « pan » type : String of 15 to 19 digits. For « tokenPan » : String of 15 to 50 characters. For « cardHolderId » : String of 10 to 30 characters" description: principal examples: - { "type": "pan", "value": "4976700000000015" } 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 examples: - "HUB_NRT" subIssuerCode: length: 5 type: string description: sub issuer code examples: - 66666 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 default: false issuerCode: length: 5 type: string description: Issuer code examples: - 66666 principal: type: object properties: type: type: string description: "Principal type : 'pan', 'encryptedPan' or 'cardId' " enum: - pan - cardId - encryptedPan value: type: string description: "For « pan » type : String of 15 to 19 digits. For « encryptedPan » type, the keyTag is mandatory" keyTag: type: string maxLength: 2 description: Useful in case of encrypted pan for decryption. If keyTag is sent in the request encrypted PAN is returned, otherwise plain PAN. examples: - "01" description: principal examples: - { "type": "pan", "value": "4976700000000015" } requestId: type: string description: Request ID format: String examples: - "943d422f-7ff6-4abb-815c-f49e5261a862" service: maxLength: 255 minLength: 1 type: string description: Calling service examples: - "HUB_NRT" subIssuerCode: length: 5 type: string description: sub issuer code examples: - 66666 description: CardDataGet DTO resource representation CardDataUpdate: required: - issuerCode - service - subIssuerCode type: object properties: cardId: maxLength: 36 description: Card technical identifier, provided by IS Bank via Batch, WS STD API or UUID generated by HUB. examples: - 1609039243305 credentials: type: object description: list of credentials. String on key/value json format examples: - { "METHOD:EMAIL": [ { "email": "e1@em.fr" }, { "email": "e2@em.fr" } ], "METHOD:SMS": [ { "phoneNumber": "+33622113333", "ignoreForSms": "true" } ] } deletedTime: type: string description: deleted Time format: date-time issuerCode: length: 5 type: string description: Issuer Code. Mandatory if keyTag is sent in the request. examples: - 66666 principal: 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 : 'pan', 'encryptedPan', 'tokenPan', 'cardId' or 'cardHolderId'" enum: - pan - cardId - tokenPan - encryptedPan - cardHolderId value: type: string description: "For « pan » type : String of 15 to 19 digits. For « encryptedPan » type, the keyTag is mandatory. For « tokenPan » : String of 15 to 50 characters. For « cardHolderId » : String of 10 to 30 characters" description: principal examples: - { "type": "encryptedPan", "value": "967c938267941c6194db0ec2631f33e1f785833cd86a2099abeab962ea2b1388", "keyTag": "01" } profileSetName: type: string description: profile set name of customer examples: - Profile set name psns: type: array description: list of psns format: List of strings items: type: string description: list of psns format: List of strings examples: - [ { "rid": "01", "id": "d8040e87-8f6d-44bc-9655-f1c989f2041c", "atc": "82", "dki": "02", "expiryDate": "2019-11", "status": "ACTIVE" } ] requestId: type: string description: Request ID format: String examples: - 5fc54165-b034-40ed-b163-cba61f796522 service: maxLength: 255 minLength: 1 type: string description: Calling service examples: - "HUB_NRT" status: type: string description: card status format: "String : 'ACTIVE' or 'INACTIVE' or 'DELETED'" examples: - ACTIVE subIssuerCode: length: 5 type: string description: sub issuer code examples: - 66666 tokenPan: type: string maxLength: 36 description: Internal Token PAN calculated by ACS platform. examples: - mckNDk3NjcwMDAwMDAwMDExNA== description: CardDataUpdate DTO resource representation CardDetailRequest: required: - service - rid type: object properties: customerCode: type: string description: customer Code format: String of 5 characters, also can be a wildcard (‘*’) character encryptPan: type: boolean description: boolean variable, ‘false’ by default (when the value is not provided in the request body), not used default: false issuerCode: length: 5 type: string description: Issuer code examples: - 66666 providePan: type: boolean description: boolean variable, ‘false’ by default (when the value is not provided in the request body) default: false deprecated: true rid: maxLength: 36 description: Card technical identifier, provided by IS Bank via Batch, WS STD API or UUID generated by HUB. examples: - 1609039243305 service: maxLength: 255 minLength: 1 type: string description: Calling service examples: - "HUB_NRT" subIssuerCode: length: 5 type: string description: sub issuer code examples: - 66666 requestId: type: string examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 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). " examples: - [ { "type": "SMS", "value": "+33606060606", "modifier": "EXTRANET" }, { "type": "PWD", "value": "4b358ed84b7940619235a22328c584c7bc4508d4524e75231d6f450521d16a17", "algorithm": "SHA-256", "creationDate": "2024-10-05T19:18:48.382", "modifier": "EXTRANET" }, { "type": "DDN", "value": "01011970", "pattern": "ddMMyyyy", "creationDate": "2024-10-05T19:18:48.383", "modifier": "EXTRANET" } ] items: $ref: '#/components/schemas/Credential' credentials: type: object description: List of credentials format: "Key = String, Mean Code (METHOD:EMAIL, METHOD:PHONE, …).\nValue\ \ = List of data (List>). " examples: - { "METHOD:EMAIL": [ { "email": "e1@em.fr" }, { "email": "e2@em.fr" } ], "METHOD:PHONE": [ { "phoneNumber": "+33622113333", "ignoreForSms": "true" }, { "phoneNumber": "+33622113333", } ], "METHOD:PWD": [ { "pwd": "4b358ed84b7940619235a22328c584c7bc4508d4524e75231d6f450521d16a17", "algorithm": "SHA-256" } ], "METHOD:DDN": [ { "pattern": "ddMMyyyy", "ddn": "01011970" } ] } user: $ref: '#/components/schemas/CardUser' virtualCards: type: integer format: int64 description: Number of virtual cards that are linked for given card examples: - 1 description: CardDetailResponse DTO resource representation CardRequest: required: - issuerCode - service - subIssuerCode - principal type: object properties: binShared: type: boolean description: BIN shared examples: - false cardHolderId: maxLength: 36 minLength: 2 type: string description: Cardholder ID examples: - 5fc54165-b034-40ed-b163-cba61f796522 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} )" examples: - 1609039243305 createdTime: type: string format: date-time deletedTime: type: string format: date-time issuerCode: length: 5 type: string description: Issuer code examples: - 66666 language: type: string description: language of the customer format: String of 1 to 2 characters examples: - fr principal: type: object properties: keyTag: type: string maxLength: 2 description: Useful in case of encrypted pan for decryption. If keyTag is sent in the request encrypted PAN is returned, otherwise plain PAN. examples: - "01" type: type: string description: "Principal type : 'Pan', 'encryptedPan', 'tokenPan'" format: PrincipalType object enum: - pan - encryptedPan - tokenPan value: type: string description: Principal value format: "For « pan » type : String of 15 to 19 digits.For « encryptedPan » type, the keyTag is mandatory. For « tokenPan » type : String of 15 to 50 characters" examples: - "4976700000000015" description: principal format: RefPrincipal object profileSetName: type: string description: profile set name of customer examples: - Profile set name requestId: type: string description: Request ID format: String examples: - 5fc54165-b034-40ed-b163-cba61f796522 rid: type: string description: card ID deprecated: true service: maxLength: 255 minLength: 1 type: string description: Calling service examples: - "HUB_NRT" subIssuerCode: length: 5 type: string description: sub issuer code examples: - 66666 description: CardRequest DTO resource representation CardUser: type: object properties: firstName: type: string description: Card holder fist name format: String of 4 to 64 characters examples: - "User firstname" id: type: string description: Card holder ID examples: - "89402add-ad0e-4a68-a8bc-067b9cbc2181" language: type: string description: Card holder language format: String of 2 characters examples: - "fr" lastName: type: string description: Card holder last name format: String of 4 to 64 characters examples: - "User lastname" description: CardUser DTO resource representation format: CardUser object CipherableTypedDataCipherablePrincipalType: type: object properties: keyTag: type: string examples: - "01" type: type: string enum: - pan - encryptedPan description: | | type | description | | ---- | ---- | | pan | Plain Pan | | encryptedPan | If keyTag is provided in the request | value: type: string examples: - "8a3f1293494d11daef02ab5df9b0153e659ba7cfa18c6ceb8ae35b8d1eb35ad5" description: Ciphered data CreateCredentialsRequest: required: - issuerCode - service - subIssuerCode type: object properties: cardId: maxLength: 36 description: Card technical identifier, provided by IS Bank via Batch, WS STD API or UUID generated by HUB. examples: - 1609039243305 credentialList: uniqueItems: true type: array description: list of credentials. String on type/value json format examples: - [ { "type": "SMS", "value": "+33606060606" }, { "type": "PWD", "value": "4b358ed84b7940619235a22328c584c7bc4508d4524e75231d6f450521d16a17", "algorithm": "SHA-256" } ] items: $ref: '#/components/schemas/Credential' deletedTime: type: string description: deleted Time format: yyyy-MM-ddTHH:mm:ss.SS examples: - 2024-10-17T10:52:54.19 issuerCode: length: 5 type: string description: Issuer code examples: - 66666 keyTag: type: string maxLength: 2 description: Useful in case of encrypted pan for decryption. If keyTag is sent in the request encrypted PAN is returned, otherwise plain PAN. examples: - "01" modifier: type: string description: "An optional field , who made changes" examples: - "EXTRANET" principal: type: object properties: type: type: string description: "Principal type : 'pan', 'encryptedPan', 'tokenPan' or 'cardId' " enum: - pan - cardId - tokenPan value: type: string description: "For « pan » type : String of 15 to 19 digits. For « tokenPan » : String of 15 to 50 characters. " description: principal examples: - { "type": "pan", "value": "4976700000000015" } profileSetName: type: string description: profile set name of customer examples: - Profile set name service: maxLength: 255 minLength: 1 type: string description: Calling service examples: - "HUB_NRT" status: type: string description: card status format: "String : 'ACTIVE' or 'INACTIVE' or 'DELETED'" examples: - "ACTIVE" subIssuerCode: length: 5 type: string description: sub issuer code examples: - 66666 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). " examples: - [ { "type": "SMS", "value": "+33606060606" }, { "type": "PWD", "value": "4b358ed84b7940619235a22328c584c7bc4508d4524e75231d6f450521d16a17", "algorithm": "SHA-256" } ] items: $ref: '#/components/schemas/Credential' issuerCode: length: 5 type: string description: Issuer code examples: - 66666 subIssuerCode: length: 5 type: string description: sub issuer code examples: - 66666 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" examples: - "SHA-256" 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" examples: - "EXTRANET" pattern: type: string description: "Credential pattern, only for DDN means" examples: - "ddMMyyyy" 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). " examples: - [ { "type": "SMS", "value": "+33606060606" }, { "type": "PWD", "value": "4b358ed84b7940619235a22328c584c7bc4508d4524e75231d6f450521d16a17", "algorithm": "SHA-256" } ] CustomerRequest: required: - service - code - label - codeParent type: object properties: code: type: string description: Customer code format: String of 5 digits examples: - "66666" codeParent: type: string description: Parent customer code format: String of 5 digits examples: - "*" label: type: string description: Customer label examples: - "NRT" language: type: string description: Customer language format: String of 1 or 2 characters examples: - "fr" service: maxLength: 255 minLength: 1 type: string description: Calling service examples: - "HUB_NRT" description: CustomerRequest DTO resource representation DetokenizePanRequest: required: - service - tokenPan type: object properties: issuerCode: length: 5 type: string description: Issuer Code. Mandatory if keyTag is sent in the request. examples: - 66666 keyTag: type: string maxLength: 2 description: Useful in case of encrypted pan for decryption. If keyTag is sent in the request encrypted PAN is returned, otherwise plain PAN. examples: - "01" service: maxLength: 255 minLength: 1 type: string description: Calling service examples: - "HUB_NRT" tokenPan: type: string maxLength: 36 description: Internal Token PAN calculated by ACS platform. examples: - mckNDk3NjcwMDAwMDAwMDExNA== 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}\ \ )" examples: - "0150f247-a108-4b20-afc9-3ea7d74857a4" cardholderId: type: string description: cardholder ID examples: - "89402add-ad0e-4a68-a8bc-067b9cbc2181" issuerCode: length: 5 type: string description: Issuer code examples: - 66666 subIssuerCode: length: 5 type: string description: sub issuer code examples: - 66666 tokenPan: type: string description: token of PAN examples: - "mckNDk3NjcwMDAwMDAwMDAxNQ==" description: GetCardResponse DTO resource representation RefPrincipal: type: object properties: keyTag: type: string maxLength: 2 description: Useful in case of encrypted pan for decryption. If keyTag is sent in the request encrypted PAN is returned, otherwise plain PAN. examples: - "01" 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: - service - principal type: object properties: issuerCode: length: 5 type: string description: Issuer code examples: - 66666 principal: type: object properties: type: type: string description: "Principal type : 'pan', 'cardId', 'tokenPan', 'cardHolderId', 'vPan' or 'tokenVPan'" enum: - pan - cardId - tokenPan - cardHolderId - vPan - tokenVPan value: type: string description: "For « pan » type : String of 15 to 19 digits. For « tokenPan » : String of 15 to 50 characters. " description: principal examples: - { "type": "pan", "value": "4976700000000015" } provideDeletedCards: type: boolean description: provide deleted cards format: "boolean\n if true, search also deleted cards" providePan: type: boolean description: PAN provided format: boolean deprecated: true requestId: type: string description: Request ID format: String service: maxLength: 255 minLength: 1 type: string description: Calling service examples: - "HUB_NRT" subIssuerCode: length: 5 type: string description: sub issuer code examples: - 66666 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}\ \ )" examples: - "0150f247-a108-4b20-afc9-3ea7d74857a4" cardholderId: type: string description: cardholder ID examples: - "89402add-ad0e-4a68-a8bc-067b9cbc2181" createdTime: type: string description: UTC Datetime of the creation format: yyyy-MM-ddTHH:mm:ss.SS examples: - 2025-10-17T08:15:04.500+0400 customer: $ref: '#/components/schemas/CardCustomer' customerParent: $ref: '#/components/schemas/CardCustomer' examples: - { "code": "*", "label": "root" } data: type: string description: is composed by psns (list of strings psns codes) and profileSetExpiryDate (YYYYMMDD or null) deletedTime: type: string description: UTC Datetime of the deletion format: yyyy-MM-ddTHH:mm:ss.SS examples: - 2025-10-17T08:15:04.500+0400 expiryDate: type: string description: expiration Date format: String of characters complying with date format (YYYY-MM) examples: - "2023-10" id: type: string description: card ID format: String examples: - "0150f247-a108-4b20-afc9-3ea7d74857a4" maskedPan: type: string description: masked PAN format: String of 15 to 19 characters examples: - "497670xxxxxxxx15" pan: type: string description: PAN format: String of 15 to 19 digits profileSetName: type: string description: profile set name of customer examples: - Profile set name rid: type: string description: Card RID deprecated: true 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 examples: - "mckNDk3NjcwMDAwMDAwMDAxNQ==" updatedTime: type: string description: UTC Datetime of the last update format: yyyy-MM-ddTHH:mm:ss.SS examples: - 2025-10-17T08:15:04.500+0400 description: SearchCardResponse DTO resource representation format: SearchCardResponse object CardResponse: type: object properties: cardholderId: type: string description: Card Holder ID examples: - 5fc54165-b034-40ed-b163-cba61f796522 statusCard: type: string description: Card status format: "String : 'ACTIVE', 'INACTIVE'" enum: - ACTIVE - INACTIVE status: type: string description: Status of operation format: "String : 'OK', 'CREATED'" enum: - OK - CREATED tokenPan: type: string description: token of PAN format: String of 15 to 50 characters examples: - mckNDk3NjcwMDAwMDAwMDExNA== language: type: string description: language of the customer format: String of 1 to 2 characters examples: - fr profileSetName: type: string description: profile set name of customer examples: - Profile set name description: CardResponse DTO resource representation format: CardResponse object TokenPanRequest: required: - issuerCode - service - subIssuerCode - principal type: object properties: issuerCode: length: 5 type: string description: Issuer code examples: - 66666 principal: type: object properties: keyTag: type: string maxLength: 2 description: Useful in case of encrypted pan for decryption. If keyTag is sent in the request encrypted PAN is returned, otherwise plain PAN. examples: - "01" type: type: string description: "Principal type : 'Pan' or 'encryptedPan'" enum: - pan - encryptedPan value: type: string description: "For « pan » type : String of 15 to 19 digits. For « encryptedPan » type, the keyTag is mandatory" description: principal examples: - { "type": "encryptedPan", "value": "967c938267941c6194db0ec2631f33e1f785833cd86a2099abeab962ea2b1388", "keyTag": "01" } service: maxLength: 255 minLength: 1 type: string description: Calling service examples: - "HUB_NRT" subIssuerCode: length: 5 type: string description: sub issuer code examples: - 66666 requestId: type: string description: Request Identifier. For logging and as an IV for PAN decryption examples: - 334864fe-f311-4655-94df-a0c547aa7cd5 description: TokenPanRequest DTO resource representation TokenPanResponse: type: object properties: oldTokenPans: type: array description: used for the PAN, from the most recent to the oldest one format: list of Strings items: type: string description: list of old tokens examples: - [ "224f7d50000fp", "oldestToken" ] tokenPan: type: string description: token of PAN examples: - "mckNDk3NjcwMDAwMDAwMDAxNQ==" VirtualCard: type: object properties: createdTime: type: string description: VirtualCard createdTime format: date-time vDeletedTime: type: string description: VirtualCard vDeletedTime format: date-time vExpiryDate: type: string description: VirtualCard vExpiryDate examples: - "2024-12" vMaskedPan: type: string description: VirtualCard vMaskedPan examples: - "471663xxxxxxxx07" vPan: type: string description: VirtualCard vPan examples: - "4716636697857207" vToken: type: string description: VirtualCard vToken examples: - "mckNDcxNjYzNjY5Nzg1NzIwNw==" 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 examples: principalExample1: value: - { "type": "encryptedPan", "value": "df02868391a3c7593bda1b928227035e500024cca436029eba5c079376bc9c83", "keyTag": "01" } summary: encrypted pan principalExample2: value: - { "type": "pan", "value": "4976700000000015" } summary: plain pan