Get Card Balance

Get Card Balance

The Get Card Balance API calls Get Card Report API, but its response contains card balances only.

Input Parameters:

Name
Required
Definition
Comments

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

Output Parameters:

Name
Definition
Failure Case
Success Case
Comments

CardAvailableBalance

Format: Numeric, 11

Not returned

Returned

ActiveHoldsTotalAmount

Format: Numeric, 11 Description: Total amount of all active holds existing for Cardholder

Not returned

Returned

XML Samples

Input XML

<?xml version="1.0"?>
<PraxellXMLRequest>
  <AuthenticationDetails>
    <UserName>FB_PRX_ER</UserName>
    <UserPassword></UserPassword>
    <ClientSourceIP></ClientSourceIP> 
 </AuthenticationDetails>;
  <ServiceDetails>
    <UniqueRequestId>2757570</UniqueRequestId>
    <ServiceName>GetCardBalance</ServiceName>
  </ServiceDetails>
  <Origin>
    <OriginType>ExtAPI</OriginType>
  </Origin>
  <ServiceParams>
    <ID></ID>
    <IDType></IDType>
  </ServiceParams>
</PraxellXMLRequest>
<?xml version="1.0"?>
<PraxellXMLResponse>
    <ResponseDetails>
        <ServiceName>GetCardBalance</ServiceName>
        <SessionId>73043110200739091</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2007-09-16 10:39:13</ServiceDate>
        <ServiceId>73043110200739091</ServiceId>
    </ResponseDetails>
    <ResponseParams>
        <CardAvailableBalance>1999</CardAvailableBalance>
        <ActiveHoldsTotalAmount>120865</ActiveHoldsTotalAmount>
    </ResponseParams>
</PraxellXMLResponse>
<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>GetCardBalance</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>

Last updated