blob: c3f84f58a2b5c6cfba65016e890de002b61f0248 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<services xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/services.xsd">
<description>Accounting Services</description>
<vendor>OFBiz</vendor>
<version>1.0</version>
<!-- ValueLink Implementations -->
<service name="valueLinkProcessor" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="giftCardProcessor" auth="true">
<description>Gift Card Payment Processing</description>
<implements service="giftCardProcessInterface"/>
</service>
<service name="valueLinkRelease" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="giftCardRelease" auth="true">
<description>Gift Card Release (reverse) Payment</description>
<implements service="paymentReleaseInterface"/>
</service>
<service name="valueLinkRefund" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="giftCardRefund" auth="true">
<description>Gift Card Refund Payment</description>
<implements service="paymentRefundInterface"/>
</service>
<!-- ValueLink Fulfillment Services -->
<service name="valueLinkGcPurchase" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="giftCardPurchase" auth="true">
<description>Gift Card Payment Processing</description>
<implements service="itemFulfillmentInterface"/>
</service>
<service name="valueLinkGcReload" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="giftCardReload" auth="true">
<description>Gift Card Payment Processing</description>
<implements service="itemFulfillmentInterface"/>
</service>
<!-- ValueLink Transaction Services -->
<service name="createVLKeys" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="createKeys" auth="true">
<description>Create Public/Private Keys + KEK and Display Them</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="kekOnly" type="Boolean" mode="IN" optional="true"/>
<attribute name="kekTest" type="String" mode="IN" optional="true"/>
<attribute name="output" type="String" mode="OUT" optional="false"/>
</service>
<service name="testKekEncryption" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="testKekEncryption" auth="true">
<description>Test KEK Encryption</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="kekTest" type="String" mode="IN" optional="false"/>
<attribute name="mode" type="Integer" mode="IN" optional="false"/>
<attribute name="output" type="String" mode="OUT" optional="false"/>
</service>
<service name="assignWorkingKey" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="assignWorkingKey" auth="true">
<description>Assign a new working key to ValueLink</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="desHexString" type="String" mode="IN" optional="true"/>
</service>
<service name="activateGiftCard" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="activate" auth="true">
<description>Activate (create new) gift card</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="vlPromoCode" type="String" mode="IN" optional="false"/>
<attribute name="currency" type="String" mode="IN" optional="false"/>
<attribute name="orderId" type="String" mode="IN" optional="true"/>
<attribute name="partyId" type="String" mode="IN" optional="true"/>
<attribute name="amount" type="BigDecimal" mode="INOUT" optional="false"/>
<attribute name="processResult" type="Boolean" mode="OUT" optional="false"/>
<attribute name="responseCode" type="String" mode="OUT" optional="false"/>
<attribute name="authCode" type="String" mode="OUT" optional="true"/>
<attribute name="cardNumber" type="String" mode="OUT" optional="true"/>
<attribute name="pin" type="String" mode="OUT" optional="true"/>
<attribute name="expireDate" type="String" mode="OUT" optional="true"/>
<attribute name="cardClass" type="String" mode="OUT" optional="true"/>
<attribute name="referenceNum" type="String" mode="OUT" optional="false"/>
</service>
<service name="voidActivateGiftCard" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="voidActivate" auth="true">
<description>Void a Activate (create new) gift card</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="currency" type="String" mode="IN" optional="false"/>
<attribute name="orderId" type="String" mode="IN" optional="true"/>
<attribute name="partyId" type="String" mode="IN" optional="true"/>
<attribute name="amount" type="BigDecimal" mode="INOUT" optional="false"/>
<attribute name="processResult" type="Boolean" mode="OUT" optional="false"/>
<attribute name="responseCode" type="String" mode="OUT" optional="false"/>
<attribute name="authCode" type="String" mode="OUT" optional="true"/>
<attribute name="cardNumber" type="String" mode="INOUT" optional="true"/>
<attribute name="pin" type="String" mode="INOUT" optional="true"/>
<attribute name="expireDate" type="String" mode="OUT" optional="true"/>
<attribute name="cardClass" type="String" mode="OUT" optional="true"/>
<attribute name="referenceNum" type="String" mode="OUT" optional="false"/>
</service>
<service name="redeemGiftCard" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="redeem" auth="true">
<description>Redeem (take money off) gift card</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="cardNumber" type="String" mode="IN" optional="false"/>
<attribute name="pin" type="String" mode="IN" optional="false"/>
<attribute name="currency" type="String" mode="IN" optional="false"/>
<attribute name="orderId" type="String" mode="IN" optional="true"/>
<attribute name="partyId" type="String" mode="IN" optional="true"/>
<attribute name="amount" type="BigDecimal" mode="INOUT" optional="false"/>
<attribute name="previousAmount" type="BigDecimal" mode="OUT" optional="true"/>
<attribute name="processResult" type="Boolean" mode="OUT" optional="false"/>
<attribute name="responseCode" type="String" mode="OUT" optional="false"/>
<attribute name="authCode" type="String" mode="OUT" optional="true"/>
<attribute name="cashBack" type="BigDecimal" mode="OUT" optional="true"/>
<attribute name="expireDate" type="String" mode="OUT" optional="true"/>
<attribute name="cardClass" type="String" mode="OUT" optional="true"/>
<attribute name="referenceNum" type="String" mode="OUT" optional="false"/>
</service>
<service name="voidRedeemGiftCard" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="voidRedeem" auth="true">
<description>Void a Redeem (take money off) gift card</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="cardNumber" type="String" mode="IN" optional="false"/>
<attribute name="pin" type="String" mode="IN" optional="false"/>
<attribute name="currency" type="String" mode="IN" optional="false"/>
<attribute name="orderId" type="String" mode="IN" optional="true"/>
<attribute name="partyId" type="String" mode="IN" optional="true"/>
<attribute name="amount" type="BigDecimal" mode="INOUT" optional="false"/>
<attribute name="previousAmount" type="BigDecimal" mode="OUT" optional="true"/>
<attribute name="processResult" type="Boolean" mode="OUT" optional="false"/>
<attribute name="responseCode" type="String" mode="OUT" optional="false"/>
<attribute name="authCode" type="String" mode="OUT" optional="true"/>
<attribute name="cashBack" type="BigDecimal" mode="OUT" optional="true"/>
<attribute name="expireDate" type="String" mode="OUT" optional="true"/>
<attribute name="cardClass" type="String" mode="OUT" optional="true"/>
<attribute name="referenceNum" type="String" mode="OUT" optional="false"/>
</service>
<service name="reloadGiftCard" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="reload" auth="true">
<description>Reload (add money to) gift card</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="cardNumber" type="String" mode="IN" optional="false"/>
<attribute name="pin" type="String" mode="IN" optional="false"/>
<attribute name="currency" type="String" mode="IN" optional="false"/>
<attribute name="orderId" type="String" mode="IN" optional="true"/>
<attribute name="partyId" type="String" mode="IN" optional="true"/>
<attribute name="amount" type="BigDecimal" mode="INOUT" optional="false"/>
<attribute name="previousAmount" type="BigDecimal" mode="OUT" optional="true"/>
<attribute name="processResult" type="Boolean" mode="OUT" optional="false"/>
<attribute name="responseCode" type="String" mode="OUT" optional="false"/>
<attribute name="authCode" type="String" mode="OUT" optional="true"/>
<attribute name="expireDate" type="String" mode="OUT" optional="true"/>
<attribute name="cardClass" type="String" mode="OUT" optional="true"/>
<attribute name="referenceNum" type="String" mode="OUT" optional="false"/>
</service>
<service name="voidReloadGiftCard" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="voidReload" auth="true">
<description>Void a Reload (add money to) gift card</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="cardNumber" type="String" mode="IN" optional="false"/>
<attribute name="pin" type="String" mode="IN" optional="false"/>
<attribute name="currency" type="String" mode="IN" optional="false"/>
<attribute name="orderId" type="String" mode="IN" optional="true"/>
<attribute name="partyId" type="String" mode="IN" optional="true"/>
<attribute name="amount" type="BigDecimal" mode="INOUT" optional="false"/>
<attribute name="previousAmount" type="BigDecimal" mode="OUT" optional="true"/>
<attribute name="processResult" type="Boolean" mode="OUT" optional="false"/>
<attribute name="responseCode" type="String" mode="OUT" optional="false"/>
<attribute name="authCode" type="String" mode="OUT" optional="true"/>
<attribute name="expireDate" type="String" mode="OUT" optional="true"/>
<attribute name="cardClass" type="String" mode="OUT" optional="true"/>
<attribute name="referenceNum" type="String" mode="OUT" optional="false"/>
</service>
<service name="balanceInquireGiftCard" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="balanceInquire" auth="false">
<description>Inquire current card balance</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="cardNumber" type="String" mode="IN" optional="false"/>
<attribute name="pin" type="String" mode="IN" optional="false"/>
<attribute name="currency" type="String" mode="IN" optional="false"/>
<attribute name="orderId" type="String" mode="IN" optional="true"/>
<attribute name="partyId" type="String" mode="IN" optional="true"/>
<attribute name="processResult" type="Boolean" mode="OUT" optional="false"/>
<attribute name="responseCode" type="String" mode="OUT" optional="false"/>
<attribute name="balance" type="BigDecimal" mode="OUT" optional="true"/>
<attribute name="expireDate" type="String" mode="OUT" optional="true"/>
<attribute name="cardClass" type="String" mode="OUT" optional="true"/>
<attribute name="referenceNum" type="String" mode="OUT" optional="false"/>
</service>
<service name="transactionHistoryGiftCard" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="transactionHistory" auth="false">
<description>Obtain card transaction history</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="cardNumber" type="String" mode="IN" optional="false"/>
<attribute name="pin" type="String" mode="IN" optional="false"/>
<attribute name="orderId" type="String" mode="IN" optional="true"/>
<attribute name="partyId" type="String" mode="IN" optional="true"/>
<attribute name="processResult" type="Boolean" mode="OUT" optional="false"/>
<attribute name="responseCode" type="String" mode="OUT" optional="false"/>
<attribute name="balance" type="BigDecimal" mode="OUT" optional="true"/>
<attribute name="history" type="List" mode="OUT" optional="true"/>
<attribute name="expireDate" type="String" mode="OUT" optional="true"/>
<attribute name="cardClass" type="String" mode="OUT" optional="true"/>
<attribute name="referenceNum" type="String" mode="OUT" optional="false"/>
</service>
<service name="refundGiftCard" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="refund" auth="true">
<description>Refund a gift card</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="cardNumber" type="String" mode="IN" optional="false"/>
<attribute name="pin" type="String" mode="IN" optional="false"/>
<attribute name="currency" type="String" mode="IN" optional="false"/>
<attribute name="orderId" type="String" mode="IN" optional="true"/>
<attribute name="partyId" type="String" mode="IN" optional="true"/>
<attribute name="amount" type="BigDecimal" mode="INOUT" optional="false"/>
<attribute name="previousAmount" type="BigDecimal" mode="OUT" optional="true"/>
<attribute name="processResult" type="Boolean" mode="OUT" optional="false"/>
<attribute name="responseCode" type="String" mode="OUT" optional="false"/>
<attribute name="authCode" type="String" mode="OUT" optional="true"/>
<attribute name="expireDate" type="String" mode="OUT" optional="true"/>
<attribute name="cardClass" type="String" mode="OUT" optional="true"/>
<attribute name="referenceNum" type="String" mode="OUT" optional="false"/>
</service>
<service name="voidRefundGiftCard" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="voidRefund" auth="true">
<description>Refund a gift card</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="cardNumber" type="String" mode="IN" optional="false"/>
<attribute name="pin" type="String" mode="IN" optional="false"/>
<attribute name="currency" type="String" mode="IN" optional="false"/>
<attribute name="orderId" type="String" mode="IN" optional="true"/>
<attribute name="partyId" type="String" mode="IN" optional="true"/>
<attribute name="amount" type="BigDecimal" mode="INOUT" optional="false"/>
<attribute name="previousAmount" type="BigDecimal" mode="OUT" optional="true"/>
<attribute name="processResult" type="Boolean" mode="OUT" optional="false"/>
<attribute name="responseCode" type="String" mode="OUT" optional="false"/>
<attribute name="authCode" type="String" mode="OUT" optional="true"/>
<attribute name="expireDate" type="String" mode="OUT" optional="true"/>
<attribute name="cardClass" type="String" mode="OUT" optional="true"/>
<attribute name="referenceNum" type="String" mode="OUT" optional="false"/>
</service>
<service name="linkPhysicalGiftCard" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="linkPhysicalCard" auth="false">
<description>Link a physical card to a virtual account</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="virtualCard" type="String" mode="IN" optional="false"/>
<attribute name="virtualPin" type="String" mode="IN" optional="false"/>
<attribute name="physicalCard" type="String" mode="IN" optional="false"/>
<attribute name="physicalPin" type="String" mode="IN" optional="false"/>
<attribute name="partyId" type="String" mode="IN" optional="true"/>
<attribute name="processResult" type="Boolean" mode="OUT" optional="false"/>
<attribute name="responseCode" type="String" mode="OUT" optional="false"/>
<attribute name="authCode" type="String" mode="OUT" optional="true"/>
<attribute name="amount" type="BigDecimal" mode="OUT" optional="false"/>
<attribute name="expireDate" type="String" mode="OUT" optional="true"/>
<attribute name="cardClass" type="String" mode="OUT" optional="true"/>
<attribute name="referenceNum" type="String" mode="OUT" optional="false"/>
</service>
<service name="disableGiftCardPin" engine="java"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="disablePin" auth="true">
<description>Disable a gift card PIN</description>
<attribute name="paymentConfig" type="String" mode="IN" optional="false"/>
<attribute name="cardNumber" type="String" mode="IN" optional="false"/>
<attribute name="pin" type="String" mode="IN" optional="false"/>
<attribute name="orderId" type="String" mode="IN" optional="true"/>
<attribute name="partyId" type="String" mode="IN" optional="true"/>
<attribute name="processResult" type="Boolean" mode="OUT" optional="false"/>
<attribute name="responseCode" type="String" mode="OUT" optional="false"/>
<attribute name="balance" type="BigDecimal" mode="OUT" optional="true"/>
<attribute name="expireDate" type="String" mode="OUT" optional="true"/>
<attribute name="cardClass" type="String" mode="OUT" optional="true"/>
<attribute name="referenceNum" type="String" mode="OUT" optional="false"/>
</service>
<service name="vlTimeOutReversal" engine="java" validate="false"
location="org.apache.ofbiz.accounting.thirdparty.valuelink.ValueLinkServices" invoke="timeOutReversal" auth="true">
<description></description>
</service>
</services>