GET api/customercc/{id}

Returns a specific Customer Credit Card record by CustomerCCID

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

CustomerCC

Name	Description	Type	Additional information
CustomerCCId	The Customer_CC_Id from the AR_Customer_CC table	integer	None.
CustomerId	The Customer_Id foreign key from the AR_Customer_CC table; must reference a record in the AR_Customer	integer	Required
CardType	The type of Credit Card; possible values: AMER, DISC, MAST, VISA; required for POST/PUT	string	Max length: 4 Min length: 4 String length: inclusive between 0 and 4
CardTypeLong		string	None.
CardNumber	Pass in only if not using tokenization (value will come back encrypted on GET)	string	String length: inclusive between 0 and 16
ExpirationMonth	2-digit Expiration Month	string	Max length: 2 Min length: 2 String length: inclusive between 0 and 2
ExpirationYear	2-digit Expiration Year	string	Max length: 2 Min length: 2 String length: inclusive between 0 and 2
ExpirationDate	Read-only, formatted as: MM / YY	string	None.
AccountName	Name on the account	string	String length: inclusive between 0 and 22
PaymentMethodId	foreign key from AR_Payment_Method; do not set explicitly (will be determined from CardType)	integer	None.
CustomerAddress	Street of address associated with the credit card	string	String length: inclusive between 0 and 35
CustomerZip	Zip code of the address associated with the credit card	string	String length: inclusive between 0 and 10
SecurityCode	3-digit security code on the back of the card	string	String length: inclusive between 0 and 8
UsedForAutoProcess	This credit card should be used for Recurring Auto Processing; defaults to false if not supplied	boolean	None.
AutoPay	Display only; Y if UsedForAutoProcess = true	string	String length: inclusive between 0 and 1
AutoProcessDay	Day of month to auto-process payment; required if UsedForAutoProcess is true	integer	None.
LastFour	Last 4 digit of the credit card number	string	String length: inclusive between 0 and 4
ACHDirectToken	the token returned from Forte	string	String length: inclusive between 0 and 50
UsedForNonRecurAuto	This credit card should be used for Non-Recurring Auto Processing; defaults to false if not supplied	boolean	None.
UsedForInitialPmt	Set to true only to designate this credit card in conjunction with an initial ACH payment	boolean	None.
CustomerBillId	Optional - pass in the CustomerBillId this is tied to; defaults to 1 if not supplied	integer	None.
ChangeExistingEFTDay	Optional - set true on PUT to update the Hold Date for any unsubmitted EFT transactions using this Credit Card to a new AutoProcessDay (same month only)	boolean	None.
VoidExistingEFTs	Optional - set true on PUT to void any existing unsubmitted EFT transactions using this Credit Card; if true, do not pass in ReplaceEFTsForCustomerBankID or ReplaceEFTsForCustomerCCID	boolean	None.
VoidExistingEFTsReason		string	String length: inclusive between 0 and 50
ReplaceEFTsForCustomerBankID	Optional - pass in an existing CustomerBankID that this payment method is replacing; the system will void any pending ACH transactions for that CustomerBankID (unsubmitted only), and replace them with this new Credit Card; if set, do not set VoidExistingEFTs to true	integer	None.
ReplaceEFTsForCustomerCCID	Optional - pass in an existing CustomerCCID that this payment method is replacing; the system will void any pending ACH transactions for that CustomerCCID (unsubmitted only), and replace them with this new Credit Card; if set, do not set VoidExistingEFTs to true	integer	None.
ReplaceExistingEFTsReason	specify the Void reason for replacing existing ACH entries; automatically set if blank	string	String length: inclusive between 0 and 50
PrintCycleInvoices	Print Cycle Invoices in AR_Customer table	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerCCId": 1,
  "CustomerId": 2,
  "CardType": "sample string 3",
  "CardTypeLong": "sample string 4",
  "CardNumber": "sample string 5",
  "ExpirationMonth": "sample string 6",
  "ExpirationYear": "sample string 7",
  "ExpirationDate": "sample string 8",
  "AccountName": "sample string 9",
  "PaymentMethodId": 1,
  "CustomerAddress": "sample string 10",
  "CustomerZip": "sample string 11",
  "SecurityCode": "sample string 12",
  "UsedForAutoProcess": true,
  "AutoPay": "sample string 13",
  "AutoProcessDay": 1,
  "LastFour": "sample string 14",
  "ACHDirectToken": "sample string 15",
  "UsedForNonRecurAuto": true,
  "UsedForInitialPmt": true,
  "CustomerBillId": 1,
  "ChangeExistingEFTDay": true,
  "VoidExistingEFTs": true,
  "VoidExistingEFTsReason": "sample string 16",
  "ReplaceEFTsForCustomerBankID": 1,
  "ReplaceEFTsForCustomerCCID": 1,
  "ReplaceExistingEFTsReason": "sample string 17",
  "PrintCycleInvoices": true
}

application/xml, text/xml

Sample:

<CustomerCC xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <ACHDirectToken>sample string 15</ACHDirectToken>
  <AccountName>sample string 9</AccountName>
  <AutoPay>sample string 13</AutoPay>
  <AutoProcessDay>1</AutoProcessDay>
  <CardNumber>sample string 5</CardNumber>
  <CardType>sample string 3</CardType>
  <CardTypeLong>sample string 4</CardTypeLong>
  <ChangeExistingEFTDay>true</ChangeExistingEFTDay>
  <CustomerAddress>sample string 10</CustomerAddress>
  <CustomerBillId>1</CustomerBillId>
  <CustomerCCId>1</CustomerCCId>
  <CustomerId>2</CustomerId>
  <CustomerZip>sample string 11</CustomerZip>
  <ExpirationDate>sample string 8</ExpirationDate>
  <ExpirationMonth>sample string 6</ExpirationMonth>
  <ExpirationYear>sample string 7</ExpirationYear>
  <LastFour>sample string 14</LastFour>
  <PaymentMethodId>1</PaymentMethodId>
  <PrintCycleInvoices>true</PrintCycleInvoices>
  <ReplaceEFTsForCustomerBankID>1</ReplaceEFTsForCustomerBankID>
  <ReplaceEFTsForCustomerCCID>1</ReplaceEFTsForCustomerCCID>
  <ReplaceExistingEFTsReason>sample string 17</ReplaceExistingEFTsReason>
  <SecurityCode>sample string 12</SecurityCode>
  <UsedForAutoProcess>true</UsedForAutoProcess>
  <UsedForInitialPmt>true</UsedForInitialPmt>
  <UsedForNonRecurAuto>true</UsedForNonRecurAuto>
  <VoidExistingEFTs>true</VoidExistingEFTs>
  <VoidExistingEFTsReason>sample string 16</VoidExistingEFTsReason>
</CustomerCC>