Resource Details

CRM/Accounts/CardNumber

Create a credit card account, storing the card number. Will create and store a token if tokenization is enabled.

Http Verb	POST
Resource URL	https://ts-stg-appgw.calacademy.org/TessituraService/CRM/Accounts/CardNumber

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : CreateCardNumberAccountRequest

Request object type CreateCardNumberAccountRequest has the following properties.

Property Name	Data Type	Required	Notes
AccountNumber	string	Y
CardExpiryMonth	integer	Y
CardExpiryYear	integer	Y
ConstituentId	integer	Y
ConstituentId	FK: T_CUSTOMER.customer_no Resource: Constituents
ExclusiveToControlledBatchId	integer	N	If controlled batch ID number is provided, the account will be deleted when the controlled batch is closed.
ExclusiveToControlledBatchId	FK: T_BATCH.batch_no Resource: Batch
Inactive	boolean	Y
Name	string	Y	Name on card
PaymentMethodGroupId	integer	N	Required when payment card tokenization enabled
PaymentMethodGroupId	FK: TR_PMT_METHOD_GROUP.id Resource: PaymentMethodGroups
ReturnAccountIfAccountExists	boolean	N	Don't create account if the account being created already exists. Instead, return the data for the existing account.
TransactionOrigin	string	Y	Text indicating the origin of the transaction. The text will be written to T_PAYMENT_GATEWAY_ACTIVITY.origin if payment card tokenization is enabled.
VantivEncryptedCard	VantivEncryptedCard	N	Accepted only for controlled batches

application/json, text/json
application/xml, text/xml

{
  "AccountNumber": "sample string 1",
  "CardExpiryMonth": 1,
  "CardExpiryYear": 1,
  "ConstituentId": 1,
  "Inactive": true,
  "Name": "sample string 2",
  "PaymentMethodGroupId": 1,
  "TransactionOrigin": "sample string 3",
  "ExclusiveToControlledBatchId": 1,
  "VantivEncryptedCard": {
    "Version": "sample string 1",
    "vantivDevice": {
      "DvcType": "sample string 1",
      "DvcSN": "sample string 2",
      "Entry": "sample string 3"
    },
    "vantivCard": {
      "ECData": "sample string 1",
      "ETrk1": "sample string 2",
      "ETrk2": "sample string 3",
      "CDataKSN": "sample string 4",
      "DbtKSN": "sample string 5",
      "DbtPINB": "sample string 6",
      "Exp": "sample string 7",
      "MskPAN": "sample string 8",
      "CHolder": "sample string 9",
      "EFormat": "sample string 10"
    },
    "vantivAddr": {
      "AvsAddr": "sample string 1",
      "AvsZip": "sample string 2"
    },
    "vantivTran": {
      "TranType": "sample string 1"
    }
  },
  "ReturnAccountIfAccountExists": true
}

<CreateCardNumberAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AccountNumber>sample string 1</AccountNumber>
  <CardExpiryMonth>1</CardExpiryMonth>
  <CardExpiryYear>1</CardExpiryYear>
  <ConstituentId>1</ConstituentId>
  <ExclusiveToControlledBatchId>1</ExclusiveToControlledBatchId>
  <Inactive>true</Inactive>
  <Name>sample string 2</Name>
  <PaymentMethodGroupId>1</PaymentMethodGroupId>
  <ReturnAccountIfAccountExists>true</ReturnAccountIfAccountExists>
  <TransactionOrigin>sample string 3</TransactionOrigin>
  <VantivEncryptedCard>
    <Version>sample string 1</Version>
    <vantivAddr>
      <AvsAddr>sample string 1</AvsAddr>
      <AvsZip>sample string 2</AvsZip>
    </vantivAddr>
    <vantivCard>
      <CDataKSN>sample string 4</CDataKSN>
      <CHolder>sample string 9</CHolder>
      <DbtKSN>sample string 5</DbtKSN>
      <DbtPINB>sample string 6</DbtPINB>
      <ECData>sample string 1</ECData>
      <EFormat>sample string 10</EFormat>
      <ETrk1>sample string 2</ETrk1>
      <ETrk2>sample string 3</ETrk2>
      <Exp>sample string 7</Exp>
      <MskPAN>sample string 8</MskPAN>
    </vantivCard>
    <vantivDevice>
      <DvcSN>sample string 2</DvcSN>
      <DvcType>sample string 1</DvcType>
      <Entry>sample string 3</Entry>
    </vantivDevice>
    <vantivTran>
      <TranType>sample string 1</TranType>
    </vantivTran>
  </VantivEncryptedCard>
</CreateCardNumberAccountRequest>

Response object type : AccountResponse

Response object type AccountResponse has the following properties.

Property Name	Data Type	Required	Notes
AccountNumber	string		Masked account number.
AccountType	AccountTypeSummary	N	Card type (MC, Visa, etc) or Direct Debit type.
AccountType	FK: TR_ACCOUNT_TYPE.id
BankIdentifierCode	string		Used for SEPA direct debit accounts.
CardExpiryMonth	integer
CardExpiryYear	integer
ConstituentId	integer	N
ConstituentId	FK: T_CUSTOMER.customer_no Resource: Constituents
CreatedBy	string
CreatedDateTime	date
CreateLocation	string
DirectDebitAccountType	DirectDebitAccountTypeSummary	N	Used for direct debit accounts. Required if creating or updating a direct debit account.
DirectDebitAccountType	FK: TR_DIRECT_DEBIT_ACCOUNT_TYPE.id
Id	integer
Inactive	boolean
MandateNumber	string		Used for SEPA direct debit accounts.
MandateType	integer		Used for SEPA direct debit accounts.
MerchantId	string		If payment card tokenization is turned on, this is the merchant that was used to generate the token with the processor.
Name	string		Name on card, or name on the direct debit account.
NumberFirstSix	string		First six digits of account, unencrypted. Not all six digits may be available.
NumberLastFour	string		Last 4 digits of account, unencrypted.
PaymentMethodGroup	PaymentMethodGroupSummary	N	If payment card tokenization is turned on, this is the payment method group that was used to locate the merchant to create the token.
PaymentMethodGroup	FK: TR_PMT_METHOD_GROUP.id Resource: PaymentMethodUserGroups
ShopperReference	string
SignatureDate	date		Used for SEPA direct debit accounts.
Token	string		If payment card tokenization is turned on, this is the token that will be submitted to the processor in lieu of actual card details.
UpdatedBy	string
UpdatedDateTime	date

application/json, text/json
application/xml, text/xml

{
  "AccountNumber": "sample string 1",
  "AccountType": {
    "Id": 1,
    "Description": "sample string 1",
    "CardPrefix": "sample string 2",
    "CardtypeIndicator": "sample string 3",
    "EditMask": "sample string 4",
    "Inactive": true
  },
  "BankIdentifierCode": "sample string 2",
  "CardExpiryMonth": 1,
  "CardExpiryYear": 1,
  "ConstituentId": 3,
  "CreatedBy": "sample string 4",
  "CreatedDateTime": "2025-04-24T09:28:33.887284-07:00",
  "CreateLocation": "sample string 5",
  "DirectDebitAccountType": {
    "Id": 1,
    "Description": "sample string 1",
    "Inactive": true
  },
  "Id": 6,
  "Inactive": true,
  "MandateNumber": "sample string 8",
  "MandateType": 1,
  "MerchantId": "sample string 9",
  "Name": "sample string 10",
  "NumberFirstSix": "sample string 11",
  "NumberLastFour": "sample string 12",
  "PaymentMethodGroup": {
    "Id": 1,
    "Description": "sample string 1",
    "Inactive": true,
    "MerchantId": "sample string 3"
  },
  "SignatureDate": "2025-04-24T09:28:33.887284-07:00",
  "Token": "sample string 14",
  "UpdatedBy": "sample string 15",
  "UpdatedDateTime": "2025-04-24T09:28:33.887284-07:00",
  "ShopperReference": "sample string 16"
}

<AccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AccountNumber>sample string 1</AccountNumber>
  <AccountType>
    <CardPrefix>sample string 2</CardPrefix>
    <CardtypeIndicator>sample string 3</CardtypeIndicator>
    <Description>sample string 1</Description>
    <EditMask>sample string 4</EditMask>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </AccountType>
  <BankIdentifierCode>sample string 2</BankIdentifierCode>
  <CardExpiryMonth>1</CardExpiryMonth>
  <CardExpiryYear>1</CardExpiryYear>
  <ConstituentId>3</ConstituentId>
  <CreateLocation>sample string 5</CreateLocation>
  <CreatedBy>sample string 4</CreatedBy>
  <CreatedDateTime>2025-04-24T09:28:33.887284-07:00</CreatedDateTime>
  <DirectDebitAccountType>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </DirectDebitAccountType>
  <Id>6</Id>
  <Inactive>true</Inactive>
  <MandateNumber>sample string 8</MandateNumber>
  <MandateType>1</MandateType>
  <MerchantId>sample string 9</MerchantId>
  <Name>sample string 10</Name>
  <NumberFirstSix>sample string 11</NumberFirstSix>
  <NumberLastFour>sample string 12</NumberLastFour>
  <PaymentMethodGroup>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <MerchantId>sample string 3</MerchantId>
  </PaymentMethodGroup>
  <ShopperReference>sample string 16</ShopperReference>
  <SignatureDate>2025-04-24T09:28:33.887284-07:00</SignatureDate>
  <Token>sample string 14</Token>
  <UpdatedBy>sample string 15</UpdatedBy>
  <UpdatedDateTime>2025-04-24T09:28:33.887284-07:00</UpdatedDateTime>
</AccountResponse>

Change	Version	Description	Contract	Old	New
Property Added	15.2.26	ShopperReference has been added to AccountResponse	AccountResponse		AccountResponse.ShopperReference