Documentation for POST api/order/Payment/Tokenized/AuthorizeNet/Save

POST api/order/Payment/Tokenized/AuthorizeNet/Save

Allows for the creation of a new payment from system credits for the given order. This will deduct from system credits to apply to the order.

Request Information

URI Parameters

None.

Body Parameters

The tokenized payment details to apply

AuthorizeNetTokenizedViewModel

Name	Description	Type	Additional information
OrderID	The order # to apply the payment to.	integer	Required
PaymentDate	The payment date.	date	Required
Amount	The payment amount. If you are creating a recorded payment for a return order, the payment amount should be negative.	decimal number	Required
Last4CCNumber	Last 4 digits of the credit card number. Optional.	string	None.
ExpirationMonth	Expiration date of the credit card. MM format. Optional.	string	None.
ExpirationYear	Expiration date of the credit card. YY format. Optional.	string	None.
AuthorizationCode	The Authorization Code returned from the processor. This can be used later to process voids or refunds if needed. Optional.	string	None.
TransactionID	The transaction ID returned from the processor. This can be used later to process voids or refunds if needed. Optional.	string	None.
CustomerProfileID	This is the Authorize.NET customer profile ID that payment was applied against	string	None.
PaymentProfileID	This is the Authorize.NET payment profile ID that payment was applied against	string	None.
TokenizedAccountID	Identifier of the ByDesign tokenized account to associate to this payment record.	integer	Required
CreditCardType	Credit card type.	CreditCardType	None.

Request Formats

application/xml, text/xml

Sample:

<AuthorizeNetTokenizedViewModel>
  <OrderID>1</OrderID>
  <PaymentDate>01/09/2025 02:08:25</PaymentDate>
  <Amount>3</Amount>
  <Last4CCNumber>sample string 4</Last4CCNumber>
  <ExpirationMonth>sample string 5</ExpirationMonth>
  <ExpirationYear>sample string 6</ExpirationYear>
  <AuthorizationCode>sample string 7</AuthorizationCode>
  <TransactionID>sample string 8</TransactionID>
  <CustomerProfileID>sample string 9</CustomerProfileID>
  <PaymentProfileID>sample string 10</PaymentProfileID>
  <TokenizedAccountID>11</TokenizedAccountID>
  <CreditCardType>Visa</CreditCardType>
</AuthorizeNetTokenizedViewModel>

application/json, text/json

Sample:

{
  "OrderID": 1,
  "PaymentDate": "2025-01-09T02:08:25.8828865-05:00",
  "Amount": 3.0,
  "Last4CCNumber": "sample string 4",
  "ExpirationMonth": "sample string 5",
  "ExpirationYear": "sample string 6",
  "AuthorizationCode": "sample string 7",
  "TransactionID": "sample string 8",
  "CustomerProfileID": "sample string 9",
  "PaymentProfileID": "sample string 10",
  "TokenizedAccountID": 11,
  "CreditCardType": 1
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'AuthorizeNetTokenizedViewModel'.

Response Information

Resource Description

ApiResultOfPaymentViewModel

Name	Type	Additional information
Result	PaymentViewModel	None.
IsSuccessful	boolean	None.
MessageTranslationKey	string	None.
Message	string	None.
Messages	Collection of ApiResultMessage	None.

Response Formats

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

Sample:

Sample not available.