Card Programs are configurable templates for the cards that are issued to borrowers. A Program serves both as a template for cards issued to borrowers and as a container for a collection of cards. Secure Payments provides the same functionality.
You can retrieve card program information, create a card program, update a card program, and upload a card program's background image.
An issuer contains card programs just as a card program contains cards. This hierarchy allows Card Programs to act as templates for Cards. When creating a Card, the values set in the Card Program will act as the Card's defaults unless overwritten. You will find the key-value pairs for Card Programs below.
Key-value pairs
| Value: | Definition: |
|---|---|
issuer_product_id | An ID from the issuer that represents the card product offering. |
swipe_enrichment | Determines whether the default card has swipe enrichment. > Enabling swipe enrichment will allow for the capturing of additional swipe information. |
processing_type | The default card processing type. |
display_card_attributes | Determines whether to display the cards' expiration dates, PAN, name, and brand. |
card_color | The default color for cards. |
shipping_method | The default shipping method for physical cards. > This field is used when the card_type field is set to either physical or hybrid. |
card_issuer_id | The card issuer ID. |
updated | The Card Program's last updated date time. |
card_currency | The default currency for cards. |
available_balance | The default available credit for cards. |
available_advance_balance | The default amount that a borrower can use for cash advance requests for cards. |
name | The Card Program's name. |
spend_limit | The default amount a borrower can spend during a determined period of time for cards. > The spend_limit is separate from the available_balance and controls the velocity of spending with a card. |
authorization_expiration_days | The default number of days after which an "Authorization Expired" type of event should be extended if the authorized amount is still greater than the sum of the cleared amount and the voided amount. |
created | The Card Program's creation date time. |
spend_limit_interval | The default spend limit interval. |
card_metadata | The metadata that can be stored for cards. > This fields needs to include the ID of the LMS Tenant that is associated with your Secure Payments account. |
card_title | The default name for cards. |
issuer_account_id | The Secure Payments ID of the card issuer. |
status | Determines whether the Program is active or inactive. |
id | The Card Program's ID. |
bin | The "bank identification number" which defaults the first four to six digits for cards. |
card_status | The default activation status for cards. |
card_text_color | The default text color for cards. |
network | The default network for cards. |
card_background | The default background image for cards. |
card_type | The default card type of the Card Program. |
swipe_expiration_exceptionsobject | The default swipe expiration exceptions. > For more information see the swipe_expiration_exceptions table below. |
swipe_restrictionsobject | The default swipe restrictions. > For more information see the swipe_restrictions table below. |
Swipe expiration exceptions
This object is nested within the program entity and it holds information regarding how swipe expiration exceptions are made.
| Value: | Definition: |
|---|---|
id | The swipe expiration exceptions' ID. |
attribute | The exception's type of transaction attribute. |
attribute_values | The value(s) of the attribute(s) selected within the attribute field. > Multiple values can be added with a comma delimiter. |
authorization_expiration_days | The number of days that will be added to the authorization_expiration_days value for swipes that meet the attribute criteria. |
created | The swipe expiration exceptions' created date time. |
updated | The swipe expiration exceptions' updated date time. |
Swipe restrictions
This object is nested within the program entity and it holds information regarding how swipe restrictions are made.
| Value: | Definition: |
|---|---|
id | The swipe restrictions' ID. |
attribute | The exception's type of transaction attribute. |
attribute_whitelist | Determines whether the values provided are allowed or disallowed. |
attribute_values | The value(s) of the attribute(s) selected within the attribute field. > Multiple values can be added with a comma delimiter. |
authorize_when_empty | Determines whether swipes will be authorized or denied when the attribute values are empty. |
created | The swipe restriction's created date time. |
updated | The swipe restriction's updated date time. |