Get Card Holder Spend Limits

Get Card Holder Spend Limits

The Get Card Holds API can be used to retrieve Spend Limits on a card.

Input Parameters:

Name
Required
Definition
Comments

ID

Y

Identifier for the service, e.g., card ID, user ID.

IDType

Y

Type of identifier used, e.g., RPID (Retailer ID).

Output Parameters:

Name
Required
Definition
Comments

ServiceName

Y

Name of the service being requested.

SessionId

Y

Format: UUID

Unique identifier for the session.

StatusCode

Y

Numerical code indicating the result of the service request.

Common HTTP status codes may be used.

StatusName

Y

Human-readable status name corresponding to the status code.

Descriptive status name.

StatusDescription

Y

Detailed description of the status, providing additional context.

Explanation of the status result.

ServiceDate

Y

Format: YYYY-MM-DD HH:mm:ss

Date and time of the service request.

ServiceId

Y

Format: UUID

Unique identifier for the service request.

AllowCardNotPresentTransaction

Y

Indicates whether card-not-present transactions are allowed.

Y/N

AllowCashAccess

Y

Indicates whether cash access is allowed.

Y/N

AllowContactlessTransaction

Y

Indicates whether contactless transactions are allowed.

Y/N

AllowInternationalUse

Y

Indicates whether international use is allowed.

Y/N

AllowOnlineTransaction

Y

Indicates whether online transactions are allowed.

Y/N

AllowPINPurchase

Y

Indicates whether PIN purchases are allowed.

Y/N

AllowPOSTransaction

Y

Indicates whether point-of-sale (POS) transactions are allowed.

Y/N

AllowRecurringTransaction

Y

Indicates whether recurring transactions are allowed.

Y/N

BypassCardMonetaryLimit

Y

Indicates whether card monetary limits are bypassed.

Y/N

BypassCardMonetaryPeriod

Duration for bypassing card monetary limits.

Comment: Specify the duration if applicable.

BypassMerchantCategoryPeriod

Duration for bypassing merchant category restrictions.

Comment: Specify the duration if applicable.

BypassMerchantCategoryRestrictions

Y

Indicates whether merchant category restrictions are bypassed.

Y/N

CardDailyAmount

Maximum allowed daily spending amount for the card.

Comment: Specify the limit if applicable.

CardDailyCount

Maximum allowed count of daily transactions for the card.

Comment: Specify the limit if applicable.

CardMonthlyAmount

Maximum allowed monthly spending amount for the card.

Comment: Specify the limit if applicable.

CardMonthlyCount

Maximum allowed count of monthly transactions for the card.

Comment: Specify the limit if applicable.

CardSingleTransaction

Maximum allowed amount for a single transaction for the card.

Comment: Specify the limit if applicable.

CardWeeklyAmount

Maximum allowed weekly spending amount for the card.

Comment: Specify the limit if applicable.

CardWeeklyCount

Maximum allowed count of weekly transactions for the card.

Comment: Specify the limit if applicable.

ContactlessCardDailyAmount

Maximum allowed daily spending amount for contactless transactions.

Comment: Specify the limit if applicable.

ContactlessCardDailyCount

Maximum allowed count of daily contactless transactions.

Comment: Specify the limit if applicable.

ContactlessCardMonthlyAmount

Maximum allowed monthly spending amount for contactless transactions.

Comment: Specify the limit if applicable.

ContactlessCardMonthlyCount

Maximum allowed count of monthly contactless transactions.

Comment: Specify the limit if applicable.

ContactlessCardSingleTransaction

Maximum allowed amount for a single contactless transaction.

Comment: Specify the limit if applicable.

ContactlessCardWeeklyAmount

Maximum allowed weekly spending amount for contactless transactions.

Comment: Specify the limit if applicable.

ContactlessCardWeeklyCount

Maximum allowed count of weekly contactless transactions.

Comment: Specify the limit if applicable.

NotPresentCardDailyAmount

Maximum allowed daily spending amount for card-not-present transactions.

Comment: Specify the limit if applicable.

NotPresentCardDailyCount

Maximum allowed count of daily card-not-present transactions.

Comment: Specify the limit if applicable.

NotPresentCardMonthlyAmount

Maximum allowed monthly spending amount for card-not-present transactions.

Comment: Specify the limit if applicable.

NotPresentCardMonthlyCount

Maximum allowed count of monthly card-not-present transactions.

Comment: Specify the limit if applicable.

NotPresentCardSingleTransaction

Maximum allowed amount for a single card-not-present transaction.

Comment: Specify the limit if applicable.

NotPresentCardWeeklyAmount

Maximum allowed weekly spending amount for card-not-present transactions.

Comment: Specify the limit if applicable.

NotPresentCardWeeklyCount

Maximum allowed count of weekly card-not-present transactions.

Comment: Specify the limit if applicable.

PINPOSCardDailyAmount

Maximum allowed daily spending amount for PIN POS transactions.

Comment: Specify the limit if applicable.

PINPOSCardDailyCount

Maximum allowed count of daily PIN POS transactions.

Comment: Specify the limit if applicable.

PINPOSCardMonthlyAmount

Maximum allowed monthly spending amount for PIN POS transactions.

Comment: Specify the limit if applicable.

PINPOSCardMonthlyCount

Maximum allowed count of monthly PIN POS transactions.

Comment: Specify the limit if applicable.

PINPOSCardSingleTransaction

Maximum allowed amount for a single PIN POS transaction.

Comment: Specify the limit if applicable.

PINPOSCardWeeklyAmount

Maximum allowed weekly spending amount for PIN POS transactions.

Comment: Specify the limit if applicable.

PINPOSCardWeeklyCount

Maximum allowed count of weekly PIN POS transactions.

Comment: Specify the limit if applicable.

SignPOSCardDailyAmount

Maximum allowed daily spending amount for Signature POS transactions.

Comment: Specify the limit if applicable.

SignPOSCardDailyCount

Maximum allowed count of daily Signature POS transactions.

Comment: Specify the limit if applicable.

SignPOSCardMonthlyAmount

Maximum allowed monthly spending amount for Signature POS transactions.

Comment: Specify the limit if applicable.

SignPOSCardMonthlyCount

Maximum allowed count of monthly Signature POS transactions.

Comment: Specify the limit if applicable.

SignPOSCardSingleTransaction

Maximum allowed amount for a single Signature POS transaction.

Comment: Specify the limit if applicable.

SignPOSCardWeeklyAmount

Maximum allowed weekly spending amount for Signature POS transactions.

Comment: Specify the limit if applicable.

SignPOSCardWeeklyCount

Maximum allowed count of weekly Signature POS transactions.

Comment: Specify the limit if applicable.

Limit

Y

Object containing detailed spending limits.

Comment: Define spending limits for various transaction types.

MCCs

Y

List of Merchant Category Codes (MCCs)

Comment: Specify Merchant Category Codes and associated plans.

EnablePlan

Y

Indicates whether the plan is enabled for the specific MCC.

Y/N

MCCDescription

Y

Description of the Merchant Category Code (MCC).

Comment: Provide a brief description.

Plan

Y

Plan code associated with the MCC.

Comment: Specify the plan code.

PlanDescription

Y

Description of the plan associated with the MCC.

Comment: Provide a brief description.

PlanLimitDailyAmount

Maximum allowed daily spending amount for the plan and MCC combination.

Comment: Specify the limit if applicable.

PlanLimitDailyCount

Maximum allowed count of daily transactions for the plan and MCC combination.

Comment: Specify the limit if applicable.

PlanLimitMonthlyAmount

Maximum allowed monthly spending amount for the plan and MCC combination.

Comment: Specify the limit if applicable.

PlanLimitMonthlyCount

Maximum allowed count of monthly transactions for the plan and MCC combination.

Comment: Specify the limit if applicable.

PlanLimitWeeklyAmount

Maximum allowed weekly spending amount for the plan and MCC combination.

Comment: Specify the limit if applicable.

PlanLimitWeeklyCount

Maximum allowed count of weekly transactions for the plan and MCC combination.

Comment: Specify the limit if applicable.

XML Samples

Input XML

Last updated