swagger: '2.0' info: description: 'The current set of APIs will be available in Q2 2026 on Worldline Global Issuing Platforms. Additional APIs are under construction and planned to be available in 2026.' version: 2.41.1 title: Worldline Issuing Account - AccountState Card API contact: {} host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing basePath: /api/v2 schemes: - https tags: - name: Card description: Card Api Controller paths: /issuers/{issuerId}/cards/block-all: post: tags: - Card summary: Block all cards with same PAN or same PAN Reference operationId: blockAllCards description: "The API is similar to Block a card API but is applied to all cards having the same PAN or same PAN reference.\n\nThe API allows the permanent blocking (immediately or in the future), or temporary blocking, depending on the configured blocking reason, of all cards having the same PAN or same PAN reference.\nCards must be in “CREATED” or “ACTIVE” status. \nThe blocking reason is chosen from the reasons configured beforehand for the issuer.\nIf a card is in \"DEACTIVATED\" status and the blocking reason is temporary, it will be ignored.\n\nIt is also possible to update the following blocking information by this API :\n- When the card is already blocked:\n - Blocking reason among those available for the issuer\n - Blocking detail\n - Lost and stolen date if the blocking reason is LOST or STOLEN\n - Fraud process\n - The flag indicating whether the PIN is compromised\n - Scheduled blocking information : delay or blocking reason if the delay is not yet reached\n\n- When the card is active :\n - Scheduled blocking information : delay or blocking reason if the delay is not yet reached" consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/BlockAllCardsRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityBlockAllCardsResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}: get: tags: - Card summary: Retrieve card by external reference operationId: retrieveCardByIssuerExtRef description: 'This API enables card information for a given card identifier to be retrieved. The response can also be enriched (if specified as embedded fields in input) with additional data such as the status history of the card, the card Contract information, the card order identifiers linked to the card.' produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - name: publicKeyIdentifier in: query description: Public Key Identifier required: false type: string - name: embed in: query description: Embedded Fields required: false type: array items: type: string enum: - statusHistory - cardContract - renewedBy - renewedFor - replacementBy - replacementFor - cardContract.contactCenters - orderIdentifiers - orders collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCard' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/activate: post: tags: - Card summary: Activate a card by external reference operationId: activateCardByIssuerExtRef description: 'The API allows to activate on demand a card in ''''created'''' status identified by the Issuer Card External Reference or the Card Reference. The activation reason is chosen among the reasons configured beforehand for the issuer. As a result, the card is active in our system.' consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ActivateCardRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityActivateCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block: post: tags: - Card summary: Block a card by external reference operationId: blockCardByIssuerExtRef description: "The API allows blocking a card permanently (immediately or in the future) or temporarily, depending on the configured blocking reason, using the Issuer Card External Reference or the Card Reference.\n\n- The card must be in “Created”, “Active”, or “Deactivated” status (“Deactivated” only if a reason for permanent blocking is requested).\n- The blocking reason is chosen among those configured beforehand for the issuer.\n\nExample Use Cases:\n- Use case 1: Card is blocked permanently (e.g., lost, stolen, not delivered, fraudulent activity).\n Result: The card is definitively blocked in our system (final status).\n- Use case 2: Card compromised in Common Point of Purchase (CPP); a permanent block is scheduled, but the cardholder can still use the card for PIN-based transactions.\n Result: The card remains active, and a permanent block is scheduled.\n- Use case 3: Card is blocked temporarily due to fraud suspicion (e.g., by issuer or fraud system).\n Result: The card is temporarily blocked and can be unblocked later.\n\nBlocking Information Updates via API:\n- When the card is already blocked:\n - Blocking reason (among those available for the issuer)\n - Blocking detail\n - Lost and stolen date (if the reason is LOST or STOLEN)\n - Fraud process\n - Flag indicating whether the PIN is compromised\n - Scheduled blocking information (delay or blocking reason if the delay is not yet reached)\n- When the card is active:\n - Scheduled blocking information (delay or blocking reason if the delay is not yet reached)" consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/BlockCardRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityBlockCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block-and-replace: post: x-wl-idempotent: true x-wl-lra-operation: true tags: - Card summary: Block and replace a card by external reference operationId: blockAndReplaceCardByIssuerExtRef description: "The API allows a card identified by the Issuer Card External Reference or the Card Reference to be blocked and replaced.\nThis API regroups Block a card (for card blocking or blocking information update) and Replace a card APIs in a single request.\nAs result, the card is blocked and the new card is created.\nIf any error occurs while card blocking or card replacing, the card is neither blocked nor replaced.\n\nWith this API, it is also possible to block all cards having the same PAN than the card referenced by Issuer Card External Reference or the Card Reference. In this case Block all cards API is called instead Block a card API.\n\nIn case a product change on renewal is planned on the contract of the card to be replaced, the card will not be replaced but the product change will be forced instead. From the replace card request, only blocking reason and embossingName/embossingName2ndLine will be considered : \n- If blocking reason is provided (for temporary blocking only), the new card of the new contract is blocked with this reason\n- If embossingName and/or embossingName2ndLine are provided, they will be applied to the old card and will be transferred to the new card of the new contract.\nIn the request response, information related to the new contract and the product change will be returned.\n\nIdempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/BlockAndReplaceCardRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityBlockAndReplaceCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract: get: tags: - Card summary: Retrieve card contract for a card by external reference operationId: retrieveCardContractForCardByIssuerExtRef description: "The API enables the card contract information related to a given card to be retrieved.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe card for which the detail is requested: It can be provided by using the card reference or the issuer card external reference. \nIt is also possible to request some additional data by using the embedded fields (such as the list of models linked to the card contract, the account identifiers linked to the card contract, the identifiers and the information of the linked cards).\nIn return, the interface provides the generic information (mainly master data) relevant to the card contract." produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - name: embed in: query description: Embedded Fields required: false type: array items: type: string enum: - selectedModels - cardIdentifiers - relatedAccounts - cards collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCardContract' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-events: get: tags: - Card summary: Retrieve card event list (e.g. PIN change information) by external reference operationId: listCardEventsByIssuerExternalRef description: The API enables the events information related to a given card to be retrieved (e.g. status change such as card blocking/card activation, card issuing for replacement or renewal, PIN change.). produces: - application/json parameters: - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: eventType in: query description: 'Type of event to return. Possible values are : PINChange, TanMailerOrderIssuing, CardOrderIssuing, PinMailerOrderIssuing, TanMailerOrderExtraction, CardOrderExtraction, PinMailerOrderExtraction, CancelCardOrderIssuing, CancelTanMailerOrderIssuing, CancelPinMailerOrderIssuing, CardActivation, CardIssuing, CardCancellation, CardDeactivation, CardBlocking, CardUnblocking.' required: false type: array items: type: string collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityListCardEvent' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/deactivate: post: tags: - Card summary: Deactivate a card by external reference operationId: deactivateCardByIssuerExtRef description: 'The API allows an active card, or a temporary blocked card, to be deactivated on demand, by using the Issuer Card External Reference or the Card Reference. The deactivation reason is chosen from the reasons configured beforehand for the issuer. As a result, the card is deactivated in our system. This process is not reversible. New card authorizations are declined. If necessary, a request for a card replacement may be made by the issuer. This API allows also to cancel a card in “Created” status, e.g., when the card production has failed.' consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/DeactivateCardRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeactivateCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/new-tan: post: x-wl-idempotent: true tags: - Card summary: Create new TAN by external reference operationId: createTanByIssuerExtRef description: "For PIN self-selection without a direct bank connection to the card issuing institute - i.e., without online banking access - Worldline offers the variant PIN change with TAN (Trusted Authentication Number). \nThis applies in particular to card programs where the bank is the card issuer for another partner, e.g., TUI or eBay.\nThe API allows to generate a TAN, which is used as a one-time password, printed and sent to cardholder in order to change card pin by e.g. IVR.\n\nIdempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateTanRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateTanResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders: get: tags: - Card summary: List orders for a card by external reference operationId: listOrdersForCardByIssuerExtRef description: 'The API enables the orders information related to a given card to be retrieved. The response can also be enriched (if specified as embedded fields in input) with additional data such as the orders status history of the card, the card information.' produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - name: orderType in: query description: Order type to retrieve (CardOrder, PinMailerOrder or TanMailerOrder) required: false type: string - name: embed in: query description: Embedded Fields required: false type: array items: type: string enum: - card - statusHistory collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityListOrder' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/remind-pin: post: x-wl-idempotent: true tags: - Card summary: Remind pin for a card by external reference description: 'The API allows a PIN reminder to be requested for a card, identified by the Issuer Card External Reference or the Card Reference when a cardholder forgot its PIN. The card must be in “ACTIVE” status. As a result, a PIN mailer order is generated. Idempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system.' operationId: remindPINByIssuerExtRef consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/RemindPINRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityRemindPINResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/reorder-pin: post: x-wl-idempotent: true tags: - Card summary: Reorder new PIN for the card by external reference description: 'The API allows to order a new PIN for the card when a cardholder wants to change its PIN. The card must be in "CREATED" or "ACTIVE" status. As a result, a PIN mailer order with PIN REORDER reason is generated. Idempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system.' operationId: reorderPINByIssuerExtRef consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ReorderPINRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityReorderPINResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/replace: post: x-wl-idempotent: true x-wl-lra-operation: true tags: - Card summary: Replace a card by external reference operationId: replaceCardByIssuerExtRef description: "The API allows a card, that has not yet been replaced or renewed, to be replaced when the card is lost/stolen or damaged, or when the customer’s information has changed, by using the Issuer Card External Reference or the Card Reference. \nThe card contract must be ACTIVE with no replacement blocking. No check of the card status is performed. \nThe replacement reason is chosen from the reasons configured beforehand for the issuer.\nData that may need to be changed during replacement can be provided, such as: card data (e.g., embossing name), order data (e.g., card producer if several are allowed), customer data (e.g., name), PIN.\nAs a result, the new card is created, a card order and a PIN mailer order are created when applicable (physical card requested).\n\nIn case a product change on renewal is planned on the contract of the card to be replaced, the card will not be replaced but the product change will be forced instead. From the request, only blocking reason and embossingName/embossingName2ndLine will be considered : \n- If blocking reason is provided (for temporary blocking only), the new card of the new contract is blocked with this reason\n- If embossingName and/or embossingName2ndLine are provided, they will be applied to the old card and will be transferred to the new card of the new contract.\nIn the request response, information related to the new contract and the product change will be returned.\n\nIdempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ReplaceCardRequest' responses: '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityReplaceCardResponse' '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/unblock: post: tags: - Card summary: Unblock a card by external reference operationId: unblockCardByIssuerExtRef description: 'The API allows to unblock a card identified by the Issuer Card External Reference or the Card Reference. The card must be temporary blocked. The unblocking reason is chosen among the reasons configured beforehand for the issuer. As a result, the card is active again in our system. An issuer cannot request the unblocking of a permanently blocked card.' consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/UnblockCardRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityUnblockCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/search: post: tags: - Card summary: Retrieve card by cardNumber and sequenceNumber and expiryDate operationId: searchCard description: 'This API enables card information to be retrieved based on PAN or PAN reference, and optionally on PAN sequence number and/or expiry date information as search criteria. The response can be enriched (if specified as embedded fields in input) with additional data such as the status history of the card, the card contract information, the card order identifiers linked to the card, card identifiers of the new card in case of replacement or renewal, the related accounts and the selected models linked to the card contract.' consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: embed in: query description: Embedded Fields required: false type: array items: type: string enum: - statusHistory - cardContract - renewedBy - renewedFor - replacementBy - replacementFor - orderIdentifiers - orders - cardContract.relatedAccounts - cardContract.selectedModels collectionFormat: multi - in: body name: body required: false schema: $ref: '#/definitions/SearchCardRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityListCard' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/unblock-all: post: tags: - Card summary: Unblock all cards with same PAN or same PAN Reference operationId: unblockAllCards description: "The API is similar to Unblock a card API but is applied to all cards having the same PAN or same PAN reference.\n\nThe API allows the unblocking of all cards having the same PAN or same PAN reference.\nCards must be in temporary “Blocked” status.\nThe unblocking reason is chosen from the reasons configured beforehand for the issuer.\nThe Issuer cannot request this API for permanently blocked cards. \nAs a result, cards having the same PAN or same PAN reference are active again in our system." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/UnblockAllCardsRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityUnblockAllCardsResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}: get: tags: - Card summary: Retrieve card operationId: retrieveCard description: 'This API enables card information for a given card identifier to be retrieved. The response can also be enriched (if specified as embedded fields in input) with additional data such as the status history of the card, the card Contract information, the card order identifiers linked to the card.' produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - name: publicKeyIdentifier in: query description: Public Key Identifier required: false type: string - name: embed in: query description: Embedded Fields required: false type: array items: type: string enum: - statusHistory - cardContract - renewedBy - renewedFor - replacementBy - replacementFor - cardContract.contactCenters - orderIdentifiers - orders collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCard' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/activate: post: tags: - Card summary: Activate a card operationId: activateCard description: 'The API allows to activate on demand a card in ''''created'''' status identified by the Issuer Card External Reference or the Card Reference. The activation reason is chosen among the reasons configured beforehand for the issuer. As a result, the card is active in our system.' consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ActivateCardRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityActivateCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/block: post: tags: - Card summary: Block a card operationId: blockCard description: "The API allows blocking a card permanently (immediately or in the future) or temporarily, depending on the configured blocking reason, using the Issuer Card External Reference or the Card Reference.\n\n- The card must be in “Created”, “Active”, or “Deactivated” status (“Deactivated” only if a reason for permanent blocking is requested).\n- The blocking reason is chosen among those configured beforehand for the issuer.\n\nExample Use Cases:\n- Use case 1: Card is blocked permanently (e.g., lost, stolen, not delivered, fraudulent activity).\n Result: The card is definitively blocked in our system (final status).\n- Use case 2: Card compromised in Common Point of Purchase (CPP); a permanent block is scheduled, but the cardholder can still use the card for PIN-based transactions.\n Result: The card remains active, and a permanent block is scheduled.\n- Use case 3: Card is blocked temporarily due to fraud suspicion (e.g., by issuer or fraud system).\n Result: The card is temporarily blocked and can be unblocked later.\n\nBlocking Information Updates via API:\n- When the card is already blocked:\n - Blocking reason (among those available for the issuer)\n - Blocking detail\n - Lost and stolen date (if the reason is LOST or STOLEN)\n - Fraud process\n - Flag indicating whether the PIN is compromised\n - Scheduled blocking information (delay or blocking reason if the delay is not yet reached)\n- When the card is active:\n - Scheduled blocking information (delay or blocking reason if the delay is not yet reached)" consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/BlockCardRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityBlockCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/block-and-replace: post: x-wl-idempotent: true x-wl-lra-operation: true tags: - Card summary: Block and replace a card operationId: blockAndReplaceCard description: "The API allows a card identified by the Issuer Card External Reference or the Card Reference to be blocked and replaced.\nThis API regroups Block a card (for card blocking or blocking information update) and Replace a card APIs in a single request.\nAs result, the card is blocked and the new card is created.\nIf any error occurs while card blocking or card replacing, the card is neither blocked nor replaced.\n\nWith this API, it is also possible to block all cards having the same PAN than the card referenced by Issuer Card External Reference or the Card Reference. In this case Block all cards API is called instead Block a card API.\n\nIn case a product change on renewal is planned on the contract of the card to be replaced, the card will not be replaced but the product change will be forced instead. From the replace card request, only blocking reason and embossingName/embossingName2ndLine will be considered : \n- If blocking reason is provided (for temporary blocking only), the new card of the new contract is blocked with this reason\n- If embossingName and/or embossingName2ndLine are provided, they will be applied to the old card and will be transferred to the new card of the new contract.\nIn the request response, information related to the new contract and the product change will be returned.\n\nIdempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/BlockAndReplaceCardRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityBlockAndReplaceCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/card-contract: get: tags: - Card summary: Retrieve card contract for a card operationId: retrieveCardContractForCard description: "The API enables the card contract information related to a given card to be retrieved.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe card for which the detail is requested: It can be provided by using the card reference or the issuer card external reference. \nIt is also possible to request some additional data by using the embedded fields (such as the list of models linked to the card contract, the account identifiers linked to the card contract, the identifiers and the information of the linked cards).\nIn return, the interface provides the generic information (mainly master data) relevant to the card contract." produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - name: embed in: query description: Embedded Fields required: false type: array items: type: string enum: - selectedModels - cardIdentifiers - relatedAccounts - cards collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCardContract' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/card-events: get: tags: - Card summary: Retrieve card event list (e.g. PIN change information) operationId: listCardEvents description: The API enables the events information related to a given card to be retrieved (e.g. status change such as card blocking/card activation, card issuing for replacement or renewal, PIN change.). produces: - application/json parameters: - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: eventType in: query description: 'Type of event to return. Possible values are : PINChange, TanMailerOrderIssuing, CardOrderIssuing, PinMailerOrderIssuing, TanMailerOrderExtraction, CardOrderExtraction, PinMailerOrderExtraction, CancelCardOrderIssuing, CancelTanMailerOrderIssuing, CancelPinMailerOrderIssuing, CardActivation, CardIssuing, CardCancellation, CardDeactivation, CardBlocking, CardUnblocking.' required: false type: array items: type: string collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityListCardEvent' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/deactivate: post: tags: - Card summary: Deactivate a card operationId: deactivateCard description: 'The API allows an active card, or a temporary blocked card, to be deactivated on demand, by using the Issuer Card External Reference or the Card Reference. The deactivation reason is chosen from the reasons configured beforehand for the issuer. As a result, the card is deactivated in our system. This process is not reversible. New card authorizations are declined. If necessary, a request for a card replacement may be made by the issuer. This API allows also to cancel a card in “Created” status, e.g., when the card production has failed.' consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/DeactivateCardRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeactivateCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/declare-counterfeit-card: post: x-wl-idempotent: true tags: - Card summary: Declare counterfeit card operationId: declareCounterfeitCard description: 'The API allows a counterfeit card to be declared.The PAN of the counterfeit card must be provided.The expiry date and/or the psn can be provided.It is possible to indicate if the card has been compromised in Common Point of Purchase (card is in CPP list). Idempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once. The response will be retrieved directly from our system.' consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/DeclareCounterfeitCardRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityDeclareCounterfeitCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/orders: get: tags: - Card summary: List orders for a card operationId: listOrdersForCard description: 'The API enables the orders information related to a given card to be retrieved. The response can also be enriched (if specified as embedded fields in input) with additional data such as the orders status history of the card, the card information.' produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - name: orderType in: query description: Order type to retrieve (CardOrder, PinMailerOrder or TanMailerOrder) required: false type: string - name: embed in: query description: Embedded Fields required: false type: array items: type: string enum: - card - statusHistory collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityListOrder' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/release-orders: post: tags: - Card summary: Release card orders for a card (beta) description: "The API allows orders (card order, PIN mailer order, TAN mailer order) related to a card to be released in case a bank validation is required (before starting the embossing process).\nThe bank validation must be configured in the card creation model corresponding to the order reason (in renewal model for renewal treatment…).\n\nThe main input fields requested by the API are:\no\tThe issuer ID\no\tThe card for which the orders release is requested: It can be provided by using the card reference or the issuer external card reference\n\nAs a result, the orders related to the requested card are orderable." operationId: releaseOrderForCardByCardReference consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityReleaseOrdersResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/release-orders: post: tags: - Card summary: Release card orders for a card by external reference (beta) operationId: releaseOrderForCardByIssuerCardExtRef description: "The API allows orders (card order, PIN mailer order, TAN mailer order) related to a card to be released in case a bank validation is required (before starting the embossing process).\nThe bank validation must be configured in the card creation model corresponding to the order reason (in renewal model for renewal treatment…).\n\nThe main input fields requested by the API are:\no\tThe issuer ID\no\tThe card for which the orders release is requested: It can be provided by using the card reference or the issuer external card reference\n\nAs a result, the orders related to the requested card are orderable." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: ' issuer Card External Reference' required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityReleaseOrdersResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/remind-pin: post: x-wl-idempotent: true tags: - Card summary: Remind pin for a card description: 'The API allows a PIN reminder to be requested for a card, identified by the Issuer Card External Reference or the Card Reference when a cardholder forgot its PIN. The card must be in “ACTIVE” status. As a result, a PIN mailer order is generated. Idempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system.' operationId: remindPIN consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/RemindPINRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityRemindPINResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/reorder-pin: post: x-wl-idempotent: true tags: - Card summary: Reorder new PIN for the card description: 'The API allows to order a new PIN for the card when a cardholder wants to change its PIN. The card must be in "CREATED" or "ACTIVE" status. As a result, a PIN mailer order with PIN REORDER reason is generated. Idempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system.' operationId: reorderPIN consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ReorderPINRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityReorderPINResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/replace: post: x-wl-idempotent: true x-wl-lra-interface: true x-wl-lra-operation: true tags: - Card summary: Replace a card operationId: replaceCard description: "The API allows a card, that has not yet been replaced or renewed, to be replaced when the card is lost/stolen or damaged, or when the customer’s information has changed, by using the Issuer Card External Reference or the Card Reference. \nThe card contract must be ACTIVE with no replacement blocking. No check of the card status is performed. \nThe replacement reason is chosen from the reasons configured beforehand for the issuer.\nData that may need to be changed during replacement can be provided, such as: card data (e.g., embossing name), order data (e.g., card producer if several are allowed), customer data (e.g., name), PIN.\nAs a result, the new card is created, a card order and a PIN mailer order are created when applicable (physical card requested).\n\nIn case a product change on renewal is planned on the contract of the card to be replaced, the card will not be replaced but the product change will be forced instead. From the request, only blocking reason and embossingName/embossingName2ndLine will be considered : \n- If blocking reason is provided (for temporary blocking only), the new card of the new contract is blocked with this reason\n- If embossingName and/or embossingName2ndLine are provided, they will be applied to the old card and will be transferred to the new card of the new contract.\nIn the request response, information related to the new contract and the product change will be returned.\n\nIdempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ReplaceCardRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityReplaceCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/unblock: post: tags: - Card summary: Unblock a card operationId: unblockCard description: 'The API allows to unblock a card identified by the Issuer Card External Reference or the Card Reference. The card must be temporary blocked. The unblocking reason is chosen among the reasons configured beforehand for the issuer. As a result, the card is active again in our system. An issuer cannot request the unblocking of a permanently blocked card.' consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/UnblockCardRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityUnblockCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/blocking-information: get: tags: - Card summary: Retrieve blocking information for a card operationId: retrieveCardBlockingInformation description: 'The API enables the blocking information related to a given card to be retrieved. As a response, a set of information is returned such as : - Blocking reason and blocking date time - The date when our system receives the blocking instruction - If the PIN has been compromised - Additional information in case blocking reason is LOST : Lost date, Loss circumstances, the place or the country where the card has been lost - if a permanent card blocking is scheduled in the future - if the card has been compromised in Common Point of Purchase (card is in CPP list)' produces: - application/json parameters: - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCardBlockingInformation' security: - basic: [] deprecated: false patch: tags: - Card summary: Update blocking information for a card operationId: updateCardBlockingInformationByReference description: "This API can be used but it will no longer evolve. It is recommended to use the Block card API.\n\nThe API enables blocking information related to a given card to be updated such as:\n•\tBlocking reason among those available for the issuer\n•\tBlocking detail\n•\tLost and stolen date if the blocking reason is LOST or STOLEN\n•\tThe fraud process\n•\tThe flag indicating whether the card is in a CPP list\n•\tThe flag indicating whether the PIN is compromised\n•\tScheduled blocking information : delay or blocking reason if the delay is not yet reached" consumes: - application/json produces: - application/json parameters: - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ModifyCardBlockingInformationRequest' - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityModifyCardBlockingInformationResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/blocking-information: get: tags: - Card summary: Retrieve blocking information for a card by external reference operationId: retrieveCardBlockInformationByIssuerExtRef description: 'The API enables the blocking information related to a given card to be retrieved. As a response, a set of information is returned such as : - Blocking reason and blocking date time - The date when our system receives the blocking instruction - If the PIN has been compromised - Additional information in case blocking reason is LOST : Lost date, Loss circumstances, the place or the country where the card has been lost - if a permanent card blocking is scheduled in the future - if the card has been compromised in Common Point of Purchase (card is in CPP list)' produces: - application/json parameters: - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: issuer Card External Reference required: true type: string - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCardBlockingInformation' security: - basic: [] deprecated: false patch: tags: - Card summary: Update blocking information for a card by external reference operationId: updateCardBlockInformationByIssuerExtRef description: "This API can be used but it will no longer evolve. It is recommended to use the Block card API.\n\nThe API enables blocking information related to a given card to be updated such as:\n•\tBlocking reason among those available for the issuer\n•\tBlocking detail\n•\tLost and stolen date if the blocking reason is LOST or STOLEN\n•\tThe fraud process\n•\tThe flag indicating whether the card is in a CPP list\n•\tThe flag indicating whether the PIN is compromised\n•\tScheduled blocking information : delay or blocking reason if the delay is not yet reached" consumes: - application/json produces: - application/json parameters: - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: issuer Card External Reference required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/ModifyCardBlockingInformationRequest' - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityModifyCardBlockingInformationResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/update-all-blocking-information: post: tags: - Card summary: Update blocking information for all cards with same PAN or same PAN Reference operationId: updateAllBlockInformationByIssuer description: "This API can be used but it will no longer evolve. It is recommended to use the Block all cards API.\nThe API is similar to “Update blocking information for a card” API but is applied to all cards having the same PAN or same PAN reference.\nBlocking information can be updated such as:\n•\tBlocking reason among those available for the issuer\n•\tBlocking detail\n•\tLost and stolen date if the blocking reason is LOST or STOLEN\n•\tThe fraud process\n•\tThe flag indicating whether the PIN is compromised\n•\tScheduled blocking information : delay or blocking reason if the delay is not yet reached\nIn response, card information for each matched card is provided." consumes: - application/json produces: - application/json parameters: - name: issuerId in: path description: Issuer ID required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ModifyAllCardsBlockingInformationRequest' - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ModifyAllCardsBlockingInformationResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/advise-product-extension: post: tags: - Card summary: Advice a product extension for a card (beta) operationId: adviceProductExtensionForCard description: "This API is used to get the product extension for a card replacement depending on the configured algorithm.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe card for which the advice is requested: It can be provided by using the card reference or the issuer card external reference. \nThe API returns the product extension advised for the card replacement and also the current product extension of the card." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityAdviceProductExtensionCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/advise-product-extension: post: tags: - Card summary: Advice a product extension for a card by external reference (beta) operationId: adviceProductExtensionForCardByExternalReference description: "This API is used to get the product extension for a card replacement depending on the configured algorithm.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe card for which the advice is requested: It can be provided by using the card reference or the issuer card external reference. \nThe API returns the product extension advised for the card replacement and also the current product extension of the card." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityAdviceProductExtensionCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/disputes: get: tags: - Card summary: List DisputeFolders for a card operationId: listDisputeFoldersByCardReference description: "The API returns the list of dispute folders for a given card, identified by his card identifier.\n\nFor each dispute folder provided, the content of the dispute is retrieved:\n•\tGeneral dispute folder information including the dispute reason, the status\n•\tCardholder information including the card status and billing amount\n•\tThe issuer accounting balance\n•\tThe transaction details including the reconciliation amount, the transaction type and merchant information\n\nFor each dispute folder, the response can also be enriched (if specified as embedded fields in input) with additional data relative to the events added, the postings performed, the documents attached, and the messages sent or received from the scheme. This corresponds to the dispute cycle history." produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - name: embed in: query description: Embedded Fields required: false type: array items: type: string enum: - events - postings - documents - messages collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityListDispute' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/new-tan: post: x-wl-idempotent: true tags: - Card summary: Create new TAN operationId: createTan description: "For PIN self-selection without a direct bank connection to the card issuing institute - i.e., without online banking access - Worldline offers the variant PIN change with TAN (Trusted Authentication Number). \nThis applies in particular to card programs where the bank is the card issuer for another partner, e.g., TUI or eBay.\nThe API allows to generate a TAN, which is used as a one-time password, printed and sent to cardholder in order to change card pin by e.g. IVR.\n\nIdempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: Card Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateTanRequest' responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateTanResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/disputes: get: tags: - Card summary: List DisputeFolders for a card by external reference operationId: listDisputeFoldersByIssCardExtRef description: "The API returns the list of dispute folders for a given card, identified by his card identifier.\n\nFor each dispute folder provided, the content of the dispute is retrieved:\n•\tGeneral dispute folder information including the dispute reason, the status\n•\tCardholder information including the card status and billing amount\n•\tThe issuer accounting balance\n•\tThe transaction details including the reconciliation amount, the transaction type and merchant information\n\nFor each dispute folder, the response can also be enriched (if specified as embedded fields in input) with additional data relative to the events added, the postings performed, the documents attached, and the messages sent or received from the scheme. This corresponds to the dispute cycle history. " produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: Issuer Card External Reference required: true type: string - name: embed in: query description: Embedded Fields required: false type: array items: type: string enum: - events - postings - documents - messages collectionFormat: multi responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityListDispute' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/{cardReference}/create-emergency-card: post: x-wl-idempotent: true tags: - Card summary: ' Create Emergency Card' operationId: createEmergencyCard description: "Emergency Card is a type of card that can be provided to a customer in emergency cases (for example, a customer has lost his card, while travelling outside his country and urgently needs a new card). The customer will call 24-hour service and request an Emergency Card. \nIn general, those cards will have short validity period and will not be renewed and replaced. Emergency Card is not produced by the issuer but by the scheme. \n\nThe emergency card creation is possible in our system only if an Emergency Card product is defined for the issuer and if the contract of the customer is allowed to issue an Emergency Card.\n\nThe API allows to create an emergency card for a given card.\n\nIdempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once. The response will be retrieved directly from our system." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: cardReference in: path description: cardReference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateEmergencyCardResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card: post: x-wl-idempotent: true tags: - Card summary: ' Create Emergency Card by external reference' operationId: createEmergencyCardByIssuerExtRef description: "Emergency Card is a type of card that can be provided to a customer in emergency cases (for example, a customer has lost his card, while travelling outside his country and urgently needs a new card). The customer will call 24-hour service and request an Emergency Card. \nIn general, those cards will have short validity period and will not be renewed and replaced. Emergency Card is not produced by the issuer but by the scheme. \n\nThe emergency card creation is possible in our system only if an Emergency Card product is defined for the issuer and if the contract of the customer is allowed to issue an Emergency Card.\n\nThe API allows to create an emergency card for a given card.\n\nIdempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system." consumes: - application/json produces: - application/json parameters: - name: WL-Correlation-ID in: header required: false type: string - name: WL-Origin in: header required: false type: string - name: WL-Username in: header required: false type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: Issuer ID required: true type: string - name: issuerCardExternalReference in: path description: issuerCardExternalReference required: true type: string responses: '400': description: Bad request schema: $ref: '#/definitions/BadRequestErrorApiResponse' '401': description: Unauthorized schema: $ref: '#/definitions/UnauthorizedErrorApiResponse' '403': description: Forbidden schema: $ref: '#/definitions/ForbiddenErrorApiResponse' '404': description: Not found schema: $ref: '#/definitions/NotFoundErrorApiResponse' '500': description: Internal server error schema: $ref: '#/definitions/InternalServerErrorErrorApiResponse' '502': description: Bad gateway schema: $ref: '#/definitions/BadGatewayErrorApiResponse' '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateEmergencyCardResponse' security: - basic: [] deprecated: false definitions: CustomerIdentifier: type: object description: Identification of the updated customer either by Issuer customer external reference or by customer reference properties: customerReference: type: string description: Reference computed internally by our system issuerCustomerExternalReference: type: string description: Reference provided by the Issuer title: CustomerIdentifier CardIdentifier: type: object description: Identification of the card either by Issuer card external reference or by card reference properties: cardReference: type: string description: 'Reference of the card generated by our system, unique per platform. This reference is calculated sequentially by an internal algorithm on 16 digits (e.g. 2000000000096013).' issuerCardExternalReference: type: string description: 'External reference of the card provided by the issuer or calculated by the system if the external reference generation algorithm is configured for the issuer. This reference is unique per issuer and may be used to carry out research and find information.' title: CardIdentifier ModifyCustomerRequest: x-wl-patch-request: true type: object properties: active: type: boolean description: DEPRECATED default: true courtesyTitle: type: string description: 'Refer to Customer.courtesyTitle ' lastName: type: string description: Refer to Customer.lastName. Only mandatory when using PUT method firstName: type: string description: Refer to Customer.firstName. Only mandatory when using PUT method onlineRiskCategory: type: string example: Standard description: 'Only when using PUT method : If this field is not provided and a default value is configured, the default value will be used. Otherwise, the issuer must provide an online risk category among those allowed' offlineRiskCategory: type: string example: Standard description: 'Only when using PUT method : If this field is not provided and a default value is configured, the default value will be used. Otherwise, the issuer must provide an offline risk category among those allowed.' commercialStatus: type: string example: Normal description: 'Only when using PUT method : If this field is not provided and a default value is configured, the default value will be used. Otherwise, the issuer must provide a commercial status among those allowed.' secondFirstName: type: string description: Refer to Customer.secondFirstName maidenName: type: string description: Refer to Customer.maidenName correspondenceName: type: string description: Refer to Customer.correspondenceName sex: type: string description: Refer to Customer.sex birthDate: type: string format: date-time description: 'Refer to Customer.birthDate ' birthPlace: type: string description: 'Refer to Customer.birthPlace ' nationality: type: string description: Refer to Customer.nationality profession: type: string description: 'Refer to Customer.profession ' employerName: type: string description: Refer to Customer.employerName employerAddress: type: string description: Refer to Customer.employerAddress monthlySalary: type: string description: 'Refer to Customer.monthlySalary ' maritalStatus: type: string description: Refer to Customer.maritalStatus preferredCorrespondenceLanguage: type: string description: Refer to Customer.preferredCorrespondenceLanguage picture: type: string description: 'Refer to Customer.picture ' url1: type: string description: Refer to Customer.url1 url2: type: string description: Refer to Customer.url2 secretQuestion: type: string description: Refer to Customer.secretQuestion secretAnswer: type: string description: Refer to Customer.secretAnswer vatNumber: type: string description: Refer to Customer.vatNumber vatCountry: type: string description: Refer to Customer.vatCountry customerClass: type: string description: Refer to Customer.customerClass employee: type: boolean description: 'Refer to Customer.employee ' partnerExternalReference: type: string description: Refer to Customer.partnerExternalReference doNotContact: type: boolean description: Refer to Customer.doNotContact specificFields: type: object description: "The issuer can update Specific Fields for the customer. \nIt is a list of external data {\"label\":\"value\"} separated by a \",\" related to the customer (pass-thru data) that can be provided by e.g. the issuer for information or for usage by other systems.\nA new data can be added or an existing data can be updated {\"label1\":\"newValue\"} or removed {\"label2\":\"null\"}.\nAny existing data that is not present in this list is not updated in the customer.\nThose provided data have no impact on our system business processes." additionalProperties: type: string vulnerabilities: description: List of vulnerabilities applicable to the customer. type: array items: $ref: '#/definitions/Vulnerability' vulnerabilityIndicator: type: boolean description: indicates if the client is vulnerable vulnerabilityNote: type: string description: note about the client's vulnerability (free text) contacts: type: array description: List of contacts linked to the customer items: $ref: '#/definitions/ModifyCustomerRequestContact' title: ModifyCustomerRequest DisputeMessage: type: object properties: type: type: string description: Identifies the type de the message FIRST_PRESENTMENT, CHARGEBACK etc ... associated to the Dispute Folder status: type: string description: Status of the message associated to the Dispute Folder creationDate: type: string format: date-time description: Date of the message creation associated to the Dispute Folder amount: description: Amount in Scheme Reconciliation Currency of the message creation associated to the Dispute Folder allOf: - $ref: '#/definitions/Amount' reasonCode: type: string description: Reason Code of the message associated to the Dispute Folder reasonCodeDescription: type: string description: Description of the Reason Code of the message associated to the Dispute Folder reverseFlag: type: boolean description: Identifies if the message is reversed or not schemeCaseId: type: string description: The Scheme Case Id received from the Scheme VROL or MasterCom related to a chargeback message title: DisputeMessage ProductIdentifier: type: object properties: issuerProductExternalReference: type: string description: Product External Reference provided by the issuer productReference: type: string description: Reference of the product in our system, unique per platform title: ProductIdentifier DeactivateCardResponse: type: object properties: cardIdentifier: description: Card Identifier allOf: - $ref: '#/definitions/CardIdentifier' status: type: string description: Card status after card deactivation request (DEACTIVATED/CANCELLED) reason: type: string description: Deactivation reason provided in the request deactivationDateTime: type: string format: date-time description: Date and time when the card has been deactivated in the system title: DeactivateCardResponse ReleasedOrder: type: object required: - orderIdentifier - orderType - orderReason - currentInternalStatus properties: orderIdentifier: description: Order Identifier allOf: - $ref: '#/definitions/OrderIdentifier' orderType: type: string description: 'The order can correspond to a card, a PIN mailer or a TAN mailer.Possible values are : CardOrder, PinMailerOrder, TanMailerOrder' orderReason: type: string description: 'Reason why the order is done ' currentInternalStatus: type: string description: Current internal status of the order currentInternalStatusDate: type: string format: date-time description: Last modification date of the internal status of the order title: ReleasedOrder CardEvent: type: object properties: eventType: type: string example: CardActivation, CardIssuing, CardCancellation, CardDeactivation, CardBlocking, CardUnblocking description: "Type of an event associated to a card \n Example: CardActivation, CardIssuing (can be first issuing or replacement or renewal), CardCancellation, CardDeactivation, CardBlocking, CardUnblocking" eventDate: type: string format: date-time description: 'Date time when an event is performed on the card by our system (mandatory) Example: blocking card, unblocking card, replacement card' reason: type: string description: 'Reason associated to a card status (mandatory) The list of reasons is configurable per issuer (example: ActivationReason, CancellationReason, DeactivationReason, CardBlockingReason)' comment: type: string description: A comment (free text) used in case of blocking or unblocking a card (optional) waiveFee: type: boolean description: Indicates if the fee was waived (true) or not (false). By default, value is false. blockingInformation: description: Information related to the card blocking (present if the card is blocked) allOf: - $ref: '#/definitions/CardBlockingInformation' pinChangeInformation: description: Information related to the pin change (present if the event type if PinChange) allOf: - $ref: '#/definitions/PinChangeInformation' feeConditions: type: array description: Fee conditions for this kind of event items: $ref: '#/definitions/FeeCondition' title: CardEvent ApiResponseEntityRemindPINResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/RemindPINResponse' description: Issuer response entity title: ApiResponseEntityRemindPINResponse ApiResponseEntityUnblockAllCardsResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/UnblockAllCardsResponse' description: Issuer response entity title: ApiResponseEntityUnblockAllCardsResponse DisputePosting: type: object properties: postingAmount: description: Amount in Scheme Reconciliation Currency associated to the posting (message, write off, cardholder refund ...) allOf: - $ref: '#/definitions/Amount' message: type: string description: Message information for the posting immediateReimbursement: type: boolean description: Optional parameter for impacting cardholder account immediatly postingTypeReference: type: string description: 'Identifier of the external reference of the posting. The list of values are configured by issuer: Three family of postings type: - Cardholder: For impacting the cardholder account, possible values can be: ''Cardholder Account'', ''POST TO OTHER ACCOUNT'' - Issuer: Write off: possible values can be ''ISSUER_ACCOUNT'', ''PROFIT AND LOSS'', ''FRAUD'' - Foreign exchange fee (''FOREIGN_EXCHANGE_FEE''), Financial Advice Exchange Rate Difference (''ADVANCE_EXCHANGE_RATE_DIFFERENCE''): the dispute officer can manually create a dispute posting amount to this account' operationReference: type: string description: Internal reference of a transaction in external service, is needed for posting to cardholder account. disputeAdjustmentType: type: string description: Dispute adjustment type creationDate: type: string format: date-time description: Date of posting creation title: DisputePosting EncryptedPan: type: object properties: encryptedValue: type: string publicKeyIdentifier: type: string title: EncryptedPan ModifyAllCardsBlockingInformationResponse: x-wl-api-response: true type: object required: - responseMetadata - data properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/BlockAllCardsResponse' description: Issuer response entity title: ModifyAllCardsBlockingInformationResponse PinInheritanceExternalCardIdentifier: type: object properties: pinInheritanceExternalCardReference: type: string description: Reference of the external card used when the card is only known by the PIN management module (used in migration context) title: PinInheritanceExternalCardIdentifier ApiResponseEntityUnblockCardResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/UnblockCardResponse' description: Issuer response entity title: ApiResponseEntityUnblockCardResponse ApiResponseEntityDeclareCounterfeitCardResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/DeclareCounterfeitCardResponse' description: Issuer response entity title: ApiResponseEntityDeclareCounterfeitCardResponse ExternalAuthorizationsRestrictionIdentifier: type: object properties: authorizationRestrictionReference: type: string title: ExternalAuthorizationsRestrictionIdentifier ApiResponseEntityListCard: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: type: array description: Response data items: $ref: '#/definitions/Card' description: Issuer response entity title: ApiResponseEntityListCard ReplaceCardRequestCardOrder: type: object description: Card Order for the new card.Empty if no card order needed for the card properties: specificFields: type: object description: 'The issuer can provide Specific Fields for the card order. It is a list of external data {"label":"value"} separated by a "," related to the card order (pass-thru data) that can be provided by e.g. the issuer for information or for usage by other systems. Example : {"label1":"value1","label2":"value2"} Those provided data have no impact on our system business processes' additionalProperties: type: string cardProducer: type: string description: The issuer can indicate a card producer (to be used instead of the default one from card profile). sendingMode: type: string description: 'The issuer must provide the sending mode for a physical card if no default sending mode is defined for the replacement reason in the replacement model. In the other cases, the sending mode is optional (for a virtual card or if the skipCardOrderGeneration field is set to true or for a physical card if a default sending mode has been defined for the replacement reason).' deliveryChannel: type: string description: 'The issuer can provide the delivery channel if a creation of a card order is requested (if skipCardOrderGeneration field is set to false). By default, the delivery channel from the distribution rule of the card product will be used.' deliveryType: type: string description: 'Indicates whether the delivery of the card should be to branch or customer (instead of the one from the distribution rule of the card product) Possible values are: CUSTOMER, BRANCH To override the delivery address, the card delivery type must not be provided and only one of these fields must be provided: customDeliveryAddress, customDeliveryEmail or customDeliveryPhone.' deliveryBranchCode: type: string description: 'The issuer must provide the card delivery branch code if the delivery type is BRANCH. Refer to Order.deliveryBranchCode' customDeliveryAddressee: type: string description: 'Refer to Order.customDeliveryAddressee When the customDeliveryAddress is provided, the field must also be provided.' customDeliveryAddress: description: 'Refer to Order.customDeliveryAddress. The customDeliveryAddressee must also be provided when the field is provided.' allOf: - $ref: '#/definitions/CreateAddressRequestMailAddress' customDeliveryEmail: description: Refer to Order.customDeliveryEmail allOf: - $ref: '#/definitions/EmailAddress' customDeliveryPhone: description: Refer to Order.customDeliveryPhone allOf: - $ref: '#/definitions/CreateAddressRequestPhoneNumber' skipCardOrderGeneration: type: boolean description: 'Card order will be not generated if this field is true. If this field is false or empty, the card order will be generated as per the product configuration. By default, value is false.' default: false title: ReplaceCardRequest.CardOrder ApiResponseEntityAdviceProductExtensionCardResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/AdviceProductExtensionCardResponse' description: Issuer response entity title: ApiResponseEntityAdviceProductExtensionCardResponse BlockAllCardsResponse: type: object required: - cards properties: cards: type: array description: List of cards and associated data items: $ref: '#/definitions/BlockAllCardsResponseCard' title: BlockAllCardsResponse ApiResponseEntityModifyCardBlockingInformationResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: $ref: '#/definitions/ModifyCardBlockingInformationResponse' title: ApiResponseEntityModifyCardBlockingInformationResponse ModifyCustomerRequestContact: x-wl-patch-request: true type: object properties: name: type: string description: Refer to Contact.lastName firstName: type: string description: 'Refer to Contact.firstName ' description: type: string description: 'Refer to Contact.description ' courtesyTitle: type: string description: 'Refer to Customer.courtesyTitle ' sex: type: string description: Refer to Contact.sex type: type: string description: Refer to Contact.type birthDate: type: string format: date-time description: 'Refer to Contact.birthDate ' postalAddress: description: The postal adress of the contact allOf: - $ref: '#/definitions/ModifyAddressRequestMailAddress' title: ModifyCustomerRequestContact ApiResponseEntityListDispute: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: type: array description: Response data items: $ref: '#/definitions/Dispute' description: Issuer response entity title: ApiResponseEntityListDispute Order: type: object properties: issuerId: type: string description: Issuer identifier (unique per platform) orderType: type: string description: 'The order can correspond to a card, a PIN mailer or a TAN mailer. Possible values are : CardOrder, PinMailerOrder, TanMailerOrder' orderIdentifier: description: 'Unique identifier of the order (mandatory) Refer to OrderIdentifier data type for detail information' allOf: - $ref: '#/definitions/OrderIdentifier' currentExternalStatus: type: string description: 'Current external status of the order (optional) The list of external statuses is configurable per issuer. The external status can be used to follow the card producing status for the card order e.g. received, embossed, sent, etc.' currentExternalStatusDate: type: string format: date-time description: Modification date of the last external status of the order (optional) currentInternalStatus: type: string description: 'Current internal status of the order (mandatory) Possible values: are: CREATED, CONFIRMED, ORDERED, REJECTED, CANCELLED, FINISHED, ORDERABLE' currentInternalStatusDate: type: string format: date-time description: Last modification date of the internal status of the order (optional) sendingMode: type: string description: 'Code identifying the desired sending mode for the order (mandatory) Example: Normal, Urgent, Ultra Urgent' deliveryChannel: type: string description: 'Code of the delivery channel for the card The list of delivery channels is configurable per Issuer.' deliveryType: type: string description: 'Indicates whether the delivery of the card should be to branch or customer (instead of the one from the distribution rule of the card product) (optional) Possible values: CUSTOMER (the card is to be delivered to the customer address, BRANCH (the card is to be delivered to the bank branch)' orderReason: type: string description: 'Reason why the order is done (mandatory) Possible values are: CARD_RENEWAL, PIN_CARD_RENEWAL, FIRST_CARD_ISSUE, FIRST_PIN_CARD_ISSUE, CARD_REPLACEMENT, PIN_CARD_REPLACEMENT, PIN_REMINDER, PIN_REORDER, TAN_REQUEST' statusHistory: type: array description: 'List of order status history data Refer to OrderStatusHistory data type for detail information. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' items: $ref: '#/definitions/OrderStatusHistory' cardProducer: type: string description: 'It is the card producer or embosser. It is present if it is different than the default one (defined in the card profile) and was provided when requesting the card creation. The list of allowed card producer is configurable per issuer.' pinMailerEditor: type: string description: 'It is the PIN mailer printer. It is present if it is different than the default one (defined in the card profile) and was provided when requesting the card/PIN creation. The list of allowed PIN mailer editors is configurable by issuer.' deliveryBranchCode: type: string description: 'Code of the delivery branch (mandatory only if card delivery type is BRANCH) The list of issuer branches is configurable per Issuer. The branch code is used to access a preconfigured Postal address (configured in the system).' customDeliveryAddressee: type: string description: "Custom postal address to send the order \n Depending on countries, the address format (mainly for line1, line 2, line3, line4 and line5) can have specific conditions such as length restriction. The customer should contact WL to check the address format and have more information." customDeliveryAddress: description: 'Custom postal address to send the order Depending on countries, the address format (mainly for line1, line 2, line3, line4 and line5) can have specific conditions such as length restriction. The customer should contact WL to check the address format and have more information.' allOf: - $ref: '#/definitions/MailAddress' customDeliveryPhone: description: 'Custom phone to send the card. NOT USED' allOf: - $ref: '#/definitions/PhoneNumber' customDeliveryEmail: description: 'Custom email to send the card. NOT USED' allOf: - $ref: '#/definitions/EmailAddress' specificFields: type: object description: 'List of external data {"label":"value"} separated by a "," related to an order that can be provided by e.g. the issuer for information or for usage by other systems. Example : {"label1":"value1","label2":"value2"} Those provided data have no impact on our system business processes.' additionalProperties: type: string card: description: 'Card information related to the order. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/Card' cardIdentifier: description: Unique identifier of the card allOf: - $ref: '#/definitions/CardIdentifier' embossingFileName: type: string description: Embossing file name in CardOrder tanOrigin: type: string description: Origin of the TAN request, e.g. GUI. (free text) tanBackupMethod: type: string description: The backup method that should be applied for TAN mailer order. tanExpiryDate: type: string format: date-time description: Expiry date of the TAN, date until which the TAN can used (mandatory for TanMailerOrder) tanStatus: type: string description: 'Status of the TAN (mandatory for TanMailerOrder) Possible values: CREATED, FAILED, ACTIVE, USED, EXPIRED' freeTanMailerCounter: type: integer description: Number of free TAN requests (optional) tanUsageDate: type: string format: date-time description: Date when the TAN was used to change the PIN (optional) free: type: boolean description: Indicates if the operation is free (true) or not (false). Default value is false (mandatory) tanValue: type: string description: Clear value of the TAN (mandatory for TanMailerOrder) feeConditions: type: array description: Conditions of the fee generation (if fee configured in the product) (optional) items: $ref: '#/definitions/FeeCondition' notExtractedReason: type: string description: In case the order will not be extracted because of invalid customer address, then it will be indicated in this field notExtractedUpdateDate: type: string format: date-time description: The last update date of notExtractedReason field waitingPin: type: boolean format: date-time description: 'This flag is used only for a card order or a PIN mailer order. - If this flag is true, the PIN is waiting to be provided by the cardholder (the mode “Self Selected Pin” is activated in the PIN production model). Depending on the configuration, after x days, the card is extracted with a default PIN if the cardholder has not provided a PIN. - If this flag is false, the PIN is not waiting to be provided , e.g. the PIN has been generated by PMM or provided by the cardholder.' title: Order ChangedContract: type: object description: Only if a product change is triggered by card replacement. Represents the new contract data after product change has occured properties: contractIdentifier: description: Identification of the contract either by the Issuer contract external reference or the Contract reference. allOf: - $ref: '#/definitions/ContractIdentifier' status: type: string description: 'Current status of the contract. Refer to Contract.status' creationDate: type: string format: date-time description: Date of creation of the contract signatureDate: type: string format: date-time description: Date of signature of the contract contractOwnerIdentifier: description: contract owner identifier allOf: - $ref: '#/definitions/CustomerIdentifier' productIdentifier: description: Identification of the product change identified either by the Issuer Product External Reference or the Product Reference. allOf: - $ref: '#/definitions/ProductIdentifier' accounts: type: array items: $ref: '#/definitions/ChangedAccount' cardContracts: type: array items: $ref: '#/definitions/ChangedCardContract' originalContractIdentifier: description: Identification of the original contract either by the Issuer contract external reference or the Contract reference. allOf: - $ref: '#/definitions/ContractIdentifier' title: ChangeProductResponse.ChangedContract DeactivateCardRequest: type: object required: - reason properties: reason: type: string description: Deactivation reason chosen among the reasons configured for the issuer title: DeactivateCardRequest ForbiddenErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/ForbiddenResponseMetadata' title: ForbiddenErrorApiResponse BlockAndReplaceCardRequest: type: object required: - blockCardRequest - replaceCardRequest properties: blockAllCardsWithSamePan: type: boolean description: 'This flag indicates if all cards having the same PAN as the card in input have to be blocked as well (true). The default value is false (only the card in the input is blocked).' default: false blockCardRequest: description: Refer to BlockCardRequest allOf: - $ref: '#/definitions/BlockCardRequest' replaceCardRequest: description: Refer to ReplaceCardRequest allOf: - $ref: '#/definitions/ReplaceCardRequest' title: BlockAndReplaceCardRequest DisputeEvent: type: object properties: type: type: string description: Dispute Event Type (values shared between WL and the issuer) message: type: string description: Description of the event external: type: boolean description: Indicates if the event is external (value true) or internal (value false) creationDate: type: string format: date-time description: Date of the event creation title: DisputeEvent ReplaceCardResponse: x-wl-sensitive-data: true type: object properties: card: description: Card Information Mandatory for card replacement process Not filled in case of product change, triggered by card replacement (originalContract and changedContract include card information) allOf: - $ref: '#/definitions/ReplaceCardResponseCard' replacementForCardStatus: type: string description: Card Status of the card to be replaced (mandatory for card replacement process) replacementReason: type: string description: Replacement Reason provided in the request (mandatory for card replacement process) cardReplacementDateTime: type: string format: date-time description: System Date time when the card is replaced by our system (mandatory for card replacement process) newRelatedCardList: description: 'List of cards linked to the replaced card that have been replaced as well (cards from multi cards product) For each replaced card, information such as card status, cardReference/issuerCardExternalReference, replacement reason, card replacement date and time is returned, new PAN.' type: array items: $ref: '#/definitions/ReplaceCardResponse' originalContract: description: Only if a product change is triggered by card replacement.Represents the original contract data before product change has occured allOf: - $ref: '#/definitions/OriginalContract' changedContract: description: Only if a product change is triggered by card replacement.Represents the new contract data after product change has occured allOf: - $ref: '#/definitions/ChangedContract' productChangeInformation: description: Only if a product change is triggered by card replacement.Represents product change information allOf: - $ref: '#/definitions/ProductChangeInformation' title: ReplaceCardResponse Card: type: object required: - issuerId properties: issuerId: type: string description: Issuer identifier (unique per platform) cardIdentifier: description: Identification of the card either by Issuer card external reference or by card reference allOf: - $ref: '#/definitions/CardIdentifier' encryptedPan: description: This field returns the encrypted PAN and the public key identifier if the encryption is activated on the platform. allOf: - $ref: '#/definitions/EncryptedPan' pan: type: string description: "Primary Account Number (PAN) also called card number (mandatory) \n It is calculated by our system from the BIN range associated to the card product or provided by the issuer." maskedPan: type: string description: "Masked Primary Account Number (PAN) of the card (optional). \nExample: 445442******0275\nThe mask is defined per platform." panReference: type: string description: "Reference related to the PAN\nCards having the same PAN have the same PAN reference.\nPAN reference is generated in the system according to the following algorithm : \n1 (VISA) or 2 (MCI) + 3 last digit of issuer + UUID (without the -)\nExample : 1006f041ae6814bf4f068aa501141c85d57d" expiryDate: type: string description: 'Card expiry date (mandatory) Format is MMYY (month and year)' panSequenceNumber: type: string description: PAN sequence number is a number (usually from 1 to N) that allows identifying either cards with same PAN or cards with same PAN and same Expiry date status: type: string description: "Current status of the card (mandatory) \n Possible values: CREATED, ACTIVE, BLOCKED, DEACTIVATED, CANCELLED\n Status of the card (mandatory)\n The card status is changing during its life cycle according to business processes in the system.\n Possible values are :\n CREATED : The first status when the card is created. The card is not usable.\n ACTIVE : Card is active and ready for authorizations processing\n Examples of business processes triggering this status: contract creation request as per product configuration, card activation request, contract creation after a product change request.\n BLOCKED : card is blocked permanently (final status) or temporarily. Related authorizations are declined.\n DEACTIVATED : Card is deactivated (final status) and related authorizations are declined\n Examples of business processes triggering this status: contract closing request, card contract closing, contract closure after a product change request. Card was in ACTIVE status previously.\n CANCELLED : Card is cancelled (final status). Card has never been activated.\n Examples of business processes triggering this status: contract closing request, card contract closing, contract closure after a product change request. Card was in CREATED status previously." statusDate: type: string format: date-time description: Last card status change date (mandatory) externalStatus: type: string description: 'External status of the card Possible values are: - IN_PROGRESS (it implies the card has not registered in all the WL systems) - CREATED (it implies the card is registered in all the WL systems and ready for use) - ERROR (the synchronization process between WL systems is failed)' statusHistory: type: array description: 'List of card status history Refer to resource CardStatusHistory for detail information _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' items: $ref: '#/definitions/CardStatusHistory' embossingName: type: string description: 'First line of the name embossed on the physical card (mandatory) It can be provided by the issuer or calculated by our system (if allowed within card Technology and Application model and depending on the selected embossing name calculation algorithm)' embossingName2ndLine: type: string description: 'Second line of the name embossed on the physical card, optional, can be provided only in addition to the first line. It can be provided by the issuer or calculated by our system (if embossing name is required within card Technology and Application model and depending on the selected embossing name calculation algorithm)' embossingLine5: type: string description: 'Specific additional embossing line that can be used by the issuer (mandatory only if required within card Technology and Application model) It is sent out to the embosser with card order.' artwork: type: string description: Artwork (card design) used for the physical card (mandatory) permanentlyBlocked: type: boolean description: Indicates if the card is permanently blocked (true) or not (false). Default value is false emergencyCard: type: boolean description: This attribute indicates if the card is an emergency card (scheme emergency card service). emergencyCashAdvance: type: boolean description: Deprecated - Not used renewed: type: boolean description: Indicates if the card is renewed (true) or not (false). Default value is false replaced: type: boolean description: Indicates if the card is replaced (true) or not (false). Default value is false replacementReason: type: string description: 'Reason for replacing a card (mandatory only if the card is replaced) The list of replacing reasons is configurable per issuer (For example, LOST, STOLEN, FRAUDULENT …)' blockingReason: type: string description: 'Reason for blocking a card (mandatory only if card status is blocked) The list of blocking reasons is configurable per issuer (For example, LOST, STOLEN, FRAUDULENT …)' pinInheritanceCardIdentifier: description: Identifier of the card from which the PIN is inherited (card is known in the issuing system). allOf: - $ref: '#/definitions/PinInheritanceCardIdentifier' pinInheritanceCardReference: type: string description: Deprecated pinInheritanceExternalCardIdentifier: description: Identifier of the external card used when the card is only known by the PIN management module. allOf: - $ref: '#/definitions/PinInheritanceExternalCardIdentifier' specificFields: type: object description: 'List of external data {"label":"value"} separated by a "," related to a card that can be provided by e.g. the issuer for information or for usage by other systems. Example : {"label1":"value1","label2":"value2"} Those provided data have no impact on our system business processes.' additionalProperties: type: string renewedBy: description: 'Card identifier of the new card created during the renewal process. Relevant information for the renewed card. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/CardIdentifier' replacementBy: description: 'Card identifier of the new card created during the replacement process. Relevant information for the replaced card. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/CardIdentifier' renewedFor: description: 'Card identifier of the renewed card. Relevant information for the new card created during the renewal process. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/CardIdentifier' replacementFor: description: 'Card identifier of the replaced card. Relevant information for the new card created during the replacement process. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/CardIdentifier' cardContractIdentifier: description: Card Contract Identifier allOf: - $ref: '#/definitions/CardContractIdentifier' cardContract: description: 'Card Contract _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/CardContract' orderIdentifiers: type: array description: 'Order Identifiers _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' items: $ref: '#/definitions/OrderIdentifier' orders: type: array description: 'List of orders linked to the Card _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' items: $ref: '#/definitions/Order' isCardDigitalizationAllowed: type: boolean description: "Indicates if the digitalization of the card is allowed (true) or not (false, default value). \nThis attribute is returned during wallets (e.g. GooglePay, ApplePay) enrollment process to e.g. the Issuer TSP (in case the card digitalization is not allowed then the Issuer TSP should decline the enrollment)." default: false multiCardInfo: description: Multi card set if the card belongs to a multi card set allOf: - $ref: '#/definitions/MultiCardInfo' cardScheme: type: string description: 'Card scheme to which the BIN of the card is belonging ' virtual: type: boolean description: Indicates if the card is physical or virtual contactlessEnabled: type: boolean description: Indicates if the chip contactless capability enabled or not technologyType: type: string description: "Technology of the card (code/short name)\nPossible values are : \n- VIRTUAL\n- EMV\n- MAGSTRIPE\n- EMV_MAGSTRIPE\n- CONTACT_ONLY (contact only for EMV card with magstripe)\n- DUAL_INTERFACE (contact+contactless for EMV card with magstripe)" techAndAppModelName: type: string description: Technology and application model name of the card photoReference: type: string description: Reference of the photo sent to the embosser and retrieved from the card contract during the card order extraction (optional). pictureReference: type: string description: Reference of the picture sent to the embosser and retrieved from the card contract during the card order extraction (optional). logoReference: type: string description: 'Reference of the company logo sent to the embosser and retrieved from the card contract during the card order extraction (optional). Relevant only for corporate cards.' dispatchCode: type: string description: If present the dispatch code is sent to the embosser. The dispatch code defines the corporate card orders delivery address which is known and managed by the embosser (Corporate cards only). If not present the standard process is applied to retrieve the card delivery address. automaticDeactivationDate: type: string format: date-time description: Date when the card is deactivated automatically (x days after its replacement if the feature is enabled). contractType: type: string description: "Indicates if the card is a consumer (private) or corporate card. \n Possible values: \n CORPORATE \nCONSUMER " enum: - CORPORATE - CONSUMER cardDeactivationRuleOverride: type: string description: 'Indicates which card deactivation rule is enabled for the card. It overrides the product card deactivation rule Possible value : FIRST_APPROVED_AUTHO (1st approved online authorization)' partnerExternalCardReference: type: string description: This reference is generated by our system using rules define with the issuer that needs it. recovered: type: boolean description: Indicates if the card is recovered (true) or not (false). Default value is false. recoveryDate: type: string format: date-time description: Date when the card was recovered. Only relevant if the card is recovered. lastSavingMeasureCode: type: string description: 'Indicates the last saving measure applied (a saving measure is used to forbid some actions or remove the forbidding. For example: block the card replacement, the card renewal, the PIN mailer reprint)' title: Card FeeCondition: type: object properties: description: type: string description: Conditions of the fee generation for the event (optional) operationType: type: string description: 'Contains the type of the operation on which the criteria applies For example: PinOrderIssuing - PIN_REQUEST (optional)' criteria: type: string description: 'Criteria of the fee condition For example: (counter[''ALL''] - counter[''IVR''] ) > 1 => If the condition is successfull, one Fee is allocated (optional)' title: FeeCondition CreateTanResponse: type: object properties: orderIdentifier: $ref: '#/definitions/OrderIdentifier' currentInternalStatus: type: string example: ORDERABLE description: Current internal status of the order (mandatory). orderType: type: string example: CardOrder, TanMailerOrder, PinMailerOrder description: Type of the order. title: CreateTanResponse MailAddress: type: object required: - country properties: typeCode: type: string description: Deprecated field line1: type: string description: Address line 1 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line2: type: string description: Address line 2 (optional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line3: type: string description: Address line 3 (optional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line4: type: string description: Address line 4 (optional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line5: type: string description: Address line 5 (optional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). buildingNumber: type: string description: Building number of the address (optional) boxNumber: type: string description: Box number of the address (optional) streetName: type: string description: Street name of the address (optional) postCode: type: string description: Zip Code of the address (optional) townName: type: string description: 'City corresponding to the address ' countrySubdivision: type: string description: Subdivision of the country (optional) country: type: string description: Code of the country (mandatory). Free text. The value can be subject to a validation process if a specific rule has been configured at issuer level. The value can be optional if a specific rule has been configured. countryName: type: string description: Country Name of the address. Free text courtesyTitle: type: string description: Courtesy title of the address. Free text title: MailAddress ApiResponseEntityListOrder: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: type: array description: Response data items: $ref: '#/definitions/Order' description: Issuer response entity title: ApiResponseEntityListOrder NotFoundErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/NotFoundResponseMetadata' title: NotFoundErrorApiResponse BadGatewayErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/BadGatewayResponseMetadata' title: BadGatewayErrorApiResponse InternalServerErrorErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/InternalServerErrorResponseMetadata' title: InternalServerErrorErrorApiResponse InternalServerErrorResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated statusCode: type: integer format: int32 example: 500 description: HTTP status code statusMessage: type: string example: Internal server error description: Executed REST API status message title: InternalServerErrorResponseMetadata UnblockCardResponse: type: object properties: status: type: string description: Card status after the unblocking request (ACTIVE) cardIdentifier: description: Refer to Card.Identifier allOf: - $ref: '#/definitions/CardIdentifier' comment: type: string description: Comment provided in the request for the card unblocking cardUnblockingDateTime: type: string format: date-time description: Date and time when the card has been unblocked in the system title: UnblockCardResponse ProductExtensionIdentifier: properties: issuerProductExtensionExternalReference: description: External reference of the product extension provided by the issuer and defined for a product (e.g. it can be used when adding cards and accounts to a contract ) type: string title: ProductExtensionIdentifier type: object UnblockAllCardsResponseCard: type: object required: - status - cardIdentifier - cardUnblockingDateTime - comment properties: status: type: string description: Card status after the unblocking request (ACTIVE) cardIdentifier: description: Refer to Card.cardIdentifier allOf: - $ref: '#/definitions/CardIdentifier' comment: type: string description: Comment for unblocking the card provided in the request cardUnblockingDateTime: type: string format: date-time description: Date and time when the card has been unblocked in the system title: UnblockAllCardsResponse.Card OriginalCardContract: type: object properties: cardContractIdentifier: description: Identification of the card contract either by the Issuer card contract external reference or the card contract reference. allOf: - $ref: '#/definitions/CardContractIdentifier' status: type: string description: 'Current status of the card contract. Refer to CardContract.status' changedCardContractIdentifier: description: Identification of the new card contract either by the Issuer card contract external reference or the card contract reference. allOf: - $ref: '#/definitions/CardContractIdentifier' cards: type: array items: $ref: '#/definitions/OriginalCard' cardContractGroupReference: type: string description: Unique reference to group card contracts calculated by the system if required by the product configuration title: OriginalCardContract SearchCardRequest: type: object properties: pan: type: string description: 'Primary Account Number (PAN) also called card number Either the PAN or the PAN reference is mandatory to search a card. If both are provided, the search will be done only on the PAN and on optional fields if provided.' expiryDate: type: string description: 'Expiry date of the card. Format is MMYY (month and year)' pattern: ^(?:0[1-9]|1[0-2])(\d{2})$ panSequenceNumber: type: string description: Number identifying cards either with same PAN or with same PAN and same Expiry date (depending of the card product configuration), e.g 1 panReference: type: string description: 'Refer to Card.panReference Either the PAN or the PAN reference is mandatory to search a card. If both are provided, the search will be done only on the PAN and on optional fields if provided.' title: SearchCardRequest ReorderPINRequest: type: object required: - sendingMode properties: sendingMode: type: string example: Normal description: Sending mode selected among the ones allowed by the card product e.g. 'Normal' deliveryType: type: string description: 'Indicates whether the delivery of the PIN mailer should be to branch or customer (instead of the one from the distribution rule of the card product) Possible values are: CUSTOMER, BRANCH To override the delivery address, the delivery type must not be provided and only one of these fields must be provided: customDeliveryAddress, customDeliveryEmail or customDeliveryPhone.' deliveryBranchCode: type: string description: 'Delivery branch code to be provided (among the ones configured for the issuer) if the delivery type is BRANCH. Not to be provided if the delivery type is different from BRANCH (ignored if provided and not needed).' customDeliveryAddressee: type: string description: 'Can be provided in case of customised delivery address. When the customDeliveryAddress is provided, the field must also be provided. Postal recipient’s name used for delivery, usually card holder’s full name.' customDeliveryAddress: description: 'Custom postal address to send the PIN mailer. When the customDeliveryAddressee is provided, the field must also be provided. To be provided when delivery type is empty, but not in combination with Email for PIN and/or Phone for PIN.' allOf: - $ref: '#/definitions/CreateAddressRequestMailAddress' customDeliveryEmail: description: 'Custom email address to send the PIN mailer. To be provided when delivery type is empty, but not in combination with Phone for PIN and/or Postal address for PIN.' allOf: - $ref: '#/definitions/EmailAddress' customDeliveryPhone: description: 'Custom phone number to send the PIN mailer. To be provided when delivery type is empty, but not in combination with Email for PIN and/or Postal address for PIN.' allOf: - $ref: '#/definitions/CreateAddressRequestPhoneNumber' specificFields: type: object example: label1:value|label2:value description: 'The issuer can provide Specific Fields for the PIN mailer order. It is a list of external data {"label":"value"} separated by a "," related to the PIN mailer order (pass-thru data) that can be provided by e.g. the issuer for information or for usage by other systems. Example : {"label1":"value1","label2":"value2"} Those provided data have no impact on our system business processes.' additionalProperties: type: string deliveryChannel: type: string description: Delivery channel for pin mailer order among the channels configured for the issuer (if any). waiveFee: type: boolean description: Indicates if the configured fee (if any) is waived (true) or not (false) while reordering PIN. By default is false. default: false title: ReorderPINRequest OriginalCard: type: object properties: cardIdentifier: description: Identification of the card either by the Issuer card external reference or the card reference. allOf: - $ref: '#/definitions/CardIdentifier' maskedPan: type: string description: Masked Pan expiryDate: description: Expiry Date type: string format: date-time panSequenceNumber: type: string description: Pan Sequence Number status: type: string description: 'Current status of the card. Refer to Card.internalStatus' title: OriginalCard MultiCardInfo: type: object properties: multiCardReference: type: string description: Main card reference samePin: type: boolean description: Indicate if multi card set shares same PIN multiCards: type: array description: List of multi cards items: $ref: '#/definitions/MultiCard' title: MultiCardInfo AccountIdentifier: type: object properties: accountReference: type: string description: Account reference is to identify the Account calculated by the system (algorithm is configurable per issuer). Either the account number or the issuerAccountExternalReference is provided, or, if both are provided then only the account number is used. issuerAccountExternalReference: type: string description: Issuer account external reference is to identify the Account. Either the account number or the issuerAccountExternalReference is provided, or, if both are provided then only the account number is used. Algorithm configurable by issuer, can be generated by the system if there is an externalReferenceGeneratorAlgorithm. title: AccountIdentifier DeclareCounterfeitCardRequest: type: object required: - pan properties: pan: type: string description: The PAN of the counterfeit card must be provided. expiryDate: type: string description: The expiry date can be provided if the counterfeit card has an expiry date in Format 'mmyy' panSequenceNumber: type: string description: The PAN sequence number can be provided if the counterfeit card has a PSN. comment: type: string description: A comment associated with the instantiate counterfeit card action can be provided (free text). ccpFlag: type: boolean description: DEPRECATED fraudProcess: type: string description: "Fraud process which leads to card blocking.\n\t\t\t\t\tPossible values : \n\t\t\t\t•CPP : the card is in CCP list\n\t\t\t\t•TFI : Fraud detected for a single card\n\t\t\t\t•MBA : Fraud detected for several cards (Mass action)" title: DeclareCounterfeitCardRequest ReplaceCardRequestEncryptedPIN: type: object required: - keyId - pinAlgorithmId - pinBlock - pinBlockFormat properties: pinBlock: type: string description: The encrypted pin block pinBlockFormat: type: string description: Format of the encrypted PIN (e.g. ISO-1-BAPOF) pinAlgorithmId: type: string description: 'The encryption algorithm identifier: - format numeric-2 - value ''05'' = BAPOF' key: type: string description: This is the session key (can be provided) keyId: type: string description: 'Encryption key identifier Format: numeric-2 Current possible values: ‘01’, ‘02’ (this list depends on number of keys configured in the HSM)' requestId: type: string description: Identifier of the request requestorId: type: string description: Identifier of the requestor title: ReplaceCardRequest.EncryptedPIN ApiResponseEntityActivateCardResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/ActivateCardResponse' description: Issuer response entity title: ApiResponseEntityActivateCardResponse ApiResponseEntityListCardEvent: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: type: array description: Response data items: $ref: '#/definitions/CardEvent' description: Issuer response entity title: ApiResponseEntityListCardEvent EmailAddress: type: object required: - email properties: email: type: string description: 'Email address of the Customer (mandatory). The email address should have the following format: aaa@bbb.ccc aaa, bbb, ccc are character string.' title: EmailAddress UnblockAllCardsResponse: type: object required: - cards properties: cards: type: array description: List of cards and associated data items: $ref: '#/definitions/UnblockAllCardsResponseCard' title: UnblockAllCardsResponse ChangedCardContract: type: object properties: cardContractIdentifier: description: Identification of the card contract either by the Issuer card contract external reference or the card contract reference. allOf: - $ref: '#/definitions/CardContractIdentifier' status: type: string description: 'Current status of the card contract. Refer to CardContract.status' card: $ref: '#/definitions/ChangedCard' cardHolderIdentifier: description: card holder identifier allOf: - $ref: '#/definitions/CustomerIdentifier' principalSupplementaryCardIndicator: type: string description: Indicates whether the card is a Principal or Supplementary card. relatedAccounts: type: array description: Related Accounts items: $ref: '#/definitions/AccountRelation' originalCardContractIdentifier: description: Identification of the original card contract either by the Issuer card contract external reference or the card contract reference. allOf: - $ref: '#/definitions/CardContractIdentifier' 'cardContractGroupReference ': type: string description: Unique reference to group card contracts calculated by the system if required by the product configuration title: ChangedCardContract BlockAllCardsResponseCard: type: object required: - cardIdentifier - status - blockingReason - cardBlockingDateTime properties: cardIdentifier: description: Refer to Card.cardIdentifier allOf: - $ref: '#/definitions/CardIdentifier' status: type: string description: Refer to Card.status blockingReason: type: string description: Refer to CardBlockingInformation.blockingReason blockingReasonDetail: type: string description: Refer to CardBlockingInformation.blockingReasonDetail cardBlockingDateTime: type: string format: date-time description: Refer to CardBlockingInformation.cardBlockingDateTime title: BlockAllCardsResponse.Card CreateTanRequest: type: object required: - tanOrigin - sendingMode properties: tanOrigin: type: string description: Origin of the TAN request, e.g. GUI. (free text) sendingMode: type: string description: "Sending mode selected among the sending modes allowed in the card product for the TAN mailer \nExample: Normal, Urgent, Ultra Urgent" specificFields: type: object example: '{"tanSF1":"tanSF1Value","tanSF2":"tanSF2Value"}' description: 'The issuer can provide Specific Fields for the order. It is a list of external data {"label":"value"} separated by a "," related to the TAN mailer order (pass-thru data) that can be provided by e.g. the issuer for information or for usage by other systems. Example : {"label1":"value1","label2":"value2"} Those provided data have no impact on our system business processes.' additionalProperties: type: string waiveFee: type: boolean description: Indicates whether the TAN order fee (if any) while requesting TAN password is waived. Default value is false. default: false waiveShippingFee: type: boolean description: Indicates whether the TAN order shipping fee is waived. Default value is false. default: false title: CreateTanRequest CardContract: type: object properties: issuerId: type: string description: Issuer identifier (unique per platform) cardContractIdentifier: description: Identification of the card contract either by Issuer card contract external reference or by card contract reference allOf: - $ref: '#/definitions/CardContractIdentifier' cardTemplateReference: type: string description: Card template reference used for card contract creation cardTypeCode: type: string description: Scheme card type from the card profile cardTypeLabel: type: string description: Scheme card type label from the card profile status: type: string description: 'Status of the card contract (mandatory) The status of the card contract is changing during its life cycle according to business processes in the system. Possible values are : - CREATED : The first status when the card contract is created. Related card is not activated. - ACTIVE : The card contract is active. Related card is activated as per product configuration Examples of business processes triggering this status: contract creation request, contract creation after a product change request. - CLOSED : The card contract is closed and the associated card is deactivated/cancelled (if not already permanently blocked). Card renewal and card replacement are not possible. Examples of business processes triggering this status: contract closing request, card contract closing request, contract closure after a product change request.' openingDate: type: string format: date-time description: Creation date of the card contract (mandatory) activationDate: type: string format: date-time description: Date when the card contract becomes active in our system closingDate: type: string format: date-time description: Closing date of the card contract (present only in case of card contract is already closed or card contract closing is scheduled) closingComment: type: string description: 'Comment associated with the card contract closing action (optional) Free text' closingReason: type: string description: Indicates the reason for closing the card contract (present only in case of card contract is already closed or card contract closing is scheduled) Free text closingDelayType: type: string description: 'The closing type of the card contract (present only in case of card contract is already closed or card contract closing is scheduled) The closing type can be: IMMEDIATE (at current date) SCHEDULED (at future date, greater than the current date) SCHEDULED_EXP_DATE (at the expiration date of active card)' trustedAuthenticationReference: type: string description: 'Unique reference generated by card management system used as trusted authentication credential It is related to a card. Same reference is used in case of card renewal/replacement. Used for ACS enrolment (3D Secure)' newCardRenewalAllowed: type: boolean description: "Indicates if the renewal is allowed for a card (true) or not (false). \nDefault value is true." blockingRenewalReasonCode: type: string description: 'Reason for blocking the renewal of a card (optional) The list of renewal blocking reasons is configurable per issuer (For example : LOST, CREDIT_RISK, FRAUDULENT …)' newCardReplacementAllowed: type: boolean description: 'Indicates if the replacement is allowed for a card (true) or not (false). Default value is false ' blockingReplacementReasonCode: type: string description: Reason for blocking the replacement of a card (optional) The list of replacement blocking reasons is configurable per issuer (For example, CONTRACT_SUSPENSION …) blockingPinReorderReasonCode: type: string description: 'Mandatory reason to be set for blocking a pin reorder The list of blocking reasons for pin reorder is configurable per issuer (For example, CONTRACT_SUSPENSION …)' newPinReorderAllowed: type: boolean description: The pin reorder process can be blocked (blocking pin reorder reason code must be provided) or not. blockingPinReminderReasonCode: type: string description: 'Mandatory reason to be set for blocking pin reminder The list of blocking reasons for pin reminder is configurable per issuer (For example, CONTRACT_SUSPENSION …)' newPinReminderAllowed: type: boolean description: The pin reminder process can be blocked (blocking pin reminder reason code must be provided) or not. issuerBranchCode: type: string description: 'The Branch code (optional) By default, the value is NO_BRANCH.' artwork: type: string description: Artwork (card design) defined for the card contract (mandatory) forcedEmbossingName: type: string description: First line of the name to be embossed on the next physical card if provided by the issuer (optional) forcedEmbossingName2ndLine: type: string description: 'The second line of the name to be embossed on the physical card if provided by the issuer (optional) Can be present (optional) only if first line of forced embossing name is present and if embossing name calculation algorithm accepts a second line.' schemeDeclarationOptOut: type: boolean description: DEPRECATED schemeReportDeclarationBehavior: type: string description: 'The issuer can indicate if the card events are reported to the scheme. Relevant only if the ABU-VAU program is enabled. If the ABU-VAU program is disabled, the use of this attribute generates an error. Possible values are: OPT_IN: the card events are reported to the scheme, OPT_OUT: the card events are not reported to the scheme. If the ABU-VAU program is enabled and the attribute is empty, the default value set on card product is applied.' principalSupplementaryCardIndicator: type: string description: 'Indicates if it is a Principal card or an additional card (mandatory) Possible values: PRINCIPAL, SUPPLEMENTARY' productCategory: type: string description: 'Defines the category of the product (mandatory) The list of product categories is configurable per issuer (e.g. CREDIT, DEBIT, PREPAID)' productCategoryLabel: type: string description: 'Label of the product category (optional) Example: IMMEDIATE_DEBIT_DEBIT, REVOLVING_CREDIT_CREDIT, DIFFERED_DEBIT_CREDIT' specificFields: type: object description: 'List of external data {"label":"value"} separated by a "," related to a card contract that can be provided by e.g. the issuer for information or for usage by other systems. Example : {"label1":"value1","label2":"value2"} Those provided data have no impact on our system business processes.' additionalProperties: type: string productIdentifier: description: Identifier of the product used to create the contract to which the card contract is belonging. It corresponds also to the identifier of the product used to create the card contract if the card contract is created from the product directly. allOf: - $ref: '#/definitions/ProductIdentifier' productExtensionIdentifier: description: "Identifier of the product extension used to create the card contract. \n Relevant if the card contract is created from a product extension." allOf: - $ref: '#/definitions/ProductExtensionIdentifier' selectedModels: type: array description: 'List of models linked to the card contract _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' items: $ref: '#/definitions/CardContractModel' cardClass: type: string description: 'Information provided by the issuer to categorize cards within a contract. The list of allowed card classes is defined by the issuer at its convenience according to its own business rules (e.g special conditions on fees for example) and is configured at product level to be controlled at card creation.' cardIdentifiers: type: array description: 'Card Identifiers _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' items: $ref: '#/definitions/CardIdentifier' cards: type: array description: 'List of cards linked to the card contract. See the Card''s datatype for the detail list of the attributes _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' items: $ref: '#/definitions/Card' cardHolderIdentifier: description: Card Holder Identifier allOf: - $ref: '#/definitions/CustomerIdentifier' vipFlag: type: boolean default: false description: "Indicates if the holder of the priority pass is a VIP or not. This information is used to determine the priority pass fees to apply. \n if true, VIP fees are applied. \n If false, standard fees are applied. \n By default, the value is false." contractIdentifier: description: Contract Identifier allOf: - $ref: '#/definitions/ContractIdentifier' relatedAccounts: type: array description: 'List of posting accounts linked to a card contract _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' items: $ref: '#/definitions/AccountRelation' cardProfileDescription: type: string description: Description of the card profile linked to a card originalCardContractIdentifier: description: CardContract Identifier of the original cardContract in case of ProductChange allOf: - $ref: '#/definitions/CardContractIdentifier' changedCardContractIdentifier: description: CardContract Identifier of the new cardContract in case of ProductChange allOf: - $ref: '#/definitions/CardContractIdentifier' photoReference: type: string description: Reference of a cardholder photo used to personalise the card (free text), e.g. URL where object is stored, a reference (optional). pictureReference: type: string description: Reference of an image used to personalise the card (free text), e.g. URL where object is stored, a reference (optional). cardProfileReference: type: string description: Reference of the card profile. mainCardIndicator: type: boolean description: Indicates whether the card is the main one or not for a mutli cards product logoReference: type: string description: For a corporate card a logo reference can be provided (free text), e.g. alphanumeric value, numeric value, URL where the logo is stored. This logo reference is sent to the embosser with the card order data. cardContractGroupReference: type: string description: Unique reference to group card contracts calculated by the system if required by the product configuration contractType: type: string description: "Indicates if it is a consumer (private) or corporate card. \n Possible values: \n CORPORATE \n CONSUMER" enum: - CORPORATE - CONSUMER deviceTokensNumber: type: integer description: Indicates the number of device tokens on the card attached to the card contract commercialProductReference: type: string description: Commercial reference of the card profile linked to a card commercialProductDescription: type: string description: Commercial description of the card profile linked to a card merchantTokensNumber: type: integer description: Indicates the number of merchant tokens on the card attached to the card contract authorizationDataValidation: description: Cardholder data defined at card contract level and used by the Front Office for verification (AVS/ANI) allOf: - $ref: '#/definitions/AuthorizationDataValidation' contactCenters: type: array items: $ref: '#/definitions/ContactCenter' clickToPayEnrollment: type: string description: 'Indicates if the card enrollment in Click to Pay service is requested or not. Possible values are : - OPT_IN : enrollment of the card in Click to Pay service is requested. - OPT_OUT : enrollment of the card in Click to Pay service is not requested. Relevant only if the Click to Pay feature is enabled.' title: CardContract BlockCardResponse: type: object properties: cardIdentifier: description: Refer to Card.cardIdentifier allOf: - $ref: '#/definitions/CardIdentifier' status: type: string description: Card status after card blocking request (BLOCKED) blockingReason: type: string description: Blocking reason provided in the request blockingReasonDetail: type: string description: Complementary information of the blocking reason provided in the request if any cardBlockingDateTime: type: string format: date-time description: Refer to CardBlockingInformation.cardBlockingDateTime relatedBlockedCardList: description: 'List of cards linked to the blocked card that have been blocked as well (cards from multi cards product or cards with same PAN for example) For each blocked card, information such as card status, cardReference/issuerCardExternalReference, blocking reason, card blocking date and time is returned.' type: array items: $ref: '#/definitions/BlockCardResponse' title: BlockCardResponse ActivateCardResponse: type: object properties: cardIdentifier: description: Card Identifier allOf: - $ref: '#/definitions/CardIdentifier' status: type: string description: Card status after card activation request (ACTIVE) reason: type: string description: Activation reason provided in the request activationDateTime: type: string format: date-time description: Date and time when the card has been activated in the system title: ActivateCardResponse BlockAndReplaceCardResponse: x-wl-sensitive-data: true type: object required: - blockCardResponse - replaceCardResponse properties: blockCardResponse: description: Refer to BlockCardResponse allOf: - $ref: '#/definitions/BlockCardResponse' replaceCardResponse: description: Refer to ReplaceCardResponse allOf: - $ref: '#/definitions/ReplaceCardResponse' title: BlockAndReplaceCardResponse OrderIdentifier: type: object description: Order reference calculated by our system properties: orderReference: type: string description: 'The reference of the order in our system, unique per platform This reference is calculated from an algorithm configurable per issuer (currently a unique algorithm is defined). The reference is composed of the creation date of the order (YYYYMMDD) + a sequence number of 16 digits (e;g; 202203212000000000097002, where 20220321 is the date when the order is created)' title: OrderIdentifier UnauthorizedErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/UnauthorizedResponseMetadata' title: UnauthorizedResponseMetadata ApiResponseEntityBlockCardResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/BlockCardResponse' description: Issuer response entity title: ApiResponseEntityBlockCardResponse ExternalAuthorizationsRestriction: type: object required: - externalAuthorizationsRestrictionIdentifier properties: externalAuthorizationsRestrictionIdentifier: description: Reference identifier for external authorization restriction allOf: - $ref: '#/definitions/ExternalAuthorizationsRestrictionIdentifier' activationStartTime: type: string format: date-time description: First point in time at which the override will be considered. Has to be before end date time. Can be present without end date time. If not provided the override will be taken into account immediately (optional) activationEndTime: type: string format: date-time description: Last point in time at which the override will be considered. Has to be later than start date time. Can be present without start date time. If not provided the override will be taken into account forever (optional) conditionCheck: type: boolean description: Overrides the default configured for the corresponding restriction attribute. In case nothing is provided then the default becomes effective. priority: type: string description: In case multiple overrides with overlapping activation times are existing this information is used to resolve this situation by applying the overrides one by one starting with the one with lowest priority. The priority needs to be unique across all overrides associated with the same velocity check/restriction and the same account (card) title: ExternalAuthorizationsRestriction ModifyAllCardsBlockingInformationRequest: type: object properties: pan: type: string description: 'The issuer can provide the PAN to update blocking information for all cards with the same PAN. Either the PAN or the PAN reference is mandatory to update blocking information for all cards with same PAN or same PAN reference.' panReference: type: string description: 'The issuer can provide the PAN reference to update blocking information for all cards with the same PAN. Either the PAN or the PAN reference is mandatory to update blocking information for all cards with same PAN or same PAN reference.' blockingReason: type: string description: 'Reason of the card blocking. It is selected among the card blocking reasons configured for the issuer. A permanently blocked card can''t be updated with a temporary card blocking reason.' blockingReasonDetail: type: string description: "Complementary information describing the defined blocking reason \nFree text" lostStolenDate: type: string format: date-time description: 'Date when the card has been lost or stolen Can be updated if the card was blocked previously in a context of loss/theft Required if the card is blocked in a context of loss/theft' pinCompromised: type: boolean description: 'Indicates if the PIN is compromised (true) or not (false). Can be updated if the blocking reason was previously Lost or Stolen. To be provided if the new blocking reason is Lost or Stolen' transferEffectiveDate: type: string format: date-time description: Transfer effective date. It must be a date prior to the card blocking date time comment: type: string description: 'Comment associated with the card blocking action. Free text.' scheduledCardBlockingDate: type: string format: date-time description: Date when the permanent card blocking is scheduled.If scheduledCardBlockingDate is provided, scheduledCardBlockingDelay is not relevant. scheduledCardBlockingDelay: type: integer format: int32 description: Delay in calendar days used to block the card in the future.It can be updated if needed as long as the scheduled card blocking date is not yet reached and if the new scheduled card blocking date is in the future.If scheduledCardBlockingDelay is provided, scheduledCardBlockingDate is not relevant. scheduledCardBlockingReason: type: string description: 'Scheduled permanent blocking reason. It is relevant if the card is already temporarily blocked. It can be updated if needed as long as the scheduled card blocking date is not yet reached Permanent blocking reasons used context of loss/theft are not allowed.' cppFlag: type: boolean description: DEPRECATED fraudProcess: type: string description: "Fraud process which leads to card blocking.\n\t\t\t\t\tPossible values : \n\t\t\t\t•CPP : the card is in CCP list\n\t\t\t\t•TFI : Fraud detected for a single card\n\t\t\t\t•MBA : Fraud detected for several cards (Mass action)" title: ModifyAllCardsBlockingInformationRequest ProductChangeInformation: type: object description: Only if a product change is triggered by card replacement. Represents product change information properties: targetProductIdentifier: description: Target product of the product change identified either by the Issuer Product External Reference or the Product Reference. allOf: - $ref: '#/definitions/ProductIdentifier' closingReason: type: string description: 'Closing reason used at the contract termination. Free text' feeReimbursementAtCardContractClosing: type: boolean description: Indicates whether the membership & account setup fees shall be reimbursed for the old contract at the contract termination (per card contract) cardCreationSendingMode: type: string description: 'Sending mode used for all physical cards ordered in the contract Same value as provided in the Product change request' pinMailerSendingMode: type: string description: 'Sending mode used for all PIN mailers created for the contract Same value as provided in the Product change request' cardChanges: type: array description: 'List of card changes requested during the product change (optional). Same value as provided in the Product change request ' items: $ref: '#/definitions/CardChange' productChangeTrigger: type: string description: "This field indicates when the product change is triggered once the product change request is received. \nIt depends of the product change configuration.\nPossible values are : \n- IMMEDIATE\n- ON_RENEWAL" productChangeReference: type: string description: External reference of the configured Product Change definition used for the product change. productChangeStatus: type: string description: 'Status of the product change Possible values are : - PENDING (for scheduled product change, date not reached) - PROCESSED (for immediate product change, or scheduled product change when date is reached) - CANCELLED (When a scheduled product change is cancelled before the scheduled product change date is reached)' futureChangeDate: type: string format: date-time description: "Future date of the product change. \nCalculated by the system in case of product change on renewal (= anticipated card renewal date (when only one card) or first anticipated card renewal date within the contract when contract has several cards).\nUTC time zone.\nFormat: \"yyyy-MM-dd'T'HH:mm:ssZ\"" productChangeStatusDate: type: string format: date-time description: 'Date the status of the product change was last updated. UTC time zone. Format: "yyyy-MM-dd''T''HH:mm:ssZ"' title: ChangeProductResponse.ProductChangeInformation CardContractIdentifier: type: object description: Identification of the card contract either by Issuer card contract external reference or by card contract reference properties: cardContractReference: type: string description: 'The reference of the card contract in our system, unique per platform This reference is calculated from an algorithm (currently a unique algorithm ''DefaultCardContractReferenceAlgorithm'' referenced in the card profile version). The reference is composed of the issuerId + a sequence number of 16 digits (e;g; 100042000000000095003, where 10004 is the issuerId)' issuerCardContractExternalReference: type: string description: 'The external reference of the card contract provided by the issuer This reference is unique per issuer and may be used to carry out research and find information.' title: CardContractIdentifier UnblockCardRequest: type: object properties: comment: type: string description: 'Comment to be provided when unblocking the card ' cancelScheduledCardBlocking: type: boolean description: 'Flag indicating the scheduled blocking is cancelling False by default - If True, scheduled card blocking is cancelled if any - If false, scheduled card blocking is kept if any' default: false unblockingReason: type: string description: 'Unblocking reason (optional) Possible values : TEMPORARY_UNBLOCK, FALSE_POSITIVE (Those values are mainly used in the context of Fraud management) ' title: UnblockCardRequest Dispute: type: object properties: issuerId: type: string description: Issuer Identifier (unique per platform) disputeFolderIdentifier: description: Dispute Folder Identifier allOf: - $ref: '#/definitions/DisputeFolderIdentifier' events: type: array description: 'Events attached to the dispute folder.Event can be triggered by our system or added by the issuer (purpose can to indicate a communication from/to cardholder) _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' items: $ref: '#/definitions/DisputeEvent' postings: type: array description: "Posted operation on the dispute folder, example : Do a refund towards the cardholder account, \nDo a write-off towards an issuer account (Profit and Loss, Fraud,..), \ndo a Foreign exchange fee, Financial Advice Exchange Rate Difference\n_Embedded property, only filled when available for the endpoint and explicitly requested in the 'embed' query parameter._" items: $ref: '#/definitions/DisputePosting' documents: type: array description: 'Documents added to the dispute folder. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' items: $ref: '#/definitions/DisputeDocument' messages: type: array description: 'Messages exchanged with the scheme linked to the dispute folder. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' items: $ref: '#/definitions/DisputeMessage' acquirerReferenceData: type: string description: Acquiring Reference Number (ARN) related to the disputed transaction transactionType: type: string description: DEPRECATED transactionTime: type: string format: date-time description: Transaction Date and Time on the Merchant site related to the disputed transaction transactionAmount: description: Transaction Amount (Value/Currency/Currency Exponent) related to the disputed transaction allOf: - $ref: '#/definitions/Amount' reconciliationAmount: description: Scheme Reconciliation Amount (Value/Currency/Currency Exponent) related to the disputed transaction allOf: - $ref: '#/definitions/Amount' billingAmount: description: Cardholder Billing Amount (Value/Currency/Currency Exponent) related to the disputed transaction on Cardholder point of view allOf: - $ref: '#/definitions/Amount' billingFees: description: Cardholder Billing Fees Amount (Value/Currency/Currency Exponent) associated to the disputed transaction on Cardholder point of view allOf: - $ref: '#/definitions/Amount' outstandingBalance: description: Cardholder Outstanding balance (Value/Currency/Currency Exponent) associated to the disputed transaction allOf: - $ref: '#/definitions/Amount' issuerAccountingBalance: description: Issuer Accounting Balance (Value/Currency/Currency Exponent) related to the dispute on issuer point of view allOf: - $ref: '#/definitions/Amount' statusCode: type: string description: Dispute status (open, closed) associated to the Dispute Folder reason: type: string description: Dispute Reason associated to the Dispute Folder creationDate: type: string format: date-time description: Date of the Dispute Folder creation cardAcceptorName: type: string description: Merchant Address Name related to the disputed transaction cardAcceptorCity: type: string description: Merchant Address City related to the disputed transaction cardAcceptorCountry: type: string description: Merchant Address Country Code (num-3) related to the disputed transaction cardAcceptorIdCode: type: string description: Merchant Identifier related to the disputed transaction cardAcceptorZipCode: type: string description: Merchant Address Zip Code related to the disputed transaction userInCharge: type: string description: User in charge of the Dispute Folder cardIdentifier: description: Card Identifier related to the disputed transaction allOf: - $ref: '#/definitions/CardIdentifier' lastMessageType: type: string description: Type of the last Message of the Dispute Folder lastMessageDate: type: string format: date-time description: Date of the last Message of the Dispute Folder lastMessageStatus: type: string description: Status of the last Message of the Dispute Folder superFolderReference: type: string description: Super folder reference if super folder exists transactionCategory: type: string description: Internal Transaction category (SALES, CASH_WITHDRAWAL, etc ..) related to the disputed transaction transmissionDate: type: string format: date-time description: 'Transmission date from the scheme MCI : PDS 0158 - s5 Central Site Business Date VISA : TCR0 164-167 Central Processing Date (YDDD)' clientOpenDate: type: string format: date-time description: Date when the cardholder has raised the Dispute, used to track the receipt of the cardholder dispute originalValueDate: type: string format: date-time description: Optional parameter external Value Date title: Dispute ApiResponseEntityBlockAllCardsResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/BlockAllCardsResponse' description: Issuer response entity title: ApiResponseEntityBlockAllCardsResponse ApiResponseEntityCardContract: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/CardContract' description: Issuer response entity title: ApiResponseEntityCardContract UnblockAllCardsRequest: type: object properties: pan: type: string description: 'The issuer provides the pan to unblock all the cards having this PAN. Mandatory if pan reference is not provided. Refer to Card.pan' panReference: type: string description: The issuer provides the pan reference to unblock all the cards having this pan reference. Mandatory if pan is not provided.Refer to Card.panReference comment: type: string description: 'Comment to be provided when unblocking the card ' cancelScheduledCardBlocking: type: boolean description: 'Flag indicating the scheduled blocking is cancelling False by default - If True, scheduled card blocking is cancelled if any - If false, scheduled card blocking is kept if any' default: false unblockingReason: type: string description: 'Unblocking reason (optional) Possible values : TEMPORARY_UNBLOCK, FALSE_POSITIVE (Those values are mainly used in the context of Fraud management) ' title: UnblockAllCardsRequest OriginalContract: type: object description: Only if a product change is triggered by card replacement. Represents the original contract data before product change has occured properties: contractIdentifier: description: Identification of the contract either by the Issuer contract external reference or the Contract reference. allOf: - $ref: '#/definitions/ContractIdentifier' status: type: string description: 'Current status of the contract. Refer to Contract.status' productIdentifier: description: Identification of the product change identified either by the Issuer Product External Reference or the Product Reference. allOf: - $ref: '#/definitions/ProductIdentifier' accounts: type: array items: $ref: '#/definitions/OriginalAccount' cardContracts: type: array items: $ref: '#/definitions/OriginalCardContract' closingDate: type: string format: date-time description: Date of cloture of the contract changedContractIdentifier: description: Identification of the new contract either by the Issuer contract external reference or the Contract reference. allOf: - $ref: '#/definitions/ContractIdentifier' title: ChangeProductResponse.OriginalContract ReplaceCardRequestCardContractCard: type: object properties: pan: type: string description: 'The issuer can provide the Primary Account Number (PAN) or card number of the new card if this is allowed by the product configuration only (allowed by the numbering model and the replacement reason). The provided PAN must belong to the card product BIN range. ' panSequenceNumber: type: string description: PAN sequence number of the card. It will be possible to override PSN at the time of card creation if it is allowed in card creation model configuration issuerCardExternalReference: type: string description: 'The issuer can provide the external reference for the new card (maximum length is 50 characters). This external reference must be unique per issuer. If not provided, the external reference is calculated by the system if a reference generation algorithm is configured for the issuer else the issuer card external reference will be empty.' expiryDate: type: string description: 'The issuer can provide the expiry date of the new card if allowed by the product (replacement model). Format is MMYY (month and year)' pattern: ^(?:0[1-9]|1[0-2])(\d{2})$ embossingName: type: string description: DEPRECATED, field forcedEmbossingName should be used instead embossingName2ndLine: type: string description: DEPRECATED, field forcedEmbossingName2ndLine should be used instead embossingLine5: type: string description: 'The issuer can provide the embossing line 5 (additional embossing line) for the new card. By default, the previous value is used.' specificFields: type: object description: "The issuer can provide Specific Fields for the new card. It is a list of external data {\"label\":\"value\"} separated by a \",\" related to the card (pass-thru data) that can be provided by e.g. the issuer for information or for usage by other systems.\n Example : {\"label1\":\"value1\",\"label2\":\"value2\"}.\n Those provided data have no impact on our system business processes." additionalProperties: type: string cardOrder: description: Card Order for the new card Empty if no card order needed for the card allOf: - $ref: '#/definitions/ReplaceCardRequestCardOrder' pinMailerOrder: description: Pin Mailer Order for the new card Empty if no PIN mailer order needed allOf: - $ref: '#/definitions/ReplaceCardRequestPinMailerOrder' encryptedPin: description: Encrypted Pin for the new card allOf: - $ref: '#/definitions/ReplaceCardRequestEncryptedPIN' blockingReason: type: string description: When replacing a card, the issuer can temporarily block the card immediately after issuing, providing temporary blocking reason only. This can happen, for example, if the cardholder was not properly authenticated (or for other business reason). The card will be activated when, for instance, the cardholder calls the contact center and passes the respective procedures. externalCobadgedCardNumber: type: string description: This is an external card number used for Giro card in Germany. externalCobadgedSequenceNumber: type: string description: Sequence Number of Cobadged card externalCobadgedExpiryDate: type: string description: ExpiryDate of Cobadged card cardDeactivationRuleOverride: type: string description: "Indicates which card deactivation rule is enabled for the card.\n\t\t\t\t\t\t\t\tIt overrides the product card deactivation rule\n\t\t\t\t\t\t\t\tPossible value :\n\t\t\t\t\t\t\t•FIRST_APPROVED_AUTHO (1st approved online authorization))" externalAuthorizationsRestrictions: type: array description: List of external authorization restrictions related to the card items: $ref: '#/definitions/ExternalAuthorizationsRestriction' subBinRangeReference: type: string description: Reference of the sub BIN range selected for PAN generation.This field applies only if the card product is configured with random PAN generation and sub BIN range references title: ReplaceCardRequest.CardContract.Card ReleaseOrdersResponse: type: object properties: releasedOrders: type: array items: $ref: '#/definitions/ReleasedOrder' title: ReleaseOrdersResponse ApiResponseEntityCardBlockingInformation: x-wl-api-response: true type: object required: - responseMetadata - data properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: $ref: '#/definitions/CardBlockingInformation' title: ApiResponseEntityCardBlockingInformation BlockCardRequest: type: object properties: blockingReason: type: string description: The blocking reason must be provided if the card is not already blocked or temporary blocked with a scheduled information present on the card and without a new scheduled blocking request, otherwise it is optional. blockingReasonDetail: type: string description: Refer to CardBlockingInformation.blockingReasonDetail lostStolenDate: type: string format: date-time description: "This date can be provided in addition to the blocking reason if the card is blocked in a context of loss/theft (usually mandatory as per issuer configuration). \nThe date will be ignored if the provided blocking reason is not requiring it." lossPlace: type: string description: Refer to CardBlockingInformation.lossPlace lastUsageDate: type: string format: date-time description: 'Refer to CardBlockingInformation.lastUsageDate The Last Usage Date must not be later than current date.' lastUsagePlace: type: string description: Refer to CardBlockingInformation.lastUsagePlace lossCircumstances: type: string description: Refer to CardBlockingInformation.lossCircumstances lossReportedBy: type: string description: Refer to CardBlockingInformation.lossReportedBy lossReportedVia: type: string description: Refer to CardBlockingInformation.lossReportedVia fraudCode: type: string description: Refer to CardBlockingInformation.fraudCode lossCountry: type: string description: Refer to CardBlockingInformation.lossCountry contactData: type: string description: Refer to CardBlockingInformation.contactData pinCompromised: type: boolean description: Refer to CardBlockingInformation.pinCompromised customerRequestingBlockDate: type: string format: date-time description: Refer to CardBlockingInformation.customerRequestingBlockDate transferEffectiveDate: type: string format: date-time description: Refer to CardBlockingInformation.transferEffectiveDate noReplacementReason: type: string description: Refer to CardBlockingInformation.noReplacementReason comment: type: string description: Refer to CardBlockingInformation.comment waiveFee: type: boolean description: 'Indicates if the configured fee (if any) is waived (true) or not (false) while blocking card. By default is false.' default: false cppFlag: type: boolean description: DEPRECATED default: false fraudProcess: type: string description: "Fraud process which leads to card blocking.\n\t\t\t\t\tPossible values : \n\t\t\t\t•CPP : the card is in CCP list\n\t\t\t\t•TFI : Fraud detected for a single card\n\t\t\t\t•MBA : Fraud detected for several cards (Mass action)" scheduledCardBlockingDate: type: string format: date-time description: 'Date when the permanent card blocking is scheduled If scheduledCardBlockingDate is provided, scheduledCardBlockingDelay is not relevant' scheduledCardBlockingDelay: type: integer description: "Delay applied for the scheduled permanent card blocking. \nDefault value = 35 calendar days (configurable), can be overrriden if needed. The delay can be updated as long as it has not been reached. \nIf scheduledCardBlockingDelay is provided, scheduledCardBlockingDate is not relevant" scheduledCardBlockingReason: type: string description: "Reason for scheduled permanent blocking\nValues =\nFRAUD_CPP or FRAUD_TFI (permanent blocking). \nPermanent blocking reasons used context of loss/theft are not allowed.\nDue to system logic, for current API the value of this field can be for permanent blocking only and can be set if the blockingReason attribute value is set to temporary blocking reason.\nIf the card remains active with a scheduled permanent blocking, this field is empty and the scheduled permanent blocking reason is provided in blockingReason." transactionId: type: string description: 'Relevant in the context of Fraud detection. Indicates the transactionId of the suspicious transaction that has triggered the card blocking.' cancelScheduledCardBlocking: type: boolean description: "If the card is ACTIVE or TEMPORARY BLOCKED and a scheduled information is already present on the card (scheduled permanent blocking):\n- a scheduled card blocking cancellation can be requested by providing the flag cancelScheduledCardBlocking to true.\nIn this case, the fields scheduledCardBlockingDelay, scheduledCardBlockingDate and scheduledCardBlockingReason must not be provided, otherwise the request is rejected\n- if a scheduled card blocking cancellation is not requested (the flag cancelScheduledCardBlocking is not provided or set to false).\nIn this case : \n* If a new scheduled permanent blocking is requested, the field scheduledCardBlockingDelay or scheduledCardBlockingDate must be provided if the delay is not yet reached. The field scheduledCardBlockingReason can optionally be provided if the card is temporary blocked.\n* If a new temporary blocking is requested, the field scheduledCardBlockingDelay, scheduledCardBlockingDate, scheduledCardBlockingReason must not be provided." default: false title: BlockCardRequest MultiCard: type: object properties: cardId: type: string description: Card ID cardIdentifier: description: Unique identifier of the card allOf: - $ref: '#/definitions/CardIdentifier' cardStatus: type: string description: "Current status of the card \n Possible values: CREATED, ACTIVE, BLOCKED, DEACTIVATED, CANCELLED" permanentlyBlocked: type: boolean description: Indicates if the card is permanently blocked (true) or not (false). Default value is false renewed: type: boolean description: Indicates if the card is renewed (true) or not (false). Default value is false replaced: type: boolean description: Indicates if the card is replaced (true) or not (false). Default value is false title: MultiCard PinInheritanceCardIdentifier: type: object properties: pinInheritanceCardReference: type: string description: The reference of the card from which the PIN is inherited. pinInheritanceIssuerCardExternalReference: type: string description: The external reference of the card from which the PIN is inherited. title: PinInheritanceCardIdentifier CardContractModel: type: object properties: reference: type: string description: Reference of a card contract model type: type: string description: 'Type of a card contract model Possible values: CARD_CREATION_MODEL, CARD_AUTONUMBERING_MODEL, TECHNOLOGY_AND_APPLICATION_MODEL, EVENT_FEE_MODEL, CARD_RENEWAL_MODEL, CARD_REPLACEMENT_MODEL, PIN_PRODUCTION_MODEL, DISTRIBUTION_MODEL' title: CardContractModel Amount: type: object required: - value - exponent - isoCode properties: value: type: integer format: int64 description: Integer amount value. Ex. if it is two hundred euros and 17 cents, then amount value is 20017 (exponent = 2 digits for currency=EUR) exponent: type: integer format: int32 description: Exponent of Amount. Number of decimal digits. isoCode: type: string description: 'Currency code of amount The currency in ISO4217 alphabetic format. Example: EUR for Euro' title: Amount ApiResponseEntityBlockAndReplaceCardResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/BlockAndReplaceCardResponse' description: Issuer response entity title: ApiResponseEntityBlockAndReplaceCardResponse CreateEmergencyCardResponse: x-wl-sensitive-data: true type: object required: - embossingName - panReference properties: pan: type: string description: Primary Account Number (PAN) calculated by our system from the BIN range assigned to the emergency card product. maskedPan: type: string description: 'Masked Primary Account Number (PAN) of the card. Only the first 6 and the last 4 digits are visible. All other digits are replaced by a hash character. Example: 445442******0275' panReference: type: string description: Refer to Card.panReference. expiryDate: type: string description: 'Expiry date of the card Format is MMYY (month and year)' panSequenceNumber: type: string description: PAN sequence number is a number (usually from 1 to N) that allows identifying either cards with same PAN or cards with same PAN and same Expiry date cardIdentifier: description: Identification of the card either by Issuer card external reference or by card reference allOf: - $ref: '#/definitions/CardIdentifier' statusDate: type: string format: date-time description: Last card status change date embossingName: type: string description: 'uncryptedcardHolderName (lines separated by ''*'', see EmbossingNameHelper) First line of the name embossed on the physical card (mandatory) It can be provided by the issuer or calculated by the Issuing Back Office system (if allowed within card Technology and Application model and depending on the selected embossing name calculation algorithm) ' status: type: string description: Card status embossingName2ndLine: type: string description: 'Second line of the name embossed on the physical card, optional, can be provided only in addition to the first line. It can be provided by the issuer or calculated by our system (if embossing name is required within card Technology and Application model and depending on the selected embossing name calculation algorithm).' activeCreditLimitAmount: description: 'Active credit limit amount Can be inherited from the credit limit of old card according the issuer configuration. ' allOf: - $ref: '#/definitions/Amount' activationMethod: type: string description: Activation method of the emergency card e.g on card creation or on demand title: CreateEmergencyCardResponse DisputeDocument: type: object properties: data: type: string description: Contains the document (letter) attached to the Dispute Folder encoded in Base64 type: type: string description: Type of the document attached to the Dispute Folder label: type: string description: Label of the external document attached to the Dispute Folder fileName: type: string description: File name of the external document attached to the Dispute Folder creationDate: type: string format: date-time description: Date of the external document creation attached to the Dispute Folder title: DisputeDocument ContactCenterIdentifier: type: object properties: contactCenterReference: type: string description: Contact center dentifier (unique per issuer) title: ContactCenterIdentifier ReplaceCardRequest: type: object required: - replacementReason properties: waiveFee: type: boolean description: 'Indicates if the configured fee (if any) is waived (true) or not (false) while replacing card. By default is false.' default: false replacementReason: type: string description: 'Reason of the card replacement Refer to Card.replacementReason' cardContract: description: Card Contract allOf: - $ref: '#/definitions/ReplaceCardRequestCardContract' overrideDistributionRules: type: boolean description: DEPRECATED default: false forceNewPin: type: boolean description: The attribute can be set to true when a new pin change is needed in the process of replacing a card and it is not foreseen by default process (it is not possible however to inhibit the new pin change if it is foreseen by the default process) default: false title: ReplaceCardRequest ContactCenter: type: object properties: description: type: string description: Description of the contact center. Free text addressType: type: string description: The type of an address is POSTAL_MAIL, PHONE or E_MAIL contactCenterIdentifier: description: Unique reference of the contact center within the issuer allOf: - $ref: '#/definitions/ContactCenterIdentifier' postalAddress: description: The postal adress of the contact center allOf: - $ref: '#/definitions/MailAddress' emailAddress: description: The email adress of the contact center allOf: - $ref: '#/definitions/EmailAddress' phone: description: The phone number of the contact center allOf: - $ref: '#/definitions/PhoneNumber' title: ContactCenter AuthorizationDataValidation: type: object description: The issuer can update cardholder data used by the Front Office for verification (AVS/ANI). properties: firstName: type: string description: First name of the cardholder lastName: type: string description: Last name of the cardholder secondFirstName: type: string description: Second first name of the cardholder streetName: type: string description: Street name of the cardholder address zipCode: type: string description: Zip code of the cardholder address birthDate: type: string format: date-time description: Birth date of the cardholder BadRequestResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated statusCode: type: integer format: int32 example: 400 description: HTTP status code statusMessage: type: string example: Bad request description: Executed REST API status message title: BadRequestResponseMetadata CardStatusHistory: type: object properties: eventType: type: string description: 'Event type associated to a card status and an event date (mandatory) Example: CardActivation, CardIssuing, CardCancellation, CardDeactivation, CardBlocking, CardUnblocking' eventDate: type: string format: date-time description: 'Date time when an event is performed on the card by our system (mandatory) Example: blocking card, unblocking card, replacement card' reason: type: string description: 'Reason associated to a card status (mandatory) The list of reasons is configurable per issuer (example: ActivationReason, CancellationReason, DeactivationReason, CardBlockingReason)' comment: type: string description: A comment (free text) used in case of blocking or unblocking a card (optional) waiveFee: type: boolean description: Indicates if the fee was waived (true) or not (false). By default, value is false. blockingInformation: description: Information related to the card blocking (present if the card is blocked) allOf: - $ref: '#/definitions/CardBlockingInformation' title: CardStatusHistory ChangedCard: type: object properties: cardIdentifier: description: Identification of the card either by the Issuer card external reference or the card reference. allOf: - $ref: '#/definitions/CardIdentifier' maskedPan: type: string description: Masked Pan expiryDate: description: Expiry Date type: string format: date-time pan: type: string description: Pan (depends on user rights) panReference: type: string description: Reference related to the PAN orders: type: array description: Orders items: $ref: '#/definitions/ChangeProductResponseOrder' panSequenceNumber: type: string description: Pan Sequence Number status: type: string description: 'Current status of the card. Refer to Card.status' title: ChangedCard PhoneNumber: type: object required: - localPhoneNumber properties: countryCode: type: string description: Country dialing code (optional). Free text. It is recommended to provide a region dialing code (e.g. +33, +49). localPhoneNumber: type: string description: "Free text (mandatory). It’s recommended to provide an international phone number in accordance with the value provided in the country code.\nEx : \n- country code = ‘+’33’ and localPhoneNumber = ‘0622334455’ \n- country code = empty and localPhoneNumber = ‘+33622334455’\nThe value can be subject to a validation process if a specific rule has been configured at issuer level." internationalPhoneNumber: type: string description: "Free text (mandatory). It’s recommended to provide an international phone number in accordance with the value provided in the country code.\nEx : \n- country code = ‘+’33’ and localPhoneNumber = ‘0622334455’ \n- country code = empty and localPhoneNumber = ‘+33622334455’\nThe value can be subject to a validation process if a specific rule has been configured at issuer level." title: PhoneNumber BadGatewayResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated statusCode: type: integer format: int32 example: 502 description: HTTP status code statusMessage: type: string example: Bad Gateway description: Executed REST API status message title: BadGatewayResponseMetadata RemindPINRequest: type: object required: - sendingMode properties: sendingMode: type: string description: The issuer must provide a sending mode among ones allowed. deliveryType: type: string description: 'Indicates whether the delivery of the PIN mailer should be to branch or customer (instead of the one from the distribution rule of the card product) Possible values are: CUSTOMER, BRANCH To override the delivery address, the card delivery type must not be provided and only one of these fields must be provided: customDeliveryAddress, customDeliveryEmail or customDeliveryPhone.' deliveryBranchCode: type: string description: 'The issuer must provide the card delivery branch code If the delivery type is provided and is BRANCH. Not to be provided if the delivery type is different from BRANCH (ignored if provided and not needed).' customDeliveryAddressee: type: string description: 'Can be provided in case of customised delivery address. When the customDeliveryAddress is provided, the field must also be provided.' customDeliveryAddress: description: 'Custom postal address to send the PIN mailer. When the customDeliveryAddressee is provided, the field must also be provided. To be provided when delivery type is empty, but not in combination with Email for PIN and/or Phone for PIN.' allOf: - $ref: '#/definitions/CreateAddressRequestMailAddress' customDeliveryEmail: description: 'Custom email address to send the PIN mailer To be provided when delivery type is empty, but not in combination with Phone for PIN and/or Postal address for PIN.' allOf: - $ref: '#/definitions/EmailAddress' customDeliveryPhone: description: 'Custom phone number to send the PIN mailer To be provided when delivery type is empty, but not in combination with Email for PIN and/or Postal address for PIN.' allOf: - $ref: '#/definitions/CreateAddressRequestPhoneNumber' specificFields: type: object description: 'The issuer can update Specific Fields for the order during the PIN reminding. It is a list of external data {"label":"value"} separated by a "," related to the order (pass-thru data) that can be provided by e.g. the issuer for information or for usage by other systems. A new data can be added or an existing data can be updated {"label1":"newValue"} or removed {"label2":"null"}. Any existing data that is not present in this list is not updated in the order. Those provided data have no impact on our system business processes.' additionalProperties: type: string resetPinTryCounter: type: boolean description: A reset of the PIN try counter can be requested (message is sent to the Front Office to reset the PIN). default: false waiveFee: type: boolean description: Indicates if the configured fee (if any) is waived (true) or not (false) while reminding PIN. By default is false. default: false title: RemindPINRequest ContractIdentifier: type: object description: Identification of thecorporate contract either by Issuer contract external reference or by contract reference properties: contractReference: type: string description: 'The unique reference of the contract in our system, unique per platform This reference is an UUID (universally unique identifier) on 36 digits (e.g.196c2215-9a80-4b8b-868c-18beb8c8c9).' issuerContractExternalReference: type: string description: 'The external reference of the contract provided by the issuer This reference is unique per issuer and may be used to carry out research and find information.' title: ContractIdentifier ChangedAccount: type: object properties: accountIdentifier: description: Identification of the account either by the Issuer account external reference or the account reference. allOf: - $ref: '#/definitions/AccountIdentifier' root: type: boolean description: Indicate whether this account is the root account or not. accountOwnerIdentifier: description: account owner identifier allOf: - $ref: '#/definitions/CustomerIdentifier' accountGuarantorIdentifier: description: account guarantor identifier allOf: - $ref: '#/definitions/CustomerIdentifier' status: type: string description: 'Current status of the account. Refer to Account.status' originalAccountIdentifier: description: Identification of the new account either by the Issuer account external reference or the account reference. allOf: - $ref: '#/definitions/AccountIdentifier' title: ChangedAccount ForbiddenResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated statusCode: type: integer format: int32 example: 403 description: HTTP status code statusMessage: type: string example: Forbidden description: Executed REST API status message title: ForbiddenResponseMetadata Vulnerability: type: object required: - type properties: type: type: string description: Type of vulnerability applicable to the customer (free text). comment: type: string description: Details about the vulnerability of the customer (free text). ModifyCardBlockingInformationResponse: type: object required: - responseMetadata - cardIdentifier properties: cardIdentifier: description: Refer to Card.cardIdentifier allOf: - $ref: '#/definitions/CardIdentifier' title: ModifyCardBlockingInformationResponse ApiResponseEntityDeactivateCardResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/DeactivateCardResponse' description: Issuer response entity title: ApiResponseEntityDeactivateCardResponse RemindPINResponse: type: object properties: orderIdentifier: description: Order reference calculated by our system. Refer to Order.orderIdentifier allOf: - $ref: '#/definitions/OrderIdentifier' currentInternalStatus: type: string description: 'Current internal status of the order after the remind PIN request - CONFIRMED: if the order is validated by the branch - ORDERABLE: if ready to be issued (depending on the configuration, e.g. PIN is generated and available)' orderType: type: string description: Type of the order (PinMailerOrder) title: RemindPINResponse CreateAddressRequestPhoneNumber: type: object required: - localPhoneNumber properties: countryCode: type: string description: Country dialing code (optional). Free text. It is recommended to provide a region dialing code (e.g. +33, +49). localPhoneNumber: type: string description: 'Free text (mandatory). It’s recommended to provide an international phone number in accordance with the value provided in the country code Ex : - country code = ‘+’33’ and localPhoneNumber = ‘0622334455’ - country code = empty and localPhoneNumber = ‘+33622334455’ The value can be subject to a validation process if a specific rule has been configured at issuer level.' title: CreateAddressRequest.PhoneNumber CardBlockingInformation: type: object required: - cardBlockingDateTime properties: cardBlockingDateTime: type: string format: date-time description: Date and time when the card has been blocked by our system blockAgent: type: string description: Operator who blocked the card (mandatory only if the card is blocked). It corresponds to the name of the user, referenced in our system, mentioned at the card blocking time. blockingReason: type: string description: 'Reason for blocking a card (mandatory only if the card is blocked) The list of blocking reasons is configurable per issuer (For example, LOST, STOLEN, FRAUDULENT …)' blockingReasonDetail: type: string description: 'Complementary information describing the defined blocking reason Free text' lostStolenDate: type: string format: date-time description: 'Date when the card has been lost or stolen This date is provided in addition to the blocking reason (required only if the card is blocked in a context of loss/theft)' lossPlace: type: string description: 'Place where the card has been lost Free text' lossCountry: type: string description: 'Country of card loss or steal Can be required in certain countries (e.g. french issuers with CB) Free text (not check on the provided value)' lastUsageDate: type: string format: date-time description: ' Date of last use of the card Example: for lost or stolen reason' lastUsagePlace: type: string description: 'Last place where the card has been used Example: for lost or stolen reason' lossCircumstances: type: string description: 'Description of the circumstances of the card loss Free text' lossReportedBy: type: string description: 'Person who has reported the card loss Free text' lossReportedVia: type: string description: 'How was reported the loss (channel) Free text' fraudCode: type: string description: 'Fraud code can be used in the context of dispute management. Fraud code (free text) is provided in case of Fraud for Fraud declaration to the schemes (VISA, MasterCard). The value must be a value expected by the schemes.' contactData: type: string description: 'Indicates contact data (usually phone number) Free text' pinCompromised: type: boolean description: 'Indicates if the PIN is compromised (true) or not (false) only in case of lost or stolen reason. Default value is false ' customerRequestingBlockDate: type: string format: date-time description: 'Date when the customer has declared the blocking request. For example, the cardholder calls the customer service at 4 pm to declare he lost his card and the card blocking request can only be sent at 5 pm to the system: then the customerRequestingBlockDateTime is 4 pm.' transferEffectiveDate: type: string format: date-time description: Transfer effective date (either a date prior to the card blocking date time or it is the card blocking date time in our system) noReplacementReason: type: string description: 'The reason why the card is not replaced. Free text' comment: type: string description: 'Comment associated with the card blocking action Free text' cppFlag: type: boolean description: DEPRECATED fraudProcess: type: string description: "Fraud process in which the card is blocked. \nPossible values : \n•\tCPP : the card is in CCP list \n•\tTFI : Fraud detected for a single card \n•\tMBA : Fraud detected for several cards (Mass action)" scheduledCardBlockingDate: type: string format: date-time description: Date when the permanent card blocking is scheduled scheduledCardBlockingDelay: type: integer description: Delay in calendar days used to permanently block the card in the future scheduledCardBlockingReason: type: string description: 'Blocking reason used when the card is blocked in the future Relevant if a scheduled permanent blocking is requested at the same time as an immediate temporary card blocking. Permanent blocking reasons used context of loss/theft are not allowed.' transactionId: type: string description: Indicates the transactionId of the suspicious transaction that has triggered the card blocking. title: CardBlockingInformation ReplaceCardRequestCardContract: type: object properties: specificFields: type: object description: The issuer can update Specific Fields for the card contract during the card replacement. It is a list of external data {"label":"value"} separated by a "," related to the card contract (pass-thru data) that can be provided by e.g. the issuer for information or for usage by other systems. A new data can be added or an existing data can be updated {"label1":"newValue"} or removed {"label2":"null"}. Any existing data that is not present in this list is not updated in the card contract. Those provided data have no impact on our system business processes. additionalProperties: type: string card: description: Card allOf: - $ref: '#/definitions/ReplaceCardRequestCardContractCard' cardHolder: description: Card holder data to update before replacing the card (in related customer resource having customerIdentifier equals to CardContract.cardHolderIdentifier). Only the fields provided in request will be updated, others will remain unchanged. allOf: - $ref: '#/definitions/ModifyCustomerRequest' selectedModels: type: array description: The issuer can replace one or several models linked to the card contract if this latest is active (only applicable for TECHNOLOGY_AND_APPLICATION_MODEL for the moment) items: $ref: '#/definitions/CardContractModel' schemeReportDeclarationBehavior: type: string description: 'The issuer can indicate if the card events are reported to the scheme. Relevant only if the ABU-VAU program is enabled. If the ABU-VAU program is disabled, the use of this attribute generates an error. Possible values are: OPT_IN: the card events are reported to the scheme, OPT_OUT: the card events are not reported to the scheme. If the ABU-VAU program is enabled and the attribute is empty, the default value set on card product is applied.' clickToPayEnrollment: type: string description: "Indicates if the card enrollment in Click to Pay service is requested or not. \nRelevant only if the Click to Pay feature is enabled. If the Click to Pay feature is disabled, the use of this attribute generates an error.\n\nPossible values are :\n- OPT_IN : enrollment of the card in Click to Pay service is requested.\n- OPT_OUT : enrollment of the card in Click to Pay service is not requested. \n\nIf the Click to Pay feature is enabled and the attribute is empty, the default value set on card product is applied.\n\nAs a result :\nIf OPT_IN, the enrollment of the new card in Click to Pay service is requested and will be effective through WL iTSP at card activation\nIf OPT_OUT, the enrollment of the new card in Click to Pay service is not requested." forcedEmbossingName: type: string description: 'The issuer can provide the embossing name (first line of the name embossed on the physical card) for the new card if allowed within card Technology and Application model. By default, the previous value is used. The character "*" is not allowed in the line 1 of the embossing name.' forcedEmbossingName2ndLine: type: string description: 'The issuer can provide the 2nd Line of embossing name for the new card if the first line of embossing name is provided and if it is allowed by the embossing name calculation algorithm. By default, the previous value is used. The character "*" is not allowed in the line 2 of the embossing name.' title: ReplaceCardRequest.CardContract ChangeProductResponseOrder: type: object properties: orderIdentifier: description: Identification of the order either by the Issuer order external reference or the order reference. allOf: - $ref: '#/definitions/OrderIdentifier' orderType: type: string description: Order type currentInternalStatus: type: string description: 'Current status of the order. Refer to Order.currentInternalStatus' title: Order ReplaceCardResponseOrder: type: object properties: orderIdentifier: description: Order reference calculated by our system allOf: - $ref: '#/definitions/OrderIdentifier' orderType: type: string description: Refer to Order.orderType currentInternalStatus: type: string description: Refer to Order.currentInternalStatus title: ReplaceCardResponse.Order AdviceProductExtensionCardResponse: type: object required: - cardIdentifier properties: cardIdentifier: description: Unique identifier of the card provided in the request allOf: - $ref: '#/definitions/CardIdentifier' advisedProductExtensionIdentifier: description: Identifier of the product extension advised for the card replacement allOf: - $ref: '#/definitions/ProductExtensionIdentifier' currentProductExtensionIdentifier: description: Identifier of the current product extension for the card to be replaced allOf: - $ref: '#/definitions/ProductExtensionIdentifier' title: AdviceProductExtensionCardResponse Links: type: object required: - self properties: self: type: string example: /x/{x}?x=x description: Service method URL next: type: string example: /x/{x}?page[offset]=2 description: URL pagination query parameter next page title: Links ReorderPINResponse: type: object properties: orderIdentifier: $ref: '#/definitions/OrderIdentifier' currentInternalStatus: type: string example: ORDERABLE description: Current internal status of the order (mandatory). orderType: type: string example: CardOrder, TanMailerOrder, PinMailerOrder description: ' Type of the order.' title: ReorderPINResponse DisputeFolderIdentifier: type: object required: - disputeFolderReference properties: disputeFolderReference: type: string description: "The Dispute Folder Reference \nPresent if \"Dispute Folder\" creation is successful. \nThe value of this field is constructed by algorithm. Example for IDM4Sempris, it is like this : D-V-6500-1234-1 (D = for Dispute / M = MCI , V= VISA / 6500 = issuerId / 1234 = YDDD = julien date / 1 = the sequence is constructed under (D-scheme Id- Issuer Id))" issuerDisputeExternalReference: type: string description: The issuer Dispute External Reference, Present if provided in the request. title: DisputeFolderIdentifier ActivateCardRequest: type: object required: - activationReasonCode properties: activationReasonCode: type: string description: Activation reason chosen among the reasons configured for the issuer title: ActivateCardRequest ReplaceCardResponseCard: type: object description: Card Information Mandatory for card replacement process Not filled in case of product change, triggered by card replacement (originalContract and changedContract include card information) required: - cardIdentifier - panSequenceNumber - status - replacementFor properties: cardIdentifier: description: CardIdentifier of the new card allOf: - $ref: '#/definitions/CardIdentifier' pan: type: string description: PAN of the new card maskedPan: type: string description: Masked PAN of the new card expiryDate: type: string description: 'Expiry Date of the new card Format is MMYY (month and year).' panSequenceNumber: type: string description: Pan Sequence Number of the new card status: type: string description: Card status of the new card (CREATED or ACTIVE, depending on the configuration of the card creation model) externalStatus: type: string description: 'External status of the card Possible values are: - IN_PROGRESS (it implies the card has not registered in all the WL systems) - CREATED (it implies the card is registered in all the WL systems and ready for use) - ERROR (the synchronization process between WL systems is failed)' replacementFor: description: CardIdentifier of the replaced card allOf: - $ref: '#/definitions/CardIdentifier' orders: type: array description: List of orders linked to the new card items: $ref: '#/definitions/ReplaceCardResponseOrder' orderIdentifier: description: Order Identifier allOf: - $ref: '#/definitions/OrderIdentifier' panReference: type: string description: Reference related to the PAN for the new card. Refer to Card.panReference automaticDeactivationDate: type: string format: date-time description: Automatic deactivation date of the replaced card. Relevant if the feature is enabled for the issuer. title: ReplaceCardResponse.Card OriginalAccount: type: object properties: accountIdentifier: description: Identification of the account either by the Issuer account external reference or the account reference. allOf: - $ref: '#/definitions/AccountIdentifier' status: type: string description: 'Current status of the account. Refer to Account.status' changedAccountIdentifier: description: Identification of the new account either by the Issuer account external reference or the account reference. allOf: - $ref: '#/definitions/AccountIdentifier' title: OriginalAccount UnauthorizedResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated statusCode: type: integer format: int32 example: 401 description: HTTP status code statusMessage: type: string example: Unauthorized description: Executed REST API status message title: UnauthorizedResponseMetadata ApiResponseEntityReplaceCardResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/ReplaceCardResponse' description: Issuer response entity title: ApiResponseEntityReplaceCardResponse ApiResponseEntityReorderPINResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/ReorderPINResponse' description: Issuer response entity title: ApiResponseEntityReorderPINResponse ReplaceCardRequestPinMailerOrder: type: object description: Pin Mailer Order for the new card.Empty if no PIN mailer order needed properties: pinMailerEditor: type: string description: Refer to Order.pinMailerEditor sendingMode: type: string description: 'The issuer must provide the sending mode for a physical card if no default sending mode is defined for the replacement reason in the replacement model. In the other cases, the sending mode is optional (for a virtual card or if the skipPinMailerOrderGeneration field is set to true or for a physical card if a default sending mode has been defined for the replacement reason).' deliveryChannel: type: string description: 'The issuer can provide the delivery channel if a creation of a PIN order is requested (if the skipPinMailerOrderGeneration field is set to false). By default, the delivery channel from the distribution rule of the card product will be used.' deliveryType: type: string description: 'Indicates whether the delivery of the PIN should be to branch or customer (instead of the one from the distribution rule of the card product) Possible values are: CUSTOMER, BRANCH To override the delivery address, the pin mailer delivery type must not be provided and only one of these fields must be provided: customDeliveryAddress, customDeliveryEmail or customDeliveryPhone.' deliveryBranchCode: type: string description: 'The issuer must provide the PIN delivery branch code if the delivery type is BRANCH. Refer to Order.deliveryBranchCode' customDeliveryAddressee: type: string description: 'Refer to Order.customDeliveryAddressee When the customDeliveryAddress is provided, the field must also be provided.' customDeliveryAddress: description: 'Refer to Order.customDeliveryAddress. The customDeliveryAddressee must also be provided when the field is provided.' allOf: - $ref: '#/definitions/CreateAddressRequestMailAddress' customDeliveryEmail: description: Refer to Order.customDeliveryEmail allOf: - $ref: '#/definitions/EmailAddress' customDeliveryPhone: description: Refer to Order.customDeliveryPhone allOf: - $ref: '#/definitions/CreateAddressRequestPhoneNumber' specificFields: type: object description: 'The issuer can provide Specific Fields for the PIN mailer order. It is a list of external data {"label":"value"} separated by a "," related to the PIN mailer order (pass-thru data) that can be provided by e.g. the issuer for information or for usage by other systems. Example : {"label1":"value1","label2":"value2"} Those provided data have no impact on our system business processes.' additionalProperties: type: string skipPinMailerOrderGeneration: type: boolean description: 'Pin mailer will be not generated if this field is true. If this field is false or empty, the pin mailer order will be generated as per the product configuration. By default, value is false.' default: false title: ReplaceCardRequest.PinMailerOrder NotFoundResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated statusCode: type: integer format: int32 example: 404 description: HTTP status code statusMessage: type: string example: Not found description: Executed REST API status message title: NotFoundResponseMetadata ResponseMetadata: type: object required: - correlationId - responseDateTime - statusCode - statusMessage properties: correlationId: type: string description: Correlation Identifier links: description: Metadata Links allOf: - $ref: '#/definitions/Links' statusMessage: type: string example: Executed successfully description: Executed REST API status message statusCode: type: integer format: int32 example: 200 description: HTTP status code responseDateTime: type: string example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ description: Timestamp when response date was generated timeTakenMs: type: integer format: int64 example: 12 description: Wall clock time required from service to generate the response title: ResponseMetadata AccountRelation: type: object required: - relation - accountIdentifier properties: relation: type: string description: Is a combination of criteria to describe the posting rule (one criteria or combination of several ones such as transaction currency = XXX) for each posting account - DEFAULT for the default posting account. accountIdentifier: description: Identification of the account either by the Issuer account external reference or by the account reference. allOf: - $ref: '#/definitions/AccountIdentifier' title: AccountRelation OrderStatusHistory: type: object properties: type: type: string description: 'Type of the history order status (mandatory) Possible values: InternalStatus or ProducerStatus' date: type: string format: date-time description: Date of the history order status (mandatory) status: type: string description: 'Status of the history order (mandatory) The possible values are the same the ones defined for the current internal status and the current external status depending on the type of the order status. ' title: OrderStatusHistory ApiResponseEntityCreateTanResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/CreateTanResponse' description: Issuer response entity title: ApiResponseEntityCreateTanResponse ModifyAddressRequestMailAddress: type: object required: - country properties: typeCode: type: string description: DEPRECATED courtesyTitle: type: string description: Courtesy title of the address. Free text line1: type: string description: Address line 1 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line2: type: string description: Address line 2 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line3: type: string description: Address line 3 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line4: type: string description: Address line 4 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line5: type: string description: Address line 5 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). buildingNumber: type: string description: Building number of the address (optional) boxNumber: type: string description: Box number of the address (optional) streetName: type: string description: Street name of the address (optional) postCode: type: string description: zip code of the address (optional) townName: type: string description: City corresponding to the address countrySubdivision: type: string description: Subdivision of the country (optional) country: type: string description: Code of the country (mandatory). Free text. The value can be subject to a validation process if a specific rule has been configured at issuer level. The value can be optional if a specific rule has been configured. title: ModifyAddressRequest.MailAddress PinChangeInformation: type: object properties: freePinChangeCounter: type: integer description: Free pin change counter requestDate: type: string format: date-time description: Request date source: type: string description: Source of the PIN change request (optional) e.g. IVR, online banking. changeType: type: string description: Type of the PIN change request (mandatory) e.g. First PIN selection or PIN change or PIN inherited from another card for which the PIN is changed. free: type: boolean description: Indicates if the pin change is free of charge title: PinChangeInformation BlockAllCardsRequest: type: object properties: pan: type: string description: 'The issuer can provide the PAN to block all the cards having this PAN. If both PAN and PAN reference are provided, the cards blocking will be done only on the PAN and the PAN reference will be ignored.' panReference: type: string description: 'The issuer can provide the PAN reference to block all the cards having this PAN reference. If both PAN and PAN reference are provided, the cards blocking will be done only on the PAN and the PAN reference will be ignored.' blockingReason: type: string description: The blocking reason must be provided if the card is not already blocked or temporary blocked with a scheduled information present on the card and without a new scheduled blocking request, otherwise it is optional. blockingReasonDetail: type: string description: Refer to CardBlockingInformation.blockingReasonDetail lostStolenDate: type: string format: date-time description: "This date can be provided in addition to the blocking reason if the card is blocked in a context of loss/theft (usually mandatory as per issuer configuration). \nThe date will be ignored if the provided blocking reason is not requiring it." lossPlace: type: string description: Refer to CardBlockingInformation.lossPlace lastUsageDate: type: string format: date-time description: 'Refer to CardBlockingInformation.lastUsageDate The Last Usage Date must not be later than current date.' lastUsagePlace: type: string description: Refer to CardBlockingInformation.lastUsagePlace lossCircumstances: type: string description: Refer to CardBlockingInformation.lossCircumstances lossReportedBy: type: string description: Refer to CardBlockingInformation.lossReportedBy lossReportedVia: type: string description: Refer to CardBlockingInformation.lossReportedVia fraudCode: type: string description: Refer to CardBlockingInformation.fraudCode lossCountry: type: string description: Refer to CardBlockingInformation.lossCountry contactData: type: string description: Refer to CardBlockingInformation.contactData pinCompromised: type: boolean description: Refer to CardBlockingInformation.pinCompromised customerRequestingBlockDate: type: string format: date-time description: Refer to CardBlockingInformation.customerRequestingBlockDate transferEffectiveDate: type: string format: date-time description: Refer to CardBlockingInformation.transferEffectiveDate noReplacementReason: type: string description: Refer to CardBlockingInformation.noReplacementReason comment: type: string description: Refer to CardBlockingInformation.comment waiveFee: type: boolean description: 'Indicates if the configured fee (if any) is waived (true) or not (false) while blocking card. By default is false.' default: false cppFlag: type: boolean description: DEPRECATED default: false fraudProcess: type: string description: "Fraud process which leads to card blocking.\n\t\t\t\t\tPossible values : \n\t\t\t\t•CPP : the card is in CCP list\n\t\t\t\t•TFI : Fraud detected for a single card\n\t\t\t\t•MBA : Fraud detected for several cards (Mass action)" scheduledCardBlockingDate: type: string format: date-time description: Date when the permanent card blocking is scheduled scheduledCardBlockingDelay: type: integer description: 'Delay in calendar days used to block the card in the future. It has to be provided if a default delay is not configured or if the default delay is overridden. If the card remains active, the scheduled permanent blocking reason is provided in blockingReason.' scheduledCardBlockingReason: type: string description: 'Reason for scheduled permanent blocking Values = FRAUD_CPP or FRAUD_TFI (permanent blocking) Permanent blocking reasons used context of loss/theft are not allowed. Due to system logic, for current API the value of this field can be for permanent blocking only and can be set if the blockingReason attribute value is set to temporary blocking reason. If the card remains active with a scheduled permanent blocking, this field is empty and the scheduled permanent blocking reason is provided in blockingReason.' transactionId: type: string description: 'Relevant in the context of Fraud detection. Indicates the transactionId of the suspicious transaction that has triggered the card blocking.' cancelScheduledCardBlocking: type: boolean description: "If the card is ACTIVE or TEMPORARY BLOCKED and a scheduled information is already present on the card (scheduled permanent blocking):\n- a scheduled card blocking cancellation can be requested by providing the flag cancelScheduledCardBlocking to true.\nIn this case, the fields scheduledCardBlockingDelay, scheduledCardBlockingDate and scheduledCardBlockingReason must not be provided, otherwise the request is rejected\n- if a scheduled card blocking cancellation is not requested (the flag cancelScheduledCardBlocking is not provided or set to false).\nIn this case : \n* If a new scheduled permanent blocking is requested, the field scheduledCardBlockingDelay or scheduledCardBlockingDate must be provided if the delay is not yet reached. The field scheduledCardBlockingReason can optionally be provided if the card is temporary blocked.\n* If a new temporary blocking is requested, the field scheduledCardBlockingDelay, scheduledCardBlockingDate, scheduledCardBlockingReason must not be provided." default: false title: BlockAllCardsRequest CreateAddressRequestMailAddress: type: object required: - country properties: typeCode: type: string description: DEPRECATED courtesyTitle: type: string description: Courtesy title of the address. Free text line1: type: string description: Address line 1 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line2: type: string description: Address line 2 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line3: type: string description: Address line 3 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line4: type: string description: Address line 4 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). line5: type: string description: Address line 5 (conditional). Free text. A specific issuer algorithm can be activated to e.g. build the line, apply controls (e.g. length restriction). buildingNumber: type: string description: Building number of the address (optional) boxNumber: type: string description: Box number of the address (optional) streetName: type: string description: Street name of the address (optional) postCode: type: string description: zip code of the address (optional) townName: type: string description: City corresponding to the address countrySubdivision: type: string description: Subdivision of the country (optional) country: type: string description: Code of the country (mandatory). Free text. The value can be subject to a validation process if a specific rule has been configured at issuer level. The value can be optional if a specific rule has been configured. title: CreateAddressRequest.MailAddress ApiResponseEntityReleaseOrdersResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/ReleaseOrdersResponse' description: Issuer response entity title: ApiResponseEntityReleaseOrdersResponse DeclareCounterfeitCardResponse: type: object required: - counterfeitCardCreationDate properties: counterfeitCardCreationDate: description: Creation date of the counterfeit card type: string format: date-time title: DeclareCounterfeitCardResponse ApiResponseEntityCard: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Response data allOf: - $ref: '#/definitions/Card' description: Issuer response entity title: ApiResponseEntityCard CardChange: type: object properties: cardContractIdentifier: description: 'Card contract to which the card change is applied in the new card contract identified either by the Issuer card contract external reference or the Card contract reference. Mandatory if a card change is requested.' allOf: - $ref: '#/definitions/CardContractIdentifier' cardClass: type: string description: Card class for the new card title: CardChange ModifyCardBlockingInformationRequest: type: object properties: scheduledCardBlockingDelay: type: integer format: int32 description: 'Delay in calendar days used to block the card in the future. It can be updated if needed as long as the scheduled card blocking date is not yet reached and if the new scheduled card blocking date is in the future. If scheduledCardBlockingDelay is provided, scheduledCardBlockingDate is not relevant.' scheduledCardBlockingDate: type: string format: date-time description: 'Date when the permanent card blocking is scheduled If scheduledCardBlockingDate is provided, scheduledCardBlockingDelay is not relevant.' scheduledCardBlockingReason: type: string description: 'Scheduled permanent blocking reason. It is relevant if the card is already temporarily blocked. It can be updated if needed as long as the scheduled card blocking date is not yet reached Permanent blocking reasons used context of loss/theft are not allowed.' cppFlag: type: boolean description: DEPRECATED blockingReason: type: string description: 'Reason of the card blocking. It is selected among the card blocking reasons configured for the issuer. A permanently blocked card can''t be updated with a temporary card blocking reason.' blockingReasonDetail: type: string description: "Complementary information describing the defined blocking reason \nFree text" lostStolenDate: type: string format: date-time description: 'Date when the card has been lost or stolen Can be updated if the card was blocked previously in a context of loss/theft Required if the card is blocked in a context of loss/theft' pinCompromised: type: boolean description: 'Indicates if the PIN is compromised (true) or not (false). Can be updated if the blocking reason was previously Lost or Stolen. To be provided if the new blocking reason is Lost or Stolen' transferEffectiveDate: type: string format: date-time description: Transfer effective date. It must be a date prior to the card blocking date time comment: type: string description: 'Comment associated with the card blocking action. Free text.' fraudProcess: type: string description: "Fraud process which leads to card blocking.\n\t\t\t\t\tPossible values : \n\t\t\t\t•CPP : the card is in CCP list\n\t\t\t\t•TFI : Fraud detected for a single card\n\t\t\t\t•MBA : Fraud detected for several cards (Mass action)" title: ModifyCardBlockingInformationRequest BadRequestErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/BadRequestResponseMetadata' title: BadRequestErrorApiResponse ApiResponseEntityCreateEmergencyCardResponse: x-wl-api-response: true type: object required: - responseMetadata properties: data: description: Response data allOf: - $ref: '#/definitions/CreateEmergencyCardResponse' responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' title: ApiResponseEntityCreateEmergencyCardResponse description: Issuer response entity securityDefinitions: basic: type: oauth2 flow: application tokenUrl: https://sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/token