POST api/Payment/ProcessAutoCreditCard/{testProcess}

Process a recurring credit card

Request Information

URI Parameters

Name	Description	Type	Additional information
testProcess	True if just testing	boolean	Required

Body Parameters

The credit card object

CreditCardDto

Name	Description	Type	Additional information
CardNumber	The credit card number	string	None.
Address	The credit card billing address	string	None.
PostalCode	The credit card billing postal code	string	None.
ExpirationMonth	The expiration month of the card	integer	None.
ExpirationYear	The expiration year of the card	integer	None.
CardType	The card type. One of {Visa, Mastercard, AmericanExpress, Discover, JCB, Invalid}	string	None.
Authorization	Internal use only	string	None.
ConfirmationNumber	Internal use only	string	None.
TransactionReference	Internal use only	string	None.
AccountNumber	The account number related to this payment method	string	None.
Name	The name on the bank account	string	None.
OrderID	The order number	string	None.
PaymentCodeDescription	The description of the payment code	string	None.
User	the user id related processing this payment	string	None.
PaymentTypeDescription	The description of this type of payment method	string	None.
PaymentID	The unique ID for this payment	string	None.
ServiceType	The payment type (I.E PMT, NCR, PRCR)	string	None.
Amount	The amount of the payment	decimal number	None.
PaymentDate	The payment date	date	None.
EntryDate	The date the payment was entered into the system	date	None.
AccountType	The type of the account	string	None.
Currency	The currency for the payment (USD or CDN)	Currency	None.
InternetCodeType	The internet code type. One of {CNS, CLI, IVR, OTHER, NCL}	string	None.
PaymentStatus	The payment status	string	None.
PaymentType	The payment type.	string	None.
SetupDate	The date this payment was set up	date	None.
SetupBy	Who this payment was set up by	string	None.
LastDebitDate	The last debit date	date	None.
LastDeclineDate	The last decline date	date	None.
LastDeclineReason	The reason for the last decline	string	None.
DisabledReason	The reason this payment is disabled	string	None.
RestrictReason	The reason this payment is restricted	string	None.
CanUnrestrict	True if this payment can be unrestricted	boolean	None.
Debug	True if this is being run as a test payment	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "CardNumber": "sample string 1",
  "Address": "sample string 2",
  "PostalCode": "sample string 3",
  "ExpirationMonth": 4,
  "ExpirationYear": 5,
  "CardType": "sample string 6",
  "Authorization": "sample string 7",
  "ConfirmationNumber": "sample string 8",
  "TransactionReference": "sample string 9",
  "AccountNumber": "sample string 10",
  "Name": "sample string 11",
  "OrderID": "sample string 12",
  "PaymentCodeDescription": "sample string 13",
  "User": "sample string 14",
  "PaymentTypeDescription": "sample string 15",
  "PaymentID": "sample string 16",
  "ServiceType": "sample string 17",
  "Amount": 18.1,
  "PaymentDate": "2025-01-09T11:24:31.3131113-07:00",
  "EntryDate": "2025-01-09T11:24:31.3131113-07:00",
  "AccountType": "sample string 21",
  "Currency": 0,
  "InternetCodeType": "sample string 22",
  "PaymentStatus": "sample string 23",
  "PaymentType": "sample string 24",
  "SetupDate": "2025-01-09T11:24:31.3131113-07:00",
  "SetupBy": "sample string 26",
  "LastDebitDate": "2025-01-09T11:24:31.3131113-07:00",
  "LastDeclineDate": "2025-01-09T11:24:31.3131113-07:00",
  "LastDeclineReason": "sample string 29",
  "DisabledReason": "sample string 30",
  "RestrictReason": "sample string 31",
  "CanUnrestrict": true,
  "Debug": true
}

application/xml, text/xml

Sample:

<CreditCardDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RestAPI.Models">
  <AccountNumber>sample string 10</AccountNumber>
  <AccountType>sample string 21</AccountType>
  <Amount>18.1</Amount>
  <CanUnrestrict>true</CanUnrestrict>
  <Currency>USD</Currency>
  <Debug>true</Debug>
  <DisabledReason>sample string 30</DisabledReason>
  <EntryDate>2025-01-09T11:24:31.3131113-07:00</EntryDate>
  <InternetCodeType>sample string 22</InternetCodeType>
  <LastDebitDate>2025-01-09T11:24:31.3131113-07:00</LastDebitDate>
  <LastDeclineDate>2025-01-09T11:24:31.3131113-07:00</LastDeclineDate>
  <LastDeclineReason>sample string 29</LastDeclineReason>
  <Name>sample string 11</Name>
  <OrderID>sample string 12</OrderID>
  <PaymentCodeDescription>sample string 13</PaymentCodeDescription>
  <PaymentDate>2025-01-09T11:24:31.3131113-07:00</PaymentDate>
  <PaymentID>sample string 16</PaymentID>
  <PaymentStatus>sample string 23</PaymentStatus>
  <PaymentType>sample string 24</PaymentType>
  <PaymentTypeDescription>sample string 15</PaymentTypeDescription>
  <RestrictReason>sample string 31</RestrictReason>
  <ServiceType>sample string 17</ServiceType>
  <SetupBy>sample string 26</SetupBy>
  <SetupDate>2025-01-09T11:24:31.3131113-07:00</SetupDate>
  <User>sample string 14</User>
  <Address>sample string 2</Address>
  <Authorization>sample string 7</Authorization>
  <CardNumber>sample string 1</CardNumber>
  <CardType>sample string 6</CardType>
  <ConfirmationNumber>sample string 8</ConfirmationNumber>
  <ExpirationMonth>4</ExpirationMonth>
  <ExpirationYear>5</ExpirationYear>
  <PostalCode>sample string 3</PostalCode>
  <TransactionReference>sample string 9</TransactionReference>
</CreditCardDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The transaction ID

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.