openapi: "3.0.4" info: title: Merchant - Contract API description: This is the API server supplied by Worldline Financial Services. contact: name: Worldline FS Acquiring Processing API team. url: "https://financial-services.developer.worldline.com/" email: dl-fr-dp2si-acquiring@worldline.com license: name: proprietary Worldline Financial Services version: "2.1.4" servers: - url: /MerchantApiContract/api paths: /acquiring/contract/v2.1/acquirers/{acquirerId}/clusters: get: tags: - Acquirer summary: Retrieve the list of clusters description: This operation retrieves the total list of clusters operationId: GetAcquirerClusters parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/BF8F33_ClusterListData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/lists/{listName}: get: tags: - Acquirer summary: Retrieve all the possible values for a specific list (e.g. paymentFrequency, merchantCategoryCode, countryCode) as configured for the acquirer description: "This operation retrieves all possible values for the selected list. The following lists are supported:\n - bankAccountType,\n - brand,\n - channel,\n - country,\n - communicationLanguage,\n - communicationPreference,\n - dccProvider,\n - independentSalesOrganization,\n - merchantCategoryCode,\n - networkServiceProvider,\n - paymentAggregation,\n - paymentCurrency,\n - paymentDayMonthly,\n - paymentDayWeekly,\n - paymentDelay,\n - paymentFrequency,\n - paymentLevel,\n - paymentServiceProvider,\n - paymentTemplate,\n - statusReason,\n - terminalDomain,\n - transactionCurrency" operationId: GetAcquirerList parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: listName in: path description: "Possible values: \n - bankAccountType,\n - brand,\n - channel,\n - country,\n - communicationLanguage,\n - communicationPreference,\n - dccProvider,\n - independentSalesOrganization,\n - merchantCategoryCode,\n - networkServiceProvider,\n - paymentAggregation,\n - paymentCurrency,\n - paymentDayMonthly,\n - paymentDayWeekly,\n - paymentDelay,\n - paymentFrequency,\n - paymentLevel,\n - paymentServiceProvider,\n - paymentTemplate,\n - statusReason,\n - terminalDomain,\n - transactionCurrency" required: true schema: type: string responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/BF8F33_AcquirerListData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/holdings: get: tags: - Holding summary: Retrieve active holdings of an acquirer description: This operation retrieves a list of holdings. operationId: GetAcquirerHoldings parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: holdingId in: query description: Unique identification of the holding, determined by Worldline Financial Services schema: type: integer format: int32 - name: holdingName in: query description: Holding name schema: type: string - name: sortField in: query description: Sort field schema: enum: - holdingId - holdingName type: string - name: sortOrder in: query description: Sort order schema: enum: - Ascending - Descending type: string - name: pageSize in: query description: Page size schema: type: string - name: pageNumber in: query description: Page number schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: type: array items: $ref: '#/components/schemas/2E7D6D_HoldingListData' "400": description: Invalid input provided "401": description: Not authorised to use this call "403": description: Not authorised to use this call "500": description: Server side error "502": description: Backend service problem post: tags: - Holding summary: Add a holding operationId: PostHolding parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/648B1C_PostHolding' application/json: schema: allOf: - $ref: '#/components/schemas/648B1C_PostHolding' text/json: schema: allOf: - $ref: '#/components/schemas/648B1C_PostHolding' application/*+json: schema: allOf: - $ref: '#/components/schemas/648B1C_PostHolding' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/2E7D6D_PostHoldingResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/holdings/{holdingId}: get: tags: - Holding summary: Retrieve a holding of an acquirer description: This operation retrieves a holding based on the given search criteria. operationId: GetHolding parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: holdingId in: path description: Unique identification of the holding, determined by Worldline Financial Services required: true schema: type: integer format: int32 - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/2E7D6D_HoldingData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem delete: tags: - Holding summary: Terminate a holding operationId: DeleteHolding parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: holdingId in: path description: Unique identification of the holding, determined by Worldline Financial Services required: true schema: type: integer format: int32 responses: "200": description: Termination of the holding is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem patch: tags: - Holding summary: Update a holding description: "Fields that can be used: /basic/holdingName**\nOperations that can be used: **replace**\nSample request: \n\n [\n {\n \"value\": \"MyHolding\",\n \"path\": \"/basic/holdingName\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchHolding parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: holdingId in: path description: Unique identification of the holding, determined by Worldline Financial Services required: true schema: type: integer format: int32 requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/holdings/{holdingId}/addresses: get: tags: - Holding summary: Retrieve the addresses of a holding description: This operation retrieves addresses of a holding. operationId: GetHoldingAddresses parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: holdingId in: path description: Unique identification of the holding, determined by Worldline Financial Services required: true schema: type: integer format: int32 - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/2E7D6D_HoldingAddressData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/merchants: get: tags: - Merchant summary: Search merchants description: This operation retrieves a list of merchants based on the given search criteria. operationId: GetAcquirerMerchants parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: iban in: query description: International Bank Account Number for merchant payments schema: type: string - name: holdingId in: query description: Unique identification of the holding, determined by Worldline Financial Services schema: type: integer format: int32 - name: merchantId in: query description: Unique identification of the merchant, determined by the acquirer schema: type: string - name: merchantName in: query description: Name of the merchant schema: type: string - name: postalCode in: query description: Postal code of business address. schema: type: string - name: houseNumber in: query description: Housenumber of business address. Note, Postalcode must be given too schema: type: integer format: int32 - name: terminalId in: query description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) schema: type: string - name: cardAcceptorId in: query description: Unique identification of the site in accordance with payment scheme rules schema: type: string - name: sortField in: query description: Sort field schema: enum: - merchantId - merchantName type: string - name: sortOrder in: query description: Sort order schema: enum: - Ascending - Descending type: string - name: pageSize in: query description: Page size (Max page size is 300) schema: type: string - name: pageNumber in: query description: Page number schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: type: array items: $ref: '#/components/schemas/006163_MerchantListData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem post: tags: - Merchant summary: Add a merchant operationId: PostMerchant parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchant' application/json: schema: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchant' text/json: schema: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchant' application/*+json: schema: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchant' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/006163_PostMerchantResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/merchants/{merchantId}: get: tags: - Merchant summary: Retrieve a merchant description: This operation retrieves a merchant. operationId: GetMerchant parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: merchantId in: path description: Unique identification of the merchant, determined by the acquirer required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/006163_MerchantData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem delete: tags: - Merchant summary: Delete a merchant operationId: DeleteMerchant parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: merchantId in: path description: Unique identification of the merchant, determined by the acquirer required: true schema: type: string responses: "200": description: Termination of the merchant is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem patch: tags: - Merchant summary: Update a merchant description: "Based on a GET Merchant call a PATCH Merchant call can be generated to change one or more fields. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. Sample request: \n\n [\n {\n \"value\": \"MyMerchant\",\n \"path\": \"/basic/merchantName\",\n \"op\": \"replace\" \n }, \n {\n \"value\": \"NL12121\",\n \"path\": \"/externalIds/vatNumber\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchMerchant parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: merchantId in: path description: Unique identification of the merchant, determined by the acquirer required: true schema: type: string requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/merchants/{merchantId}/addresses: get: tags: - Merchant summary: Retrieve the addresses of a merchant description: This operation retrieves addresses of a merchant. operationId: GetMerchantAddresses parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: merchantId in: path description: Unique identification of the merchant, determined by the acquirer required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/006163_MerchantAddressData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem post: tags: - Merchant summary: Add addresses to a Merchant operationId: PostMerchantAddresses parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: merchantId in: path description: Unique identification of the merchant, determined by the acquirer required: true schema: type: string requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchantAddresses' application/json: schema: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchantAddresses' text/json: schema: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchantAddresses' application/*+json: schema: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchantAddresses' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem patch: tags: - Merchant summary: Update the addresses of a Merchant description: "Based on a GET Merchant Addresses call a PATCH Merchant Addresses call can be generated to change one or more fields. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. Sample request: \n\n [\n {\n \"value\": \"Mainstreet\",\n \"path\": \"/addresses/0/streetName\",\n \"op\": \"replace\" \n }, \n {\n \"value\": 12,\n \"path\": \"/addresses/0/houseNumber\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchMerchantAddresses parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: merchantId in: path description: Unique identification of the merchant, determined by the acquirer required: true schema: type: string requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/merchants/{merchantId}/addresses/{addressType}: delete: tags: - Merchant summary: Delete an address from a merchant description: This operation deletes a merchant address operationId: DeleteMerchantAddress parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: merchantId in: path description: Unique identification of the merchant, determined by the acquirer required: true schema: type: string - name: addressType in: path description: "Type of the address. Values [Business, Chargeback, Creditor, Debtor, Invoice, Location, Postal, Private]" required: true schema: type: string responses: "200": description: Delete is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/merchants/{merchantId}/clusters: post: tags: - Merchant summary: Add clusters to a merchant description: This operation adds clusters to a merchant operationId: PostMerchantClusters parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: merchantId in: path description: Unique identification of the merchant, determined by the acquirer required: true schema: type: string requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchantClusters' application/json: schema: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchantClusters' text/json: schema: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchantClusters' application/*+json: schema: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchantClusters' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/merchants/{merchantId}/clusters/{clusterId}: delete: tags: - Merchant summary: Delete a cluster from a merchant description: This operation deletes a cluster from a merchant operationId: DeleteMerchantCluster parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: merchantId in: path description: Unique identification of the merchant, determined by the acquirer required: true schema: type: string - name: clusterId in: path description: Unique identification of the cluster, determined by Worldline Financial Services required: true schema: type: integer format: int32 responses: "200": description: Delete is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts: get: tags: - Contract summary: Search contracts description: This operation retrieves a list of contracts based on the given search criteria. operationId: GetAcquirerContracts parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: holdingId in: query description: Unique identification of the holding, determined by Worldline Financial Services schema: type: integer format: int32 - name: merchantId in: query description: Unique identification of the merchant, determined by the acquirer schema: type: string - name: contractId in: query description: Unique identification of the contract, determined by the acquirer schema: type: string - name: iban in: query description: Iban schema: type: string - name: contractName in: query description: Optional name for this specific contract schema: type: string - name: postalCode in: query description: Postal code of business address. schema: type: string - name: houseNumber in: query description: House number of business address. Note, Postal code must be given as well schema: type: integer format: int32 - name: cardAcceptorId in: query description: Unique identification of the site in accordance with payment scheme rules schema: type: string - name: terminalId in: query schema: type: string - name: merchantName in: query description: Name of the merchant schema: type: string - name: sortField in: query description: Sort field schema: enum: - contractId - contractName type: string - name: sortOrder in: query description: Sort order schema: enum: - Ascending - Descending type: string - name: pageSize in: query description: Page size (Max page size is 300) schema: type: string - name: pageNumber in: query description: Page number schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: type: array items: $ref: '#/components/schemas/AF779F_ContractListData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem post: tags: - Contract summary: Add a contract operationId: PostContract parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContract' application/json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContract' text/json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContract' application/*+json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContract' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/AF779F_PostContractResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}: get: tags: - Contract summary: Retrieve a contract description: This operation retrieves a contract. operationId: GetContract parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/AF779F_ContractData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem delete: tags: - Contract summary: Delete a contract operationId: DeleteContract parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem patch: tags: - Contract summary: Update a contract description: "Based on a GET Contract call a PATCH Contract call can be generated to change one or more fields. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. Sample request: \n\n [\n {\n \"value\": \"MyContract\",\n \"path\": \"/basic/contractName\",\n \"op\": \"replace\" \n }, \n {\n \"value\": \"true\",\n \"path\": \"/basic/highRiskMerchant\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchContract parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/AF779F_ContractResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/currencies: post: tags: - Contract summary: Add currencies to a contract operationId: PostContractCurrencies parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractCurrency' application/json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractCurrency' text/json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractCurrency' application/*+json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractCurrency' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/AF779F_PostContractCurrenciesResponse' "400": description: Returns when business errors are found content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/addresses: get: tags: - Contract summary: Retrieve the addresses of a contract description: This operation retrieves addresses of a contract. operationId: GetContractAddresses parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/AF779F_ContractAddressData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem post: tags: - Contract summary: Add addresses to a contract operationId: PostContractAddresses parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractAddresses' application/json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractAddresses' text/json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractAddresses' application/*+json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractAddresses' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/AF779F_EditContractAddressesResponse' "400": description: Returns when business errors are found content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem patch: tags: - Contract summary: Update the addresses of a contract description: "Based on a GET Contract Addresses call a PATCH Contract Addresses call can be generated to change one or more fields. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. Sample request: \n\n [\n {\n \"value\": \"Mainstreet\",\n \"path\": \"/addresses/0/streetName\",\n \"op\": \"replace\" \n }, \n {\n \"value\": 12,\n \"path\": \"/addresses/0/houseNumber\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchContractAddresses parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/AF779F_EditContractAddressesResponse' "400": description: Returns when business errors are found content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/addresses/{addressType}: delete: tags: - Contract summary: Delete an address from a contract description: This operation deletes a contract address operationId: DeleteContractAddress parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: addressType in: path description: "Type of the address. Values [Business, Chargeback, Creditor, Debtor, Invoice, Location, Postal, Private]" required: true schema: type: string responses: "200": description: Delete is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/balances: get: tags: - Contract summary: Retrieve the balances of a contract description: This operation retrieves balances of a contract. operationId: GetContractBalances parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/AF779F_ContractBalanceData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem post: tags: - Contract summary: Add balances to a contract operationId: PostContractBalances parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractBalances' application/json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractBalances' text/json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractBalances' application/*+json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractBalances' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/AF779F_EditContractBalancesResponse' "400": description: Returns when business errors are found content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem patch: tags: - Contract summary: Update the balances of a contract description: "Based on a GET Contract Balances call a PATCH Contract Balances call can be generated to change one or more fields. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. Sample request: \n\n [\n {\n \"value\": \"Fil.100\",\n \"path\": \"/balances/0/merchantReconciliationReference\",\n \"op\": \"replace\"\n }, \n {\n \"value\": \"1\",\n \"path\": \"/balances/0/bankAccounts/0/bankAccountType\",\n \"op\": \"replace\" \n },\n {\n \"value\": \"NL91STUB0000007899\",\n \"path\": \"/balances/0/bankAccounts/0/iban\",\n \"op\": \"replace\" \n },\n {\n \"value\": \"STUBNL2A\",\n \"path\": \"/balances/0/bankAccounts/0/bic\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchContractBalances parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/AF779F_EditContractBalancesResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/brands: get: tags: - Contract summary: Retrieve the brand parameters of a contract description: This operation retrieves brands of a contract. operationId: GetContractBrands parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/AF779F_ContractBrandData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem post: tags: - Contract summary: Add brands to a contract operationId: PostContractBrands parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractBrands' application/json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractBrands' text/json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractBrands' application/*+json: schema: allOf: - $ref: '#/components/schemas/D3BE35_PostContractBrands' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/AF779F_PostContractBrandsResponse' "400": description: Returns when business errors are found content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Not authorised to use this call "404": description: Resource not found "500": description: Server side error "502": description: Bad Gateway patch: tags: - Contract summary: Update the brand parameters of a contract description: "Based on a GET Contract Brands call a PATCH Contract Brands call can be generated to change one or more fields. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. Sample request: \n\n [\n {\n \"value\": 12,\n \"path\": \"/brands/1/brandParameters/offlineMaximumTipPercentage\",\n \"op\": \"replace\" \n }, \n {\n \"path\": \"/brands/1/brandParameters/magstripeTransactionProcessingOptions\",\n \"op\": \"remove\"\n },\n {\n \"value\": \"12.0000\",\n \"path\": \"/brands/1/brandParameters/amounts/0/iccOfflineFloorLimit\",\n \"op\": \"replace\" \n },\n {\n \"value\": \"true\",\n \"path\": \"/brands/1/brandParameters/manualEntryProcessingOptions/refuseTransaction\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchContractBrands parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: applyToAll in: query description: If value is true then the changes made to 1 brand (with index 0) will automatically apply to all brands schema: type: boolean requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Returns when business errors are found content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Not authorised to use this call "404": description: Resource not found "500": description: Unexpected error "502": description: Bad Gateway /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/brands/{label}: delete: tags: - Contract summary: Delete a brand from a contract operationId: DeleteContractBrand parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: label in: path description: "Unique identification of the brand (payment product). Maestro = MAES, American Express = AMEX, Visa = VISA, etc." required: true schema: type: string responses: "200": description: Delete is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Returns when business errors are found content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Not authorised to use this call "404": description: Resource not found "500": description: Server side error "502": description: Bad Gateway /acquiring/contract/v2.1/acquirers/{acquirerId}/sites: get: tags: - Site summary: Search sites description: This operation retrieves a list of sites based on the given search criteria. operationId: GetAcquirerSites parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: iban in: query description: International Bank Account Number for merchant payments schema: type: string - name: holdingId in: query description: Unique identification of the holding, determined by Worldline Financial Services schema: type: integer format: int32 - name: merchantId in: query description: Unique identification of the merchant, determined by the acquirer schema: type: string - name: contractId in: query description: Unique identification of the contract, determined by the acquirer schema: type: string - name: postalCode in: query description: Postal code of site address schema: type: string - name: houseNumber in: query description: House number of site address. Note, Postal code must be given as well schema: type: integer format: int32 - name: siteId in: query description: Unique identification of the site within the contract schema: type: integer format: int32 - name: cardAcceptorId in: query description: Unique identification of the site in accordance with payment scheme rules schema: type: string - name: terminalId in: query description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) schema: type: string - name: merchantName in: query description: Name of the merchant schema: type: string - name: contractName in: query description: Optional name for this specific contract schema: type: string - name: siteName in: query description: Name of the site schema: type: string - name: sortField in: query description: Sort field schema: enum: - siteId - siteName type: string - name: sortOrder in: query description: Sort order schema: enum: - Ascending - Descending type: string - name: pageSize in: query description: Page size (Max page size is 300) schema: type: string - name: pageNumber in: query description: Page number schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: type: array items: $ref: '#/components/schemas/3349CF_SiteListData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem post: tags: - Site summary: Add a site (based on Card Acceptor ID) operationId: PostSiteCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/6D115A_PostSite' application/json: schema: allOf: - $ref: '#/components/schemas/6D115A_PostSite' text/json: schema: allOf: - $ref: '#/components/schemas/6D115A_PostSite' application/*+json: schema: allOf: - $ref: '#/components/schemas/6D115A_PostSite' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/3349CF_PostSiteResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}: get: tags: - Site summary: Retrieve a site (based on Card Acceptor ID) operationId: GetSiteCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/3349CF_SiteData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem delete: tags: - Site summary: Terminate a site (based on Card Acceptor ID) operationId: DeleteSiteCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem patch: tags: - Site summary: Update a site (based on Card Acceptor ID) description: "Fields that can be used: **/basic/siteName, /basic/subMerchantId**\nOperations that can be used: **replace, remove**\nSample request: \n\n [\n {\n \"value\": \"MySite\",\n \"path\": \"/basic/siteName\",\n \"op\": \"replace\" \n }, \n {\n \"value\": \"123456\",\n \"path\": \"/basic/subMerchantId\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchSiteCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/addresses: get: tags: - Site summary: Retrieve addresses of a site (based on Card Acceptor ID) operationId: GetSiteAddressesCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/3349CF_SiteAddressData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem patch: tags: - Site summary: Update addresses of a site (based on Card Acceptor ID) description: "Fields that can be used: **/addresses/0/streetName, /addresses/0/houseNumber**\nOperations that can be used: **replace, remove**\nSample request: \n\n [\n {\n \"value\": \"Mainstreet\",\n \"path\": \"/addresses/0/streetName\",\n \"op\": \"replace\" \n }, \n {\n \"value\": 12,\n \"path\": \"/addresses/0/houseNumber\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchSiteAddressCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/sites: post: tags: - Site summary: Add a site operationId: PostSite parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/6D115A_PostSite' application/json: schema: allOf: - $ref: '#/components/schemas/6D115A_PostSite' text/json: schema: allOf: - $ref: '#/components/schemas/6D115A_PostSite' application/*+json: schema: allOf: - $ref: '#/components/schemas/6D115A_PostSite' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/3349CF_PostSiteResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}: get: tags: - Site summary: Retrieve a site description: This operation retrieves a site. operationId: GetSite parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/3349CF_SiteData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem delete: tags: - Site summary: Delete a site operationId: DeleteSite parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem patch: tags: - Site summary: Update a site description: "Based on a GET Site call a PATCH Site call can be generated to change one or more fields. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution.\nSample request: \n\n [\n {\n \"value\": \"MySite\",\n \"path\": \"/basic/siteName\",\n \"op\": \"replace\" \n }, \n {\n \"value\": \"123456\",\n \"path\": \"/basic/subMerchantId\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchSite parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int32 requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/addresses: get: tags: - Site summary: Retrieve the addresses of a site description: This operation retrieves addresses of a site. operationId: GetSiteAddresses parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/3349CF_SiteAddressData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem patch: tags: - Site summary: Updates the adresses of a site description: "Based on a GET Site Addresses call a PATCH Site Addresses call can be generated to change one or more fields. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. Since a site only has one address the index is always 0\nSample request: \n\n [\n {\n \"value\": \"Mainstreet\",\n \"path\": \"/addresses/0/streetName\",\n \"op\": \"replace\" \n }, \n {\n \"value\": 12,\n \"path\": \"/addresses/0/houseNumber\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchSiteAddresses parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int32 requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/balances: get: tags: - Site summary: Retrieve the balances of a site description: This operation retrieves balances of a site. operationId: GetSiteBalances parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/3349CF_SiteBalanceData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem patch: tags: - Site summary: Update the balances of a site description: "Based on a GET Site Balances call a PATCH Site Balances call can be generated to change one or more fields of one or more balances. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. To reference a specific balance the index of that balance in the GET call needs to be used.\nSample request: \n\n [\n {\n \"value\": \"Shop123\",\n \"path\": \"/balances/0/merchantReconciliationReference\",\n \"op\": \"replace\" \n }, \n {\n \"value\": \"NL94PCGD0000000222\",\n \"path\": \"/balances/0/bankAccounts/0/iban\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchSiteBalances parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int32 requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/brands: get: tags: - Site summary: Retrieve the brand parameters of a site description: This operation retrieves brands of a site. operationId: GetSiteBrands parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/3349CF_SiteBrandData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem patch: tags: - Site summary: Update the brand parameters of a site description: "Based on a GET Site Brands call a PATCH Site Brands call can be generated to change one or more fields of one or more brands. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. To reference a specific brand the index of that brand in the GET call needs to be used.\nSample request: \n\n [\n {\n \"value\": \"true\",\n \"path\": \"brands/0/brandParameters/allowedServices/refundService\",\n \"op\": \"replace\" \n }, \n {\n \"path\": \"brands/0/brandParameters/allowedServicesContactless/refundService\",\n \"op\": \"remove\" \n }\n ]" operationId: PatchSiteBrands parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int32 - name: applyToAll in: query description: If value is true then the changes made to 1 brand (with index 0) will automatically apply to all brands schema: type: boolean requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/balances: get: tags: - Site summary: Retrieve balances of a site (based on Card Acceptor ID) operationId: GetSiteBalancesCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/3349CF_SiteBalanceData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem patch: tags: - Site summary: Update the balances of a site (based on Card Acceptor ID) description: "Based on a GET Site Balances call a PATCH Site Balances call can be generated to change one or more fields of one or more balances. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. To reference a specific balance the index of that balance in the GET call needs to be used.\nSample request: \n\n [\n {\n \"value\": \"Shop123\",\n \"path\": \"/balances/0/merchantReconciliationReference\",\n \"op\": \"replace\" \n }, \n {\n \"value\": \"NL94PCGD0000000222\",\n \"path\": \"/balances/0/bankAccounts/0/iban\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchSiteBalancesCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/brands: get: tags: - Site summary: Retrieve the brand parameters of a site (based on Card Acceptor ID) description: This operation retrieves brands of a site. operationId: GetSiteBrandsCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/3349CF_SiteBrandData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem patch: tags: - Site summary: Update the brand parameters of a site (based on Card Acceptor ID) description: "Based on a GET Site Brands call a PATCH Site Brands call can be generated to change one or more fields of one or more brands. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. To reference a specific brand the index of that brand in the GET call needs to be used.\nSample request: \n\n [\n {\n \"value\": \"true\",\n \"path\": \"brands/0/brandParameters/allowedServices/refundService\",\n \"op\": \"replace\" \n }, \n {\n \"path\": \"brands/0/brandParameters/allowedServicesContactless/refundService\",\n \"op\": \"remove\" \n }\n ]" operationId: PatchSiteBrandCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string - name: applyToAll in: query description: If value is true then the changes made to 1 brand (with index 0) will automatically apply to all brands schema: type: boolean requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/terminals: get: tags: - Terminal summary: Search terminals description: This operation retrieves a list of terminals based on the given search criteria. operationId: GetAcquirerTerminals parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: iban in: query description: International Bank Account Number for merchant payments schema: type: string - name: holdingId in: query description: Unique identification of the holding, determined by Worldline Financial Services schema: type: integer format: int32 - name: merchantId in: query description: Unique identification of the merchant, determined by the acquirer schema: type: string - name: contractId in: query description: Unique identification of the contract, determined by the acquirer schema: type: string - name: siteId in: query description: Unique identification of the site within the contract schema: type: integer format: int64 - name: cardAcceptorId in: query description: Unique identification of the site in accordance with payment scheme rules schema: type: string - name: terminalId in: query description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) schema: type: string - name: merchantName in: query description: Name of the merchant schema: type: string - name: contractName in: query description: Optional name for this specific contract schema: type: string - name: siteName in: query description: Name of the site schema: type: string - name: sortField in: query description: Sort field schema: enum: - terminalId - nameOnStatement type: string - name: sortOrder in: query description: Sort order schema: enum: - Ascending - Descending type: string - name: pageSize in: query description: Page size (Max page size is 300) schema: type: string - name: pageNumber in: query description: Page number schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: type: array items: $ref: '#/components/schemas/BDB114_TerminalListData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}: get: tags: - Terminal summary: Retrieve a terminal description: This operation retrieves a terminal. operationId: GetSiteTerminal parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/BDB114_TerminalData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem delete: tags: - Terminal summary: Delete a terminal operationId: DeleteSiteTerminal parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem patch: tags: - Terminal summary: Update a terminal description: "Based on a GET Terminal call a PATCH Terminal call can be generated to change one or more fields. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution.\nSample request: \n\n [\n {\n \"value\": \"1010101\",\n \"path\": \"/contractIndentification/siteId\",\n \"op\": \"replace\" \n }, \n {\n \"value\": \"true\",\n \"path\": \"/basic/transactionReference\",\n \"op\": \"replace\" \n },\n {\n \"value\": \"1111\",\n \"path\": \"/basic/merchantCategoryCode\",\n \"op\": \"replace\"\n },\n {\n \"path\": \"/basic/nameOnStatement\",\n \"op\": \"remove\"\n }\n ]" operationId: PatchSiteTerminal parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals: post: tags: - Terminal summary: Add a terminal (based on Card Acceptor ID) operationId: PostSiteTerminalCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/FAEA4B_PostTerminal' application/json: schema: allOf: - $ref: '#/components/schemas/FAEA4B_PostTerminal' text/json: schema: allOf: - $ref: '#/components/schemas/FAEA4B_PostTerminal' application/*+json: schema: allOf: - $ref: '#/components/schemas/FAEA4B_PostTerminal' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/BDB114_PostTerminalResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}: get: tags: - Terminal summary: Retrieve a terminal (based on Card Acceptor ID) operationId: GetSiteTerminalCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/BDB114_TerminalData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem delete: tags: - Terminal summary: Terminate a terminal (based on Card Acceptor ID) operationId: DeleteSiteTerminalCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem patch: tags: - Terminal summary: Update a terminal (based on Card Acceptor ID) description: "Fields that can be used: **/contractIdentification/siteId, /basic/merchantCategoryCode, /basic/nameOnStatement, /basic/transactionReference**\nOperations that can be used: **replace, remove**\nSample request: \n\n [\n {\n \"value\": \"1010101\",\n \"path\": \"/contractIdentification/siteId\",\n \"op\": \"replace\" \n }, \n {\n \"value\": \"true\",\n \"path\": \"/basic/transactionReference\",\n \"op\": \"replace\" \n },\n {\n \"value\": \"1111\",\n \"path\": \"/basic/merchantCategoryCode\",\n \"op\": \"replace\"\n },\n {\n \"path\": \"/basic/nameOnStatement\",\n \"op\": \"remove\"\n }\n ]" operationId: PatchSiteTerminalCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}/addresses: get: tags: - Terminal summary: Retrieve addresses of a terminal (based on Card Acceptor ID) operationId: GetSiteTerminalAddressesCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/BDB114_TerminalAddressData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals: post: tags: - Terminal summary: Add a terminal operationId: PostSiteTerminal parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/FAEA4B_PostTerminal' application/json: schema: allOf: - $ref: '#/components/schemas/FAEA4B_PostTerminal' text/json: schema: allOf: - $ref: '#/components/schemas/FAEA4B_PostTerminal' application/*+json: schema: allOf: - $ref: '#/components/schemas/FAEA4B_PostTerminal' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/BDB114_PostTerminalResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}/addresses: get: tags: - Terminal summary: Retrieve the addresses of a terminal description: This operation retrieves addresses of the terminal location. operationId: GetSiteTerminalAddresses parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/BDB114_TerminalAddressData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}/balances: get: tags: - Terminal summary: Retrieve the balances of a terminal description: This operation retrieves balances of the terminal operationId: GetSiteTerminalBalances parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/BDB114_TerminalBalanceData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem patch: tags: - Terminal summary: Update the balances of a terminal description: "Based on a GET Terminal Balances call a PATCH Terminal Balances call can be generated to change one or more fields of one or more balances. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. To reference a specific balance the index of that balances in the GET call needs to be used.\nSample request: \n\n [\n {\n \"value\": \"Shop123\",\n \"path\": \"/balances/0/merchantReconciliationReference\",\n \"op\": \"replace\" \n }, \n {\n \"value\": \"NL94PCGD0000000222\",\n \"path\": \"/balances/0/bankAccounts/0/iban\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchSiteTerminalBalances parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}/balances: get: tags: - Terminal summary: Retrieve the balances of a terminal (based on Card Acceptor ID) description: This operation retrieves balances of the terminal operationId: GetSiteTerminalBalancesCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/BDB114_TerminalBalanceData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem patch: tags: - Terminal summary: Update the balances of a terminal (based on Card Acceptor ID) description: "Based on a GET Terminal Balances call a PATCH Terminal Balances call can be generated to change one or more fields of one or more balances. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. To reference a specific balance the index of that balances in the GET call needs to be used.\nSample request: \n\n [\n {\n \"value\": \"Shop123\",\n \"path\": \"/balances/0/merchantReconciliationReference\",\n \"op\": \"replace\" \n }, \n {\n \"value\": \"NL94PCGD0000000222\",\n \"path\": \"/balances/0/bankAccounts/0/iban\",\n \"op\": \"replace\" \n }\n ]" operationId: PatchSiteTerminalBalancesCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}/brands: get: tags: - Terminal summary: Retrieve the brand parameters of a terminal description: This operation retrieves balances of the terminal operationId: GetSiteTerminalBrands parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/BDB114_TerminalBrandData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem patch: tags: - Terminal summary: Update the brand parameters of a terminal description: "Based on a GET Terminal Brands call a PATCH Terminal Brands call can be generated to change one or more fields of one or more brands. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. To reference a specific brand the index of that brand in the GET call needs to be used.\nSample request: \n\n [\n {\n \"value\": \"true\",\n \"path\": \"brands/0/brandParameters/allowedServices/refundService\",\n \"op\": \"replace\" \n }, \n {\n \"path\": \"brands/0/brandParameters/allowedServicesContactless/refundService\",\n \"op\": \"remove\" \n }\n ]" operationId: PatchSiteTerminalBrands parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: contractId in: path description: Unique identification of the contract, determined by the acquirer required: true schema: type: string - name: siteId in: path description: Unique identification of the site within the contract required: true schema: type: integer format: int64 - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string - name: applyToAll in: query description: If value is true then the changes made to 1 brand (with index 0) will automatically apply to all brands schema: type: boolean requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}/brands: get: tags: - Terminal summary: Retrieve the brand parameters of a terminal (based on Card Acceptor ID) description: This operation retrieves balances of the terminal operationId: GetSiteTerminalBrandsCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/BDB114_TerminalBrandData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem patch: tags: - Terminal summary: Update the brand parameters of a terminal (based on Card Acceptor ID) description: "Based on a GET Terminal Brands call a PATCH Terminal Brands call can be generated to change one or more fields of one or more brands. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. To reference a specific brand the index of that brand in the GET call needs to be used.\nSample request: \n\n [\n {\n \"value\": \"true\",\n \"path\": \"brands/0/brandParameters/allowedServices/refundService\",\n \"op\": \"replace\" \n }, \n {\n \"path\": \"brands/0/brandParameters/allowedServicesContactless/refundService\",\n \"op\": \"remove\" \n }\n ]" operationId: PatchSiteTerminalBrandCaid parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: cardAcceptorId in: path description: Unique identification of the site in accordance with payment scheme rules required: true schema: type: string - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string - name: applyToAll in: query description: If value is true then the changes made to 1 brand (with index 0) will automatically apply to all brands schema: type: boolean requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/terminals/{terminalId}/checknumbers/{checkNumber}: get: tags: - Terminal summary: Retrieve a terminal check number operationId: GetSiteTerminalCheckNumber parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: terminalId in: path description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) required: true schema: type: string - name: checkNumber in: path description: Check number of the terminal. Only relevant in case the terminal ID is generated up front during the reservation process by processor equensWordline required: true schema: type: string responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/BDB114_TerminalCheckNumberResponse' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/transactionFeePricePlans: get: tags: - PricePlan summary: Retrieve transaction fee price plans of an acquirer operationId: GetAcquirerTransactionFeePricePlans parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: transactionFeePricePlanId in: query description: Unique identification of the transaction fee price plan, determined by Worldline Financial Services schema: type: integer format: int32 - name: transactionFeePricePlanName in: query description: Name of the transaction fee price plan schema: type: string - name: transactionFeePricePlanType in: query description: Type of the transaction fee price plan (based on the selected template) schema: enum: - StandardPricing - InterchangeFeePlus - InterchangeTieredPricing - InterchangePlusPlus - DefaultSchemeFees - SteppedPricing type: string - name: currency in: query description: Currency of the transaction fee price plan according to ISO 4217 (alphanumeric-3). All tariffs in the price plan are in this currency. schema: type: string - name: sortField in: query description: Sort field schema: enum: - acquirerId - transactionFeePricePlanId - transactionFeePricePlanName - transactionFeePricePlanType - currency type: string - name: sortOrder in: query description: Sort order schema: enum: - Ascending - Descending type: string - name: pageSize in: query description: Page size (max page size is 300) schema: type: string - name: pageNumber in: query description: Page number schema: type: string - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: type: array items: $ref: '#/components/schemas/ACC7D4_TransactionFeePricePlanListData' "400": description: Invalid input provided "401": description: Not authorised to use this call "403": description: Not authorised to use this call "500": description: Server side error "502": description: Backend service problem post: tags: - PricePlan summary: Add a transaction fee price plan operationId: PostTransactionFeePricePlan parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string requestBody: content: application/json-patch+json: schema: allOf: - $ref: '#/components/schemas/B92357_PostTransactionFeePricePlan' application/json: schema: allOf: - $ref: '#/components/schemas/B92357_PostTransactionFeePricePlan' text/json: schema: allOf: - $ref: '#/components/schemas/B92357_PostTransactionFeePricePlan' application/*+json: schema: allOf: - $ref: '#/components/schemas/B92357_PostTransactionFeePricePlan' responses: "201": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/ACC7D4_PostTransactionFeePricePlanResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem /acquiring/contract/v2.1/acquirers/{acquirerId}/transactionFeePricePlans/{transactionFeePricePlanId}: get: tags: - PricePlan summary: Retrieve a transaction fee price plan operationId: GetTransactionFeePricePlan parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: transactionFeePricePlanId in: path description: Unique identification of the transaction fee price plan, determined by Worldline Financial Services required: true schema: type: integer format: int32 - name: includeTerminated in: header description: "Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included)." schema: type: boolean responses: "200": description: Successful content: application/json: schema: $ref: '#/components/schemas/ACC7D4_TransactionFeePricePlanData' "400": description: Invalid input provided "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Server side error "502": description: Backend service problem patch: tags: - PricePlan summary: Update a transaction fee price plan description: "Based on a GET Transaction fee price plan call a PATCH Transaction fee price plan call can be generated to change one or more fields. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution. To reference a specific counter, tariff group or tariff the index of that item in the GET call needs to be used. \n \n [\n {\n \"value\": \"MyTransactionFeePricePlanName\",\n \"path\": \"/basic/transactionFeePricePlanName\",\n \"op\": \"replace\" \n }, \n {\n \"value\": \"200.2500\",\n \"path\": \"/counters/1/tariffGroups/2/tariffs/5/baseAmount\",\n \"op\": \"replace\"\n }\n ]" operationId: PatchTransactionFeePricePlan parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: transactionFeePricePlanId in: path description: Unique identification of the transaction fee price plan, determined by Worldline Financial Services required: true schema: type: integer format: int32 requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' text/json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/D716BC_Operation' responses: "200": description: Change is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem delete: tags: - PricePlan summary: Delete a transaction fee price plan operationId: DeleteTransactionFeePricePlan parameters: - name: acquirerId in: path description: Unique identification of the acquirer, determined by Worldline Financial Services required: true schema: type: string - name: transactionFeePricePlanId in: path description: Unique identification of the transaction fee price plan, determined by Worldline Financial Services required: true schema: type: integer format: int32 responses: "200": description: Termination of the holding is processed with correlation id content: application/json: schema: $ref: '#/components/schemas/08BFAF_CorrelationResponse' "400": description: Invalid input provided content: application/json: schema: $ref: '#/components/schemas/08BFAF_ErrorResponse' "401": description: Unauthorized "403": description: Forbidden "404": description: Resource not found "500": description: Unexpected error "502": description: Backend service problem components: schemas: 006163_ContractIdentification3: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" holdingId: type: integer description: Unique identification of the holding, determined by Worldline Financial Services format: int32 example: 200 additionalProperties: false 006163_MerchantAddressData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/006163_MerchantContractIdentification' addresses: type: array items: $ref: '#/components/schemas/A1DCC6_AddressDetails' additionalProperties: false 006163_MerchantBasic: type: object properties: acquirerName: type: string description: Name of the acquirer example: Worldline Sandbox Bank holdingName: type: string description: Name of the holding example: Event Payment Solutions merchantName: type: string description: Name of the merchant example: Event Payment Solutions 1 masterCardAssignedId: type: string description: Unique identifier of the merchant, issued by Mastercard example: "123456" visaMerchantVerificationValue: type: string description: Unique identifier of the merchant, issued by Visa example: "1234567890" visaMerchantVolumeIndicator: type: integer description: Used to identify merchant volume thresholds to be defined by Visa format: int32 example: 10 participationMupp: type: string description: Indicates whether the merchant is enrolled in the Mastercard Utility Payment Program example: "false" masterCardPaymentFacilitatorId: type: string description: Payment facilitator ID, issued by Mastercard example: "200000" visaPaymentFacilitatorId: type: string description: Payment facilitator ID, issued by Visa example: "10000000" paymentFacilitatorIndicator: type: boolean description: Indicates whether the merchant is a payment facilitator example: true paymentFacilitatorModel: type: integer description: "3 models are supported:\n1) The sub-merchants are registered in the contract management system, all have the(same) card acceptor ID of the payment facilitator, transactions contain the card acceptor ID of the payment facilitator\n2) The sub-merchants are registered in the contract management system, all have a unique card acceptor ID, transactions contain the card acceptor ID of the sub-merchant\n3) The sub-merchants are not registered in the contract management system, transactions contain the card acceptor ID of the payment facilitator, all sub-merchant data is retrieved by the front office from the incoming transactions" format: int32 example: 1 paymentFacilitatorName: type: string description: (Abbreviation of the) name of the payment facilitator to be used as first part of the card acceptor name example: EPS countryOfOrigin: type: string description: Country of origin (home country) of a merchant that is owned by or under control of a government example: "729" merchantProfileId: type: string description: Unique identification of the merchant profile example: "13" additionalProperties: false 006163_MerchantClusters: type: object properties: clusterId: type: integer description: Unique identification of the cluster, determined by Worldline Financial Services format: int32 example: 432 type: type: string description: Type of the cluster example: Merchant account type name: type: string description: Name of the cluster example: Key account additionalProperties: false 006163_MerchantContractIdentification: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" holdingId: type: string description: Unique identification of the holding, determined by Worldline Financial Services example: "200" merchantId: type: string description: Unique identification of the merchant, determined by the acquirer example: "1001" additionalProperties: false 006163_MerchantData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/006163_MerchantContractIdentification' basic: allOf: - $ref: '#/components/schemas/006163_MerchantBasic' externalIds: allOf: - $ref: '#/components/schemas/1D0D36_ExternalIds' refundLimits: allOf: - $ref: '#/components/schemas/1D0D36_MerchantRefundLimits' clusters: type: array items: $ref: '#/components/schemas/006163_MerchantClusters' status: allOf: - $ref: '#/components/schemas/006163_MerchantStatus' addressDetailsURI: type: string description: URI to get the merchant address details example: acquiring/contract/v2.1/acquirers/315000001/merchants/1001/addresses additionalProperties: false 006163_MerchantListData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/006163_ContractIdentification3' merchantId: type: string description: Unique identification of the merchant, determined by the acquirer example: "1001" merchantName: type: string description: Name of the merchant example: Event Payment Solutions 1 status: type: string description: "The status of the merchant. values [Active, Terminated]" example: Active address: allOf: - $ref: '#/components/schemas/A1DCC6_Address' merchantDetailsURI: type: string description: URI to get the merchant details example: acquiring/contract/v2.1/acquirers/315000001/merchants/1001 additionalProperties: false 006163_MerchantStatus: type: object properties: status: type: string description: "The status of the merchant. values [Active, Terminated]" example: Active commencementDate: type: string description: Date at which the merchant was registered (yyyy-mm-dd) example: "2013-05-23" terminationDate: type: string description: Date at which the merchant was terminated (yyyy-mm-dd) additionalProperties: false 006163_PostMerchantResponse: type: object properties: correlationId: type: string description: Unique ID that was generated for the specific change format: uuid contractIdentification: allOf: - $ref: '#/components/schemas/08BFAF_MerchantIdentificationResponse' additionalProperties: false 08BFAF_CorrelationResponse: type: object properties: correlationId: type: string description: Unique ID that was generated for the specific change format: uuid additionalProperties: false 08BFAF_ErrorResponse: type: object properties: code: type: string description: Unique code of the error as returned by the system handling the request message: type: string description: Message explaining the error moreInformation: type: string description: Error details 08BFAF_MerchantIdentificationResponse: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" holdingId: type: string description: Unique identification of the holding, determined by Worldline Financial Services example: "200" merchantId: type: string description: Unique identification of the merchant, determined by the acquirer example: "1001" contractId: type: string description: Unique identification of the contract, determined by the acquirer example: "10011" siteId: type: integer description: Unique identification of the site within the contract format: int64 example: 100111 cardAcceptorId: type: string description: Unique identification of the site in accordance with payment scheme rules example: "90100110" terminalId: type: string description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) example: W01AB01 additionalProperties: false 1D0D36_ExternalIds: type: object properties: vatNumber: type: string description: VAT number of the merchant example: NL123456789B01 chamberOfCommerce: type: string description: Chamber of commerce number of the merchant example: "12345678" socialSecurityNumber: type: string description: Social security number of the merchant (only allowed in specific countries) example: "123456789" branchOrganisationId: type: string description: Identification of the merchant by his branch organization example: "1234" additionalProperties: false 1D0D36_MerchantRefundLimits: type: object properties: maximumDailyRefundAmountMerchant: type: string description: Maximum daily total refund amount per merchant in Euro example: "200000.00" additionalProperties: false 1D0D36_PostCluster: type: object properties: clusterId: type: integer description: Unique identification of the cluster, determined by Worldline Financial Services format: int32 example: 432 additionalProperties: false 1D0D36_PostMerchant: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchantContractIdentification' basic: allOf: - $ref: '#/components/schemas/1D0D36_PostMerchantBasic' externalIds: allOf: - $ref: '#/components/schemas/1D0D36_ExternalIds' refundLimits: allOf: - $ref: '#/components/schemas/1D0D36_MerchantRefundLimits' additionalProperties: false 1D0D36_PostMerchantAddresses: type: object properties: addresses: type: array items: $ref: '#/components/schemas/A1DCC6_AddressDetails' additionalProperties: false 1D0D36_PostMerchantBasic: type: object properties: merchantName: type: string description: Name of the merchant example: Event Payment Solutions 1 masterCardAssignedId: type: string description: Unique identifier of the merchant, issued by Mastercard example: "123456" visaMerchantVerificationValue: type: string description: Unique identifier of the merchant, issued by Visa example: "1234567890" visaMerchantVolumeIndicator: type: integer description: Used to identify merchant volume thresholds to be defined by Visa format: int32 example: 10 participationMupp: type: boolean description: Indicates whether the merchant is enrolled in the Mastercard Utility Payment Program example: false masterCardPaymentFacilitatorId: type: string description: Payment facilitator ID, issued by Mastercard example: "200000" visaPaymentFacilitatorId: type: string description: Payment facilitator ID, issued by Visa example: "10000000" paymentFacilitatorIndicator: type: boolean description: Indicates whether the merchant is a payment facilitator example: true paymentFacilitatorModel: type: integer description: "3 models are supported:\n\n1. The sub-merchants are registered in the contract management system, all have the(same) card acceptor ID of the payment facilitator, transactions contain the card acceptor ID of the payment facilitator\n2. The sub-merchants are registered in the contract management system, all have a unique card acceptor ID, transactions contain the card acceptor ID of the sub-merchant\n3. The sub-merchants are not registered in the contract management system, transactions contain the card acceptor ID of the payment facilitator, all sub-merchant data is retrieved by the front office from the incoming transaction" format: int32 example: 1 paymentFacilitatorName: type: string description: (Abbreviation of the) name of the payment facilitator to be used as first part of the card acceptor name example: EPS countryOfOrigin: type: string description: Country of origin (home country) of a merchant that is owned by or under control of a government example: "729" additionalProperties: false 1D0D36_PostMerchantClusters: type: object properties: clusters: type: array items: $ref: '#/components/schemas/1D0D36_PostCluster' additionalProperties: false 1D0D36_PostMerchantContractIdentification: type: object properties: holdingId: type: integer description: Unique identification of the holding, determined by Worldline Financial Services format: int32 example: 200 merchantId: type: string description: Unique identification of the merchant, determined by the acquirer example: "1001" additionalProperties: false 2E7D6D_ContractIdentification2: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" additionalProperties: false 2E7D6D_HoldingAddressData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/2E7D6D_HoldingContractIdentification' addresses: type: array items: $ref: '#/components/schemas/A1DCC6_AddressDetails' additionalProperties: false 2E7D6D_HoldingBasic: type: object properties: acquirerName: type: string description: Name of the acquirer example: Worldline Sandbox Bank holdingName: type: string description: Name of the holding example: Event Payment Solutions additionalProperties: false 2E7D6D_HoldingContractIdentification: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" holdingId: type: string description: Unique identification of the holding, determined by Worldline Financial Services example: "200" additionalProperties: false 2E7D6D_HoldingData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/2E7D6D_HoldingContractIdentification' basic: allOf: - $ref: '#/components/schemas/2E7D6D_HoldingBasic' status: allOf: - $ref: '#/components/schemas/2E7D6D_HoldingStatus' addressDetailsURI: type: string description: URI to get the holding address details example: acquiring/contract/v2.1/acquirers/315000001/holdings/200/addresses additionalProperties: false 2E7D6D_HoldingListData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/2E7D6D_ContractIdentification2' description: Unique identification of the acquirer, determined by Worldline Financial Services holdingId: type: integer description: Unique identification of the holding, determined by Worldline Financial Services format: int32 example: 200 holdingName: type: string description: Name of the holding example: Event Payment Solutions status: type: string description: "The status of the holding. values [Active, Terminated]" example: Active address: allOf: - $ref: '#/components/schemas/A1DCC6_Address' holdingDetailsURI: type: string description: URI to get the holding details example: acquiring/contract/v2.1/acquirers/315000001/holdings/200 additionalProperties: false 2E7D6D_HoldingStatus: type: object properties: status: type: string description: "The status of the holding. values [Active, Terminated]" example: Active commencementDate: type: string description: Date at which the holding was registered (yyyy-mm-dd) example: "2013-05-23" terminationDate: type: string description: Date at which the holding was terminated (yyyy-mm-dd) additionalProperties: false 2E7D6D_PostHoldingResponse: type: object properties: correlationId: type: string description: Unique ID that was generated for the specific change format: uuid contractIdentification: allOf: - $ref: '#/components/schemas/08BFAF_MerchantIdentificationResponse' additionalProperties: false 3349CF_ContractIdentification5: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" holdingId: type: integer description: Unique identification of the holding, determined by Worldline Financial Services format: int32 example: 200 merchantId: type: string description: Unique identification of the merchant, determined by the acquirer example: "1001" contractId: type: string description: Unique identification of the contract, determined by the acquirer example: "10011" additionalProperties: false 3349CF_PostSiteResponse: type: object properties: correlationId: type: string description: Unique ID that was generated for the specific change format: uuid contractIdentification: allOf: - $ref: '#/components/schemas/3349CF_SiteContractIdentification' additionalProperties: false 3349CF_SiteAddressData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/3349CF_SiteContractIdentification' addresses: type: array items: $ref: '#/components/schemas/A1DCC6_AddressDetails' additionalProperties: false 3349CF_SiteBalanceData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/3349CF_SiteContractIdentification' balances: type: array items: $ref: '#/components/schemas/48BE2C_Balance' additionalProperties: false 3349CF_SiteBasic: type: object properties: acquirerName: type: string description: Name of the acquirer example: Worldline Sandbox Bank contractName: type: string description: Optional name for this specific contract example: Music Festivals siteName: type: string description: Name of the site example: EPS*Metal Festival channel: type: integer description: "Channel of the site. Values [1 = POS, 2 = eCommerce]" format: int32 example: 1 terminalDomainId: type: integer description: "A domain of merchants, acquirers, terminal vendors and terminals in which a common POS terminal protocol (e.g. C-TAP) is used and in which a certain authority (e.g. Acquiris, Nets) is responsible for identifiers of acquirers and processors. Values [1 = Dutch C-TAP / IFSF, 2 = Finnish EMV, 3 = International C-TAP]" format: int32 example: 1 subMerchantId: type: string description: Sub merchant ID, defined by a payment facilitator (merchant). Each merchant that is considered to be a payment facilitator by the payment schemes needs to uniquely identify all of its sites with a sub merchant ID example: "110" terminalModel: type: integer description: "Indicates which model for terminal management applies. Values [1 = Processor defined terminal ID, 2 = Merchant specific terminal ID in contract management, 3 = Merchant specific terminal ID, no terminals in contract management, 4 = Third party hosting]" format: int32 example: 1 merchantCategoryCode: type: string description: The MCC is used to classify a business by the types of goods or services it provides, according to ISO 18245 for retail financial services example: "7999" transactionReference: type: boolean description: Indicates whether the merchant is allowed to add a reference to a C-TAP POS transaction example: true url: type: string description: URL of the website of the merchant example: metalfestival.nl geoCoordinates: type: string description: "Geographical coordinates of the site\n\nGeographical coordinates in decimal degree (DD) format Latitude,Longitude where Latitude and Longitude are floating point numbers with the unit degree. Integer and decimal digits are separated by a dot. East and north are indicated by positive numbers whereas west and south have negative ones." example: "52.07482,5.09395" additionalProperties: false 3349CF_SiteBrandData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/3349CF_SiteContractIdentification' brands: type: array items: $ref: '#/components/schemas/AF779F_BrandData' additionalProperties: false 3349CF_SiteContractIdentification: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" merchantId: type: string description: Unique identification of the merchant, determined by the acquirer example: "177" contractId: type: string description: Unique identification of the contract, determined by the acquirer example: "10011" siteId: type: integer description: Unique identification of the site within the contract format: int64 example: 100111 cardAcceptorId: type: string description: Unique identification of the site in accordance with payment scheme rules example: "1001" additionalProperties: false 3349CF_SiteData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/3349CF_SiteContractIdentification' basic: allOf: - $ref: '#/components/schemas/3349CF_SiteBasic' serviceProviders: allOf: - $ref: '#/components/schemas/3349CF_SiteServiceProviders' refundLimits: allOf: - $ref: '#/components/schemas/AF779F_RefundLimits' status: allOf: - $ref: '#/components/schemas/AF779F_Status' addressDetailsURI: type: string description: URI to get the site address details example: acquiring/contract/v2.1/acquirers/315000001/contracts/10011/sites/100111/addresses balanceDataURI: type: string description: URI to get the site balance data example: acquiring/contract/v2.1/acquirers/315000001/contracts/10011/sites/100111/balances brandDataURI: type: string description: URI to get the site brand data example: acquiring/contract/v2.1/acquirers/315000001/contracts/10011/sites/100111/brands additionalProperties: false 3349CF_SiteListData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/3349CF_ContractIdentification5' cardAcceptorId: type: string description: Unique identification of the site in accordance with payment scheme rules example: "90100110" siteId: type: integer description: Unique identification of the site within the contract format: int64 example: 100111 siteName: type: string description: Name of the site example: EPS*Metal Festival channel: type: integer description: "Channel of the site. Values [1 = POS, 2 = eCommerce]" format: int32 example: 1 commencementDate: type: string description: Date at which contract, site or terminal was registered (yyyy-mm-dd) example: "2013-05-23" paymentBlockDate: type: string description: Date at which the payment for the contract or site has been blocked (yyyy-mm-dd) transactionBlockDate: type: string description: Date at which the transactions for the contract or site has been blocked (yyyy-mm-dd) status: type: string description: "The status of this entity. Values [Active, Blocked (Trx & Pmts), Blocked (Trx), Blocked (Pmts), Terminated]" example: Active address: allOf: - $ref: '#/components/schemas/A1DCC6_Address' siteDetailsURI: type: string description: URI to get the site details example: acquiring/contract/v2.1/acquirers/315000001/contracts/10011/sites/100110 additionalProperties: false 3349CF_SiteServiceProviders: type: object properties: networkServiceProviderName: type: string description: Name of the network service provider example: MyNSP visaEnablerVerificationValue: type: string description: Visa Enabler Verification Value (EVV) example: AE2F1 additionalProperties: false 48BE2C_Balance: type: object properties: balanceNumber: type: integer description: "Number of the balance. Values [1, 2, 3]" format: int32 example: 1 merchantReconciliationReference: type: string description: Reference the merchant wants to be part of the description lines of the payment on his bank statement example: "10011" paymentLevel: type: integer description: "Level of the merchant hierarchy at which the merchant is paid. Values [4 = Contract, 5 = Site, 6 = Terminal]" format: int32 example: 4 paymentAggregation: type: integer description: "Indicates whether the merchant is paid per brand, per scheme or totalized. Values [1 = Totalized payment, 2 = Payment per brand, 3 = Payment per scheme]" format: int32 example: 1 paymentFrequency: type: integer description: "Frequency in which the balance is settled with the merchant. Values [1 = Accounting period, 2 = Weekly, 3 = Monthly, 4 = Daily, 5 = Twice a month, 6 = Per external batch, 7 = Across batches, 8 = Merchant manual cut-off, 9 = Merchant automatic cut-off]" format: int32 example: 4 paymentDay: type: integer description: "Specific day of the week or month the merchant is paid. Values in case of weekly [1 to 7], values in case of monthly [1 to 31]" format: int32 example: 1 paymentDelay: type: integer description: "Payment delay in days. Values [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 30, 60, 90]" format: int32 example: 0 terminalPeriodClosureLevel: type: integer description: "The level on which the financial counter information for the transactions cut-off period are consulted, used by the merchant to align it with the used reconciliation period when the merchant has chosen to manual cut-off the booking period of the transactions. Values [0 = Terminal, 1 = Site]" format: int32 example: 0 terminalPeriodCutoffTime: type: string description: The fixed time (hours and minutes, without date and seconds) of the daily moment - defined by the merchant - when the cut-off of the financial counter information, used by the merchant to align it with the used reconciliation period when the merchant has chosen for automatically cut off the booking period of the transactions example: "00:00" bankAccounts: type: array items: $ref: '#/components/schemas/48BE2C_TerminalBalancebankAccount' additionalProperties: false 48BE2C_BalanceNumber: type: object properties: balanceNumber: type: integer description: "Number of the balance. Values [1, 2, 3]" format: int32 example: 1 additionalProperties: false 48BE2C_TerminalBalancebankAccount: type: object properties: currency: type: string description: (Local) Payment Currency according to ISO 4217 (alphanumeric-3) example: EUR bankAccountType: type: integer description: "Describes whether a bank account number is of the type IBAN or not (Other). In the latter case it can be for example an American or South-African bank account number. Values [1 = IBAN, 99 = Other]" format: int32 example: 1 bic: type: string description: Bank Institution Code for merchant payment. A BIC needs to be registered for each payment currency of the merchant example: BITSNL2A iban: type: string description: International Bank Account Number for merchant payments. An IBAN needs to be registered for each payment currency of the merchant example: NL76BITS1234567890 threshold: type: integer description: Amount of the threshold. The acquirer can choose to hold an amount in reserve before paying the merchant. This is usually done for risk mitigation. The threshold is registered at balance 1. An amount can be registered for each payment currency of the merchant format: int32 example: 0 additionalProperties: false 648B1C_PostHolding: type: object properties: basic: allOf: - $ref: '#/components/schemas/648B1C_PostHoldingBasic' additionalProperties: false 648B1C_PostHoldingBasic: type: object properties: holdingName: type: string description: Name of the holding example: Event Payment Solutions additionalProperties: false 6D115A_PostSite: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/6D115A_PostSiteContractIdentification' basic: allOf: - $ref: '#/components/schemas/6D115A_PostSiteBasic' serviceProviders: allOf: - $ref: '#/components/schemas/6D115A_ServiceProviders' refundLimits: allOf: - $ref: '#/components/schemas/AF779F_RefundLimits' addresses: type: array items: $ref: '#/components/schemas/A1DCC6_AddressDetails' additionalProperties: false 6D115A_PostSiteBasic: type: object properties: siteName: type: string description: Name of the site example: EPS*Metal Festival channel: type: integer description: "Channel of the site. Values [1 = POS, 2 = eCommerce]" format: int32 example: 1 terminalDomainId: type: integer description: "A domain of merchants, acquirers, terminal vendors and terminals in which a common POS terminal protocol (e.g. C-TAP) is used and in which a certain authority (e.g. Acquiris, Nets) is responsible for identifiers of acquirers and processors. Values [1 = Dutch C-TAP / IFSF, 2 = Finnish EMV, 3 = International C-TAP]" format: int32 example: 1 subMerchantId: type: string description: Sub merchant ID, defined by a payment facilitator (merchant). Each merchant that is considered to be a payment facilitator by the payment schemes needs to uniquely identify all of its sites with a sub merchant ID example: "110" merchantCategoryCode: type: string description: The MCC is used to classify a business by the types of goods or services it provides, according to ISO 18245 for retail financial services example: "7999" transactionReference: type: boolean description: Indicates whether the merchant is allowed to add a reference to a C-TAP POS transaction example: true url: type: string description: URL of the website of the merchant example: metalfestival.nl geoCoordinates: type: string description: "Geographical coordinates of the site\n\nGeographical coordinates in decimal degree (DD) format Latitude,Longitude where Latitude and Longitude are floating point numbers with the unit degree. Integer and decimal digits are separated by a dot. East and north are indicated by positive numbers whereas west and south have negative ones." example: "52.07482,5.09395" additionalProperties: false 6D115A_PostSiteContractIdentification: type: object properties: siteId: type: integer description: Unique identification of the site within the contract format: int64 example: 100111 contractId: type: string description: Unique identification of the contract, determined by the acquirer example: "10011" cardAcceptorId: type: string description: Unique identification of the site in accordance with payment scheme rules example: "90100110" additionalProperties: false 6D115A_ServiceProviders: type: object properties: visaEnablerVerificationValue: type: string description: Visa Enabler Verification Value (EVV) example: AE2F1 additionalProperties: false A1DCC6_Address: type: object properties: streetName: type: string description: Street name and house number of the address. In case of a Dutch address only Street name example: Stootblok houseNumber: type: integer description: House number. Only used for Dutch addresses format: int32 example: 14 houseAddition: type: string description: House number addition. Only used for Dutch addresses example: bis postalCode: type: string description: Postal code of the address example: 3071AP city: type: string description: City of the address example: Rotterdam region: type: string description: Region of the address. Also known as country-subdivision code example: ZH countryCode: type: string description: Country of the address according to ISO 3166-1 (numeric-3) example: "528" contactPersonName: type: string description: Name of the contact person registered with the address example: M. Scott telephoneNumber: type: string description: Telephone number of contact person registered with the address example: +31-63864055 email: type: string description: E-mail address of the contact person registered with the address example: M.Scott@eventpaymentsolutions.com additionalProperties: false A1DCC6_AddressDetails: type: object properties: addressType: type: string description: "Type of the address. Values [Business, Chargeback, Creditor, Debtor, Invoice, Location, Postal, Private]" example: Business streetName: type: string description: Street name and house number of the address. In case of a Dutch address only Street name example: Stootblok houseNumber: type: integer description: House number. Only used for Dutch addresses format: int32 example: 14 houseAddition: type: string description: House number addition. Only used for Dutch addresses example: bis postalCode: type: string description: Postal code of the address example: 3071AP city: type: string description: City of the address example: Rotterdam region: type: string description: Region of the address. Also known as country-subdivision code example: ZH countryCode: type: string description: Country of the address according to ISO 3166-1 (numeric-3) example: "528" departmentName: type: string description: Department of the contact person registered with the address example: Finance contactPersonName: type: string description: Name of the contact person registered with the address example: M. Scott postalRoom: type: string description: Postal room of the contact person registered with the address example: 2N.17 telephoneNumber: type: string description: Telephone number of contact person registered with the address example: +31-63864055 faxNumber: type: string description: Fax number of the contact person registered with the address example: +31-24683905 email: type: string description: E-mail address of the contact person registered with the address example: M.Scott@eventpaymentsolutions.com customerServiceTelephoneNumber: type: string description: Telephone number of the merchant that can be used for transaction inquiries example: +31-88385511 additionalContactInformation: type: string description: "Additional information for contacting the acceptor (e.g. additional phone number or contact name)" example: Ask for Mike communicationLanguage: type: string description: Preferred communication language of the contact person registered with the address accrding to ISO 639-2 (alphanumeric-3) example: eng communicationPreference: type: integer description: "Preferred communication type of the contact person registered with the address. Values [1 = Post, 2 = Fax, 3 = E-mail]" format: int32 example: 3 additionalProperties: false A1DCC6_AddressType: type: object properties: addressType: type: string description: "Type of the address. Values [Business, Chargeback, Creditor, Debtor, Invoice, Location, Postal, Private]" example: Postal additionalProperties: false ACC7D4_ExtTfppBasic: type: object properties: acquirerName: type: string description: Name of the acquirer example: Worldline Sandbox Bank transactionFeePricePlanName: type: string description: Name of the transaction fee price plan example: Standard Pricing Supermarket transactionFeePricePlanDescription: type: string description: Description of the transaction fee price plan example: Standard pricing for supermarkets transactionFeePricePlanTemplateId: type: integer description: Unique identification of the transaction fee price plan template that the price plan is based on format: int32 example: 1 transactionFeePricePlanTemplateName: type: string description: Name of the transaction fee price plan template that the price plan is based on example: Standard Pricing transactionFeePricePlanType: type: integer description: Type of the transaction fee price plan (based on the selected template) format: int32 example: 1 currency: type: string description: Currency of the transaction fee price plan according to ISO 4217 (alphanumeric-3). All tariffs in the price plan are in this currency. example: EUR useDefaultSchemeFeesIcpp: type: boolean description: "Indicates whether the Interchange Plus Plus transaction fee price plan contains the (by the acquirer defined) default scheme fees or not. If not, then the scheme fees need to be registered in the price plan." example: false additionalProperties: false ACC7D4_ExtTfppContractIdentification: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" transactionFeePricePlanId: type: integer description: Unique identification of the transaction fee price plan, determined by Worldline Financial Services format: int32 example: 79 additionalProperties: false ACC7D4_ExtTfppCounter: type: object properties: counterId: type: string description: "Unique identification of the counter within the transaction fee price plan. Only price plans of the type \u201CStepped Pricing\u201D can have multiple counters. All other types have just 1, which has the value \"C000000\"" example: C000000 tariffGroups: type: array items: $ref: '#/components/schemas/ACC7D4_ExtTfppTariffGroup' additionalProperties: false ACC7D4_ExtTfppStatus: type: object properties: status: type: string description: "The status of the transaction fee price plan. Values [Active, Terminated]" example: Active additionalProperties: false ACC7D4_ExtTfppTariff: type: object properties: tariffId: type: string description: A combination of transaction conditions that are also used to determine the interchange fee. example: T000144 tariffDescription: type: string description: Description of the tariff ID. Shows the combination of transaction conditions the tariff applies to example: POS/Mastercard/EEA/Consumer/Credit/Purchase baseAmount: type: string description: Base amount of a fee (in the currency of the price plan). This is a fixed amount. example: "0.0506" minimumAmount: type: string description: Minimum amount of a fee (in the currency of the price plan). The fee is always equal to or higher than this amount. example: "0.1300" maximumAmount: type: string description: Maximum amount of a fee (in the currency of the price plan). The fee is always equal to or lower than this amount. example: "0.2800" percentage: type: string description: Percentage of the transaction amount example: "0.08" additionalProperties: false ACC7D4_ExtTfppTariffGroup: type: object properties: tariffGroupNumber: type: integer description: Unique identification of the tariff group within the counter. How many groups can be used is determined by the price plan type (based on the selected template) format: int32 example: 1 tariffGroupType: type: integer description: Type of the tariff group format: int32 example: 1 tariffs: type: array items: $ref: '#/components/schemas/ACC7D4_ExtTfppTariff' additionalProperties: false ACC7D4_PostTransactionFeePricePlanResponse: type: object properties: correlationId: type: string description: Unique ID that was generated for the specific change format: uuid contractIdentification: allOf: - $ref: '#/components/schemas/ACC7D4_ExtTfppContractIdentification' additionalProperties: false ACC7D4_TransactionFeePricePlanData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/ACC7D4_ExtTfppContractIdentification' basic: allOf: - $ref: '#/components/schemas/ACC7D4_ExtTfppBasic' counters: type: array items: $ref: '#/components/schemas/ACC7D4_ExtTfppCounter' status: allOf: - $ref: '#/components/schemas/ACC7D4_ExtTfppStatus' additionalProperties: false ACC7D4_TransactionFeePricePlanListData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/2E7D6D_ContractIdentification2' description: Unique identification of the acquirer, determined by Worldline Financial Services transactionFeePricePlanId: type: integer description: Unique identification of the transaction fee price plan, determined by Worldline Financial Services format: int32 example: 79 transactionFeePricePlanName: type: string description: Name of the transaction fee price plan example: Standard Pricing Supermarket transactionFeePricePlanType: type: integer description: Type of the transaction fee price plan (based on the selected template) format: int32 example: 1 currency: type: string description: Currency of the transaction fee price plan according to ISO 4217 (alphanumeric-3). All tariffs in the price plan are in this currency. example: EUR status: type: string description: "The status of the transaction fee price plan. Values [Active, Terminated]" example: Active transactionFeePricePlanDetailsURI: type: string description: URI to get the transaction fee price plan details example: acquiring/contract/v2.1/acquirers/315000001/transactionFeePricePlans/79 additionalProperties: false AF779F_AllowedServices: type: object properties: purchaseService: type: boolean description: Indicates whether purchase is allowed example: true cashAdvanceService: type: boolean description: Indicates whether cash advance is allowed example: false reservationService: type: boolean description: Indicates whether reservation is allowed example: false purchaseAfterReservationService: type: boolean description: Indicates whether purchase after reservation is allowed example: false cardValidityCheckService: type: boolean description: Indicates whether card validity check is allowed example: false refundService: type: boolean description: Indicates whether refund is allowed example: true deferredSaleService: type: boolean description: Indicates whether deferred sale is allowed example: false cancellationService: type: boolean description: Indicates whether cancellation of a purchase is allowed example: true saleWithCashback: type: boolean description: Indicates whether the sale with cashback is allowed example: false saleWithIncreasedAmount: type: boolean description: Indicates whether sale with increased amount is allowed example: false quasiCashSale: type: boolean description: Indicates whether quasi cash is allowed example: false cancellationOfSaleAfterReservation: type: boolean description: Indicates whether cancellation of a sale after reservation is allowed example: false cancellationOfCashAdvance: type: boolean description: Indicates whether cancellattion of cash advance is allowed example: false recurringSale: type: boolean description: Indicates whether recurring sale is allowed example: false cancellationOfReservation: type: boolean description: Indicates whether cancellation of a reservation is allowed example: false saleWithDcc: type: boolean description: Indicates whether sale with DCC is allowed example: false saleAfterReservationWithDcc: type: boolean description: Indicates whether sales after reservation with DCC is allowed example: false cashAdvanceWithDcc: type: boolean description: Indicates whether cash advance with DCC is allowed example: false refundWithDcc: type: boolean description: Indicates whether refund with DCC is allowed example: false reservationDcc: type: boolean description: Indicates whether reservation with DCC is allowed example: false additionalProperties: false AF779F_Amount: type: object properties: currency: type: string description: Transaction currency according to ISO 4217 (alphanumeric-3) example: EUR magstripeOfflineFloorLimit: type: string description: "Floor limit for magnetic stripe based transactions. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "0.00" iccOfflineFloorLimit: type: string description: "Floor limit for chip based EMV transactions. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "0.00" transactionLimitContactless: type: string description: "Transaction limit for contactless transactions. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "99999.99" offlineFloorLimitContactless: type: string description: "Offline floor limit for contactless transactions. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "0.00" cardholderVerificationLimit: type: string description: "Cardholder verification limit. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "50.00" receiptLimit: type: string description: "The maximum amount allowed for which a receipt does not have to be printed. A receipt must be given for all transaction amounts above this. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "0.00" noCvmLimit: type: string description: "The amount under which transactions (chip with contacts) without cardholder verification (No-CVM) are allowed. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "0.00" maximumCashBackAmount: type: string description: "The maximum amount a merchant is allowed to pay as cash back. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "0.00" maximumDailyTransactionAmount: type: string description: "The maximum total amount of online transactions for a site per day. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "75000.00" maximumTransactionAmount: type: string description: "The maximum amount of a single transaction. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "75000.00" maxDailyVoiceAuthorizationAmount: type: string description: "The maximum total amount of voice authorizations for a site per day. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "75000.00" maxVoiceAuthorizationAmount: type: string description: "The maximum amount of a single voice authorization. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "75000.00" matMaximumTransactionAmount: type: string description: "Restricts the amount of transactions in the backup mode. If the transaction amount is greater than the maximum backup transaction amount, then the backup transaction is not accepted offline." example: "150.00" matTransactionLimitContactless: type: string description: Restricts the amount of the contactless transaction in backup mode example: "150.00" matCardholderVerificationLimit: type: string description: "Restricts the amount of the contactless transaction without \u201COffline On Device Cardholder Verification\u201D in the backup mode" example: "150.00" additionalProperties: false AF779F_BrandData: type: object properties: label: type: string description: "Unique identification of the brand (payment product). Maestro = MAES, American Express = AMEX, Visa = VISA, etc." example: MAST brand: type: string description: Name of the brand example: Mastercard paymentFrequency: type: integer description: Payment frequency of the brand on contract level format: int32 example: 2 paymentDay: type: integer description: Payment day of the brand on contract level format: int32 example: 1 paymentDelay: type: integer description: Payment delay in number of days of the brand on contract level format: int32 example: 1 brandParameters: allOf: - $ref: '#/components/schemas/AF779F_BrandParameters' additionalProperties: false AF779F_BrandParameters: type: object properties: offlineManualEntryAllowed: type: boolean description: Indicates whether manual entry of card data (PAN, expiry date) is allowed for transactions which are processed offline example: false magstripeTransactionProcessingOptions: type: integer description: "Used to select the cardholder verification method for magnetic stripe based transactions. Values [1 = PIN required, 2 = Signature required, 3 = PIN or signature required based on card service code]" format: int32 example: 1 amounts: type: array items: $ref: '#/components/schemas/AF779F_Amount' offlineMaximumTipPercentage: type: integer description: "The maximum tip amount, represented as a percentage of the transaction amount, that is allowed as extra" format: int32 example: 0 noCvmAllowed: type: boolean description: Indicates whether transactions (chip with contacts) without cardholder verification (No-CVM) are allowed beneath the maximum amount set by the scheme example: false maximumDailyTransactionNumber: type: integer description: The maximum number of online transactions for a site per day format: int32 example: 250 maxDailyVoiceAuthorizationNumber: type: integer description: The maximum number of voice authorizations for a site per day format: int32 example: 250 tokenization: type: boolean description: Indicates whether C-TAP tokenization is allowed on the terminal example: false dynamicDescriptor: type: boolean description: "Card brand parameter which indicates towards the front office, whether a terminal or website is allowed to use Dynamic Descriptors. Dynamic descriptors allow merchants to add relevant information (invoice number or some other details) about a transaction to the payment description so that it shows up on bank statements of consumers. The dynamic descriptor data is sent both in authorization and clearing messages" example: false preAuthorizationPanClipping: type: boolean description: "Indicates whether the PAN must be clipped or not on merchant\u2019s ticket for pre-authorization" example: true offlineBackupModeAllowed: type: boolean description: The backup mode allows the merchant to let the terminal approve offline transactions, which normally require going online, when it is temporarily unable to go online. It is an indicator telling if the backup mode can be activated or not by the terminal example: true industrySpecificMitAllowed: type: boolean description: Indicates whether the merchant is allowed to initiate industry specific MIT transactions example: true allowedServices: allOf: - $ref: '#/components/schemas/AF779F_AllowedServices' manualEntryProcessingOptions: allOf: - $ref: '#/components/schemas/AF779F_ManualEntryProcessingOptions' cardEntryModes: allOf: - $ref: '#/components/schemas/AF779F_CardEntryModes' allowedServicesContactLess: allOf: - $ref: '#/components/schemas/AF779F_AllowedServices' rejectedProductTypes: allOf: - $ref: '#/components/schemas/AF779F_RejectedProductTypes' additionalProperties: false AF779F_CardEntryModes: type: object properties: manualEntry: type: boolean description: Indicates whether manual entry (keying) is allowed example: false magstripe: type: boolean description: Indicates whether the use of magnetic stripe is allowed example: true iccEmv: type: boolean description: Indicates whether the use of EMV chip is allowed example: true contactlessMagstripe: type: boolean description: Indicates whether the use of magnetic stripe for contactless transactions is allowed example: true contactlessIccEmv: type: boolean description: Indicates whether the use of EMV chip for contactless transactions is allowed example: true additionalProperties: false AF779F_ContractAddressData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/AF779F_ContractContractIdentification' addresses: type: array items: $ref: '#/components/schemas/A1DCC6_AddressDetails' additionalProperties: false AF779F_ContractBalanceData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/AF779F_ContractContractIdentification' balances: type: array items: $ref: '#/components/schemas/48BE2C_Balance' additionalProperties: false AF779F_ContractBasic: type: object properties: acquirerName: type: string description: Name of the acquirer example: Worldline Sandbox Bank merchantName: type: string description: Name of the merchant example: Event Payment Solutions 1 contractName: type: string description: Optional name for this specific contract example: Music Festivals highRiskMerchant: type: boolean description: Indicates whether the acquirer considers the merchant high risk example: false merchantPortalAccess: type: boolean description: Indicates whether the merchant has access to the Worldline Financial Services merchant portal example: true statementFrequency: type: integer description: "Frequency of statement generation. Values [1 = Weekly, 2 = Monthly]" format: int32 example: 1 merchantCategoryCode: type: string description: The MCC is used to classify a business by the types of goods or services it provides, according to ISO 18245 for retail financial services example: "8931" additionalProperties: false AF779F_ContractBrandData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/AF779F_ContractContractIdentification' brands: type: array items: $ref: '#/components/schemas/AF779F_BrandData' additionalProperties: false AF779F_ContractContractIdentification: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" merchantId: type: string description: Unique identification of the merchant, determined by the acquirer example: "1001" contractId: type: string description: Unique identification of the contract, determined by the acquirer example: "10011" additionalProperties: false AF779F_ContractData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/AF779F_ContractContractIdentification' basic: allOf: - $ref: '#/components/schemas/AF779F_ContractBasic' serviceProvider: allOf: - $ref: '#/components/schemas/AF779F_ContractServiceProvider' currencyData: allOf: - $ref: '#/components/schemas/AF779F_CurrencyData' refundLimits: allOf: - $ref: '#/components/schemas/AF779F_RefundLimits' financial: allOf: - $ref: '#/components/schemas/AF779F_Financial' externalIds: allOf: - $ref: '#/components/schemas/1D0D36_ExternalIds' status: allOf: - $ref: '#/components/schemas/AF779F_Status' addressDetailsURI: type: string description: URI to get the contract address details example: acquiring/contract/v2.1/acquirers/315000001/contracts/10011/addresses balanceDataURI: type: string description: URI to get the contract balance data example: acquiring/contract/v2.1/acquirers/315000001/contracts/10011/balances brandDataURI: type: string description: URI to get the contract brand data example: acquiring/contract/v2.1/acquirers/315000001/contracts/10011/brands additionalProperties: false AF779F_ContractIdentification4: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" holdingId: type: integer description: Unique identification of the holding, determined by Worldline Financial Services format: int32 example: 200 merchantId: type: string description: Unique identification of the merchant, determined by the acquirer example: "1001" additionalProperties: false AF779F_ContractListData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/AF779F_ContractIdentification4' contractId: type: string description: Unique identification of the contract, determined by the acquirer example: "10011" contractName: type: string description: Optional name for this specific contract example: Music Festivals commencementDate: type: string description: Date at which contract, site or terminal was registered (yyyy-mm-dd) example: "2013-05-23" paymentBlockDate: type: string description: Date at which the payment for the contract or site has been blocked (yyyy-mm-dd) transactionBlockDate: type: string description: Date at which the transactions for the contract or site has been blocked (yyyy-mm-dd) status: type: string description: "The status of this entity. Values [Active, Blocked (Trx & Pmts), Blocked (Trx), Blocked (Pmts), Terminated]" example: Active address: allOf: - $ref: '#/components/schemas/A1DCC6_Address' contractDetailsURI: type: string description: URI to get the contract details example: acquiring/contract/v2.1/acquirers/315000001/contracts/10011 additionalProperties: false AF779F_ContractResponse: type: object properties: correlationId: type: string description: Unique ID that was generated for the specific change format: uuid contractIdentification: allOf: - $ref: '#/components/schemas/08BFAF_MerchantIdentificationResponse' status: allOf: - $ref: '#/components/schemas/AF779F_ContractStatusResponse' additionalProperties: false AF779F_ContractServiceProvider: type: object properties: independentSalesOrganizationId: type: string description: Unique identification of the Independent Sales Organization (ISO) example: "576352" paymentServiceProviderId: type: string description: Unique identification of the Payment Service Provider (eCommerce only) example: "173" additionalProperties: false AF779F_ContractStatusResponse: type: object properties: status: type: string description: "The status of this entity. Values [Active, Blocked (Trx & Pmts), Blocked (Trx), Blocked (Pmts), Terminated]" example: Active statusReasonId: type: integer description: "Reason for blocking or terminating the contract, the site or the terminal. Values [1 = Bankrupt, 2 = Clean Up, 3 = Closed, 4 = Finance request, 5 = Suspected fraud, 6 = Legal request, 7 = To other acquirer, 8 = Incorrect bank Account, 9 = Negative balance, 10 = PCI non-compliance]" format: int32 commencementDate: type: string description: Date at which contract was registered (yyyy-mm-dd) example: "2013-05-23" transactionBlockDate: type: string description: Date at which the transactions for the contract were blocked (yyyy-mm-dd) paymentBlockDate: type: string description: Date at which the payments for the contract were blocked (yyyy-mm-dd) missing: allOf: - $ref: '#/components/schemas/AF779F_ContractSubentitiesMissingResponse' additionalProperties: false AF779F_ContractSubentitiesMissingResponse: type: object properties: brands: type: string description: For the contract to become complete at least 1 brand needs to be added example: "true" balances: type: string description: For the contract to become complete all relevant balances need to be added example: "1" addresses: type: string description: For the contract to become complete all relevant addresses need to be added example: postal business additionalProperties: false AF779F_CurrencyCombination: type: object properties: transactionCurrency: type: string description: Transaction currency according to ISO 4217 (alphanumeric-3) example: EUR paymentCurrency: type: string description: Currency in which transactions of the linked transaction currency are paid to the merchant example: EUR additionalProperties: false AF779F_CurrencyData: type: object properties: transaction2PaymentCurrency: type: array items: $ref: '#/components/schemas/AF779F_Transaction2PaymentCurrency' localPaymentCurrency: type: string description: Local payment currency according to ISO 4217 (alphanumeric-3) example: EUR dcc: allOf: - $ref: '#/components/schemas/AF779F_Dcc' additionalProperties: false AF779F_Dcc: type: object properties: dccProvider: type: string description: Unique identification of the DCC Provider example: Fexco dccPaymentCurrency: type: string description: Currency in which DCC transactions are paid to the merchant. Always part of a DCC currency combination, a combination of a DCC transaction currency and a DCC payment currency. A merchant can have only one those combinations example: EUR dccSupportIndicator: type: boolean description: Indicates whether the merchant can accept dynamic currency conversion (DCC) transactions example: true dccTransactionCurrency: type: string description: DCC base currency of the merchant. Always part of a DCC currency combination, a combination of a DCC transaction currency and a DCC payment currency. A merchant can have only one those combinations example: EUR additionalProperties: false AF779F_EditContractAddressesResponse: type: object properties: addresses: type: array items: $ref: '#/components/schemas/A1DCC6_AddressType' correlationId: type: string description: Unique ID that was generated for the specific change format: uuid contractIdentification: allOf: - $ref: '#/components/schemas/08BFAF_MerchantIdentificationResponse' status: allOf: - $ref: '#/components/schemas/AF779F_ContractStatusResponse' additionalProperties: false AF779F_EditContractBalancesResponse: type: object properties: balances: type: array items: $ref: '#/components/schemas/48BE2C_BalanceNumber' correlationId: type: string description: Unique ID that was generated for the specific change format: uuid contractIdentification: allOf: - $ref: '#/components/schemas/08BFAF_MerchantIdentificationResponse' status: allOf: - $ref: '#/components/schemas/AF779F_ContractStatusResponse' additionalProperties: false AF779F_Financial: type: object properties: transactionFeePricePlans: type: array items: $ref: '#/components/schemas/AF779F_TransactionFeePricePlan' paymentTemplateName: type: string description: "Unique name of the payment template. It dictates how many balances are used at the contract and which financial activities are posted on which balance. Values [Gross0, Gross1, Gross2, Gross3, Net1, Net2, Net3, Net4]" example: Net1 serviceBasedFeePricePlanName: type: string description: Unique name of the service based fee price plan example: Service Fees PayFac 1 additionalProperties: false AF779F_ManualEntryProcessingOptions: type: object properties: refuseTransaction: type: boolean description: Indicates whether the transaction should be refused example: false performOnlineTransaction: type: boolean description: Indicates whether the transaction should be performed online example: true pinRequired: type: boolean description: Indicates whether PIN entry is required example: false signatureRequired: type: boolean description: Indicates whether signature is required example: true cvc2OrCvv2Required: type: boolean description: "Indicates whether CVC2 (MasterCard) or CVV2 (Visa) is required" example: true luhnDigitCheckRequired: type: boolean description: Indicates whether Luhn check digit check is required example: true additionalProperties: false AF779F_PostContractBrandsResponse: type: object properties: brands: type: array items: $ref: '#/components/schemas/D3BE35_BrandLabel' correlationId: type: string description: Unique ID that was generated for the specific change format: uuid contractIdentification: allOf: - $ref: '#/components/schemas/08BFAF_MerchantIdentificationResponse' status: allOf: - $ref: '#/components/schemas/AF779F_ContractStatusResponse' additionalProperties: false AF779F_PostContractCurrenciesResponse: type: object properties: currencyCombinations: type: array items: $ref: '#/components/schemas/AF779F_CurrencyCombination' correlationId: type: string description: Unique ID that was generated for the specific change format: uuid contractIdentification: allOf: - $ref: '#/components/schemas/08BFAF_MerchantIdentificationResponse' status: allOf: - $ref: '#/components/schemas/AF779F_ContractStatusResponse' additionalProperties: false AF779F_PostContractResponse: type: object properties: correlationId: type: string description: Unique ID that was generated for the specific change format: uuid contractIdentification: allOf: - $ref: '#/components/schemas/08BFAF_MerchantIdentificationResponse' status: allOf: - $ref: '#/components/schemas/AF779F_PostContractStatus' additionalProperties: false AF779F_PostContractStatus: type: object properties: status: type: string description: "The status of this entity. Values [Active, Blocked (Trx & Pmts), Blocked (Trx), Blocked (Pmts), Terminated]" example: Incomplete missing: allOf: - $ref: '#/components/schemas/AF779F_ContractSubentitiesMissingResponse' additionalProperties: false AF779F_RefundLimits: type: object properties: maximumRefundAmount: type: string description: "Maximum refund amount in Euro. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "56.00" maximumDailyRefundAmount: type: string description: "Maximum daily total refund amount per site in Euro. Amount in the major units of the currency according to ISO 4217.\n\n\nIn case of euro, \"3.10\" (is 3.10 euro)\n\n" example: "200000.00" maximumDailyNumberOfRefunds: type: integer description: Maximum daily total number of refunds per site format: int32 example: 3000 additionalProperties: false AF779F_RejectedProductTypes: type: object properties: eeaDebit: type: boolean description: Indicates whether transactions with the card product EEA Debit should be rejected by the terminal example: false eeaCredit: type: boolean description: Indicates whether transactions with the card product EEA Credit should be rejected by the terminal example: false eeaCommercial: type: boolean description: Indicates whether transactions with the card product EEA Commercial should be rejected by the terminal example: false eeaPrepaid: type: boolean description: Indicates whether transactions with the card product EEA Pre-paid should be rejected by the terminal example: false additionalProperties: false AF779F_Status: type: object properties: status: type: string description: "The status of this entity. Values [Active, Blocked (Trx & Pmts), Blocked (Trx), Blocked (Pmts), Terminated]" example: Active statusReasonId: type: integer description: "Reason for blocking or terminating the contract, the site or the terminal. Values [1 = Bankrupt, 2 = Clean Up, 3 = Closed, 4 = Finance request, 5 = Suspected fraud, 6 = Legal request, 7 = To other acquirer, 8 = Incorrect bank Account, 9 = Negative balance, 10 = PCI non-compliance]" format: int32 commencementDate: type: string description: Date at which contract, site or terminal was registered (yyyy-mm-dd) example: "2013-05-23" terminationDate: type: string description: Date at which the contract, site or terminal was terminated (yyyy-mm-dd) transactionBlockDate: type: string description: Date at which the transactions for the contract or site were blocked (yyyy-mm-dd) paymentBlockDate: type: string description: Date at which the payments for the contract or site were blocked (yyyy-mm-dd) additionalProperties: false AF779F_Transaction2PaymentCurrency: type: object properties: transactionCurrency: type: string description: Transaction currency according to ISO 4217 (alphanumeric-3) example: EUR paymentCurrency: type: string description: (Local) payment currency according to ISO 4217 (alphanumeric-3) example: EUR additionalProperties: false AF779F_TransactionFeePricePlan: type: object properties: currency: type: string description: (Local) payment currency according to ISO 4217 (alphanumeric-3) example: EUR name: type: string description: Unique name of the Transaction Fee Price Plan example: IC+ PayFac type: type: integer description: "Type of the transaction fee price plan. Values [1 = Standard pricing, 2 = Interchange plus, 3 = Interchange tiered pricing, 4 = Interchange plus plus, 5 = Default scheme fees for interchange plus plus, 6 = Stepped pricing]" format: int32 example: 2 additionalProperties: false B92357_ExtPostTfppBasic: type: object properties: transactionFeePricePlanName: type: string description: Name of the transaction fee price plan example: Standard Pricing Supermarket transactionFeePricePlanDescription: type: string description: Description of the transaction fee price plan example: Standard pricing for supermarkets transactionFeePricePlanTemplateId: type: integer description: Unique identification of the transaction fee price plan template that the price plan is based on format: int32 example: 1 currency: type: string description: Currency of the transaction fee price plan according to ISO 4217 (alphanumeric-3). All tariffs in the price plan are in this currency. example: EUR useDefaultSchemeFeesIcpp: type: boolean description: "Indicates whether the Interchange Plus Plus transaction fee price plan contains the (by the acquirer defined) default scheme fees or not. If not, then the scheme fees need to be registered in the price plan." example: false additionalProperties: false B92357_ExtPostTfppCounter: type: object properties: counterId: type: string description: "Unique identification of the counter within the transaction fee price plan. Only price plans of the type \u201CStepped Pricing\u201D can have multiple counters. All other types have just 1, which has the value \"C000000\"" example: C000000 tariffGroups: type: array items: $ref: '#/components/schemas/B92357_ExtPostTfppTariffGroup' additionalProperties: false B92357_ExtPostTfppTariff: type: object properties: tariffId: type: string description: A combination of transaction conditions that are also used to determine the interchange fee. example: T000144 baseAmount: type: string description: Base amount of a fee (in the currency of the price plan). This is a fixed amount. example: "0.0506" minimumAmount: type: string description: Minimum amount of a fee (in the currency of the price plan). The fee is always equal to or higher than this amount. example: "0.1300" maximumAmount: type: string description: Maximum amount of a fee (in the currency of the price plan). The fee is always equal to or lower than this amount. example: "0.2800" percentage: type: string description: Percentage of the transaction amount example: "0.08" additionalProperties: false B92357_ExtPostTfppTariffGroup: type: object properties: tariffGroupNumber: type: integer description: Unique identification of the tariff group within the counter. How many groups can be used is determined by the price plan type (based on the selected template) format: int32 example: 1 tariffs: type: array items: $ref: '#/components/schemas/B92357_ExtPostTfppTariff' additionalProperties: false B92357_PostTransactionFeePricePlan: type: object properties: basic: allOf: - $ref: '#/components/schemas/B92357_ExtPostTfppBasic' counters: type: array items: $ref: '#/components/schemas/B92357_ExtPostTfppCounter' additionalProperties: false BDB114_ContractIdentification6: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" holdingId: type: integer description: Unique identification of the holding, determined by Worldline Financial Services format: int32 example: 200 merchantId: type: string description: Unique identification of the merchant, determined by the acquirer example: "1001" contractId: type: string description: Unique identification of the contract, determined by the acquirer example: "10011" additionalProperties: false BDB114_PostTerminalResponse: type: object properties: correlationId: type: string description: Unique ID that was generated for the specific change format: uuid contractIdentification: allOf: - $ref: '#/components/schemas/BDB114_TerminalContractIdentification' additionalProperties: false BDB114_TerminalAddressData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/BDB114_TerminalContractIdentification' addresses: type: array items: $ref: '#/components/schemas/A1DCC6_AddressDetails' additionalProperties: false BDB114_TerminalBalanceData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/BDB114_TerminalContractIdentification' balances: type: array items: $ref: '#/components/schemas/48BE2C_Balance' additionalProperties: false BDB114_TerminalBasic: type: object properties: acquirerName: type: string description: Name of the acquirer example: Worldline Sandbox Bank siteName: type: string description: Name of the site example: EPS*Metal Festival nameOnStatement: type: string description: Name that is visible on the cardholder statement. If not filled, then the site name is used (first 22 characters) example: EPS*Metal Festival merchantCategoryCode: type: string description: The MCC is used to classify a business by the types of goods or services it provides, according to ISO 18245 for retail financial services example: "7999" transactionReference: type: boolean description: Indicates whether the merchant is allowed to add a reference to a C-TAP POS transaction example: true additionalProperties: false BDB114_TerminalBrandData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/BDB114_TerminalContractIdentification' brands: type: array items: $ref: '#/components/schemas/AF779F_BrandData' additionalProperties: false BDB114_TerminalCheckNumberResponse: type: object properties: terminalId: type: string description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) example: W01AB01 checkNumber: type: string description: Check number of the terminal. Only relevant in case the terminal ID is generated up front during the reservation process by processor equensWordline example: "1234567" additionalProperties: false BDB114_TerminalContractIdentification: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" contractId: type: string description: Unique identification of the contract, determined by the acquirer example: "10011" siteId: type: integer description: Unique identification of the site within the contract format: int64 example: 100111 cardAcceptorId: type: string description: Unique identification of the site in accordance with payment scheme rules example: "1001" terminalId: type: string description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) example: W01AB01 additionalProperties: false BDB114_TerminalData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/BDB114_TerminalContractIdentification' basic: allOf: - $ref: '#/components/schemas/BDB114_TerminalBasic' serviceProviders: allOf: - $ref: '#/components/schemas/6D115A_ServiceProviders' status: allOf: - $ref: '#/components/schemas/BDB114_TerminalStatus' addressDetailsURI: type: string description: URI to get the terminal address details example: acquiring/contract/v2.1/acquirers/315000001/contracts/10011/sites/100111/terminals/W01AB01/addresses balanceDataURI: type: string description: URI to get the terminal balance data example: acquiring/contract/v2.1/acquirers/315000001/contracts/10011/sites/100111/terminals/W01AB01/balances brandDataURI: type: string description: URI to get the terminal brand data example: acquiring/contract/v2.1/acquirers/315000001/contracts/10011/sites/100111/terminals/W01AB01/brands additionalProperties: false BDB114_TerminalListData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/BDB114_ContractIdentification6' cardAcceptorId: type: string description: Unique identification of the site in accordance with payment scheme rules example: "90100125" siteId: type: integer description: Unique identification of the site within the contract format: int64 example: 100111 terminalId: type: string description: Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID) example: W01AB01 nameOnStatement: type: string description: Name that is visible on the cardholder statement. If not filled, then the site name is used (first 22 characters) example: EPS*Metal Festival commencementDate: type: string description: Date at which contract, site or terminal was registered (yyyy-mm-dd) example: "2013-05-23" status: type: string description: "The status of this entity. Values [Active, Terminated]" example: Active terminalDetailsURI: type: string description: URI to get the terminal details example: acquiring/contract/v2.1/acquirers/315000001/contracts/10011/sites/100111/terminals/W01AB01 additionalProperties: false BDB114_TerminalStatus: type: object properties: status: type: string description: "The status of this entity. Values [Active, Terminated]" example: Active statusReasonId: type: integer description: "Reason for blocking or terminating the contract, the site or the terminal. Values [1 = Bankrupt, 2 = Clean Up, 3 = Closed, 4 = Finance request, 5 = Suspected fraud, 6 = Legal request, 7 = To other acquirer, 8 = Incorrect bank Account, 9 = Negative balance, 10 = PCI non-compliance]" format: int32 commencementDate: type: string description: Date at which contract, site or terminal was registered (yyyy-mm-dd) example: "2013-05-23" terminationDate: type: string description: Date at which the contract, site or terminal was terminated (yyyy-mm-dd) transactionBlockDate: type: string description: Date at which the transactions for the contract or site were blocked (yyyy-mm-dd) additionalProperties: false BF8F33_ALContractIdentification: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" listName: type: string description: "Possible values: \n\n - bankAccountType,\n\n - brand,\n\n - channel,\n\n - country,\n\n - communicationLanguage,\n\n - communicationPreference,\n\n - dccProvider,\n\n - independentSalesOrganization,\n\n - merchantCategoryCode,\n\n - networkServiceProvider,\n\n - paymentAggregation,\n\n - paymentCurrency,\n\n - paymentDayMonthly,\n\n - paymentDayWeekly,\n\n - paymentDelay,\n\n - paymentFrequency,\n\n - paymentLevel,\n\n - paymentServiceProvider,\n\n - paymentTemplate,\n\n - statusReason,\n\n - terminalDomain,\n\n - transactionCurrency" example: paymentFrequency additionalProperties: false BF8F33_AcquirerListData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/BF8F33_ALContractIdentification' values: type: array items: $ref: '#/components/schemas/BF8F33_AcquirerSupportedData' additionalProperties: false BF8F33_AcquirerSupportedData: type: object properties: id: type: string description: "Unique identification of the value in the list. Depending on which list is requested, the ID can be for example a countryCode, a paymentFrequency, a merchantCategoryCode, etc." example: "2" description: type: string description: "Description of the value in the list. Depending on which list is requested, the description can be for example the name of a country, the description of a paymentFrequency, the description of a merchantCategoryCode, etc." example: Weekly default: type: boolean description: "Indicates whether this is to be used as the default value (in web GUIs etc). This field is only present in case the value is true" example: true additionalProperties: false BF8F33_ClusterData: type: object properties: clusterId: type: integer description: Unique identification of the cluster, determined by Worldline Financial Services format: int32 example: 432 type: type: string description: Type of the cluster example: Merchant account type name: type: string description: Name of the cluster example: Key account additionalProperties: false BF8F33_ClusterListData: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/BF8F33_ContractIdentification' clusters: type: array items: $ref: '#/components/schemas/BF8F33_ClusterData' additionalProperties: false BF8F33_ContractIdentification: type: object properties: acquirerId: type: string description: Unique identification of the acquirer, determined by Worldline Financial Services example: "315000001" additionalProperties: false D3BE35_BrandLabel: type: object properties: label: type: string description: "Unique identification of the brand (payment product). Maestro = MAES, American Express = AMEX, Visa = VISA, etc." example: MAST additionalProperties: false D3BE35_ContractCurrencyBalance: type: object properties: balanceNumber: type: integer description: "Number of the balance. Values [1, 2, 3]" format: int32 example: 1 bankAccounts: type: array items: $ref: '#/components/schemas/D3BE35_ContractCurrencyBankAccount' additionalProperties: false D3BE35_ContractCurrencyBankAccount: type: object properties: currency: type: string description: Payment currency according to ISO 4217 (alphanumeric-3) example: EUR bankAccountType: type: integer description: "Describes whether a bank account number is of the type IBAN or not (Other). In the latter case it can be for example an American or South-African bank account number. Values [1 = IBAN, 99 = Other]" format: int32 example: 1 bic: type: string description: Bank Institution Code for merchant payment. A BIC needs to be registered for each payment currency of the merchant example: BITSNL2A iban: type: string description: International Bank Account Number for merchant payments. An IBAN needs to be registered for each payment currency of the merchant example: NL76BITS1234567890 additionalProperties: false D3BE35_ContractCurrencyTransaction2Payment: type: object properties: transactionCurrency: type: string description: Transaction currency accepted by the merchant example: EUR paymentCurrency: type: string description: Currency in which transactions of the linked transaction currency are paid to the merchant example: EUR additionalProperties: false D3BE35_PostBankAccount: type: object properties: currency: type: string description: (Local) Payment Currency according to ISO 4217 (alphanumeric-3) example: EUR bankAccountType: type: integer description: "Describes whether a bank account number is of the type IBAN or not (Other). In the latter case it can be for example an American or South-African bank account number. Values [1 = IBAN, 99 = Other]" format: int32 example: 1 bic: type: string description: Bank Institution Code for merchant payment. A BIC needs to be registered for each payment currency of the merchant example: BITSNL2A iban: type: string description: International Bank Account Number for merchant payments. An IBAN needs to be registered for each payment currency of the merchant example: NL76BITS1234567890 threshold: type: integer description: Amount of the threshold. The acquirer can choose to hold an amount in reserve before paying the merchant. This is usually done for risk mitigation. The threshold is registered at balance 1. An amount can be registered for each payment currency of the merchant format: int32 example: 0 additionalProperties: false D3BE35_PostContract: required: - basic type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/D3BE35_PostContractContractIdentification' basic: allOf: - $ref: '#/components/schemas/D3BE35_PostContractBasic' serviceProvider: allOf: - $ref: '#/components/schemas/D3BE35_PostServiceProvider' currencyData: allOf: - $ref: '#/components/schemas/D3BE35_PostCurrencyData' refundLimits: allOf: - $ref: '#/components/schemas/D3BE35_PostRefundLimits' financial: allOf: - $ref: '#/components/schemas/D3BE35_PostFinancial' externalIds: allOf: - $ref: '#/components/schemas/1D0D36_ExternalIds' additionalProperties: false D3BE35_PostContractAddresses: type: object properties: addresses: type: array items: $ref: '#/components/schemas/A1DCC6_AddressDetails' additionalProperties: false D3BE35_PostContractBalance: type: object properties: balanceNumber: type: integer description: "Number of the balance. Values [1, 2, 3]" format: int32 example: 1 merchantReconciliationReference: type: string description: Reference the merchant wants to be part of the description lines of the payment on his bank statement example: "10011" paymentLevel: type: integer description: "Level of the merchant hierarchy at which the merchant is paid. Values [4 = Contract, 5 = Site, 6 = Terminal]" format: int32 example: 4 paymentAggregation: type: integer description: "Indicates whether the merchant is paid per brand, per scheme or totalized. Values [1 = Totalized payment, 2 = Payment per brand, 3 = Payment per scheme]" format: int32 example: 1 paymentFrequency: type: integer description: "Frequency in which the balance is settled with the merchant. Values [1 = Accounting period, 2 = Weekly, 3 = Monthly, 4 = Daily, 5 = Twice a month, 6 = Per external batch, 7 = Across batches, 8 = Merchant manual cut-off, 9 = Merchant automatic cut-off]" format: int32 example: 4 terminalPeriodCutoffTime: type: string description: The fixed time (hours and minutes, without date and seconds) of the daily moment - defined by the merchant - when the cut-off of the financial counter information, used by the merchant to align it with the used reconciliation period when the merchant has chosen for automatically cut off the booking period of the transactions example: "00:00" terminalPeriodClosureLevel: type: integer description: "The level on which the financial counter information for the transactions cut-off period are consulted, used by the merchant to align it with the used reconciliation period when the merchant has chosen to manual cut-off the booking period of the transactions. Values [0 = Terminal, 1 = Site]" format: int32 example: 0 paymentDay: type: integer description: "Specific day of the week or month the merchant is paid. Values in case of weekly [1 to 7], values in case of monthly [1 to 31]" format: int32 example: 1 paymentDelay: type: integer description: "Payment delay in days. Values [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 30, 60, 90]" format: int32 example: 0 bankAccounts: type: array items: $ref: '#/components/schemas/D3BE35_PostBankAccount' additionalProperties: false D3BE35_PostContractBalances: type: object properties: balances: type: array items: $ref: '#/components/schemas/D3BE35_PostContractBalance' additionalProperties: false D3BE35_PostContractBasic: type: object properties: contractName: type: string description: Optional name for this specific contract example: Music Festivals highRiskMerchant: type: boolean description: Indicates whether the acquirer considers the merchant high risk example: false merchantPortalAccess: type: boolean description: Indicates whether the merchant has access to the Worldline Financial Services merchant portal example: true statementFrequency: type: integer description: "Frequency of statement generation. Values [1 = Weekly, 2 = Monthly]" format: int32 example: 1 merchantCategoryCode: type: string description: The MCC is used to classify a business by the types of goods or services it provides, according to ISO 18245 for retail financial services example: "8931" additionalProperties: false D3BE35_PostContractBrands: type: object properties: brands: type: array items: $ref: '#/components/schemas/D3BE35_BrandLabel' additionalProperties: false D3BE35_PostContractContractIdentification: type: object properties: merchantId: type: string description: Unique identification of the merchant, determined by the acquirer example: "1001" contractId: type: string description: Unique identification of the contract, determined by the acquirer example: "10011" additionalProperties: false D3BE35_PostContractCurrency: type: object properties: currencyData: allOf: - $ref: '#/components/schemas/D3BE35_PostContractCurrencyData' balances: type: array items: $ref: '#/components/schemas/D3BE35_ContractCurrencyBalance' additionalProperties: false D3BE35_PostContractCurrencyData: type: object properties: transaction2PaymentCurrency: type: array items: $ref: '#/components/schemas/D3BE35_ContractCurrencyTransaction2Payment' additionalProperties: false D3BE35_PostCurrencyData: type: object properties: dcc: allOf: - $ref: '#/components/schemas/D3BE35_PostDcc' additionalProperties: false D3BE35_PostDcc: type: object properties: dccProvider: type: string description: Unique identification of the DCC Provider example: Fexco dccSupportIndicator: type: boolean description: Indicates whether the merchant can accept dynamic currency conversion (DCC) transactions example: true additionalProperties: false D3BE35_PostFinancial: type: object properties: paymentTemplateName: type: string description: "Unique name of the payment template. It dictates how many balances are used at the contract and which financial activities are posted on which balance. Values [Gross0, Gross1, Gross2, Gross3, Net1, Net2, Net3, Net4]" example: Net1 additionalProperties: false D3BE35_PostRefundLimits: type: object properties: maximumRefundAmount: type: string description: Maximum refund amount in Euro. Amount in the major units of the currency according to ISO 4217. example: "500.00" maximumDailyRefundAmount: type: string description: Maximum daily total refund amount per site in Euro. Amount in the major units of the currency according to ISO 4217. example: "100000.00" maximumDailyNumberOfRefunds: type: integer description: Maximum daily total number of refunds per site format: int32 example: 5000 additionalProperties: false D3BE35_PostServiceProvider: type: object properties: independentSalesOrganizationId: type: string description: Unique identification of the Independent Sales Organization (ISO) example: "576352" additionalProperties: false D716BC_Operation: type: object properties: value: description: The value to be used by the operation. Required for replace operations. Not applicable for remove nullable: true path: type: string description: "A JSON Pointer that identifies the location within the target document where the operation is applied (e.g. \"/basic/name\")" nullable: true op: type: string description: "The operation to be performed. Values [replace, remove]" nullable: true from: type: string description: Not used nullable: true additionalProperties: false FAEA4B_PostTerminal: type: object properties: contractIdentification: allOf: - $ref: '#/components/schemas/FAEA4B_PostTerminalContractIdentification' basic: allOf: - $ref: '#/components/schemas/FAEA4B_PostTerminalBasic' serviceProviders: allOf: - $ref: '#/components/schemas/6D115A_ServiceProviders' additionalProperties: false FAEA4B_PostTerminalBasic: type: object properties: nameOnStatement: type: string description: Name that is visible on the cardholder statement. If not filled, then the site name is used (first 22 characters) example: EPS*Metal Festival merchantCategoryCode: type: string description: The MCC is used to classify a business by the types of goods or services it provides, according to ISO 18245 for retail financial services example: "7999" transactionReference: type: boolean description: Indicates whether the merchant is allowed to add a reference to a C-TAP POS transaction example: true additionalProperties: false FAEA4B_PostTerminalContractIdentification: type: object properties: terminalId: type: string description: "Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID)\n\n" example: W01AB01 additionalProperties: false