POST 3dCartWebAPI/v1/Orders/{orderid}/Transactions


Adds a new transaction on the order

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderid

Order ID

integer

Required

Body Parameters

A Json or XML object containing the new transaction

Transaction
NameDescriptionTypeAdditional information
TransactionIndexID

Primary key, auto-incremented. database reference = transactions.id

integer

None.

OrderID

database reference = transactions.orderid

integer

None.

TransactionID

database reference = transactions.transactionid

string

String length: inclusive between 0 and 50

TransactionDateTime

database reference = transactions.datetime

date

None.

TransactionType

database reference = transactions.ttype

string

String length: inclusive between 0 and 10

TransactionMethod

database reference = transactions.paymenttype

string

String length: inclusive between 0 and 255

TransactionAmount

database reference = transactions.amount

decimal number

None.

TransactionApproval

database reference = transactions.approvalcode

string

String length: inclusive between 0 and 50

TransactionReference

database reference = transactions.reference

string

String length: inclusive between 0 and 255

TransactionGatewayID

database reference = transactions.gwid

integer

None.

TransactionCVV2

database reference = transactions.cvv2

string

String length: inclusive between 0 and 255

TransactionAVS

database reference = transactions.avs

string

String length: inclusive between 0 and 255

TransactionResponseText

database reference = transactions.responsetext

string

String length: inclusive between 0 and 65535

TransactionResponseCode

database reference = transactions.responsecode

string

String length: inclusive between 0 and 50

TransactionCaptured

database reference = transactions.captured

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "TransactionIndexID": 1,
  "OrderID": 1,
  "TransactionID": "sample string 1",
  "TransactionDateTime": "10/17/2017 20:17",
  "TransactionType": "sample string 3",
  "TransactionMethod": "sample string 4",
  "TransactionAmount": 1.1,
  "TransactionApproval": "sample string 5",
  "TransactionReference": "sample string 6",
  "TransactionGatewayID": 1,
  "TransactionCVV2": "sample string 7",
  "TransactionAVS": "sample string 8",
  "TransactionResponseText": "sample string 9",
  "TransactionResponseCode": "sample string 10",
  "TransactionCaptured": 1
}

application/xml, text/xml

Sample:
<Transaction xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TransactionIndexID>1</TransactionIndexID>
  <OrderID>1</OrderID>
  <TransactionID>sample string 1</TransactionID>
  <TransactionDateTime>2017-10-17T20:17:30.1315773-04:00</TransactionDateTime>
  <TransactionType>sample string 3</TransactionType>
  <TransactionMethod>sample string 4</TransactionMethod>
  <TransactionAmount>1.1</TransactionAmount>
  <TransactionApproval>sample string 5</TransactionApproval>
  <TransactionReference>sample string 6</TransactionReference>
  <TransactionGatewayID>1</TransactionGatewayID>
  <TransactionCVV2>sample string 7</TransactionCVV2>
  <TransactionAVS>sample string 8</TransactionAVS>
  <TransactionResponseText>sample string 9</TransactionResponseText>
  <TransactionResponseCode>sample string 10</TransactionResponseCode>
  <TransactionCaptured>1</TransactionCaptured>
</Transaction>

Sample Request



Response Information

application/json, text/json

Sample:
[
  {
    "Key":"TransactionIndexID",
    "Value":"1234",
    "Status":"201",
    "Message":"Created successfully",
  }
]
							

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.