Card Balance Information

This API returns balance information of customer authorized card.

API Information

URL

 /creditCardBalance

Method

 POST

Version

 1.0

Scope

 creditcard

Authorization Flow

 Authorization Code


Input Information

Name Format Description Required/Optional

CardID

 Integer Unique card ID number for all cards of customer Required


Output Information

CreditCardBalance

Name Format Description

TotalLimit

 Decimal Total limit

RemainingLimit

 Decimal Remaining limit

CashLimit

 Decimal Cash advance limit

RemainingCashLimit

 Decimal Remaining cash advance limit

DebtDomestic

 Decimal Debt domestic (Main Card Only)

DebtAbroad

 Decimal Debt abroad (Main Card Only)

RemainingDebtDomestic

 Decimal Remaining debt domestic (Main Card Only)

RemainingDebtAbroad

 Decimal Remaining debt abroad (Main Card Only)

MinimumPaymentAmountDomestic

 Decimal Minimum payment amount domestic (Main Card Only)

MinimumPaymentAmountAbroad

 Decimal Minimum payment amount abroad (Main Card Only)

CurrentDebtDomestic

 Decimal Current debt domestic (Main Card Only)

CurrentDebtAbroad

 Decimal Current debt abroad (Main Card Only)

CurrentTermSpendingDomestic

 Decimal Current term spending domestic

CurrentTermSpendingAbroad

 Decimal Current term spending abroad


Message Codes

Message Code Description

ACBH000114

Card number does not belong to customer in session.

ACBH000227

Card id format is incorrect.

Example

Request:

{
    "CardID": 4693
}

Response:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Completed",
        "ObjectID": "4da5b01f-2e87-48f2-8508-09ffaeb962c9"
    },
    "Data": {
        "CreditCardBalance": {
            "TotalLimit": 1.0E7,
            "RemainingCashLimit": 1.000213804E7,
            "DebtDomestic": 40.95,
            "MinimumPaymentAmountDomestic": 1,
            "CurrentDebtDomestic": 40.95,
            "CashLimit": 1.0E7,
            "RemainingDebtDomestic": 40.95,
            "RemainingLimit": 1.000213804E7
        }
    }
}