Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26176256241.4 KB
Transactions

Create transaction for an order.

post/api/v3.3/transactions

Request body

manualboolean

Determines whether the payment went through a payment processor or not. If 'manual' is false, then payment must've gone through a payment processor, so fields {type, status, transactionId} are required.

type'SALE' | 'PAYMENT_METHOD_VERIFICATION' | 'REFUND' | 'SECURITY_DEPOSIT_CHARGE' | 'SALE_MARKETPLACE' required
status'SUCCESS' | 'FAILURE' | 'UNCAPTURED' required
amountnumber

Amount of the transaction. Required when 'fullPayment' is not given or false.

fullPaymentboolean

If true, then the created transaction will have amount of remaining order balance.

transactionIdstring

Required when 'manual' is false. Id of the transaction from payment processor.

referenceTransactionIdstring

Can be specified only for transactions of type 'REFUND'. 'transactionId' of transaction that is refunded

notesstring
errorMessagestring
orderUidstring required

Response

OK