Sign in

v1

latestSwagger 2.02026-07-17148179252.3 KB
Orders

Creates a new Transaction related to a BigCommerce Order.

post/orders/{order_id}/transactions

Request body

event'purchase' | 'authorization' | 'capture' | 'refund' | 'void' | 'pending' | 'settled' required

Store event that created the transaction.

method'credit_card' | 'electronic_wallet' | 'gift_certificate' | 'store_credit' | 'apple_pay_card' | 'apple_pay_token' | 'token' | 'custom' | 'offsite' | 'offline' | 'nonce' required

The payment method: credit_card - a credit-card transaction; electronic_wallet - an online wallet; store_credit - a transaction using store credit; gift_certificate - a transaction using a gift certificate; custom - manual payment methods; token - payment token; nonce - temporary payment token; offsite - online payment off the site (e.g., PayPal); offline - payment method that takes place offline.

amountnumber float required

Amount of money in the transaction.

currencystring ISO-4217 required

Currency used for the transaction.

gateway'2checkout' | 'adyen' | 'amazon' | 'authorizenet' | 'bankdeposit' | 'braintree' | 'cheque' | 'cod' | 'custom' | 'firstdatagge4' | 'giftcertificate' | 'hps' | 'instore' | 'klarna' | 'migs' | 'moneyorder' | 'nmi' | 'paypalexpress' | 'paypalpaymentsprous' | 'paypalpaymentsprouk' | 'plugnpay' | 'qbmsv2' | 'securenet' | 'square' | 'storecredit' | 'stripe' | 'testgateway' | 'usaepay' required

The payment gateway, where applicable.

gateway_transaction_idstring

The transaction ID returned by the payment gateway for this transaction item.

date_createdstring date-time

The datetime of the transaction.

testboolean

True if the transaction performed was a test, or if the gateway is in test mode.

status'ok' | 'error'

Status of the transaction.

fraud_reviewboolean

Result of gateway fraud review, if any. Default is false.

reference_transaction_idinteger

Identifier for an existing transaction upon which this transaction acts.

Response

Successful transaction object created call

metaobject

May be used in the future