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

POST api/order/Payment/Nuvei/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

NuveiPaymentViewModel

Name	Description	Type	Additional information
OrderID	The order # to apply the payment to.	integer	Required
PaymentDate	The payment date.	date	Required
ccAccountID	CC account ID	integer	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
Token	Token. This field is required for processing Autoships.	string	None.
ExpirationDate	Expiration Date	string	None.
Name		string	None.
Address1	Street 1 of the address. Optional.	string	None.
PostalCode	Postal Code . Optional.	string	None.
AuthCode	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.	string	Required
CardType	Credit card type.	CreditCardType	None.
Last4	Last 4 digits of the credit card number. Optional.	string	None.
City	City. Optional.	string	None.
State	State. Optional.	string	None.
Country	Country. Optional.	string	None.
CustomerVaultId	This is the customer profile ID that payment was applied against	string	Required
BinNumber		string	None.

Request Formats

application/xml, text/xml

Sample:

<NuveiPaymentViewModel>
  <OrderID>1</OrderID>
  <PaymentDate>04/03/2025 02:54:15</PaymentDate>
  <ccAccountID>3</ccAccountID>
  <Amount>4</Amount>
  <Token>sample string 5</Token>
  <ExpirationDate>sample string 6</ExpirationDate>
  <Name>sample string 7</Name>
  <Address1>sample string 8</Address1>
  <PostalCode>sample string 9</PostalCode>
  <AuthCode>sample string 10</AuthCode>
  <TransactionID>sample string 11</TransactionID>
  <CardType>Visa</CardType>
  <Last4>sample string 12</Last4>
  <City>sample string 13</City>
  <State>sample string 14</State>
  <Country>sample string 15</Country>
  <CustomerVaultId>sample string 16</CustomerVaultId>
  <BinNumber>sample string 17</BinNumber>
</NuveiPaymentViewModel>

application/json, text/json

Sample:

{
  "OrderID": 1,
  "PaymentDate": "2025-04-03T02:54:15.8936-04:00",
  "ccAccountID": 3,
  "Amount": 4.0,
  "Token": "sample string 5",
  "ExpirationDate": "sample string 6",
  "Name": "sample string 7",
  "Address1": "sample string 8",
  "PostalCode": "sample string 9",
  "AuthCode": "sample string 10",
  "TransactionID": "sample string 11",
  "CardType": 1,
  "Last4": "sample string 12",
  "City": "sample string 13",
  "State": "sample string 14",
  "Country": "sample string 15",
  "CustomerVaultId": "sample string 16",
  "BinNumber": "sample string 17"
}

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

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.