Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

value

BoolValue

DoubleValue

Empty

FloatValue

StringValue

nanos

seconds

Timestamp

address string (must not exceed 100 characters)

address

city

company

three-letters country code (ISO 3166-1 alpha-3)

countryCode

email

fax number (must not exceed 100 characters)

firstName

lastName

phone number (must not exceed 100 characters)

phone

state

zipCode

Address

address details (like street and house number)

houseNumber

street

AddressDetails

appId

appName

Application

transactionId

ApproveTransactionRequest

ApproveTransactionResponse

orderId

CancelRecurringPaymentRequest

CancelRecurringPaymentResponse

CancelTransactionRequest

CancelTransactionResponse

amount

currency

CurrencyAmount

identifier of merchant account (deprecated, you have to pass signed instance in Authorization header)

merchantId

GetTransactionFiltersRequest

GetTransactionFiltersResponse

GetTransactionPermissionsResponse

identifier of merchant account (deprecated, you have to pass signed instance in Authorization header)
optional field, should not be passed

GetTransactionRequest

GetTransactionResponse

in case not empty include payments only made by defined app_id

appIds

from

if moto==true include only moto payments
if moto==false exclude moto payments
if empty not filter by moto

moto

if one_time==true include only one time payments
if one_time==false exclude one time payments same as include all kind of recurrings
if empty not filter by one_time

oneTime

in case not empty include payments only made via defined payment method

paymentMethods

in case not empty include payments only made via defined payment provider

paymentProviders

GetTransactionTotalsRequest

transactions amount and successful payments aggregated by currency

transactionTotals

GetTransactionTotalsResponse

HasTransactionsRequest

hasTransactions

HasTransactionsResponse

fromUpdated

opt out query for totals. default is `false`

ignoreTotals

include refunds into transaction object. default is `false`

includeRefunds

limit

offset

fields to sort on in format `field1:asc, field2:desc` only date and amount allowed

order

paymentMethod

paymentProvider

status

toUpdated

ListTransactionsRequest

total number of transactions with filters applied

transactions

ListTransactionsResponse

NonRefundabilityReason

Reason

Entity which represents order view for dashboard

Order

Discount amount which is included in the order.

discount

Shipping amount which is included in the order.

shipping

Absolute taxes amount which are included in the order.

OrderAdditionalCharges

additional charges which are included in the order, like tax, shipping or discount (optional)

items which are included in the order (required)

items

information about subscription (optional)

wixAppBuyerId

wixAppOrderId

OrderDescription

name

price

quantity

OrderItem

common data for all requests that supports pagination

total

PaginationResponse

Amount that was refunded by this refund request.

createdAt

idempotencyKey

providerRefundId

reason

refundId

type

Refund

Status

Type

flowType

isRefundable

Refundability

FlowType

Recurring payment is described by `frequency` (day, week, month) and `interval`.

For example, to create a recurring payment every 14 days, just set `interval` to 14 and frequency to `DAY`.

In some cases there should be a trial period for the order, after which payments start to occur.
Trial period is also defined as `frequency` and `interval` pair.

So one can define a monthly 'subscription' with a 14 days trial period.

count of billing cycles (optional, 0 by default means endless subscription)

billingCycles

frequency of recurring payment (required)

frequency

interval

Subscription

Frequency

SubscriptionStatus

amount and currency of transactions (required)

identifier of application instance (required)

appInstanceId

view of connected order snapshot (required)

paymentMethodData

provider

providerDashboardLink

providerFields

transaction payment provider name (required)

providerName

providerTransactionId

refunds

Transaction

failureCode

TransactionFailureDetails

applications

TransactionFilters

read

TransactionPermissions

TransactionStatus

currencyCode

grossVolume

netVolume

numberOfPayments

TransactionTotals

TransactionType

Get the list of transactions for merchant with specified filters.

Supports pagination.

Syntax