Skip to content

Latest commit

 

History

History
264 lines (169 loc) · 9.37 KB

readme.md

File metadata and controls

264 lines (169 loc) · 9.37 KB

OP-GenericDto

Contents

Card type

Namespace

OpenPath.Dto.Generic.Payment

Summary

A generic data object containing the standard data associated to the different types of payment cards.

Bin property

Summary

A bank identification number (BIN) is the initial four to six numbers that appear on a card. The bank identification number uniquely identifies the institution issuing the card. The BIN is key in the process of matching transactions to the issuer of the card. This numbering system applies to charge cards, gift cards, debit cards, prepaid cards, and electronic benefit cards.

ExpirationMonth property

Summary

A card expiration month tells you when the card is no longer valid along with the expiration year. After a card expires, it shouldn't be usable, because the issuers should deactivate the card when it reaches the expiration date.

ExpirationYear4Digit property

Summary

A card expiration year tells you when the card is no longer valid along with the month year. After a card expires, it shouldn't be usable, because the issuers should deactivate the card when it reaches the expiration date.

MagneticTrack1 property

Summary

The first of three megnetic tracks on a card that typically contains encoded information about the cardholder's account, such as their card number, full name, the card's expiration date and the country code.

MagneticTrack2 property

Summary

The second of three megnetic tracks on a card that typically contains encoded information about the cardholder's account, such as their card number, full name, the card's expiration date and the country code.

MagneticTrack3 property

Summary

The third of three megnetic tracks on a card that typically contains any additional encoded information from the issuer.

NameOnCard property

Summary

This is the person authorized to use the card. That person didn’t necessarily open the account, they might simply have permission to spend from the account as an "authorized user."

Network property

Summary

A card network are networks of issuing and acquiring banks through which payment cards of some certain brand are processed.

Number property

Summary

A card number is usually 15-16 digits long, but it could be as many as 19 digits or as few as 13 in some cases. Each of these individual credit card numbers has meaning.

CardNetworkEnumerator type

Namespace

OpenPath.Dto.Generic.Enumerator

Summary

A list of known network payment card types.

CardNetworkExtension type

Namespace

OpenPath.Dto.Generic.Extension

Summary

An extension class for converting card networks to enumerators and to human readable text.

ToCardNetworkEnumerator(network) method

Summary

Converts the network name in a string to an enumerator. For example: Amex would be converted to CardNetworkEnumerator.AmericanExpress.

Returns

The card network enumerator.

Parameters
Name Type Description
network System.String The name of the network.

ToHuman(network) method

Summary

Converts a card network enumerator to a human readable title cased string.

Returns

Returns a human readble string.

Parameters
Name Type Description
network OpenPath.Dto.Generic.Enumerator.CardNetworkEnumerator The card network enumerator.

FilterDto type

Namespace

OpenPath.Dto.Generic.Query

Summary

A generic data object to set the standard filters for a data query

EndDate property

Summary

The date this filter should end at.

Page property

Summary

The page of data to return based on the Return value.

Return property

Summary

The amount of results that should be returned per page.

SortBy property

Summary

The order to sort the results by.

SortItem property

Summary

The item (column) we should sort by.

StartDate property

Summary

The date this filter should start at.

OrderEnumerator type

Namespace

OpenPath.Dto.Generic.Enumerator

Summary

Enumberators for sorting orders

Assending constants

Summary

Sort in assending order.

Decending constants

Summary

Sort in decending order.

None constants

Summary

No sorting order.