HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport
Start typing to search…

listFinancialEventGroups

get https://sellingpartnerapi-na.amazon.com/finances/v0/financialEventGroups

Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events.

Usage Plan:

Rate (requests per second)Burst
0.530

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Query Params
int32
1 to 100
Defaults to 10

The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.

date-time

A date used for selecting financial event groups that opened before (but not at) a specified date and time, in ISO 8601 format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned.

date-time

A date used for selecting financial event groups that opened after (or at) a specified date and time, in ISO 8601 format. The date-time must be no later than two minutes before the request was submitted.

string

A string token returned in the response of your previous request.

Responses

Response body
object
payload
object

The payload for the listFinancialEventGroups operation.

string

When present and not empty, pass this string token in the next request to return the next response page.

FinancialEventGroupList
array of objects

A list of financial event group information.

FinancialEventGroupList
object
string

A unique identifier for the financial event group.

string

The processing status of the financial event group indicates whether the balance of the financial event group is settled.

Possible values:

  • Open

  • Closed

string

The status of the fund transfer.

OriginalTotal
object

A currency type and amount.

ConvertedTotal
object

A currency type and amount.

date-time

Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).

string

The trace identifier used by sellers to look up transactions externally.

string

The account tail of the payment instrument.

BeginningBalance
object

A currency type and amount.

date-time

Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).

date-time

Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).

errors
array of objects

A list of error responses returned when a request is unsuccessful.

errors
object
string
required

An error code that identifies the type of error that occurred.

string
required

A message that describes the error condition in a human-readable form.

string

Additional details that can help the caller understand or fix the issue.

Headers
object
string

Your rate limit (requests per second) for this operation.

string

Unique request reference identifier.

Updated 3 months ago

Did this page help you?
Language

Updated 3 months ago

Did this page help you?