v1

latestOpenAPI 3.0.02026-07-23187.1 KB

attribution transactions

Retrieve Transactions

If multiple member filters are included, only one will be used. If multiple are passed the following order precedence will be used: playerId -> memberId -> providerId -> code.<br/><br/>NOTE: This method uses private authentication API keys and should never be called from or embedded into the gaming client. These routes should ONLY be accessed from your back-end services.

get/attributions/transactions

Query parameters

groupIdstring

Group to retrieve transactions for

pageSizeinteger

Maximum number of records to return

cursorstring

Cursor for the page of transactions to be returned. Changing query parameters when using a cursor will result in an error.

pageinteger

Page of records to return. Not recommended, as it disables cursor pagination when specified.

startDatestring date-time

NOTE: Start Date should be in UTC

endDatestring date-time

NOTE: End Date should be in UTC

origin'api' | 'webshopCode' | 'storefrontCode'

Origin(s) to include.

status'normal' | 'refund' | 'fraud' | 'chargeback' | 'test'

Transaction statuses to include.

codestring

Filter transactions by creator code

codeScope'member' | 'code'

Only used when code filtering is used. Member scope will return all transactions for the member associated with the specified code (even if they have multiple codes). Code scope will return only transactions with the specified code.

memberIdstring

Filter by member ID

playerIdstring

Filter by your internal user/player ID for this member

providerIdstring

Filter a member with a specific OAUTH provider ID, such as twitch or youtube

sortstring

Property and sort direction. Format: { property }:{ asc or desc }. Valid properties: transactionDate.

Response

Returns all transactions within the specified filters

currentPagenumber

Current page of the returned response (only included when cursor pagination is disabled)

currentPageSizenumber

Page size used in this request

totalCountnumber

Total number of records found

nextCursorstring

Cursor used to retrieve the next set of records from this query

All 1 operations