For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Cardholder Data

Get Cardholder Data

magicInput Parameters:

Name
Required
Definition
Comments

ID

Y

Format: Numeric, 1–19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber

IDType

Y

Format options: CardNumber RPID

Output Parameters:

Name
Definition
Failure Case
Success Case
Comments

FirstName

Format: Alphanumeric, 10

Not returned

Returned

MiddleInitial

Format: Alpha,1 Middle name char of the cardholder

Not returned

Returned

LastName

Format: Alphanumeric, 15

Not returned

Returned

AddressLine1

Format: Alphanumeric, 30

Not returned

Returned

AddressLine2

Format: Alphanumeric, 30

Not returned

Returned

City

Format: Alphanumeric, 20

Not returned

Returned

State

Format: Alphanumeric, 2

Not returned

Returned

Zip

Format: Numeric, 5

Not returned

Returned

Country

ISO Country code (2 chars)

Not returned

Returned

Phone

Format: Numeric, 6-15

Not returned

Returned

Fax

Format: Numeric, 6-10

Not returned

Returned

Email

Format: 5-40 chars (email pattern)

Not returned

Returned

IsReceiveSms

Enabled / Disabled / Blank / Mail

Not returned

Returned

MobilePhone

Format: Numeric, 6-15

Not returned

Returned

IntPhoneNumber

International format (+ optional)

Not returned

Returned

EarlyAccess

Format: Y/N

Not returned

Returned

DateOfBirth

Format: yyyy-mm-dd

Not returned

Returned

VerificationRequest

UpdateAndVerify / UpdateOnly / NoUpdateOnVerificationError

Not returned

Returned

VerificationType

Multiple verification modes

Not returned

Returned

DocExpirationDate

Format: YYYY-MM-DD

Not returned

Returned

DocIssueDate

Format: YYYY-MM-DD

Not returned

Returned

DocIssuer

Format: Alphanumeric, 2

Not returned

Returned

DocId

Format: Alphanumeric, 3-16

Not returned

Returned

DocType

SSN / PASS / UDL / MCN / INMATE / EIN

Not returned

Returned

UseShippingDetails

Format: Y/N

Not returned

Returned

ShippingAddressLine1

Format: Alphanumeric, 30

Not returned

Returned

ShippingAddressLine2

Format: Alphanumeric, 30

Not returned

Returned

ShippingCity

Format: Alpha, 1-20

Not returned

Returned

ShippingState

Format: Alphanumeric, 2

Not returned

Returned

ShippingZip

—

Not returned

Returned

SubscribeToEmail

Y/N (default N)

Not returned

Returned

UserDefined1

Size: 255

Not returned

Returned

UserDefined2

Size: 255

Not returned

Returned

UserDefined3

Size: 255

Not returned

Returned

UserDefined4

Size: 255

Not returned

Returned

UserDefined5

Size: 255

Not returned

Returned

UserDefined6

Size: 255

Not returned

Returned

UserDefined7

Size: 255

Not returned

Returned

UserDefined8

Size: 255

Not returned

Returned

UserDefined9

Size: 255

Not returned

Returned

UserDefined10

Size: 255

Not returned

Returned

UserDefined11

Size: 255

Not returned

Returned

UserDefined12

Size: 255

Not returned

Returned

UserDefined13

Size: 255

Not returned

Returned

UserDefined14

Size: 255

Not returned

Returned

UserDefined15

Size: 255

Not returned

Returned

AuthorizedUser

—

Not returned

Returned

CardholderBankRouting

Format: Numeric, 9

Not returned

Returned

CardholderBankName

Format: Alphanumeric, 100

Not returned

Returned

CardholderAccountNumber

Format: Alphanumeric, 0-34

Not returned

Returned

CardholderAccountName

Format: Alphanumeric, 100

Not returned

Returned

ExternalPaymentProviderName1

—

Not returned

Returned

ExternalPaymentProviderID1

—

Not returned

Returned

ExternalPaymentProviderCreationDate1

—

Not returned

Returned

ExternalPaymentProviderLastUpdateDate1

—

Not returned

Returned

ExternalPaymentProviderAdditionalInfo1

—

Not returned

Returned

ExternalPaymentProviderName2

—

Not returned

Returned

ExternalPaymentProviderID2

—

Not returned

Returned

ExternalPaymentProviderCreationDate2

—

Not returned

Returned

ExternalPaymentProviderLastUpdateDate2

—

Not returned

Returned

ExternalPaymentProviderAdditionalInfo2

—

Not returned

Returned

ExternalPaymentProviderName3

—

Not returned

Returned

ExternalPaymentProviderID3

—

Not returned

Returned

ExternalPaymentProviderCreationDate3

—

Not returned

Returned

ExternalPaymentProviderLastUpdateDate3

—

Not returned

Returned

ExternalPaymentProviderAdditionalInfo3

—

Not returned

Returned

ExternalPaymentProviderName4

—

Not returned

Returned

ExternalPaymentProviderID4

—

Not returned

Returned

ExternalPaymentProviderCreationDate4

—

Not returned

Returned

ExternalPaymentProviderLastUpdateDate4

—

Not returned

Returned

ExternalPaymentProviderAdditionalInfo4

—

Not returned

Returned

ExternalPaymentProviderName5

—

Not returned

Returned

ExternalPaymentProviderID5

—

Not returned

Returned

ExternalPaymentProviderCreationDate5

—

Not returned

Returned

ExternalPaymentProviderLastUpdateDate5

—

Not returned

Returned

ExternalPaymentProviderAdditionalInfo5

—

Not returned

Returned

IntAddressLine1

Format: Alphanumeric, 1-30

Not returned

Returned

IntAddressLine2

Format: Alphanumeric, 1-30

Not returned

Returned

IntCity

Format: Alpha, 1-20

Not returned

Returned

IntStateProvinceRegion

Format: Alphanumeric, 1-30

Not returned

Returned

IntCountry

ISO Country code (2 chars)

Not returned

Returned

IntZipPostalCode

Format: Alphanumeric, 1-20

Not returned

Returned

IntDocId

Format: Alphanumeric, 1-50

Not returned

Returned

IntDocType

Format: Alphanumeric, 1-50

Not returned

Returned

IntAddress

Format: Y/N

Not returned

Returned

Language

English / Spanish

Not returned

Returned

MiddleName

Format: Alpha, 0-20

Not returned

Returned

SurName

Format: Alpha, 0-20

Not returned

Returned

AdditionalIDExpirationDate

Format: YYYY-MM-DD

Not returned

Returned

XML Samples

Input XML

Last updated