Processing a Service Fee

The fields mentioned in this section are described in "Request Fields," page 22. Additional fields for the debit service are described in Electronic Check Services Using the Simple Order API.

Service fees in electronic check transactions are processed in the following services:

■	Service fee calculation

■

Debit

■

Credit

Calculating the Service Fee

1	You include the following required fields in your request for the service fee calculate service:

■	check_accountNumber

■	merchantID

■	merchantReferenceCode

■	purchaseTotals_currency

■	purchaseTotals_grandTotalAmount or at least one item_#_unitPrice field.

■	serviceFeeCalculateService_run: Set this field to true.

2	One of the fields that CyberSource includes in the reply message is serviceFeeCalculateReply_amount.

Debiting the Principal and Service Fee

1	You include the purchaseTotals_serviceFeeAmount field in your debit request.

Set this field to the value of the serviceFeeCalculateReply_amount field that you received in the service fee calculate reply message.

For information about creating a debit request, see Electronic Check Services Using the Simple Order API.

2	CyberSource sends a debit request for the principal amount to the processor.

The principal amount is either the value of purchaseTotals_grandTotalAmount or the sum of the amounts for all of the items in the transaction.

3	If the debit for the principal amount fails, CyberSource returns the pertinent error information to you in the reply message, and none of the remaining events in this description occur.

4	If the debit for the principal amount succeeds, CyberSource sends a debit request for the service fee to the processor.

5	If the debit for the service fee fails, CyberSource returns the pertinent error information to you in the reply message, and none of the remaining events in this description occur.

6	If the debit for the service fee succeeds, you have successfully debited the principal amount and the service fee.

Crediting the Principal and Service Fee

1	You can credit the principal amount, the service fee amount, or both amounts (optional).

■	To credit only the principal amount, include one of the following values in your credit request:

●	purchaseTotals_grandTotalAmount

●	Sum of the amounts for all items in the transaction

■	To credit only the service fee amount, include the following fields and values in your credit request:

●	purchaseTotals_serviceFeeAmount

●	purchaseTotals_grandTotalAmount = 0 (zero)

●	ecCreditService_debitRequestID = request ID that was returned in the debit reply for the principal amount

■	To credit both amounts, include the following values in your credit request:

●	Either the value of purchaseTotals_grandTotalAmount or the sum of the amounts for all the items in the transaction

●	purchaseTotals_serviceFeeAmount

For information about creating a credit request, see Electronic Check Services Using the Simple Order API.

2	If the service fee credit amount qualifies to be sent to the processor, CyberSource sends the following requests to the processor:

■	Credit request for the principal amount

■	Credit request for the service fee amount

3	If one or both credits fail, CyberSource returns the pertinent error information to you in the reply message, and none of the remaining events in this description occur.

If one credit fails and the other credit succeeds, CyberSource does not void the successful credit.

4	If both credits succeed, you have successfully authorized and credited the principal amount and the service fee.

Voiding a Debit or Credit

You can void debits and credits.

For information about voiding debits and credits, see Electronic Check Services Using the Simple Order API.