listFinancialEventGroups

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.5	30

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.

Request

Query Params

MaxResultsPerPage

integer <int32>

optional

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'.

>= 1<= 100

Default:

Example:

FinancialEventGroupStartedBefore

string <date-time>

optional

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.

Example:

2025-01-22T23:59:59Z

FinancialEventGroupStartedAfter

string <date-time>

optional

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.

Example:

2025-01-22T00:00:00Z

NextToken

string

optional

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

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

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the listFinancialEventGroups operation.

payload

object (ListFinancialEventGroupsPayload)

optional

The payload for the listFinancialEventGroups operation.

NextToken

string

optional

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

FinancialEventGroupList

array[object (FinancialEventGroup) {11}]

optional

A list of financial event group information.

errors

array[object (Error) {3}]

optional

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

code

string

required

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

message

string

required

A message that describes the error condition.

details

string

optional

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

Example

{
    "payload": {
        "NextToken": "string",
        "FinancialEventGroupList": [
            {
                "FinancialEventGroupId": "string",
                "ProcessingStatus": "string",
                "FundTransferStatus": "string",
                "OriginalTotal": {
                    "amount": 0,
                    "code": "str"
                },
                "ConvertedTotal": {
                    "amount": 0,
                    "code": "str"
                },
                "FundTransferDate": "2019-08-24T14:15:22Z",
                "TraceId": "string",
                "AccountTail": "string",
                "BeginningBalance": {
                    "amount": 0,
                    "code": "str"
                },
                "FinancialEventGroupStart": "2019-08-24T14:15:22Z",
                "FinancialEventGroupEnd": "2019-08-24T14:15:22Z"
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable