Create a payment transaction

Request

Security

OAuth2(Required scopes: FullAccessOrderAdmin)

Path

directionstring(OrderDirection)required

Direction of the order, from the current user's perspective.

Enum:"Incoming""Outgoing""All"

orderIDstringrequired

ID of the order.

paymentIDstringrequired

ID of the payment.

Bodyapplication/jsonrequired

Typestringrequired

Example:""

DateExecutedstring, (date-time)required

Example:"2018-01-01T00:00:00-06:00"

IDstring, <= 100 characters

Example:""

Currencystring, <= 100 characters

Usually the same as Payment.Currency, but can be different. A marketplace owner may capture funds from the buyer user in one currency and process a payout to the seller in another.

Example:""

Amountnumber, (float)

Usually the same as Payment.Amount, but can be different. A charge might have a subsequent partial credit, for example.

Example:0

Succeededboolean

Example:false

ResultCodestring

Example:""

ResultMessagestring

Example:""

xpobject

Example:

{}

curl -i -X POST \
  'https://api.ordercloud.io/v1/orders/{direction}/{orderID}/payments/{paymentID}/transactions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ID": "",
    "Type": "",
    "DateExecuted": "2018-01-01T00:00:00-06:00",
    "Currency": "",
    "Amount": 0,
    "Succeeded": false,
    "ResultCode": "",
    "ResultMessage": "",
    "xp": {}
  }'

Responses

Bodyapplication/json

IDstring, <= 100 characters

Example:""

Typestring(PaymentType)

Enum:"PurchaseOrder""CreditCard""SpendingAccount"

Example:"PurchaseOrder"

DateCreatedstring, (date-time)read-only

Example:"2018-01-01T00:00:00-06:00"

CreditCardIDstring

Only writeable on create.

Example:""

SpendingAccountIDstring

Only writeable on create.

Example:""

Descriptionstring, <= 2000 characters

Example:""

Currencystringread-only

Inherited from order.

Example:""

Amountnumber, (float)

If null, payment applies to order total (or total of specific line items, if set), less any other payments where Amount is set. Value can only be negative if processing a payment for an order return.

Example:0

Acceptedboolean

All payments must be Accepted to submit an order. This property should be updated after authorizing or capturing the payment in your middleware by a user with the elevated OrderAdmin role.

Example:false

OrderReturnIDstring

Used to indicate this payment is associated with an order return.

Example:""

xpobject

Example:

{}

TransactionsArray of objects(PaymentTransaction)read-only

Example:

[
  {
    "ID": "",
    "Type": "",
    "DateExecuted": "2018-01-01T00:00:00-06:00",
    "Currency": "",
    "Amount": 0,
    "Succeeded": false,
    "ResultCode": "",
    "ResultMessage": "",
    "xp": {}
  }
]

Response

{
  "ID": "",
  "Type": "PurchaseOrder",
  "DateCreated": "2018-01-01T00:00:00-06:00",
  "CreditCardID": "",
  "SpendingAccountID": "",
  "Description": "",
  "Currency": "",
  "Amount": 0,
  "Accepted": false,
  "OrderReturnID": "",
  "xp": {},
  "Transactions": [
    { … }
  ]
}