Reverse Fee

Reverse Fee

The Reverse Fee API allows to rebate fee for a specific card.

Input Parameters:

Name
Required
Definition
Comments

Amount

Y

Format: Numeric, 1-9 Description: The amount is in cents.

relevant only if Reason Category is Good Will / User Error /System Error/ Other

BulkFee

N

Options: Y/N(default)

relevant if ReferenceIDType= CardSessionID or not provided

CardNumber

C

Format: Numeric, 16

Deprecated. Will be removed in the future

ID

C

Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber

IDType

C

Format options: CardNumber RPID SavingAccount

ContextTransactionCode

N

Format: Alphanumeric, 6 Validation: A/P/X-P-0..9-0..9-I/D-S/R/F (Praxell code)

Required only if Reason Category is User Error / System Error / Other. relevant if Reason Category is Good Will

Description

N

Format: 10-500, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) / : ? - % + *

& ; @ ! ~ = _ \ '

ReasonCategory

Y

Format options: GoodWill UserError SystemError Other TransactionFee Automatic (currently not used)

The reason category param is used as well to define the permission and the Praxell code

ReferenceId

N

Format: Alphanumeric, 30 Description: Allows the reverse fee to connect to the specific card session ID

Contains cardsessionID Or transactionID. Required if Reason Category is TransactionFee

ReferenceIDType

N

Options: CardSessionID (default) TransactionID

relevant only if Reason Category= TransactionFee

Output Parameters:

XML Samples

Input XML

<?xml version="1.0" ?>
<PraxellXMLRequest>
 <AuthenticationDetails>
    <UserName></UserName>
    <UserPassword></UserPassword>
 </AuthenticationDetails> 
    <ClientSourceIP></ClientSourceIP>
 <ServiceDetails>
    <ServiceName>ReverseFee</ServiceName>
    <UniqueRequestId>1212121212121213</UniqueRequestId>
 </ServiceDetails>
 <Origin>
   <OriginType>ExtAPI</OriginType>
 </Origin>
 <ServiceParams>
   <ID></ID>
   <IDType></IDType>
   <Description>Test Reverse Fee</Description>
   <Amount>100</Amount>
   <ReasonCategory>Good Will</ReasonCategory>
   <ContextTransactionCode>XP66DS</ContextTransactionCode>
   <ReferenceId>997654329</ReferenceId>     
 </ServiceParams>
</PraxellXMLRequest>
<?xml version="1.0" ?> 
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>reversefee</ServiceName> 
    <SessionId></SessionId> 
    <StatusCode></StatusCode> 
    <StatusName></StatusName> 
    <StatusDescription>NA</StatusDescription> 
    <ServiceDate></ServiceDate> 
    <ServiceId></ServiceId> 
  </ResponseDetails>
  <ResponseParams>
 </ResponseParams>
</PraxellXMLResponse>
<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>ReverseFee</ServiceName>
    <SessionId>07071612200737105</SessionId>
    <StatusCode>70029</StatusCode>
    <StatusName>Data not found (cardholder not found)</StatusName>
    <StatusDescription>Data not found (cardholder not found)</StatusDescription>
    <ServiceDate>2021-10-01 12:37:50</ServiceDate>
    <ServiceId>07071612200737105</ServiceId>
  </ResponseDetails>
  <ResponseParams>
  </ResponseParams>
</PraxellXMLResponse>
PreviousPay CH Bill

Last updated