Rate this page:

GetTransactionHistoryRequest

Props

applicationId
Optional
Copy URL
applicationId: 

number

The application ID to filter. Can be used together with or instead of the application_name parameter

applicationName
Optional
Copy URL
applicationName: 

string

The application name to filter. Can be used instead of the application_id parameter

childAccountId
Optional
Copy URL
childAccountId: 

number

|

number[]

|

any

The child account ID list separated by semicolons (;). Use the 'all' value to select all child accounts

childrenTransactionsOnly
Optional
Copy URL
childrenTransactionsOnly: 

boolean

Whether to get the children account transactions only

count
Optional
Copy URL
count: 

number

The number of returning records. The maximum value is 1000

decimalSeparator
Optional
Copy URL
decimalSeparator: 

string

The decimal mark for the CSV numbers if the output=csv. If omitted, the account locale setting is used

descOrder
Optional
Copy URL
descOrder: 

boolean

Whether to get records in the descent order

fromDate
Optional
Copy URL
fromDate: 

Date

The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. If both dates are omitted and is_uncommitted is false, a server-configured default interval is used (default is one month)

isAsync
Optional
Copy URL
isAsync: 

boolean

Whether to create an asynchronous history report instead of returning the data immediately. Has the same effect as calling GetTransactionHistoryAsync and requires the output=csv

isUncommitted
Optional
Copy URL
isUncommitted: 

boolean

Whether to get transactions on hold (transactions for which money is reserved but not yet withdrawn from the account)

offset
Optional
Copy URL
offset: 

number

The number of records to skip in the output with a maximum value of 10000

paymentReference
Optional
Copy URL
paymentReference: 

string

priceGroupName
Optional
Copy URL
priceGroupName: 

string

|

string[]

The price group name list separated by semicolons (;) to filter

resourceType
Optional
Copy URL
resourceType: 

string

|

string[]

The resource type list separated by semicolons (;) to filter

subscriptionId
Optional
Copy URL
subscriptionId: 

number

|

number[]

|

any

The subscription ID list separated by semicolons (;) to filter

subscriptionName
Optional
Copy URL
subscriptionName: 

string

|

string[]

The subscription name list separated by semicolons (;) to filter

timezone
Optional
Copy URL
timezone: 

string

toDate
Optional
Copy URL
toDate: 

Date

The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. If both dates are omitted and is_uncommitted is false, a server-configured default interval is used (default is one month)

transactionId
Optional
Copy URL
transactionId: 

number

|

number[]

|

any

The transaction ID list separated by semicolons (;)

transactionType
Optional
Copy URL
transactionType: 

string

|

string[]

The transaction type list separated by semicolons (;). The following values are possible: gift_revoke, resource_charge, money_distribution, subscription_charge, subscription_installation_charge, card_periodic_payment, card_overrun_payment, card_payment, rub_card_periodic_payment, rub_card_overrun_payment, rub_card_payment, robokassa_payment, gift, promo, adjustment, wire_transfer, us_wire_transfer, refund, discount, mgp_charge, mgp_startup, mgp_business, mgp_big_business, mgp_enterprise, mgp_large_enterprise, techsupport_charge, tax_charge, monthly_fee_charge, grace_credit_payment, grace_credit_provision, mau_charge, mau_overrun, im_charge, im_overrun, fmc_charge, sip_registration_charge, development_fee, money_transfer_to_child, money_transfer_to_parent, money_acceptance_from_child, money_acceptance_from_parent, phone_number_installation, phone_number_charge, toll_free_phone_number_installation, toll_free_phone_number_charge, services, user_money_transfer, paypal_payment, paypal_overrun_payment, paypal_periodic_payment

useAccountingDates
Optional
Copy URL
useAccountingDates: 

boolean

Whether to filter by the accounting dates instead of the transaction's performed_at timestamps

userId
Optional
Copy URL
userId: 

number

|

number[]

|

any

The user ID list separated by semicolons (;)

usersTransactionsOnly
Optional
Copy URL
usersTransactionsOnly: 

boolean

Whether to get the users' transactions only

withExtendedInfo
Optional
Copy URL
withExtendedInfo: 

boolean

Whether to include the extended transaction fields, such as the application, subscription, resource type and price group, in the response

withHeader
Optional
Copy URL
withHeader: 

boolean

Whether to get a CSV file with the column names if the output=csv

withTotalCount
Optional
Copy URL
withTotalCount: 

boolean

Whether to include the 'total_count' and increase performance

Rate this page: