POST CreditCardTransaction

Request Information

URI Parameters

None.

Body Parameters

CreditCardTransactionsBindingModel
NameDescriptionTypeAdditional information
LedgerBalance

decimal number

Required
PaymentAmount

decimal number

Required
ProcessingFee

decimal number

Required
FirstNameOnCard

string

Required
LastNameOnCard

string

Required
CreditCardNumber

string

None.
ExpirationMonth

string

String length: inclusive between 2 and 2
ExpirationYear

string

String length: inclusive between 4 and 4
CCV

string

None.
AddressLine1

string

Required
AddressLine2

string

None.
City

string

Required
StateId

byte

Required
ZipCode

string

Required
PhoneNumber

string

None.
EmailAddress

string

None.
IsMonthlyRecurring

boolean

Required
TransactionSourceId

integer

None.
SaveCard

boolean

None.
ProrateBalance

decimal number

None.
PaymentToken

string

None.
PaymentTokenDescriptor

string

None.
CustomerProfileId

string

None.
PaymentProfileId

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "LedgerBalance": 1.0,
  "PaymentAmount": 2.0,
  "ProcessingFee": 3.0,
  "FirstNameOnCard": "sample string 4",
  "LastNameOnCard": "sample string 5",
  "CreditCardNumber": "sample string 6",
  "ExpirationMonth": "sample string 7",
  "ExpirationYear": "sample string 8",
  "CCV": "sample string 9",
  "AddressLine1": "sample string 10",
  "AddressLine2": "sample string 11",
  "City": "sample string 12",
  "StateId": 64,
  "ZipCode": "sample string 14",
  "PhoneNumber": "sample string 15",
  "EmailAddress": "sample string 16",
  "IsMonthlyRecurring": true,
  "TransactionSourceId": 18,
  "SaveCard": true,
  "ProrateBalance": 20.0,
  "PaymentToken": "sample string 21",
  "PaymentTokenDescriptor": "sample string 22",
  "CustomerProfileId": "sample string 23",
  "PaymentProfileId": "sample string 24"
}

application/xml, text/xml

Sample: 
<CreditCardTransactionsBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.YottaResident.WebAPIs.Models">
  <AddressLine1>sample string 10</AddressLine1>
  <AddressLine2>sample string 11</AddressLine2>
  <CCV>sample string 9</CCV>
  <City>sample string 12</City>
  <CreditCardNumber>sample string 6</CreditCardNumber>
  <CustomerProfileId>sample string 23</CustomerProfileId>
  <EmailAddress>sample string 16</EmailAddress>
  <ExpirationMonth>sample string 7</ExpirationMonth>
  <ExpirationYear>sample string 8</ExpirationYear>
  <FirstNameOnCard>sample string 4</FirstNameOnCard>
  <IsMonthlyRecurring>true</IsMonthlyRecurring>
  <LastNameOnCard>sample string 5</LastNameOnCard>
  <LedgerBalance>1</LedgerBalance>
  <PaymentAmount>2</PaymentAmount>
  <PaymentProfileId>sample string 24</PaymentProfileId>
  <PaymentToken>sample string 21</PaymentToken>
  <PaymentTokenDescriptor>sample string 22</PaymentTokenDescriptor>
  <PhoneNumber>sample string 15</PhoneNumber>
  <ProcessingFee>3</ProcessingFee>
  <ProrateBalance>20</ProrateBalance>
  <SaveCard>true</SaveCard>
  <StateId>64</StateId>
  <TransactionSourceId>18</TransactionSourceId>
  <ZipCode>sample string 14</ZipCode>
</CreditCardTransactionsBindingModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.