Juice Financial
  • Introduction
  • ErrorCodes
  • Authentication
  • APIS
    • Administration
      • Add ACH Transaction
      • Add Processor Real Time Txn
      • Allocate Inventory
      • CardNo to RPCBB Conversion
      • Change Password
      • Check DB Up Request(Monitoring)
      • End Card Session
      • Force Change Password
      • Get Billers List
      • Get Card Effective Fee
      • Get Card Session Details
      • Get Mobile Upgrade
      • Get Product Types
      • Login
      • Manage AML Exception
      • Manage Card Session
      • Manage Code Group
      • Manage Daily Limit
      • Manage FBE
      • Manage Fee
      • Manage File
      • Manage Load Account
      • Manage Order
      • Manage Org To Orgs Relation
      • Manage Praxell Code
      • Manage Sub Organization
      • Manage Terminal
      • Manage User
      • Manage White List
      • Ping
      • Reprocess ACH Transaction
      • Reset Password
      • Resolve Card Session
      • Set Single Day Override
      • Start Card Session
      • Update ACH Transaction Status
      • Validate Inventory Location
      • Validate Product Type
      • View Debit Organizations Hierarchy
    • Card Issuance
      • Activate-Card
      • Instant-Issue-Card
      • New-Card
    • Card Status & Management
      • Change-Card-Pin
      • Close-Card
      • Free Card
      • Get Card Balance
      • Get Card Details
      • Get Card Holder Spend Limits
      • Get Card Holds
      • Get Card Report
      • Get Cards Report
      • Get Card Text Info
      • Inform Lost Stolen Card
      • Load Network Verify Card
      • Lock Card
      • Reopen Card
      • Request OTP
      • Research Card
      • Reset Card PIN
      • Return To Inventory
      • Search Cardholder
      • Suspend Card
      • Swap Cards DDAs
      • Unlock Card
      • Unsuspend Card
      • Update Card Holder Spend Limits
      • Update Card Replacement Status
      • Update Cardholder DOB
      • Update Cardholder
      • Update Fee Less Card
      • Verify Card PIN
      • Verify Cardholder
      • Verify OTP
    • Cardholder Management
      • Change Cardholder Password
      • Enroll Cardholder
      • Get Cardholder Details
      • Reset Cardholder Password
    • Transactions
      • Card to Card Transfer
      • Charge Fee
      • Load Network Reload Card
      • Load Network Unload Card
      • Load Network Verify Card
      • Load Network Void Card
      • Pay CH Bill
      • Reverse Fee
      • Webhook Examples
Powered by GitBook
On this page
  • Reverse Fee
  • Input Parameters:
  • Output Parameters:
  • XML Samples
  • Input XML
  1. APIS
  2. Transactions

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 BillNextWebhook Examples

Last updated 7 months ago