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 Card Issuing Account - AccountState Account - Operation API contact: {} host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing basePath: /api/v2 schemes: - https tags: - name: Account - Operation description: Account Operation Api Controller paths: /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations: get: tags: - Account - Operation summary: List operations for an account by external reference operationId: listOperationsByAccountIssuerExtRef description: "The API retrieves the list of operations for a given time period and a given account.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe account for which information is requested: it can be provided by using the account reference or the issuer external account reference,\n•\tA given time period (start date / end date)\nIt is also possible \n- to request the list of operations for all account hierarchy, for a certain PAN only by providing a PAN reference\n- to include internal operations (failed, rejected) in the statements\n- to exclude sub-operations generated during the payment (manual or automatic) / reimbursement apportionment on accounts\n\nOperations can be a scheme transaction or an operation generated internally.\nThe number of operations provided back can be indicated in the page and offset input field.\nThe API returns the most important operation attributes such as: the operation type, the amounts and the operation context. \nFor the full list of operation attributes, the \"Retrieve operation\" API should be used." 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: issuerAccountExternalReference in: path description: Issuer Account External Reference required: true type: string - name: allAccountHierarchy in: query description: Retrieve operations for all account hierarchy (default = only account operations are listed ) required: false type: boolean default: false - name: printOnStatement in: query description: 'Boolean parameter to indicate : - If only operations printed on statement should be returned (boolean = true or not provided) - Or if manual operations not printed on statement (internal operations such as rejections) should be also returned (boolean = false)' required: false type: boolean default: true - name: panReference in: query description: Reference of the PAN required: false type: string - name: excludeOperationKinds in: query description: 'Parameter to filter out sub-operations generated during the payment (manual or automatic)/reimbursement apportionment on accounts Available value : SUBPAYOP (apportionment operation)' required: false type: array items: type: string collectionFormat: multi - name: sort in: query description: 'To return the list of operations sorted by posting date / operation id. Available values : asc (for ascending sort) or desc (for descending sort)' required: false type: string - name: startTime in: query required: true type: string description: 'Format : yyyy-MM-ddTHH:mm:ssZ' - name: endTime in: query required: true type: string description: 'Format : yyyy-MM-ddTHH:mm:ssZ' - name: page in: query description: '0' required: false type: integer default: 0 format: int32 - name: offset in: query description: '100' required: false type: integer default: 100 format: int32 - name: includeOriginalAccount in: query description: 'Parameter to indicate if data related to the original account should be returned : case of a product change or a card reallocation (only for corporate cards).Default value is false.' required: false type: boolean default: false - name: embed in: query description: 'Available values for embed : authorization, addendum (to retrieve lodgingInformation, carRentalInformation, airItineraryInformation) ' required: false type: array items: type: string enum: - authorization - addendum 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/ApiResponseEntityListOperation' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}: get: tags: - Account - Operation summary: Retrieve operation by external reference operationId: retrieveOperationByAccountIssuerExtRef description: 'The API retrieves the detail of an operation for an account. It is also possible to request explicitly the operations linked to the current one by using the embedded field filled with parentOperation. A parent operation can be: the original operation when the requested operation is a reversal, relative fee operations linked to the current operation, refund/redebit operations for disputed transaction,.. In response, exhaustive information are provided that includes additional amounts if available (cash-back amount, DCC amount, gratuity amount, surcharge amount), exchange rate 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: issuerAccountExternalReference in: path description: Issuer Account External Reference required: true type: string - name: operationId in: path description: Operation ID required: true type: string - name: embed in: query description: 'Available values for embed : parentOperation, authorization, addendum (to retrieve lodgingInformation, carRentalInformation, airItineraryInformation) ' required: false type: array items: type: string enum: - parentOperation - authorization - addendum 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/ApiResponseEntityOperationDetails' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-balance-adjustment-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Post a balance adjustment operation for an account by external reference operationId: postBalanceAdjustmentOperationByIssuerExtRef description: 'The API is used to generate a balance adjustment operation on an account. The input account can be provided by using: - the account reference - or the issuer external account reference. 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 - name: issuerAccountExternalReference in: path description: Issuer Account External Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateOperationBalanceAdjustmentRequest' 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/ApiResponseEntityCreateOperationBalanceAdjustmentResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-fee-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Post a fee operation for an account by external reference operationId: postFeeOperationByIssuerExtRef description: "The API is used to post a fee operation to an account. \nThe fee type is mandatory, and the value must be consistent with the list defined during product definition. \nThis list is shared between WL and the issuer during the project phase.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference \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: issuerAccountExternalReference in: path description: Issuer Account External Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateOperationFeeRequest' 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/ApiResponseEntityCreateOperationFeeResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reset-balance: post: x-wl-idempotent: true tags: - Account - Operation summary: Reset the balance of an account by external reference operationId: resetBalanceByIssuerExtRef description: "The API resets the balance of an account by generating : \n a credit operation (for a debit balance) \n a debit operation (for a credit balance) \n\n As an input, the account identifier can be provided by using: \n the account reference generated by WL \n or the issuer external account reference \n This is relevant only for credit cards. \n 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 - name: issuerAccountExternalReference in: path description: Issuer Account External Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ResetBalanceRequest' 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/ApiResponseEntityResetBalanceResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-payment-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Post a payment operation for an account by external reference operationId: postPaymentOperationByIssuerExtRef description: "The API allows a payment operation to an account to be generated and posted.\nA payment operation is used to pay the due amount. \nIf the amount provided is greater than the due amount, the overpayment can be posted to another account if provided.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference \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: issuerAccountExternalReference in: path description: Issuer Account External Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateOperationPaymentRequest' 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/ApiResponseEntityCreateOperationPaymentResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-reimbursement-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Post a reimbursement operation by external reference operationId: postReimbursementOperationByIssuerExtRef description: 'The API allows a reimbursement operation to an account to be generated and posted depending on following conditions: The account must be in an ACTIVE or BEING_CLOSED status. Depending on the reimbursement model attached to the account hierarchy, the API has two behaviors: 1. If the reimbursement amount is limited by the account liable balance (default behavior) - The liable balance of the account must be in credit position - The reimbursement amount cannot be high than the liable balance 2. If the reimbursement amount is limited by the account OTB - The liable balance of the account can be in credit or debit position In both cases the reimbursement amount is limited by the Open-To-Buy of the account. A reimbursement operation allows to reimburse fully or partially the available amount on the account depending on the reimbursement type provided in input. As an input, the account identifier can be provided by using: - the account reference generated by WL - or the issuer external account reference As a result, the reimbursement operation is posted to the account and has an impact on the account balance. 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 - name: issuerAccountExternalReference in: path description: Issuer Account External Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateOperationReimbursementRequest' 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/ApiResponseEntityCreateOperationReimbursementResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-reimbursement-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Reverse a reimbursement operation by external reference (beta) operationId: reverseReimbursementOperationByIssuerExtRef description: "The API is used to fully reverse a reimbursement operation previously posted on an account.\nAs an input, it must be provided\n- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the reimbursement operation was previously posted \n- the reimbursement operation to be reversed\n the information related to the reversal operation (reference, date, service poster). \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: issuerAccountExternalReference in: path description: Issuer Account External Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ReverseOperationReimbursementRequest' 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/ApiResponseEntityReverseOperationReimbursementResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-load-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Load an account by external reference operationId: postLoadOperationByIssuerExtRef description: "The API allows an account to be loaded.\nA load operation is used for prepaid cards to put money in an account.\nThe operation can have a control on the amount authorized and trigger a load operation fee, if it is configured.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference \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: issuerAccountExternalReference in: path description: Issuer Account External Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateOperationLoadRequest' 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/ApiResponseEntityCreateOperationLoadResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-unload-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Unload an account by external reference operationId: postUnloadOperationByIssuerExtRef description: "The API allows an account to be unloaded. An unload operation is used for prepaid cards to retrieve money from an account.\nThe operation can have a control on the amount authorized.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference \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: issuerAccountExternalReference in: path description: Issuer Account External Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateOperationUnloadRequest' 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/ApiResponseEntityCreateOperationUnloadResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-balance-adjustment-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Reverse a balance adjustment operation for an account by external reference operationId: reverseBalanceAdjustmentOperationByIssuerExtRef description: "The API is used to reverse a balance adjustment operation on an account.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference\n\nThe balance adjustment operation to be reversed must be provided. \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: issuerAccountExternalReference in: path description: Issuer Account External Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ReverseOperationBalanceAdjustmentRequest' 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/ApiResponseEntityReverseOperationBalanceAdjustmentResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-fee-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Reverse a fee operation for an account by external reference operationId: reverseFeeOperationByIssuerExtRef description: "The API is used to reverse a fee operation on an account.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference\n\nThe fee type is mandatory. It must be consistent with the product definition. \nThe list of values is shared between WL and the issuer. \nThe fee reference to be reversed must be provided. \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: issuerAccountExternalReference in: path description: Issuer Account External Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ReverseOperationFeeRequest' 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/ApiResponseEntityReverseOperationFeeResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-payment-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Reverse a payment operation for an account (full reversal) by external reference operationId: reversePaymentOperationByIssuerExtRef description: "The API allows a payment reversal operation on an account.\nA payment reversal can be requested when a direct debit returns unpaid.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference\n\nThe payment reference to be reversed must be provided. \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: issuerAccountExternalReference in: path description: Issuer Account External Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ReverseOperationPaymentRequest' 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/ApiResponseEntityReverseOperationPaymentResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-interest-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Post an interest operation for an account by external reference description: "The API is used to post manually an interest operation to an account.\n\nAs an input it must be provided\n- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the interest operation has to be posted \n- the interest operation itself, uniquely identified by its external reference, date and service poster, its amount in currency (monetary)\nNote: \n- the provided currency must be the same than the posting account\n- it is possible to post credit and debit interest operation \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.\n\nAs a result, the interest operation is posted to the account and has an impact on the account balance, immediately or not depending on the provided value date." operationId: postInterestOperationByIssuerExtRef 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: issuerAccountExternalReference in: path description: issuerAccountExternalReference required: true type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: issuerId required: true type: string - in: body name: requestBody description: requestBody required: true schema: $ref: '#/definitions/CreateOperationInterestRequest' responses: '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateOperationInterestResponse' '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}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-interest-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Reverse an interest operation for an account (full reversal) by external reference description: "The API is used to fully reverse an interest operation previously posted on an account.\n\nAs an input, it must be provided\n- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the interest operation was previously posted \n- the interest operation to be reversed\n- the information related to the reversal operation (reference, date, service poster) \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." operationId: reverseInterestOperationByIssuerExtRef 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: issuerAccountExternalReference in: path description: issuerAccountExternalReference required: true type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: issuerId required: true type: string - in: body name: requestBody description: requestBody required: true schema: $ref: '#/definitions/ReverseOperationInterestRequest' responses: '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityReverseOperationInterestResponse' '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}/accounts/external-accounts/{issuerAccountExternalReference}/post-bonus-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Post a Bonus operation for an account by external reference description: "The API is used to post manually a Bonus operation to an account.\nA Bonus operation is used to reward or adjust a given account (in credit or in debit, e.g. in case of too high, too low or missing reward).\nAs an input it must be provided\n- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation has to be posted \n- the related Bonus program, defined for the issuer and the account\n- the Bonus operation itself, uniquely identified by its external reference, date and service poster, its amount in currency (monetary) or loyalty point kind (non monetary)\nNote: \n- for monetary bonus the provided currency must be the same than the posting account, for non monetary bonus the provided loyalty point unit must be allowed by the Bonus program\n- it is possible to post credit and debit bonus operation\n\nIf the Bonus operation is related to an existing initial operation, this latter can be provided.\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.\n\nAs a result the Bonus operation is posted to the account. Monetary bonus has an immediate impact on the account balance." operationId: postBonusOperationByIssuerExtRef 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: issuerAccountExternalReference in: path description: issuerAccountExternalReference required: true type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: issuerId required: true type: string - in: body name: requestBody description: requestBody required: true schema: $ref: '#/definitions/CreateOperationBonusRequest' responses: '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateOperationBonusResponse' '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}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-bonus-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Reverse a Bonus operation for an account by external reference description: "The API is used to fully reverse a Bonus operation previously posted on an account.\n\nAs an input it must be provided\n- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation was previously posted \n- the Bonus operation to be reversed\n- the information related to the reversal operation (reference, date, service poster) \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." operationId: reverseBonusOperationByIssuerExtRef 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: issuerAccountExternalReference in: path description: issuerAccountExternalReference required: true type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: issuerId required: true type: string - in: body name: requestBody description: requestBody required: true schema: $ref: '#/definitions/ReverseOperationBonusRequest' responses: '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityReverseOperationBonusResponse' '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}/accounts/external-accounts/{issuerAccountExternalReference}/inquire-operation: post: tags: - Account - Operation summary: Retrieve an operation by external references triplet and account external reference description: "This API allows retrieving for an account a particular operation from its external references.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe account reference or the issuer external account reference\n•\tThe external references of the operation for which the detail is requested: The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifying the operation in our system must be provided.\nThe API response contains operation information." operationId: inquireOperationByIssuerExtRef 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: issuerAccountExternalReference in: path description: issuerAccountExternalReference required: true type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: embed in: query description: 'Available values for embed : parentOperation, authorization, addendum (to retrieve lodgingInformation, carRentalInformation, airItineraryInformation) ' required: false type: array items: type: string enum: - parentOperation - authorization - addendum collectionFormat: multi - name: issuerId in: path description: issuerId required: true type: string - in: body name: requestBody description: requestBody required: true schema: $ref: '#/definitions/InquireOperationRequest' responses: '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityInquireOperationResponse' '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}/accounts/{accountReference}/operations: get: tags: - Account - Operation summary: List operations for an account operationId: listOperations description: "The API retrieves the list of operations for a given time period and a given account.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe account for which information is requested: it can be provided by using the account reference or the issuer external account reference,\n•\tA given time period (start date / end date)\nIt is also possible \n- to request the list of operations for all account hierarchy, for a certain PAN only by providing a PAN reference\n- to include internal operations (failed, rejected) in the statements\n- to exclude sub-operations generated during the payment (manual or automatic) / reimbursement apportionment on accounts\n\nOperations can be a scheme transaction or an operation generated internally.\nThe number of operations provided back can be indicated in the page and offset input field.\nThe API returns the most important operation attributes such as: the operation type, the amounts and the operation context. \nFor the full list of operation attributes, the \"Retrieve operation\" API should be used." 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: accountReference in: path description: Account Reference required: true type: string - name: allAccountHierarchy in: query description: Retrieve operations for all account hierarchy (default = only account operations are listed ) required: false type: boolean default: false - name: excludeOperationKinds in: query description: 'Parameter to filter out sub-operations generated during the payment (manual or automatic)/reimbursement apportionment on accounts Available value : SUBPAYOP (apportionment operation)' required: false type: array items: type: string collectionFormat: multi - name: printOnStatement in: query description: 'Boolean parameter to indicate : - If only operations printed on statement should be returned (boolean = true or not provided) - Or if manual operations not printed on statement (internal operations such as rejections) should be also returned (boolean = false)' required: false type: boolean default: true - name: panReference in: query description: Reference of the PAN required: false type: string - name: sort in: query description: 'To return the list of operations sorted by posting date / operation id. Available values : asc (for ascending sort) or desc (for descending sort)' required: false type: string - name: startTime in: query required: true type: string description: 'Format : yyyy-MM-ddTHH:mm:ssZ' - name: endTime in: query required: true type: string description: 'Format : yyyy-MM-ddTHH:mm:ssZ' - name: page in: query description: '0' required: false type: integer default: 0 format: int32 - name: offset in: query description: '100' required: false type: integer default: 100 format: int32 - name: includeOriginalAccount in: query description: 'Parameter to indicate if data related to the original account should be returned : case of a product change or a card reallocation (only for corporate cards).Default value is false.' required: false type: boolean default: false - name: embed in: query description: 'Available values for embed : authorization, addendum (to retrieve lodgingInformation, carRentalInformation, airItineraryInformation) ' required: false type: array items: type: string enum: - authorization - addendum 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/ApiResponseEntityListOperation' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}: get: tags: - Account - Operation summary: Retrieve operation operationId: retrieveOperation description: 'The API retrieves the detail of an operation for an account. It is also possible to request explicitly the operations linked to the current one by using the embedded field filled with parentOperation. A parent operation can be: the original operation when the requested operation is a reversal, relative fee operations linked to the current operation, refund/redebit operations for disputed transaction,.. In response, exhaustive information are provided that includes additional amounts if available (cash-back amount, DCC amount, gratuity amount, surcharge amount), exchange rate 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: accountReference in: path description: Account Reference required: true type: string - name: operationId in: path description: Operation ID required: true type: string - name: embed in: query description: 'Available values for embed : parentOperation, authorization, addendum (to retrieve lodgingInformation, carRentalInformation, airItineraryInformation) ' required: false type: array items: type: string enum: - parentOperation - authorization - addendum 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/ApiResponseEntityOperationDetails' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/{accountReference}/post-balance-adjustment-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Post a balance adjustment operation for an account operationId: postBalanceAdjustmentOperation description: "The API is used to generate a balance adjustment operation on an account. \nThe input account can be provided by using:\n- the account reference\n- or the issuer external account reference.\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: accountReference in: path description: Account Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateOperationBalanceAdjustmentRequest' 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/ApiResponseEntityCreateOperationBalanceAdjustmentResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/{accountReference}/post-fee-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Post a fee operation for an account operationId: postFeeOperation description: "The API is used to post a fee operation to an account. \nThe fee type is mandatory, and the value must be consistent with the list defined during product definition. \nThis list is shared between WL and the issuer during the project phase.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference \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: accountReference in: path description: Account Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateOperationFeeRequest' 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/ApiResponseEntityCreateOperationFeeResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/{accountReference}/reset-balance: post: x-wl-idempotent: true tags: - Account - Operation summary: Reset the balance of an account operationId: resetBalance description: "The API resets the balance of an account by generating : \n a credit operation (for a debit balance) \n a debit operation (for a credit balance) \n\n As an input, the account identifier can be provided by using: \nthe account reference generated by WL \n or the issuer external account reference \n This is relevant only for credit cards. \n 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 - name: accountReference in: path description: Account Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ResetBalanceRequest' 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/ApiResponseEntityResetBalanceResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/{accountReference}/post-payment-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Post a payment operation for an account operationId: postPaymentOperation description: "The API allows a payment operation to an account to be generated and posted.\nA payment operation is used to pay the due amount. \nIf the amount provided is greater than the due amount, the overpayment can be posted to another account if provided.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference.\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: accountReference in: path description: Account Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateOperationPaymentRequest' 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/ApiResponseEntityCreateOperationPaymentResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/{accountReference}/post-reimbursement-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Post a reimbursement operation operationId: postReimbursementOperation description: 'The API allows a reimbursement operation to an account to be generated and posted depending on following conditions: The account must be in an ACTIVE or BEING_CLOSED status. Depending on the reimbursement model attached to the account hierarchy, the API has two behaviors: 1. If the reimbursement amount is limited by the account liable balance (default behavior) - The liable balance of the account must be in credit position - The reimbursement amount cannot be high than the liable balance 2. If the reimbursement amount is limited by the account OTB - The liable balance of the account can be in credit or debit position In both cases the reimbursement amount is limited by the Open-To-Buy of the account. A reimbursement operation allows to reimburse fully or partially the available amount on the account depending on the reimbursement type provided in input. As an input, the account identifier can be provided by using: - the account reference generated by WL - or the issuer external account reference As a result, the reimbursement operation is posted to the account and has an impact on the account balance. 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 - name: accountReference in: path description: Account Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateOperationReimbursementRequest' 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/ApiResponseEntityCreateOperationReimbursementResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/{accountReference}/reverse-reimbursement-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Reverse a reimbursement operation (beta) operationId: reverseReimbursementOperation description: "The API is used to fully reverse a reimbursement operation previously posted on an account.\nAs an input, it must be provided\n- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the reimbursement operation was previously posted \n- the reimbursement operation to be reversed\n the information related to the reversal operation (reference, date, service poster). \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: accountReference in: path description: Account Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ReverseOperationReimbursementRequest' 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/ApiResponseEntityReverseOperationReimbursementResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/{accountReference}/post-load-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Load an account operationId: postLoadOperation description: "The API allows an account to be loaded.\nA load operation is used for prepaid cards to put money in an account.\nThe operation can have a control on the amount authorized and trigger a load operation fee, if it is configured.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference \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: accountReference in: path description: Account Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateOperationLoadRequest' 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/ApiResponseEntityCreateOperationLoadResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/{accountReference}/post-unload-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Unload an account operationId: postUnloadOperation description: "The API allows an account to be unloaded. An unload operation is used for prepaid cards to retrieve money from an account.\nThe operation can have a control on the amount authorized.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference \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: accountReference in: path description: Account Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/CreateOperationUnloadRequest' 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/ApiResponseEntityCreateOperationUnloadResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/{accountReference}/reverse-balance-adjustment-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Reverse a balance adjustment operation for an account operationId: reverseBalanceAdjustmentOperation description: "The API is used to reverse a balance adjustment operation on an account.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference\n\nThe balance adjustment operation to be reversed must be provided. \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: accountReference in: path description: Account Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ReverseOperationBalanceAdjustmentRequest' 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/ApiResponseEntityReverseOperationBalanceAdjustmentResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/{accountReference}/reverse-fee-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Reverse a fee operation for an account operationId: reverseFeeOperation description: "The API is used to reverse a fee operation on an account.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference\n\nThe fee type is mandatory. It must be consistent with the product definition. \nThe list of values is shared between WL and the issuer. \nThe fee reference to be reversed must be provided.\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: accountReference in: path description: Account Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ReverseOperationFeeRequest' 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/ApiResponseEntityReverseOperationFeeResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/{accountReference}/reverse-payment-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Reverse a payment operation for an account (full reversal) operationId: reversePaymentOperation description: "The API allows a payment reversal operation on an account.\nA payment reversal can be requested when a direct debit returns unpaid.\nAs an input, the account identifier can be provided by using:\n- the account reference generated by WL\n- or the issuer external account reference\n\nThe payment reference to be reversed must be provided. \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: accountReference in: path description: Account Reference required: true type: string - in: body name: body required: true schema: $ref: '#/definitions/ReverseOperationPaymentRequest' 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/ApiResponseEntityReverseOperationPaymentResponse' security: - basic: [] deprecated: false /issuers/{issuerId}/accounts/{accountReference}/post-interest-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Post an interest operation for an account description: "The API is used to post manually an interest operation to an account.\n\nAs an input it must be provided\n- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the interest operation has to be posted \n- the interest operation itself, uniquely identified by its external reference, date and service poster, its amount in currency (monetary)\nNote: \n- the provided currency must be the same than the posting account\n- it is possible to post credit and debit interest operation \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.\n\nAs a result, the interest operation is posted to the account and has an impact on the account balance, immediately or not depending on the provided value date." operationId: postInterestOperation 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: accountReference in: path description: accountReference required: true type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: issuerId required: true type: string - in: body name: requestBody description: requestBody required: true schema: $ref: '#/definitions/CreateOperationInterestRequest' responses: '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateOperationInterestResponse' '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}/accounts/{accountReference}/reverse-interest-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Reverse an interest operation for an account (full reversal) description: "The API is used to fully reverse an interest operation previously posted on an account.\n\nAs an input, it must be provided\n- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the interest operation was previously posted \n- the interest operation to be reversed\n- the information related to the reversal operation (reference, date, service poster) \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." operationId: reverseInterestOperation 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: accountReference in: path description: accountReference required: true type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: issuerId required: true type: string - in: body name: requestBody description: requestBody required: true schema: $ref: '#/definitions/ReverseOperationInterestRequest' responses: '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityReverseOperationInterestResponse' '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}/accounts/{accountReference}/post-bonus-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Post a Bonus operation for an account description: "The API is used to post manually a Bonus operation to an account.\nA Bonus operation is used to reward or adjust a given account (in credit or in debit, e.g. in case of too high, too low or missing reward).\nAs an input it must be provided\n- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation has to be posted \n- the related Bonus program, defined for the issuer and the account\n- the Bonus operation itself, uniquely identified by its external reference, date and service poster, its amount in currency (monetary) or loyalty point kind (non monetary)\nNote: \n- for monetary bonus the provided currency must be the same than the posting account, for non monetary bonus the provided loyalty point unit must be allowed by the Bonus program\n- it is possible to post credit and debit bonus operation\n\nIf the Bonus operation is related to an existing initial operation, this latter can be provided. \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.\n\nAs a result the Bonus operation is posted to the account. Monetary bonus has an immediate impact on the account balance." operationId: postBonusOperation 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: accountReference in: path description: accountReference required: true type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: issuerId required: true type: string - in: body name: requestBody description: requestBody required: true schema: $ref: '#/definitions/CreateOperationBonusRequest' responses: '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityCreateOperationBonusResponse' '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}/accounts/{accountReference}/reverse-bonus-operation: post: x-wl-idempotent: true tags: - Account - Operation summary: Reverse a Bonus operation for an account description: "The API is used to fully reverse a Bonus operation previously posted on an account.\n\nAs an input it must be provided\n- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation was previously posted \n- the Bonus operation to be reversed\n- the information related to the reversal operation (reference, date, service poster) \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." operationId: reverseBonusOperation 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: accountReference in: path description: accountReference required: true type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: issuerId in: path description: issuerId required: true type: string - in: body name: requestBody description: requestBody required: true schema: $ref: '#/definitions/ReverseOperationBonusRequest' responses: '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityReverseOperationBonusResponse' '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}/accounts/{accountReference}/inquire-operation: post: tags: - Account - Operation summary: Retrieve an operation by external references triplet description: "This API allows retrieving for an account a particular operation from its external references.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe account reference or the issuer external account reference\n•\tThe external references of the operation for which the detail is requested: The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifying the operation in our system must be provided.\nThe API response contains operation information." operationId: inquireOperation 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: accountReference in: path description: accountReference required: true type: string - name: filter in: query description: Filtered Fields required: false type: array items: type: string collectionFormat: multi - name: embed in: query description: 'Available values for embed : parentOperation, authorization, addendum (to retrieve lodgingInformation, carRentalInformation, airItineraryInformation) ' required: false type: array items: type: string enum: - parentOperation - authorization - addendum collectionFormat: multi - name: issuerId in: path description: issuerId required: true type: string - in: body name: requestBody description: requestBody required: true schema: $ref: '#/definitions/InquireOperationRequest' responses: '200': description: OK schema: $ref: '#/definitions/ApiResponseEntityInquireOperationResponse' '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 definitions: 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 ApiResponseEntityCreateOperationPaymentResponse: 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/CreateOperationPaymentResponse' description: Issuer response entity title: ApiResponseEntityCreateOperationPaymentResponse ReverseOperationInterestRequest: type: object required: - externalMatchingOperationReference - externalMatchingOperationDate - externalMatchingOperationServicePoster - externalOperationReference - externalOperationDate - externalOperationServicePoster properties: description: description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer.' type: string externalMatchingOperationReference: description: 'The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. It is used for retrieving the operation to be reversed. The field contains the value of externalOperationReference of the original operation to be reversed.' type: string externalMatchingOperationDate: description: 'The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. It is used for retrieving the operation to be reversed. The field contains the value of externalOperationDate of the original operation to be reversed.' type: string format: date-time externalMatchingOperationServicePoster: description: 'The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. It is used for retrieving the operation to be reversed. The field contains the value of externalOperationServicePoster of the original operation to be reversed.' type: string externalOperationReference: description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' type: string externalOperationDate: description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided)' type: string format: date-time externalOperationServicePoster: description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text).' type: string title: ReverseOperationInterestRequest ApiResponseEntityResetBalanceResponse: x-wl-api-response: true type: object required: - responseMetadata properties: responseMetadata: description: Response metadata allOf: - $ref: '#/definitions/ResponseMetadata' data: description: Issuer response entity allOf: - $ref: '#/definitions/ResetBalanceResponse' title: ApiResponseEntityResetBalanceResponse 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 TravelDetailLeg: type: object properties: flightNumber: type: string description: Number of the airline flight to be taken. The mapping to each leg from VISA and MCI file is present in general specification document carrier: type: string description: Code indicating name of carrier. The mapping to each leg from VISA and MCI file is present in general specification document class: type: string description: Indicates service class (first class, business class, etc.). The mapping to each leg from VISA and MCI file is present in general specification document stopOver: type: string description: Indicates whether a stopover is allowed on this ticket. The mapping to each leg from VISA and MCI file is present in general specification document destination: type: string description: Indicates destination city's airport code. The mapping to each leg from VISA and MCI file is present in general specification document fareCode: type: string description: Fare basis code used for the trip. The mapping to each leg from VISA and MCI file is present in general specification document title: TravelDetailLeg ApiResponseEntityOperationDetails: 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/OperationDetails' description: Issuer response entity title: ApiResponseEntityOperationDetails InquireOperationRequest: type: object required: - externalOperationReference - externalOperationServicePoster - externalOperationDate properties: externalOperationReference: description: "The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system.\n The External reference of the operation must be provided." type: string externalOperationServicePoster: description: "The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system.\n The identifier of the external system must be provided." type: string externalOperationDate: description: "The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system.\n The date the operation must be provided." format: date-time type: string title: InquireOperationRequest ReverseOperationInterestResponse: type: object required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the interest reversal (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: ReverseOperationInterestResponse ApiResponseEntityCreateOperationInterestResponse: 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/CreateOperationInterestResponse' description: Issuer response entity title: ApiResponseEntityCreateOperationInterestResponse CreateOperationUnloadResponse: type: object required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the account unloading (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: CreateOperationUnloadResponse CreateOperationReimbursementResponse: type: object required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the reimbursement (genereated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: CreateOperationReimbursementResponse ResetBalanceRequest: type: object required: - externalOperationReference - externalOperationDate - externalOperationServicePoster properties: description: type: string description: 'Textual description of the operation to be generated during the account balance reset Can contain a free text that can be used when the operation is presented to the Customer' externalOperationReference: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' externalOperationDate: format: date-time type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided)' externalOperationServicePoster: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text)' externalOperationCode: type: string description: The external operation code of the balance reset can be provided to identify the operation type in the issuer system. title: ResetBalanceRequest CarRentalInformation: type: object properties: businessFormatCode: type: string description: 'The fields represents additional data from VISA clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - CAR RENTAL; Field: Business Format Code (Value: CA); POS 17-18.' days: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - CAR RENTAL; Field: Days Rented; POS 19-20. MCI mapping is the following: PDS 0691. PDS 0691 (Days Rented) provides the number of days that the vehicle was rented.' noShowIndicator: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - CAR RENTAL; Field: Car Rental No-Show Indicator; POS 27. MCI mapping is the following: PDS 0690. PDS 0690 (No Show Indicator) provides an indicator noting that the individual did not show up after making a reservation for a vehicle or lodging.' extraCharges: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - CAR RENTAL; Field: Car Rental Extra Charges; POS 28-33. MCI mapping is the following: PDS 0701. PDS 0701 (Extra Charges) provides the extra charges associated with the vehicle rental.' checkOutDate: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - CAR RENTAL; Field: Car Rental Check-out Date (YYMMDD); POS 38-43. MCI mapping is the following: PDS 0551. PDS 0551 (Rental Check-Out Date) is the date when the vehicle was originally rented (YYMMDD).' dailyRentRate: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - CAR RENTAL; Field: Daily Rental Rate; POS 44-55. MCI mapping is the following: PDS 0553. PDS 0553 (Rental Rate) contains the rental rate charged for the vehicle and indicates whether it is a daily, weekly, or monthly rate. This PDS consists of two subfields: 1. Rental Rate Indicator; POS: 1 - D: Daily rate - W: Weekly rate - M: Monthly rate - space: Unknown or unreported 2. Rental Rate; POS: 2-13' weeklyRentRate: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - CAR RENTAL; Field: Weekly Rental Rate; POS 56-67. MCI mapping is the following: PDS 0692. PDS 0692 (Weekly Rental Amount) provides the amount charged for a seven-day rental period.' insuranceCharge: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - CAR RENTAL; Field: Insurance Charges; POS 68-79. MCI mapping is the following: PDS 0559. PDS 0559 (Vehicle Insurance) contains an indicator of whether the customer purchased insurance and of the insurance amount. This PDS consists of two subfields: 1. Insurance Indicator; POS: 1 - Y: Yes (insurance was purchased) - N: No (insurance was not purchased) - spaces: Unknown or unreported 2. Insurance Charges; POS: 2-13' fuelCharge: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - CAR RENTAL; Field: Fuel Charges; POS 80-91. MCI mapping is the following: PDS 0698. PDS 0698 (Fuel Charge) provides the amount charged for fuel used during vehicle rental.' classCode: type: string description: "The field represents additional data from VISA and MCI clearing file addendum.\n VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - CAR RENTAL; Field: Car Class Code; POS 92-93.\nMCI mapping is the following: PDS 0568. PDS 0568 (Rental Class ID) contains the classification, such as midsize or luxury, of the vehicle rented." oneWayDropCharge: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - CAR RENTAL; Field: One-Way Drop-off Charges; POS 94-105. MCI mapping is the following: PDS 0694. PDS 0694 (One Way Drop Off Charge) provides a charge associated with not returning a vehicle to the original rental location.' renterName: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - CAR RENTAL; Field: Renter Name; POS 106-145. MCI mapping is the following: PDS 0545. PDS 0545 (Renter Name) is the name of the individual making the vehicle rental agreement.' title: CarRentalInformation ForbiddenErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/ForbiddenResponseMetadata' title: ForbiddenErrorApiResponse PanTokenIdentifier: type: object required: - panTokenReference properties: panTokenReference: type: string description: Pan Token Reference title: PanTokenIdentifier CreateOperationPaymentResponse: type: object required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the payment (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: CreateOperationPaymentResponse AuthorizationBusinessCaseIdentifier: type: object required: - businessCaseId properties: businessCaseId: type: string description: 'Business case to which the transaction belongs. The provided information reflects its status after transaction completion. A business case is a group of transactions which logically belong together (e.g. original transaction and reversal of original transaction)' title: AuthorizationBusinessCaseIdentifier ApiResponseEntityCreateOperationFeeResponse: 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/CreateOperationFeeResponse' description: Issuer response entity title: ApiResponseEntityCreateOperationFeeResponse AirItineraryInformation: type: object properties: businessFormatCode: type: string description: 'The fields represents additional data from VISA clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - PASSENGER ITINERARY DATA; Field: Business Format Code; POS 17-18.' travelAgent: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - PASSENGER ITINERARY DATA; Field: Travel Agency Name; POS 92-116. MCI mapping is the following: PDS 0511. PDS 0511 (Travel Agency Name) is the name of the travel agency that issued the ticket.' travelAgentCode: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - PASSENGER ITINERARY DATA; Field: Travel Agency Code; POS 84-91. MCI mapping is the following: PDS 0510. PDS 0510 (Travel Agency Code) is a code assigned to the travel agency.' passengerName: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - PASSENGER ITINERARY DATA; Field: Passenger Name; POS 27-46. MCI mapping is the following: PDS 0505. PDS 0505 (Passenger Name) contains the name of the passenger to whom the ticket was issued.' departureDate: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - PASSENGER ITINERARY DATA; Field: Departure Date (MMDDYY); POS 47-52. MCI mapping is the following: PDS 0520. PDS 0520 (Travel Date) is the effective ticket date, also referred as departure date (YYMMDD).' originCityCode: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - PASSENGER ITINERARY DATA; Field: Origination City/Airport Code; POS 53-55. MCI mapping is the following: PDS 0523. PDS 0523 (City of Origin/Airport Code) is the originating airport or railway name standard abbreviation.' restrictedTicketIndicator: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - PASSENGER ITINERARY DATA; Field: Restricted Ticket Indicator; POS 117. MCI mapping is the following: PDS 0713. PDS 0713 (Restricted Ticket Indicator) provides the identifier noting that the ticket purchased has some restriction associated with its use.' reservationSystem: type: string description: 'The fields represents additional data from VISA clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - PASSENGER ITINERARY DATA; Field: Computerized Reservation System; POS 142-145.' creditReasonIndicator: type: string description: 'The fields represents additional data from VISA clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - PASSENGER ITINERARY DATA; Field: Credit Reason Indicator; POS 166.' ticketChangeIndicator: type: string description: 'The fields represents additional data from VISA clearing file addendum. VISA mapping is the following: TC05, TCR 3 - INDUSTRY-SPECIFIC DATA - PASSENGER ITINERARY DATA; Field: Ticket Change Indicator; POS 167.' ticketNumber: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR0; Field: Merchant Name POS 92-116; POS 13-25 of this field should be taken as input. MCI mapping is the following: PDS 0506. PDS 0506 (Ticket Number) contains the number on the ticket.' IATACode: type: string description: 'The field represents additional data from MCI clearing file addendum. MCI mapping is the following: PDS 0717. PDS 0717 (IATA Client Code) provides the International Air Transport Association (IATA) code identifying the company that purchased the ticket.' leg1: allOf: - $ref: '#/definitions/TravelDetailLeg' description: Description of first leg of trip leg2: allOf: - $ref: '#/definitions/TravelDetailLeg' description: Description of second leg of trip leg3: allOf: - $ref: '#/definitions/TravelDetailLeg' description: Description of third leg of trip leg4: allOf: - $ref: '#/definitions/TravelDetailLeg' description: Description of fourth leg of trip title: AirItineraryInformation CreateOperationBalanceAdjustmentResponse: type: object required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the balance adjustment (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: CreateOperationBalanceAdjustmentResponse ApiResponseEntityInquireOperationResponse: type: object required: - responseMetadata properties: data: description: Response data allOf: - $ref: '#/definitions/OperationDetails' responseMetadata: $ref: '#/definitions/ResponseMetadata' title: ApiResponseEntityInquireOperationResponse description: Inquire Operation response ResetBalanceResponse: type: object required: - operationIdentifier - referenceAmount properties: operationIdentifier: description: Identifier of the operation created during the balance reset (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' referenceAmount: description: Amount of the balance reset on the account (amount/exponent/currency values) allOf: - $ref: '#/definitions/Amount' title: ResetBalanceResponse CreateOperationLoadResponse: type: object required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the account loading (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: CreateOperationLoadResponse ApiResponseEntityReverseOperationBalanceAdjustmentResponse: 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/ReverseOperationBalanceAdjustmentResponse' description: Issuer response entity title: ApiResponseEntityReverseOperationBalanceAdjustmentResponse 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 CreateOperationReimbursementRequest: type: object required: - externalOperationReference - externalOperationDate - externalOperationServicePoster properties: description: type: string description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer.' externalOperationReference: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' externalOperationDate: format: date-time type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided).' externalOperationServicePoster: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text).' externalOperationCode: type: string description: The external operation code of the reimbursment can be provided to identify the operation type in the issuer system. destinationIban: type: string description: 'An IBAN can be used for the reimbursement to transfer the input amount on this IBAN. If not provided, the reimbursment will be done on the IBAN associated to the account.' reimbursementType: type: string description: 'The reimbursement type can be:: - ''FULL'': The reimbursement amount, calculated by the system based on the configuration and liable balance and/or Open-To-Buy, will be fully posted on the account. - ''PARTIAL'': If the input amount is greater than the allowed reimbursement amount calculated by the system, the maximum of the available amount will be posted on the account. - ''MAX'': If the input amount is greater than the allowed reimbursement amount calculated by the system, the posting will be refused. If the reimbursement type is not provided, the default value "MAX" will be used.' referenceAmount: description: "The amount of the operation (amount/exponent/currency values).\n The maximum amount is the balance amount limited to the Open-To-Buy.\n This field must not be provided if the reimbursement type is \"FULL\". Otherwise, the request is rejected." allOf: - $ref: '#/definitions/Amount' reimbursementReason: type: string description: 'The reason why the reimbursement is triggerred The list of possible reimbursement reasons is configurable per issuer.' specificFields: type: object description: "The issuer can provide Specific Fields for the operation.\n It is a list of external data {\"label\":\"value\"} separated by a \",\" related to the operation (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 title: CreateOperationReimbursementRequest ReverseOperationBonusResponse: type: object required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the Bonus reversal (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: ReverseOperationBonusResponse ApiResponseEntityCreateOperationReimbursementResponse: 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/CreateOperationReimbursementResponse' description: Issuer response entity title: ApiResponseEntityCreateOperationReimbursementResponse ApiResponseEntityCreateOperationBonusResponse: 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/CreateOperationBonusResponse' description: Issuer response entity title: ApiResponseEntityCreateOperationBonusResponse CreateOperationLoadRequest: type: object required: - externalOperationReference - externalOperationDate - externalOperationServicePoster - referenceAmount properties: description: type: string description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer.' externalOperationReference: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' externalOperationDate: format: date-time type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided).' externalOperationServicePoster: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text).' externalOperationCode: type: string description: The external operation code of the load operation can be provided to identify the operation type in the issuer system. referenceAmount: description: The amount of the operation (amount/exponent/currency values) allOf: - $ref: '#/definitions/Amount' paymentChannel: type: string description: 'The channel by which the payment is performed. The possible values are: DIRECT_DEBIT CHEQUE CASH ONLINE_MONEY NO_CHANNEL_PROVIDED INCOMING_PAYMENT Note that NO_CHANNEL_PROVIDED will be set by default if the paymentChannel is not provided' sepa: type: boolean description: "Indicates whether the payment is performed in SEPA format. \nBy default, the value is false." title: CreateOperationLoadRequest ApiResponseEntityListOperation: 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/Operation' description: Issuer response entity title: ApiResponseEntityListOperation LodgingInformation: type: object properties: businessFormatCode: type: string description: 'The fields represents additional data from VISA clearing file addendum. VISA mapping is the following: TC05, TCR3 - INDUSTRY-SPECIFIC DATA - LODGING; Field: Business Format Code (Value: CA); POS: 17-18.' noShowIndicator: type: string description: 'The fields represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR3 - INDUSTRY-SPECIFIC DATA - LODGING; Field: Lodging No-Show Indicator; POS 27. MCI mapping is the following: PDS 0690. PDS 0690 (No Show Indicator) provides an indicator noting that the individual did not show up after making a reservation for a vehicle or lodging.' extraCharges: type: string description: 'The fields represents additional data from VISA clearing file addendum. VISA mapping is the following: TC05, TCR3 - INDUSTRY-SPECIFIC DATA - LODGING; Field: Lodging Extra Charges; POS 28–33.' checkInDate: type: string description: 'The fields represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR3 - INDUSTRY-SPECIFIC DATA - LODGING; Field: Lodging Check-in Date (YYMMDD); POS 38-43. MCI mapping is the following: PDS 0574. PDS 0574 (Arrival Date) contains the cardholder check-in date (YYMMDD).' dailyRoomRate: type: string description: 'The fields represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR3 - INDUSTRY-SPECIFIC DATA - LODGING; Field: Daily Room Rate; POS 44-55. MCI mapping is the following: PDS 0580. PDS 0580 (Room Rate) contains the daily room charges exclusive of taxes and fees. This PDS consists of two subfields: 1. Room Rate Amount; POS: 1-12 2. Room Rate Exponent; POS: 13' totalTax: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR3 - INDUSTRY-SPECIFIC DATA - LODGING; Field: Total Tax; POS 56-67. MCI mapping is the following: PDS 0597. PDS 0597 (Total Tax Amount) contains the total amount of sales tax or value added tax (VAT) on the total purchase amount.' prepaidExpenses: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR3 - INDUSTRY-SPECIFIC DATA - LODGING; Field: Prepaid Expenses; POS 68-79. MCI mapping is the following: PDS 0704. PDS 0704 (Prepaid Expenses) provides the amount of deposit or other prepaid amounts for the lodging stay.' foodBeverageCharge: type: string description: 'The field represents additional data from VISA clearing file addendum. VISA mapping is the following: TC05, TCR3 - INDUSTRY-SPECIFIC DATA - LODGING; Field: Food/Beverage Charges; POS 80-91.' folioCashAdvances: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR3 - INDUSTRY-SPECIFIC DATA - LODGING; Field: Folio Cash Advances; POS 92-103. MCI mapping is the following: PDS 0706. PDS 0706 (Cash Advances) provides the amount of cash received during the lodging stay.' totalRoomNights: type: string description: 'The field represents additional data from VISA and MCI clearing file addendum. VISA mapping is the following: TC05, TCR3 - INDUSTRY-SPECIFIC DATA - LODGING; Field: Room Nights; POS 104-105. MCI mapping is the following: PDS 0703. PDS 0703 (Total Room Nights) provides the total number of nights for which a room was contracted during a lodging stay.' totalRoomTax: type: string description: "The field represents additional data from VISA and MCI clearing file addendum.\nVISA mapping is the following: TC05, TCR3 - INDUSTRY-SPECIFIC DATA - LODGING; Field: Total Room Tax; POS 106-117.\nMCI mapping is the following: PDS 0581. PDS 0581 (Total Room Tax) contains tax amount information such as the daily room tax, occupancy tax, energy tax, and tourist tax amounts. This PDS consists of three subfields:\n1. Total Room Tax Amount; POS: 1-12\n2. Total Room Tax Exponent; POS: 13\n 3. Total Room Tax Sign; POS: 14" title: LodgingInformation ReverseOperationPaymentResponse: required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the payment reversal (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: ReverseOperationPaymentResponse 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 Operation: type: object required: - operationIdentifier - externalOperationDate - externalOperationReference - externalOperationServicePoster - operationKind - postingDate - reversal - postingAccountIdentifier - status properties: issuerId: type: string description: Issuer identifier (unique per platform) operationIdentifier: description: 'Internal identifier associated to the transaction to which one this transaction is linked. 16-digit incremental number (1000000000000001) Ex: TRANSACTION_FEE linked to FP (Parent)' allOf: - $ref: '#/definitions/OperationIdentifier' acquirerReferenceData: type: string description: 'Acquirer Reference Number (ARN) associated to the transaction - MCI : DE 031 - Acquirer Reference Data - VISA : TCR0 Acquirer Reference Number pos. 27-49' cardAcceptorCity: type: string description: 'Card Acceptor Location (City) associated to the transaction MCI : DE 043 s3 - Card Acceptor City VISA : TCR0 - Merchant City' cardAcceptorCountry: type: string description: 'Card Acceptor Country Code associated to the transaction MCI : DE 043 s6 - Card Acceptor Country Code VISA : TCR0 - Merchant Country' cardAcceptorZipCode: type: string description: 'Card Acceptor ZIP Code associated to the transaction MCI : DE 043 s4 - Card Acceptor Postal (ZIP) Code VISA : TCR0 - Merchant zip code' cardScheme: type: string description: Short name of national or international network, if implicated. eCommerce: type: boolean description: Ecommerce indicator cardAcceptorName: type: string description: 'Complete Card Acceptor Name / Location (Merchant) associated to the transaction MCI : DE 043 s1 to s6 - Card Acceptor Name/Location VISA : TCR0' description: type: string description: Textual description of the current operation. Can contain a free text that can be used when the operation is presented to the Customer externalOperationCode: type: string description: Value per operation type posted to an Account determined by our system according to specific Issuer configuration feeType: type: string description: 'Type of fee used to create the current operation. Mandatory if the operation is a fee. In the case fee is managed within our system, the complete value list is shared with the issuer and can be for example "ACCOUNT_SETUP_FEE", "TRANSACTION_FEE". "EVENT_FEE","CARD_FEE".' maskedPan: type: string description: Refer to Card.maskedPan merchantCategoryCode: type: string description: Classifies the type of business applicable to the card acceptor 'balanceAdjustmentReason ': type: string description: 'The reason why the balance adjustment has been requested (conditional) Mandatory when balance adjustment. Allowed value list depends on the issuer configuration' exchangeRate: type: number format: double description: Used to realize the conversion between the original currency and the account currency exchangeRateDate: type: string format: date-time description: The date of the exchange operation exchangeRateSource: type: string description: The source of the exchange rate information. Rate source name or scheme used. operationCode: type: string description: 'Transaction category defined by our system describing the current operation (only for Scheme transaction and load operation). Values: CASH_ADVANCE, CASH_BACK CASH_WITHDRAWAL, CREDIT, FUND_TRANSFER, NORMAL_PURCHASE, REFUND_PURCHASE LOAD' operationKind: type: string description: 'Indicates the operation class. Values: BAL (balance transfer) FEE (fee operation) INT (interest operation) LOAD (load operation) PAY (payment operation) RMB (reimbursement operation) TRN (transaction operation from scheme) DISPUTE (refund / redebit operation triggered from our Dispute module) RST_BAL (reset balance operation) SUBPAYOP (apportionment operation) WRITE_OFF (write off - esp account closing) CRD_INST (instalment operation) CRD_INST_INIT (Instalment credit operation) BAL_ADJ (balance adjustment operation)' postingDate: type: string format: date-time description: Date and Time when the transaction is posted to the account reconciliationAmount: description: "Transaction amount provided by the scheme in the currency agreed between the scheme and the issuer/WL. \nMandatory for 1st presentment.\nScheme Reconciliation Amount / Currency / Exponent\n- MCI: DE 005 / DE 050 / associated PDS 0148\n- VISA: Destination Amount / Destination Currency" allOf: - $ref: '#/definitions/Amount' referenceAmount: description: Amount impacting the Cardholder account allOf: - $ref: '#/definitions/Amount' reversal: type: boolean description: This flag indicates if this operation is a reversal (true) or not (false) reversalReason: type: string description: The reason why the reversal has been created. Determined by the calling service depending information of the original message (conditional) Mandatory, if the operation is reversal subFeeType: type: string description: Sub Type of internal fee created and impacting the Cardholder Account (free text) frequency: description: Free text describing the frequency of the operation performed (daily, monthly, yearly...) (optional) type: string transactionAmount: description: 'DE 4 (Amount, Transaction) is the amount of funds the cardholder requested in the currency appearing on the transaction information document (TID), which may be the acquirer’s local currency or a currency acceptable to the cardholder and card acceptor that the acquirer supports, exclusive of PDS 0146 (Amounts, Transaction Fee). If no currency is identified on the TID, the transaction is deemed to have taken place in the currency that is legal tender at the point of interaction. Amount of the transaction. This field contains numerics. Two decimal positions are implied. If the Original Source Currency code is 392 (Japanese Yen), any value other than zero after the decimal produces an Invalid Amount error. MCI DE 004 VISA TCR0 The value can be both positive and negative.' allOf: - $ref: '#/definitions/Amount' transactionDate: type: string format: date-time description: 'Transaction Date in Merchant site when transaction has been performed E.g. : 2023-02-04T00:00:00+01:00 - MCI: DE 012 (Date and Time, Local Transaction) - VISA : TCR0 pos. 58-61' valueDate: type: string format: date-time description: The date the operation impacts balances or counters. If not set, the valueDate will be set to operationDate if operationDate is not in the past, today otherwise (conditional) walletId: type: string description: Indicates the identifier of the wallet (Apple Pay or other token requestor) used for the operation authorizationBusinessCaseIdentifier: description: Internal identifier provided by the WLP Front Office in each Authorisation Message received. Only present if operation (first presentment) matched with an authorization. allOf: - $ref: '#/definitions/AuthorizationBusinessCaseIdentifier' cardIdentifier: description: Refer to Card.cardIdentifier allOf: - $ref: '#/definitions/CardIdentifier' disputeFolderIdentifier: description: Refer to disputeFolderIdentifier object description (technical field) allOf: - $ref: '#/definitions/DisputeFolderIdentifier' panTokenIdentifier: description: 'Token Requestor Identifier value associated to the transaction - MCI : PDS 0059 - Token Requestor ID - VISA : TCR5 Token Requestor ID pos. 149-159' allOf: - $ref: '#/definitions/PanTokenIdentifier' externalOperationDate: type: string format: date-time description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date is provided by the caller and must not be modified in case of reprocess (idempotency)' externalOperationReference: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The reference is provided by the caller and must not be modified in case of reprocess (idempotency)' externalOperationServicePoster: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The Service Poster depends on the caller. This is a free text. When the value is ITP, OPC, IDM, CMS, CAS, WLP-CAS or WLP_CAS, operations are considered "internal".' businessCaseId: type: string description: DEPRECATED pointOfServiceDataCode: type: string description: DEPRECATED travelInformation: description: DEPRECATED allOf: - $ref: '#/definitions/TravelInformation' pan: type: string description: Refer to Card.pan (optional) panReference: type: string description: Pan reference only if the card is associated to the operation acquisitionMaterial: type: string description: 'Only for scheme transaction. Type of material used to realize the operation. Possible values: ATM, POS, INTERNET, MANUAL, VOICE_PHONE, UNATTENDED_TERMINAL, MOBILE, UNKNOWN' enum: - ATM - POS - VOICE_PHONE - MANUAL - UNATTENDED_TERMINAL - MOBILE - INTERNET - UNKNOWN cardAcceptorIdCode: type: string description: 'Identifies the card acceptor ID assigned by the acquirer. This ID must represent a unique identifier for each merchant name/location within the acquiring BIN. Card Acceptor (Merchant) Identifier associated to the transaction - MCI : DE 042 - Card Acceptor ID Code - VISA : TCR5 - Acquirer''s Business ID' entryMode: type: string description: 'Precise how the card information have been read. Conversion of the native fields. Possible values : UNKNOWN OCR: Optical Character Reader MANUAL MAGSTRIPE: Magnetic Stripe read CONTACTLESS: Contactless read (called proximity payment or Mobile Chip system) CHIP: Chip read BARCODE: Bar Code read' approvalCode: type: string description: 'Authorization Approval Code associated to the transaction * MCI : DE 038 - Approval Code * VISA : TCR0 Authorization Code pos. 152-157' authorization: description: 'Data retrieved from the authorization matched to the transaction. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/OperationAuthorization' pointOfSaleEnvironment: type: string description: 'Recurring transaction indicator, indicating that the cardholder and merchant have agreed to periodic billing for goods and services, such as utility bills, internet connection, and magazine subscriptions. Values: Space = default R = Recurring Payment Transaction I = Installment Payment C = Credential on File' mailPhoneEcommerceAndPaymentIndicator: type: string description: "Mail Phone Ecommerce and Payment Indicator indicates if transaction was initiated as mail order, telephone order or electronic commerce. \nUsed in Visa interchange validation and determination. \nRequired in input for Visa transactions. \nBase II mapped from Draft data TCR1 position 116. \nDomain: \nSpace - Field not applicable or acquirer did not specify. \n1 - Mail/Phone Order (MO/TO). \n2 - Recurring transaction (valid only for U.S. acquired transactions). \n3 - Instalment payment. \n4 - Unknown classification/other mail order. \n5 - Secure Electronic Commerce Transaction. \n6 - Non-Authenticated Security Transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D secure. \n7 - Non-Authenticated Security Transaction \n8 - Non-secure transaction. \n9 - For optional regional use only." posDataCode: type: string description: DEPRECATED pointOfService: description: Represents series of codes that identify terminal capability, terminal environment, and point-of interaction (POI) security data (both for VISA and MCI) allOf: - $ref: '#/definitions/PointOfService' acquirerId: description: 'VISA mapping is the following: TC05, TCR0; Field: Acquirer Reference Number POS 27-49. Should be taken positions 2-7 of this field (Acquirer BIN). MCI mapping is the following: DE 31 Acquirer Reference Data. Should be taken positions 2-7 of this field.' type: string destinationId: description: 'VISA mapping is the following: Determined based on transaction data. MCI mapping is the following: DE 93 transaction Destination Institution ID code.' type: string detailedFeeAmounts: type: array description: "Details of the insurance fee when this latter is a percentage of the account balance and covers several risks e.g. Payment protection insurance covering Unemployment, Incapacity for work and disability/life. \nEach detail amount represents a part of the insurance fee for a given risk and contains the following information : the covered risk (name), the related amount, the percentage applied on the account balance, the related external operation code." items: $ref: '#/definitions/DetailedFeeAmount' loyaltyPoint: description: Used when the operation has loyalty points allOf: - $ref: '#/definitions/LoyaltyPoint' schemeTransactionIdentifier: type: string description: "This field will contain the transaction identifier, a unique value that schemas assign to each transaction. It can be used to maintain an audit trailthroughout the life cycle of the transaction and all related transactions, such as reversals, adjustments, confirmations, and dispute financials\nThe corresponding mapping is:\n- VISA: TC05 TCR5 payment service, pos 5-19 \n- MCI: DE 063 - Transaction Life Cycle ID, subfield 2 - Trace ID" transactionType: type: string description: DEPRECATED rewardedOperationIdentifier: description: Internal identifier associated to the transaction linked to a Bonus operation 16-digit incremental number (1000000000000001). Used only if a Bonus operation is related to. allOf: - $ref: '#/definitions/OperationIdentifier' lodgingInformation: description: 'The list of lodging information parameters from the clearing file. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/LodgingInformation' carRentalInformation: description: 'The list of car rental information parameters from the clearing file. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/CarRentalInformation' airItineraryInformation: description: 'The list of air itinerary parameters from the clearing file. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/AirItineraryInformation' disputed: type: boolean description: The attribute shows weather the operation was disputed or not printOnStatement: type: boolean description: "Flag indicating whether to include some manual operations in the statements. Defaul values - yes\nValues: \nyes, \nno" cardAcceptorAddress: type: string description: The attribute represents card acceptor address received from scheme cardAcceptorStateProvinceRegionCode: type: string description: The attribute represents card acceptor state province region code received from scheme postingAccountIdentifier: description: Identifier of the account on which the operation was posted allOf: - $ref: '#/definitions/AccountIdentifier' status: type: string description: "Status of the transaction \n* PROCESSED\n* IN_ERROR\n* CAS_IN_DISPUTE (when the transaction is disputed)\n* CAS_PENDING" operationType: type: string description: Defines the operation type that is configured in 'Operation type tree' in the Issuer Configuration parentOperationIdentifier: description: 'Internal identifier associated to the transaction to which one this transaction is linked. 16-digit incremental number (1000000000000001) Ex: TRANSACTION_FEE linked to FP (Parent)' allOf: - $ref: '#/definitions/OperationIdentifier' virtualCardService: description: 'Data related to Virtual Card Service. These are the ones used by Virtual Card Engine in scope of Virtual Card Service program. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/VirtualCardService' virtualServiceCardReference: type: string description: Virtual service card reference of the operation generated by our system origin: type: string description: Origin used during the creation of the operation. username: type: string description: Name of the user who initiated the operation paymentTrigger: type: string description: "Indicates how the payment is triggered \nThe possible values are :\n- ON_DEMAND\n- CYCLIC (related to monthly cycle closure)\n- ON_TRANSACTION" paymentReason: type: string description: "Reason why the payment is triggered \nThe list of possible payment reasons is configurable per issuer." reimbursementTrigger: type: string description: "Indicates how the reimbursement is triggered \nThe possible values are :\n- ON_DEMAND\n- CYCLIC (related to monthly cycle closure)\n- DAILY\n- ON_TRANSACTION\n- ON_TERMINATION (on contract termination)" reimbursementReason: type: string description: "Reason why the reimbursement is triggered \nThe list of possible reimbursement reasons is configurable per issuer." specificFields: type: object description: 'List of external data {"label":"value"}, separated by a ",", related to an operation 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 bonusProgramReference: description: The issuer must provide the reference of the Bonus/Loyalty program for which the reward is applied. type: string cashAmount: description: 'Additional Amount / Currency / Exponent for Cash Back transaction amount * MCI : DE 054 s2 = 40 - Amount, Cash Back * VISA : TCR1 pos. 158-166 Cashback' allOf: - $ref: '#/definitions/Amount' surchargeAmount: description: Additional Amount / Currency / Exponent for surcharge transaction amount in Transaction Currency allOf: - $ref: '#/definitions/Amount' operationHierarchyReference: type: string description: Identifier of the original operation in our system title: Operation ReverseOperationFeeResponse: required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the fee reversal (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: ReverseOperationFeeResponse ReverseOperationFeeRequest: type: object required: - reversalReason - externalMatchingOperationReference - externalMatchingOperationDate - externalMatchingOperationServicePoster - externalOperationReference - externalOperationDate - externalOperationServicePoster properties: reversalReason: type: string description: 'The reason why the reversal has been created. Possible value: REVERSAL_ON_DEMAND' description: type: string description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer.' externalMatchingOperationReference: type: string description: "The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. \nIt is used for retrieving the operation to be reversed. \nThe field contains the value of externalOperationReference of the original operation to be reversed." externalMatchingOperationDate: format: date-time type: string description: "The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. \nIt is used for retrieving the operation to be reversed.\nThe field contains the value of externalOperationDate of the original operation to be reversed." externalMatchingOperationServicePoster: type: string description: "The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. \nIt is used for retrieving the operation to be reversed.\nThe field contains the value of externalOperationServicePoster of the original operation to be reversed." referenceAmount: description: 'The amount of the operation is requested for partial reversal (amount/exponent/currency values). If not provided, the total amount of the original amount is reversed.' allOf: - $ref: '#/definitions/Amount' externalOperationReference: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' externalOperationDate: format: date-time type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided).' externalOperationServicePoster: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text).' title: ReverseOperationFeeRequest ApiResponseEntityReverseOperationReimbursementResponse: 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/ReverseOperationReimbursementResponse' description: Issuer response entity title: ApiResponseEntityReverseOperationReimbursementResponse CreateOperationPaymentRequest: type: object required: - externalOperationReference - externalOperationDate - externalOperationServicePoster - referenceAmount properties: description: type: string description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer' externalOperationReference: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' externalOperationDate: format: date-time type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided).' externalOperationServicePoster: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text)' externalOperationCode: type: string description: The external operation code of the payment operation can be provided to identify the operation type in the issuer system. overPaymentAccountIdentifier: description: 'Identifier of the account in case of overpayment situation If provided, the overpayment account must be in an active or being closed status' allOf: - $ref: '#/definitions/AccountIdentifier' referenceAmount: description: The amount of the operation (amount/exponent/currency values) allOf: - $ref: '#/definitions/Amount' valueDate: type: string format: date-time description: 'The date when the operation impacts balances or counters. If not provided, the value date is set to the external operation date. When the value date is in the future, a pending operation is created.' paymentChannel: type: string description: "The channel by which the payment is performed (optional field). \nThe possible values are:\nDIRECT_DEBIT\nCHEQUE\nCASH\nONLINE_MONEY \nNO_CHANNEL_PROVIDED\nINCOMING_PAYMENT\nNote that NO_CHANNEL_PROVIDED will be set by default if the paymentChannel is not provided." sepa: type: boolean description: 'Indicates whether the payment is performed in SEPA format. By default, the value is false.' paymentReason: type: string description: 'The reason why the payment is triggerred The list of possible payment reasons is configurable per issuer.' specificFields: type: object description: "The issuer can provide Specific Fields for the operation.\n It is a list of external data {\"label\":\"value\"} separated by a \",\" related to the operation (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 title: CreateOperationPaymentRequest PointOfService: type: object properties: entryModePan: type: string description: VISA TCR0 PosEntryMode. entryModePin: type: string description: VISA TCR0 CardholderIDMethod. conditionCode: type: string description: VISA. Field equals to "02" if PosEntryMode is populated, "00" if not populated. posTerminalCapability: type: string description: VISA TCR0 PosTerminalCapability cardDataInputCapability: type: string description: MCI DE 22 (Point of Service [POS] Entry Mode), subfield 1 indicates the set of methods supported by the terminal for the input of account number, card, or mobile device data. cardholderAuthenticationCapability: type: string description: MCI DE 22 (Point of Service [POS] Entry Mode), subfield 2 describes the capability of the terminal device to support/accept authentication data. cardCaptureCapability: type: string description: MCI DE 22 (Point of Service [POS] Entry Mode), subfield 3 indicates whether the terminal has card capture capabilities. terminalOperatingEnvironment: type: string description: MCI DE 22 (Point of Service [POS] Entry Mode), subfield 4 indicates whether the card acceptor is attending the terminal and the location of the terminal. cardholderPresentData: type: string description: MCI DE 22 (Point of Service [POS] Entry Mode), subfield 5 indicates whether the cardholder is present at the point of service and explains the condition if the cardholder is not present. cardPresentData: type: string description: MCI DE 22 (Point of Service [POS] Entry Mode), subfield 6 indicates if the card is present at the point of service. cardDataInputMode: type: string description: MCI DE 22 (Point of Service [POS] Entry Mode), subfield 7 indicates the method used for PAN entry to initiate a transaction. cardholderAuthenticationMethod: type: string description: MCI DE 22 (Point of Service [POS] Entry Mode), subfield 8 indicates the method by which the cardholder’s identity was verified at the point of service. cardholderAuthenticationEntity: type: string description: MCI DE 22 (Point of Service [POS] Entry Mode), subfield 9 indicates the entity through which the cardholder’s identity was verified at the point of service. cardDataOutputCapability: type: string description: MCI DE 22 (Point of Service [POS] Entry Mode), subfield 10 indicates the ability of the terminal to write or output data to a card. terminalDataOutputCapability: type: string description: MCI DE 22 (Point of Service [POS] Entry Mode), subfield 11 indicates the print and display capabilities of the terminal. pinCaptureCapability: type: string description: MCI DE 22 (Point of Service [POS] Entry Mode), subfield 12 indicates the maximum number of PIN characters that the POS terminal can capture. title: PointOfService CreateOperationUnloadRequest: type: object required: - externalOperationReference - externalOperationDate - externalOperationServicePoster - referenceAmount properties: description: type: string description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer.' externalOperationReference: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' externalOperationDate: format: date-time type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided).' externalOperationServicePoster: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text).' externalOperationCode: type: string description: The external operation code of the unload can be provided to identify the operation type in the issuer system. referenceAmount: description: The amount of the operation (amount/exponent/currency values) allOf: - $ref: '#/definitions/Amount' title: CreateOperationUnloadRequest ReverseOperationBonusRequest: type: object required: - externalMatchingOperationReference - externalMatchingOperationDate - externalMatchingOperationServicePoster - externalOperationReference - externalOperationDate - externalOperationServicePoster properties: description: description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer.' type: string externalMatchingOperationReference: description: 'The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. It is used for retrieving the operation to be reversed. The field contains the value of externalOperationReference of the original operation to be reversed.' type: string externalMatchingOperationDate: description: 'The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. It is used for retrieving the operation to be reversed. The field contains the value of externalOperationDate of the original operation to be reversed.' type: string format: date-time externalMatchingOperationServicePoster: description: 'The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. It is used for retrieving the operation to be reversed. The field contains the value of externalOperationServicePoster of the original operation to be reversed.' type: string externalOperationReference: description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' type: string externalOperationDate: description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided) ' type: string format: date-time externalOperationServicePoster: description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text).' type: string title: ReverseOperationBonusRequest VirtualCardService: type: object properties: virtualServiceCardExternalReference: type: string description: The external reference calculated for VCC by the Virtual Card Engine (VCE) issuerCompanyExternalReference: type: string description: This attribute will represent a unique identifier of company (the corporate customer of the Issuer) virtualServiceCardNumber: type: string description: Virtual Service Card Number of the operation (returned only if the user is allowed to see the clear Virtual Service Card Number). Also referred as VCC PAN maskedVirtualServiceCardNumber: type: string description: Masked Virtual Service Card Number. This is the VCC (Virtula Credit Card) PAN in masked format virtualServicesFields: type: object description: 'This attribute will return specific informative fields related to VCC (Virtual Credit Card) that the Virtual Card Engine will provide to the Issuing Back Office system, List of external data (label:value), separated by a "|''", related to a virtual card that can be provided by e.g. the issuer for information or for usage by other systems. Example : label1:value|label2:value Those provided data have no impact on our system business processes.' additionalProperties: type: string title: VirtualCardService ReverseOperationReimbursementResponse: required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the balance adjustment reversal (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: ReverseOperationReimbursementResponse OperationAuthorization: type: object properties: transactionDate: type: string format: date-time description: The date and time on which the transaction was approved. Data is retrieved from the matched authorization transaction. title: OperationAuthorization ApiResponseEntityCreateOperationLoadResponse: 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/CreateOperationLoadResponse' description: Issuer response entity title: ApiResponseEntityCreateOperationLoadResponse TravelInformation: type: object properties: passengerName: type: string description: 'passengerName (customer travel information) ' ticketNumber: type: string description: 'ticketNumber (customer travel information) ' travelDetailList: type: array description: 'List of TravelDetail ' items: $ref: '#/definitions/TravelDetail' title: TravelInformation CreateOperationInterestResponse: type: object required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the interest generation (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: CreateOperationInterestResponse ApiResponseEntityReverseOperationFeeResponse: 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/ReverseOperationFeeResponse' description: Issuer response entity title: ApiResponseEntityReverseOperationFeeResponse CreateOperationInterestRequest: type: object required: - externalOperationReference - externalOperationDate - externalOperationServicePoster - interestType - referenceAmount properties: description: description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer' type: string externalOperationReference: description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation in the caller system to be created.' type: string externalOperationDate: description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided).' type: string format: date-time externalOperationServicePoster: description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text)' type: string externalOperationCode: description: The external operation code of the interest operation can be provided to identify the operation type in the issuer system. type: string interestType: description: 'The issuer must provide the type of Interest for an interest operation Possible values: CREDIT / DEBIT' type: string referenceAmount: description: 'The reference amount has to be provided (amount/exponent/currency values) If a debit operation is posted, the operation amount has to be positive. If a credit operation is posted, the operation amount has to be negative. The currency must be the same as the posting account.' allOf: - $ref: '#/definitions/Amount' title: CreateOperationInterestRequest ReverseOperationReimbursementRequest: type: object required: - reversalReason - externalMatchingOperationReference - externalMatchingOperationDate - externalMatchingOperationServicePoster - externalOperationReference - externalOperationDate - externalOperationServicePoster properties: reversalReason: type: string description: "The reason why the reversal has been created. \nPossible value:\nREVERSAL_ON_DEMAND" description: type: string description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer.' externalMatchingOperationReference: type: string description: "The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. \nIt is used for retrieving the operation to be reversed. \nThe field contains the value of externalOperationReference of the original operation to be reversed." externalMatchingOperationDate: format: date-time type: string description: "The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. \nIt is used for retrieving the operation to be reversed.\nThe field contains the value of externalOperationDate of the original operation to be reversed." externalMatchingOperationServicePoster: type: string description: "The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. \nIt is used for retrieving the operation to be reversed.\nThe field contains the value of externalOperationServicePoster of the original operation to be reversed." externalOperationReference: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' externalOperationDate: format: date-time type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided)' externalOperationServicePoster: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text).' specificFields: type: object description: "The issuer can provide Specific Fields for the operation.\n It is a list of external data {\"label\":\"value\"} separated by a \",\" related to the operation (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 title: ReverseOperationReimbursementRequest UnauthorizedErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/UnauthorizedResponseMetadata' title: UnauthorizedResponseMetadata CreateOperationBalanceAdjustmentRequest: type: object required: - 'balanceAdjustmentReason ' - externalOperationReference - externalOperationDate - externalOperationServicePoster - referenceAmount properties: 'balanceAdjustmentReason ': type: string description: 'The reason why the balance adjustment is requested Allowed value list depends on the issuer configuration' example: DISPUTE_ADJUSTMENT description: type: string description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer' externalOperationReference: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' externalOperationDate: format: date-time type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided).' externalOperationServicePoster: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text)' externalOperationCode: type: string description: The external operation code of the balance adjustment operation can be provided to identify the operation type in the issuer system. referenceAmount: description: The amount of the operation (amount/exponent/currency values) allOf: - $ref: '#/definitions/Amount' valueDate: type: string format: date-time description: 'The date when the operation impacts balances or counters. If not provided, the value date is set to the external operation date if the external operation date is not in the past, otherwise the value date is set to the current date.' specificFields: type: object description: "The issuer can provide Specific Fields for the operation.\n It is a list of external data {\"label\":\"value\"} separated by a \",\" related to the operation (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 title: CreateOperationBalanceAdjustmentRequest DetailedFeeAmount: type: object properties: percentage: type: string description: Percentage used for amount calculation of the covered risk name: type: string description: Name of the covered risk feeAmount: description: Amount / Currency / Exponent of the covered risk allOf: - $ref: '#/definitions/Amount' externalOperationCode: type: string description: External operation code the covered risk includeInOtherDetailFeeAmount: type: boolean description: Indicates if the detail fee amount is part of another detail fee amount title: DetailedFeeAmount TravelDetail: type: object properties: flightNumber: type: string description: flightNumber (customer travel details) originCity: type: string description: originCity (customer travel details) destinationCity: type: string description: 'destinationCity (customer travel details) ' title: TravelDetail ReverseOperationBalanceAdjustmentRequest: type: object required: - reversalReason - externalMatchingOperationReference - externalMatchingOperationDate - externalMatchingOperationServicePoster - externalOperationReference - externalOperationDate - externalOperationServicePoster properties: reversalReason: type: string description: "The reason why the reversal has been created. \nPossible value:\nREVERSAL_ON_DEMAND" description: type: string description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer.' externalMatchingOperationReference: type: string description: "The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. \nIt is used for retrieving the operation to be reversed. \nThe field contains the value of externalOperationReference of the original operation to be reversed." externalMatchingOperationDate: format: date-time type: string description: "The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. \nIt is used for retrieving the operation to be reversed.\nThe field contains the value of externalOperationDate of the original operation to be reversed." externalMatchingOperationServicePoster: type: string description: "The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. \nIt is used for retrieving the operation to be reversed.\nThe field contains the value of externalOperationServicePoster of the original operation to be reversed." referenceAmount: description: 'The amount of the operation is requested for partial reversal (amount/exponent/currency values). If not provided, the total amount of the original amount is reversed.' allOf: - $ref: '#/definitions/Amount' externalOperationReference: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' externalOperationDate: format: date-time type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided)' externalOperationServicePoster: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text).' specificFields: type: object description: "The issuer can provide Specific Fields for the operation.\n It is a list of external data {\"label\":\"value\"} separated by a \",\" related to the operation (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 title: ReverseOperationBalanceAdjustmentRequest CreateOperationFeeRequest: type: object required: - adjustment - externalOperationReference - externalOperationDate - externalOperationServicePoster - feeType - referenceAmount properties: description: type: string description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer.' adjustment: type: boolean description: This flag indicates if this operation is an adjustment or not. 'adjustmentReason ': type: string description: The reason why the adjustment fee is requested. Mandatory when adjustement is true. Possible values:ERROR_DURING_ACQUISITION, INVALID_OPERATION, COMMERCIAL_ADJUSTMENT, DISPUTE_RESULT, CONFIGURATION_REPROCESSING externalOperationReference: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' externalOperationDate: format: date-time type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided).' externalOperationServicePoster: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text).' externalOperationCode: type: string description: The external operation code of the fee operation can be provided to identify the operation type in the issuer system. feeType: type: string description: "The type of fee used to create the current operation. \nPossible values (additional types can be configured for the issuer) : MARKUP_FEE, TRANSACTION_FEE, PERIODIC_FEE, VOLUME_FEE, INSURANCE_FEE, MANUAL_FEE, STATEMENT_FEE, EVENT_FEE, RMESSAGE_FEE, CARD_FEE, ACCOUNT_SETUP_FEE, MEMBERSHIP_FEE, ADDON_SERVICE_FEE" referenceAmount: description: The amount of the operation (amount/exponent/currency values) allOf: - $ref: '#/definitions/Amount' valueDate: type: string format: date-time description: 'The date when the operation impacts balances or counters. If not provided, the value date is set to the external operation date if the external operation date is not in the past, otherwise the value date is set to the current date.' subFeeType: description: Refer to Operation.subFeeType type: string frequency: description: Refer to Operation.frequency type: string title: CreateOperationFeeRequest 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 OperationIdentifier: type: object required: - operationId properties: operationId: type: string description: Internal operation identifier. 16-digit incremental number title: OperationIdentifier 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 ApiResponseEntityReverseOperationInterestResponse: 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/ReverseOperationInterestResponse' description: Issuer response entity title: ApiResponseEntityReverseOperationInterestResponse 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 ReverseOperationPaymentRequest: type: object required: - reversalReason - externalMatchingOperationReference - externalMatchingOperationDate - externalMatchingOperationServicePoster - externalOperationReference - externalOperationDate - externalOperationServicePoster properties: reversalReason: type: string description: 'The reason why the reversal has been created. Possible value: REVERSAL_ON_DEMAND' description: type: string description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer.' externalMatchingOperationReference: type: string description: "The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. \nIt is used for retrieving the operation to be reversed. \nThe field contains the value of externalOperationReference of the original operation to be reversed." externalMatchingOperationDate: format: date-time type: string description: "The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. \nIt is used for retrieving the operation to be reversed.\nThe field contains the value of externalOperationDate of the original operation to be reversed." externalMatchingOperationServicePoster: type: string description: "The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. \nIt is used for retrieving the operation to be reversed.\nThe field contains the value of externalOperationServicePoster of the original operation to be reversed." externalOperationReference: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' externalOperationDate: format: date-time type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided)' externalOperationServicePoster: type: string description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text).' specificFields: type: object description: "The issuer can provide Specific Fields for the operation.\n It is a list of external data {\"label\":\"value\"} separated by a \",\" related to the operation (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 title: ReverseOperationPaymentRequest CreateOperationBonusResponse: type: object required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the Bonus generation (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: CreateOperationBonusResponse 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 CreateOperationFeeResponse: type: object required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the fee generation (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: CreateOperationFeeResponse OperationDetails: type: object required: - debit - status - productIdentifier allOf: - $ref: '#/definitions/Operation' - properties: acquisitionMaterial: type: string description: 'Only for scheme transaction. Type of material used to realize the operation. Possible values: ATM, POS, INTERNET, MANUAL, VOICE_PHONE, UNATTENDED_TERMINAL, MOBILE, UNKNOWN' adjustment: type: boolean description: 'This flag indicates if this operation is an adjustment or not. Value: true : this operation adjusts already posted operation false : this operation does not adjust the posted operation' adjustmentReason: type: string description: "The reason why the adjustment has been created. (conditional)\nMandatory when adjustment is true.\n AdjustmentReasonType (DISPUTE_RESULT, COMMERCIAL_ADJUSTMENT, INVALID_OPERATION, ERROR_DURING_ACQUISITION, CONFIGURATION_REPROCESSING)" alternativeIban: type: string description: Corresponds to PAN token received from the scheme automaticPayment: type: boolean description: For credit cards, indicate if it is an automatic payment operation posted to an account in case of direct debit issued to repay an account (this account is automatically paid after N business days) brand: type: string description: Brand associated to the Issuer Account Range (BIN) such as "MCC" (MasterCard) , "DMC" (Debit MasterCard), "MSI" (Maestro), "CIR" (Cirrus), "VIS" (VISA). cardAcceptorIdCode: type: string description: 'Identifies the card acceptor ID assigned by the acquirer. This ID must represent a unique identifier for each merchant name/location within the acquiring BIN. Card Acceptor (Merchant) Identifier associated to the transaction - MCI : DE 042 - Card Acceptor ID Code - VISA : TCR5 - Acquirer''s Business ID' cardAcceptorZipCode: type: string description: 'Card Acceptor ZIP Code associated to the transaction MCI : DE 043 s4 - Card Acceptor Postal (ZIP) Code VISA : TCR0 - Merchant zip code' cardTypeCode: type: string description: Scheme Product associated to the Issuer Account Range cashAmount: description: 'Additional Amount / Currency / Exponent for Cash Back transaction amount * MCI : DE 054 s2 = 40 - Amount, Cash Back * VISA : TCR1 pos. 158-166 Cashback' allOf: - $ref: '#/definitions/Amount' cashAmountAccountCurrency: description: Additional Amount / Currency / Exponent for Cash Back transaction amount converted in Cardholder Account Currency allOf: - $ref: '#/definitions/Amount' dccIndicator: type: string description: 'This field must contain one of these values (optional): 1 = DCC performed space = default, no DCC has been performed' debit: type: boolean description: 'Sign associated to the transaction according to the Cardholder side * D = Cardholder debited * C = Cardholder credited' destinationIban: type: string description: IBAN used for reimbursement operation directDebitEndToEndId: type: string description: Identifier of the Direct Debit order linked to payment operation entryMode: type: string description: 'Precise how the card information have been read. Conversion of the native fields. Possible values : UNKNOWN OCR: Optical Character Reader MANUAL MAGSTRIPE: Magnetic Stripe read CONTACTLESS: Contactless read (called proximity payment or Mobile Chip system) CHIP: Chip read BARCODE: Bar Code read' externalMatchingOperationDate: type: string format: date-time description: 'The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. It is used for matching the current operation with the original operation. Mandatory in case of reversal. The field contains the value of externalOperationDate of the original operation (conditional).' externalMatchingOperationReference: type: string description: 'The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. It is used for matching the current operation with the original operation. Mandatory in case of reversal. The field contains the value of externalOperationReference of the original operation (conditional).' externalMatchingOperationServicePoster: type: string description: 'The triplet (externalMatchingOperationDate, externalMatchingOperationReference, externalMatchingOperationServicePoster) uniquely identifies the original operation in our system. It is used for matching the current operation with the original operation. Mandatory in case of reversal. The field contains the value of externalOperationServicePoster of the original operation (conditional).' gratuityAmount: description: 'Additional Amount / Currency / Exponent for Gratuity transaction amount in the transaction currency Only for MC' allOf: - $ref: '#/definitions/Amount' gratuityAmountAccountCurrency: description: 'Additional Amount / Currency / Exponent for Gratuity transaction amount converted by our system in Cardholder Account Currency ' allOf: - $ref: '#/definitions/Amount' interestCondition: type: string description: Free zone, used to store description like rates, algorithm and values calculated. interestStartDate: type: string format: date-time description: The starting date used to calculate interest. Present for information purpose. interestEndDate: type: string format: date-time description: The ending date used to calculate interest. Present for information purpose. interestType: type: string description: 'Type of Interest for an interest operation : CREDIT / DEBIT' operationDate: type: string format: date-time originatingAccountNumber: type: string description: The account number of the current balance transfer in the previous institution. For information purpose. originatingInstitution: type: string description: The information about the originating financial institution having this balance. For information purpose. pan: type: string description: Refer to Card.pan panExpiryDate: type: string description: Refer to Card.expiryDate panSequenceNumber: type: string description: Refer to Card.panSequenceNumber partialOperation: type: boolean description: Indicates whether this operation is partial or not. paymentChannel: type: string description: 'Indicates the channel of incoming payment operation from an external system (e.g. bank) Ex. CHEQUE, CASH, ONLINE_MONEY, NO_CHANNEL_PROVIDED, INSTALMENT, INCOMING_PAYMENT. INSTALMENT - set for payments generated for CreditInstalmentContract' poiAmount: description: Additional Amount / Currency / Exponent for DCC (Dynamic Currency Conversion) transaction amount - Only for MC allOf: - $ref: '#/definitions/Amount' poiAmountAccountCurrency: description: POI Amount in the Cardholder account currency - Only for MC allOf: - $ref: '#/definitions/Amount' sepa: type: boolean description: Indicates if an operation (e.g. incoming payment received from the issuer) was in SEPA format (e.g. SEPA payment). status: type: string description: "Status of the transaction \n* PROCESSED\n* IN_ERROR\n* CAS_IN_DISPUTE (when the transaction is disputed)\n* CAS_PENDING" surchargeAmount: description: Additional Amount / Currency / Exponent for surcharge transaction amount in Transaction Currency allOf: - $ref: '#/definitions/Amount' surchargeAmountAccountCurrency: description: Additional Amount / Currency / Exponent for Surcharge transaction amount converted in Cardholder Account Currency allOf: - $ref: '#/definitions/Amount' validationMode: type: string description: 'Precise how the transaction has been validated. Conversion based on information of the original message MC : DE 022 VISA : TCR0 POS Entry Mode /Cardholder ID Method/POS Terminal Capability Possible values: PIN, SIGNATURE, UNKNOWN' terminalId: type: string description: Code that identifies the card acceptor terminal or ATM. parentOperation: description: 'This field is expandable and if needed - shows the list of operations linked to parentOperationIdentifier Ex: TRANSACTION_FEE linked to FP (Parent). _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/Operation' parentOperationIdentifier: description: 'Internal identifier associated to the transaction to which one this transaction is linked. 16-digit incremental number (1000000000000001) Ex: TRANSACTION_FEE linked to FP (Parent)' allOf: - $ref: '#/definitions/OperationIdentifier' productIdentifier: description: OPC product identifier code allOf: - $ref: '#/definitions/ProductIdentifier' overPaymentAccountIdentifier: description: 'The identifier of the account in overpayment ' allOf: - $ref: '#/definitions/AccountIdentifier' loyaltyPoint: description: Used when the operation has loyalty points allOf: - $ref: '#/definitions/LoyaltyPoint' rewardedOperationIdentifier: description: Internal identifier associated to the transaction linked to a Bonus operation 16-digit incremental number (1000000000000001). Used only if a Bonus operation is related to. allOf: - $ref: '#/definitions/OperationIdentifier' lodgingInformation: description: 'The list of lodging information parameters from the clearing file. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/LodgingInformation' carRentalInformation: description: 'The list of car rental information parameters from the clearing file. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/CarRentalInformation' airItineraryInformation: description: 'The list of air itinerary parameters from the clearing file. _Embedded property, only filled when available for the endpoint and explicitly requested in the ''embed'' query parameter._' allOf: - $ref: '#/definitions/AirItineraryInformation' subOperationIdentifiers: type: array description: List of suboperation identifiers for the parent operation items: $ref: '#/definitions/OperationIdentifier' correction: type: boolean description: Represents weather the operation is a correction or not intermediateAmount: description: Calculated Cardholder Amount after potential Currency Conversion but before adding the Conversion Charge allOf: - $ref: '#/definitions/Amount' billingAmount: description: 'Cardholder Billing amount MCI only - DE6 Amount, Cardholder Billing' allOf: - $ref: '#/definitions/Amount' overallExhangeRate: type: number format: double description: Currency Rate shows the rate of the complete conversion from Transaction Amount to Posted Cardholder Amount title: OperationDetails LoyaltyPoint: type: object properties: unit: type: string description: ' Unit in which the loyalty points are expressed. Defined by Bonus/Loyalty program (can be currency, points...) (optional).' cumulatedValue: type: integer format: int64 description: Total number of loyalty points (optional). title: LoyaltyPoint 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 ApiResponseEntityReverseOperationBonusResponse: 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/ReverseOperationBonusResponse' description: Issuer response entity title: ApiResponseEntityReverseOperationBonusResponse 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 CreateOperationBonusRequest: type: object required: - bonusProgramReference - externalOperationReference - externalOperationDate - externalOperationServicePoster properties: description: description: 'Textual description of the operation Can contain a free text that can be used when the operation is presented to the Customer' type: string bonusProgramReference: description: The issuer must provide the reference of the Bonus/Loyalty program for which the reward is applied. type: string externalOperationReference: description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. External reference of the operation to be created.' type: string externalOperationDate: description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The date the operation is performed (in general, the current date should be provided).' type: string format: date-time externalOperationServicePoster: description: 'The triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) uniquely identifies the operation in our system. The identifier of the external system which provides the operation to be posted (free text)' type: string externalOperationCode: description: The external operation code of the Bonus operation can be provided to identify the operation type in the issuer system. type: string referenceAmount: description: 'The reference amount has to be provided for a monetary operation (amount/exponent/currency values) If a debit operation is posted, the operation amount has to be positive. If a credit operation is posted, the operation amount has to be negative. The currency must be the same as the posting account.' allOf: - $ref: '#/definitions/Amount' loyaltyPointAmount: description: 'The loyalty point amount has to be provided for a non-monetary operation (value/unit) If a debit operation is posted, the operation amount has to be positive. If a credit operation is posted, the operation amount has to be negative. The loyalty point unit must be defined by the Bonus/Loyalty program.' allOf: - $ref: '#/definitions/LoyaltyPoint' rewardedOperationIdentifier: description: 'The issuer can provide the identifier of the operation to be rewarded, if any. If provided, the triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) has not to be provided.' allOf: - $ref: '#/definitions/OperationIdentifier' rewardedExternalMatchingOperationReference: description: 'The issuer can provide the triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) of the operation to be rewarded if any. If the triplet is provided, the identifier of the operation to be rewarded has not to be provided. External reference of the operation to be rewarded.' type: string rewardedExternalMatchingOperationDate: description: 'The issuer can provide the triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) of the operation to be rewarded if any. If the triplet is provided, the identifier of the operation to be rewarded has not to be provided. Operation date of the operation to be rewarded.' type: string format: date-time rewardedExternalMatchingOperationServicePoster: description: 'The issuer can provide the triplet (externalOperationDate, externalOperationReference, externalOperationServicePoster) of the operation to be rewarded if any. If the triplet is provided, the identifier of the operation to be rewarded has not to be provided. Identifier of the external system of the operation to be rewarded.' type: string title: CreateOperationBonusRequest 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 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 ApiResponseEntityCreateOperationBalanceAdjustmentResponse: 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/CreateOperationBalanceAdjustmentResponse' description: Issuer response entity title: ApiResponseEntityCreateOperationBalanceAdjustmentResponse ReverseOperationBalanceAdjustmentResponse: required: - operationIdentifier properties: operationIdentifier: description: Identifier of the operation created during the balance adjustment reversal (generated by our system) allOf: - $ref: '#/definitions/OperationIdentifier' title: ReverseOperationBalanceAdjustmentResponse ApiResponseEntityReverseOperationPaymentResponse: 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/ReverseOperationPaymentResponse' description: Issuer response entity title: ApiResponseEntityReverseOperationPaymentResponse BadRequestErrorApiResponse: type: object required: - responseMetadata properties: responseMetadata: allOf: - $ref: '#/definitions/BadRequestResponseMetadata' title: BadRequestErrorApiResponse ApiResponseEntityCreateOperationUnloadResponse: 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/CreateOperationUnloadResponse' description: Issuer response entity title: ApiResponseEntityCreateOperationUnloadResponse securityDefinitions: basic: type: oauth2 flow: application tokenUrl: https://sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/token