Documentation for POST api/order/Payment/CreditCard/Save

POST api/order/Payment/CreditCard/Save

Allows for the creation of a new credit card payment record for the given order. This is only for storage of already processed transactions.

Request Information

URI Parameters

None.

Body Parameters

CreditCardPaymentViewModel

Name	Description	Type	Additional information
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.
ExpirationDateMMYY	Expiration date of the credit card. Use a MMYY format. Optional.	string	None.
CardHolderName	Credit card holder name. Optional.	string	None.
Address1	Credit card address 1. Optional.	string	None.
Address2	Credit card address 2. Optional.	string	None.
City	Credit card city. Optional.	string	None.
State	Credit card city. Optional.	string	None.
Country	Credit card country. Optional.	string	None.
PostalCode	Credit card postal code. 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.
ReferenceNumber	This is the reference number from the processor.	string	None.
CreditCardAccountId	Identifier of the credit card account to associate to this payment record.	string	Required
CreditCardType	Credit card type.	CreditCardType	None.
OrderID	Order # to apply payment to	integer	None.

Request Formats

application/xml, text/xml

Sample:

<CreditCardPaymentViewModel>
  <PaymentDate>01/09/2025 01:30:59</PaymentDate>
  <Amount>2</Amount>
  <Last4CCNumber>sample string 3</Last4CCNumber>
  <ExpirationDateMMYY>sample string 4</ExpirationDateMMYY>
  <CardHolderName>sample string 5</CardHolderName>
  <Address1>sample string 6</Address1>
  <Address2>sample string 7</Address2>
  <City>sample string 8</City>
  <State>sample string 9</State>
  <Country>sample string 10</Country>
  <PostalCode>sample string 11</PostalCode>
  <AuthorizationCode>sample string 12</AuthorizationCode>
  <TransactionID>sample string 13</TransactionID>
  <ReferenceNumber>sample string 14</ReferenceNumber>
  <CreditCardAccountId>sample string 15</CreditCardAccountId>
  <CreditCardType>Visa</CreditCardType>
  <OrderID>16</OrderID>
</CreditCardPaymentViewModel>

application/json, text/json

Sample:

{
  "PaymentDate": "2025-01-09T01:30:59.2363697-05:00",
  "Amount": 2.0,
  "Last4CCNumber": "sample string 3",
  "ExpirationDateMMYY": "sample string 4",
  "CardHolderName": "sample string 5",
  "Address1": "sample string 6",
  "Address2": "sample string 7",
  "City": "sample string 8",
  "State": "sample string 9",
  "Country": "sample string 10",
  "PostalCode": "sample string 11",
  "AuthorizationCode": "sample string 12",
  "TransactionID": "sample string 13",
  "ReferenceNumber": "sample string 14",
  "CreditCardAccountId": "sample string 15",
  "CreditCardType": 1,
  "OrderID": 16
}

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 'CreditCardPaymentViewModel'.

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.