PaymentGatewayAccounts Test
PaymentGateway/Accounts/Token
Store an externally generated payment card token in Tessitura. Note that for this call to function, the card_mnemonic column in TR_ACCOUNT_TYPE must be filled in appropriately for your credit card processor. Look for the TR_ACCOUNT_TYPE topic in the Tessitura help documentation for more information on the card mnemonic column.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/PaymentGateway/Accounts/Token

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : AccountTokenRequest

Request object type AccountTokenRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Card CardData Y Include a masked card number, name on card, and expiry date.
ConstituentId integer Y
FK: T_CUSTOMER.customer_no   Resource: Constituents
DateUsed date N If token was previously used in a transaction, set to the date/time used. Otherwise, set to false (Worldpay only).
IsECommerce boolean N Unused
NetworkTransactionId string N NetworkTransactionId from initial purchase transaction or token creation (Worldpay only).
PaymentMethodGroupId integer Y The Payment Method Group should contain a merchant whose payment provider credentials match the credentials used to create the token outside of Tessitura.
FK: TR_PMT_METHOD_GROUP.id   Resource: PaymentMethodUserGroups
ShopperReference string N
Token string Y Externally-generated payment card token 
{
  "ConstituentId": 1,
  "PaymentMethodGroupId": 2,
  "Card": {
    "CardHolderName": "sample string 1",
    "CardNumber": "sample string 2",
    "Cvv2": "sample string 3",
    "ExpirationDate": "sample string 4",
    "Track1": "sample string 5",
    "Track2": "sample string 6",
    "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"
      }
    },
    "AccountId": 1,
    "TessituraMerchantServicesData": "sample string 7"
  },
  "Token": "sample string 3",
  "IsECommerce": true,
  "NetworkTransactionId": "sample string 5",
  "DateUsed": "2025-04-24T09:20:41.3435478-07:00",
  "ShopperReference": "sample string 6"
}
<AccountTokenRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Card>
    <AccountId>1</AccountId>
    <CardHolderName>sample string 1</CardHolderName>
    <CardNumber>sample string 2</CardNumber>
    <Cvv2>sample string 3</Cvv2>
    <ExpirationDate>sample string 4</ExpirationDate>
    <TessituraMerchantServicesData>sample string 7</TessituraMerchantServicesData>
    <Track1>sample string 5</Track1>
    <Track2>sample string 6</Track2>
    <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>
  </Card>
  <ConstituentId>1</ConstituentId>
  <DateUsed>2025-04-24T09:20:41.3435478-07:00</DateUsed>
  <IsECommerce>true</IsECommerce>
  <NetworkTransactionId>sample string 5</NetworkTransactionId>
  <PaymentMethodGroupId>2</PaymentMethodGroupId>
  <ShopperReference>sample string 6</ShopperReference>
  <Token>sample string 3</Token>
</AccountTokenRequest>

Response object type : PaymentAccountResponse

Response object type PaymentAccountResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
AccountId integer N Auto-assigned.
FK: T_ACCOUNT_DATA.id   Resource: Accounts
ResponseCode string A zero ("0") indicates a successful transaction.
ResponseMessage string Sometimes includes more detailed information about the response than the ResponseCode. 
{
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2",
  "AccountId": 3
}
<PaymentAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AccountId>3</AccountId>
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</PaymentAccountResponse>
Change Version Description Contract Old New
Property Added 15.2.26 ShopperReference has been added to AccountTokenRequest AccountTokenRequest AccountTokenRequest.ShopperReference
Property Added 15.1.13 DateUsed has been added to AccountTokenRequest AccountTokenRequest AccountTokenRequest.DateUsed
Property Added 15.1.13 NetworkTransactionId has been added to AccountTokenRequest AccountTokenRequest AccountTokenRequest.NetworkTransactionId
Property Removed 15.1.12 DateUsed has been removed from AccountTokenRequest AccountTokenRequest DateUsed
Property Removed 15.1.12 NetworkTransactionId has been removed from AccountTokenRequest AccountTokenRequest NetworkTransactionId
Property Added 15.1.10 DateUsed has been added to AccountTokenRequest AccountTokenRequest AccountTokenRequest.DateUsed
Property Added 15.1.10 NetworkTransactionId has been added to AccountTokenRequest AccountTokenRequest AccountTokenRequest.NetworkTransactionId