Get Started
Studio API
- Introduction
- Streaming
- CMS
- OTT
- Monetization
- Offers
- Transactions
- GETGet transaction
- GETList transactions
- GETList payment methods
- Stripe Integration
- GET
- Entitlements
- IAM
- Integration
- Analytics
Content Delivery API
Deep dive
List transactions
ListTransactions
Returns list of transactions based on specified parameters.
curl --request GET \
--url https://api.mottostreaming.com/monetization/transactions/v1 \
--header 'Authorization: Bearer <token>'{
"transactions": [
{
"id": "<string>",
"project_id": "<string>",
"user_id": "<string>",
"offer_id": "<string>",
"offer_title": "<string>",
"offer_description": "<string>",
"status": "TRANSACTION_STATUS_UNSPECIFIED",
"msrp": {
"currency_code": "<string>",
"units": "<string>",
"nanos": 123
},
"subtotal_amount": {
"currency_code": "<string>",
"units": "<string>",
"nanos": 123
},
"total_amount": {
"currency_code": "<string>",
"units": "<string>",
"nanos": 123
},
"vat_amount": {
"currency_code": "<string>",
"units": "<string>",
"nanos": 123
},
"discount_code": "<string>",
"discount_amount": {
"currency_code": "<string>",
"units": "<string>",
"nanos": 123
},
"discount_percentage": 123,
"billing_period": "BILLING_PERIOD_UNSPECIFIED",
"access_period": "ACCESS_PERIOD_UNSPECIFIED",
"payment_method_id": "<string>",
"subscription_id": "<string>",
"create_time": "2023-11-07T05:31:56Z",
"capture_time": "2023-11-07T05:31:56Z",
"is_test": true
}
],
"next_page_token": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Maximum number of records to return
Filter the result-set by properties using a subset of the Kibana Query Language. Only AND statements are supported.
Currently supports filtering on cleeng_transaction_id field.
The pagination token in the List request.
Response
The offer ID that is being purchased.
The transaction ID
The project ID that is associated with the transaction.
The user ID that is associated with the purchase.
The title of the offer. This is dematerialized from the offer at the time of creating the transaction.
The description of the offer. This is dematerialized from the offer at the time of creating the transaction.
The status of the transaction.
TRANSACTION_STATUS_UNSPECIFIED, TRANSACTION_STATUS_IN_PROGRESS, TRANSACTION_STATUS_COMPLETED, TRANSACTION_STATUS_FAILED, TRANSACTION_STATUS_EXPIRED, TRANSACTION_STATUS_CANCELLED, TRANSACTION_STATUS_REFUNDED The MSRP of the offer at the time of creating the transaction.
The three-letter currency code defined in ISO 4217.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units is positive, nanos must be positive or zero.
If units is zero, nanos can be positive, zero, or negative.
If units is negative, nanos must be negative or zero.
For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
The price that the user is paying for the offer (after any discounts or promotions, but before taxes).
Warning: wile transactions are incomplete, this field is only indicative.
The three-letter currency code defined in ISO 4217.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units is positive, nanos must be positive or zero.
If units is zero, nanos can be positive, zero, or negative.
If units is negative, nanos must be negative or zero.
For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
The price that the user is paying for the offer, after taxes have been applied. Depending on the region, this may
be the same as the price field (because VAT is included in the price), while in other regions, VAT is added
on top of the price.
The three-letter currency code defined in ISO 4217.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units is positive, nanos must be positive or zero.
If units is zero, nanos can be positive, zero, or negative.
If units is negative, nanos must be negative or zero.
For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
The VAT amount that was applied to the transaction.
The three-letter currency code defined in ISO 4217.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units is positive, nanos must be positive or zero.
If units is zero, nanos can be positive, zero, or negative.
If units is negative, nanos must be negative or zero.
For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
A discount code applied to the transaction.
The discount amount applied to the transaction.
The three-letter currency code defined in ISO 4217.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units is positive, nanos must be positive or zero.
If units is zero, nanos can be positive, zero, or negative.
If units is negative, nanos must be negative or zero.
For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
The discount percentage applied to the transaction, which is a value between 0 and 100.
BILLING_PERIOD_UNSPECIFIED, BILLING_PERIOD_ONE_TIME, BILLING_PERIOD_WEEKLY, BILLING_PERIOD_MONTHLY, BILLING_PERIOD_QUARTERLY, BILLING_PERIOD_YEARLY ACCESS_PERIOD_UNSPECIFIED, ACCESS_PERIOD_FOREVER, ACCESS_PERIOD_24_HOURS, ACCESS_PERIOD_48_HOURS, ACCESS_PERIOD_7_DAYS, ACCESS_PERIOD_30_DAYS, ACCESS_PERIOD_90_DAYS, ACCESS_PERIOD_365_DAYS The payment method that was used to (attempt to) pay for the transaction. If multiple payment attempts were made, this will be the last payment method used, or it may be empty if the attempt failed.
A subscription ID that is associated with the transaction. This is only applicable for subscription-based offers.
The time at which this Transaction was created.
The time at which the Transaction amount was captured.
Indicates whether this is a test transaction made in a sandbox environment.
The pagination token that should be used to get next page results. An empty value means no more results
curl --request GET \
--url https://api.mottostreaming.com/monetization/transactions/v1 \
--header 'Authorization: Bearer <token>'{
"transactions": [
{
"id": "<string>",
"project_id": "<string>",
"user_id": "<string>",
"offer_id": "<string>",
"offer_title": "<string>",
"offer_description": "<string>",
"status": "TRANSACTION_STATUS_UNSPECIFIED",
"msrp": {
"currency_code": "<string>",
"units": "<string>",
"nanos": 123
},
"subtotal_amount": {
"currency_code": "<string>",
"units": "<string>",
"nanos": 123
},
"total_amount": {
"currency_code": "<string>",
"units": "<string>",
"nanos": 123
},
"vat_amount": {
"currency_code": "<string>",
"units": "<string>",
"nanos": 123
},
"discount_code": "<string>",
"discount_amount": {
"currency_code": "<string>",
"units": "<string>",
"nanos": 123
},
"discount_percentage": 123,
"billing_period": "BILLING_PERIOD_UNSPECIFIED",
"access_period": "ACCESS_PERIOD_UNSPECIFIED",
"payment_method_id": "<string>",
"subscription_id": "<string>",
"create_time": "2023-11-07T05:31:56Z",
"capture_time": "2023-11-07T05:31:56Z",
"is_test": true
}
],
"next_page_token": "<string>"
}