Finances API v0 Use Case Guide

How to obtain financial information for your orders using the Finances API.

API Version: v0

What is the Finances API v0?

You can use the Finances API v0 to obtain financial information relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. For details about API operations and associated data types and schemas, refer to the Finances API v0 Reference.

Key features

Retrieve your current balance: The Finances v0 API accepts GET operations to return the total balance of transactions within of open financial event groups.
Check the balance and status of a fund transfer: The Finances v0 API accepts GET operations to return details about the status and balance of closed financial events that have successfully processed payments.
Retrieve the transactions that make up a balance: The Finances v0 API accepts GET operations to look up the transaction trace identifiers, the total disbursement or charge amount, and the date and time of transactions.

Prerequisites

To successfully complete these tutorials, you must have:

Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
Approval for the Finance and Accounting role in your developer profile.
The Finance and Accounting role selected in the app registration page for your application.

Tutorial 1: Retrieve your current balance

This tutorial demonstrates how to retrieve your open balance.

Step 1. Call the `ListFinancialEventGroups` operation with the following parameters to retrieve the current open balance

The listFinancialEventGroups operation provides the latest 100 financial event groups and a page token that can be used to call next set of financial event groups available.

Query parameters

Name	Description	Schema	Required
`MaxResultsPerPage`	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`. Minimum : 1 Maximum : 100	integer	No
`FinancialEventGroupStartedAfter`	The date used to select financial event groups that opened before (but not at) a specified date and time, in ISO 8601 date-time 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.	string (date-time)	No
`NextToken`	The string token returned in the response of your previous request.	string	No

Request example

{
 "Operation": "com.amazon.mws.finances._2015_05_01#ListFinancialEventGroups",
 "Service": "com.amazon.mws.finances._2015_05_01#MWSFinancesService",
 "Input": {
 "SellerId": "A354ABCDEFGH",
 "MaxResultsPerPage": 10,
 "FinancialEventGroupStartedAfter": 1706332468,
 }
}

Response

A successful response includes the following:

Name	Description	Schema
`FinancialEventGroupId` optional	A unique identifier for the financial event group.	string
`ProcessingStatus` optional	The processing status of the financial event group indicates whether the balance of the financial event group is settled. Possible values: Open Closed	string
`FundTransferStatus` optional	The status of the fund transfer.	string
`OriginalTotal` optional	The total amount in the currency of the marketplace in which the transactions occurred. For a closed financial group, this is the total amount of a disbursement or a charge amount. For an open financial event group, this is the current balance.	Currency
`ConvertedTotal` optional	The total amount in the currency of the marketplace in which the funds were disbursed.	Currency
`FundTransferDate` optional	The date and time when the disbursement or charge was initiated. Only present for closed settlements. In ISO 8601 date-time format.	Date
`TraceId` optional	The trace identifier used by sellers to look up transactions externally.	string
`AccountTail` optional	The account tail of the payment instrument.	string
`BeginningBalance` optional	The balance at the beginning of the settlement period.	Currency
`FinancialEventGroupStart` optional	The date and time at which the financial event group is opened. In ISO 8601 date-time format.	Date
`FinancialEventGroupEnd` optional	The date and time at which the financial event group is closed. In ISO 8601 date-time format.	Date

Response example

{
  {
    "Output":
    {
        "__type": "com.amazon.mws.finances._2015_05_01#ListFinancialEventGroupsResponse",
        "FinancialEventGroupList": [
        {
            "BeginningBalance":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "USD"
            },
            "FinancialEventGroupId": "O-dN9Vqs_--M1HeExjpmq2fvI4jAAAANoFqBBBBB_s",
            "FinancialEventGroupStart": 1.706665382522E9,
            "OriginalTotal":
            {
                "CurrencyAmount": 34.48,
                "CurrencyCode": "USD"
            },
            "ProcessingStatus": "Open"
        },
        {
            "BeginningBalance":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "USD"
            },
            "FinancialEventGroupId": "fqlzzk53Ab3bbJr8tfI8X0TAAAAQFT4vugWWBBBB",
            "FinancialEventGroupStart": 1.706494768932E9,
            "OriginalTotal":
            {
                "CurrencyAmount": 56841.84,
                "CurrencyCode": "USD"
            },
            "ProcessingStatus": "Open"
        },
        {
            "AccountTail": "678",
            "BeginningBalance":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "USD"
            },
            "FinancialEventGroupEnd": 1.706494768932E9,
            "FinancialEventGroupId": "vQDBCUXEzvJp17lCoNXRZAAAAdbw4hA-EXMSmGBBBB",
            "FinancialEventGroupStart": 1.706060973251E9,
            "FundTransferDate": 1.70658124607E9,
            "FundTransferStatus": "Succeeded",
            "OriginalTotal":
            {
                "CurrencyAmount": 20198.86,
                "CurrencyCode": "USD"
            },
            "ProcessingStatus": "Closed",
            "TraceId": "2Q2M4AAAAAAAAAA"
        },
        
        {
            "BeginningBalance":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "EUR"
            },
            "FinancialEventGroupId": "cNY51tGJ9O--I-qKiJnHO6dmy1AAAAA0-BBBB-k",
            "FinancialEventGroupStart": 1.686221326939E9,
            "OriginalTotal":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "EUR"
            },
            "ProcessingStatus": "Open"
        },
        {
            "BeginningBalance":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "CAD"
            },
            "FinancialEventGroupId": "QA8oxBDVhYpV-7VQQhOpjh1KsAAAAvdET-ZWAAAA-B",
            "FinancialEventGroupStart": 1.677763011263E9,
            "OriginalTotal":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "CAD"
            },
            "ProcessingStatus": "Open"
        }]
    },
    "Version": "1.0"
}

}

Step 2. Filter the financial event groups with `ProcessingStatus` as `Open`

Filtering the financial event groups by selecting ProcessingStatus as Open provides the currently open financial groups.

Step 3. Use `OriginalTotal` structure in the open financial event group

CurrencyAmount in OriginalTotal provides the total amount in the currency of the marketplace in which the transactions occurred. CurrencyCode provides the currency code.

Tutorial 2: Retrieve the amount and status of a payment

This tutorial demonstrates how to retrieve the amount and status of a specific payment.

Step 1. Call the `ListFinancialEventGroups` operation with the following parameters to find the specific financial event group of the payment

The listFinancialEventGroups operation provides the latest 100 financial event groups and a page token that can be used to call next set of financial event groups available.

Query parameters

Name	Description	Schema	Required
`MaxResultsPerPage`	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`. Minimum : 1 Maximum : 100	integer	No
`FinancialEventGroupStartedAfter`	The date used to select financial event groups that opened before (but not at) a specified date and time, in ISO 8601 date-time 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.	string (date-time)	No
`FinancialEventGroupStartedBefore`	TThe date used to select financial event groups that opened after (or at) a specified date and time, in ISO 8601 date-time format. The date-time must be no later than two minutes before the request was submitted.	string (date-time)	No
`NextToken`	The string token returned in the response of your previous request.	string	No

Request example

{
 "Operation": "com.amazon.mws.finances._2015_05_01#ListFinancialEventGroups",
 "Service": "com.amazon.mws.finances._2015_05_01#MWSFinancesService",
 "Input": {
 "SellerId": "A354ABCDEFGH",
 "MaxResultsPerPage": 10,
 "FinancialEventGroupStartedAfter": 1706332468,
 }
}

Response

A successful response includes the following:

Name	Description	Schema
`FinancialEventGroupId` optional	A unique identifier for the financial event group.	string
`ProcessingStatus` optional	The processing status of the financial event group indicates whether the balance of the financial event group is settled. Possible values: Open Closed	string
`FundTransferStatus` optional	The status of the fund transfer.	string
`OriginalTotal` optional	The total amount in the currency of the marketplace in which the transactions occurred. For a closed financial group, this is the total amount of a disbursement or a charge amount. For an open financial event group, this is the current balance.	Currency
`ConvertedTotal` optional	The total amount in the currency of the marketplace in which the funds were disbursed.	Currency
`FundTransferDate` optional	The date and time when the disbursement or charge was initiated. Only present for closed settlements. In ISO 8601 date-time format.	Date
`TraceId` optional	The trace identifier used by sellers to look up transactions externally.	string
`AccountTail` optional	The account tail of the payment instrument.	string
`BeginningBalance` optional	The balance at the beginning of the settlement period.	Currency
`FinancialEventGroupStart` optional	The date and time at which the financial event group is opened. In ISO 8601 date-time format.	Date
`FinancialEventGroupEnd` optional	The date and time at which the financial event group is closed. In ISO 8601 date-time format.	Date

Response example

{
  {
    "Output":
    {
        "__type": "com.amazon.mws.finances._2015_05_01#ListFinancialEventGroupsResponse",
        "FinancialEventGroupList": [
        {
            "BeginningBalance":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "USD"
            },
            "FinancialEventGroupId": "O-dN9Vqs_--M1HeExjpmq2fvI4jAAAANoFqBBBBB_s",
            "FinancialEventGroupStart": 1.706665382522E9,
            "OriginalTotal":
            {
                "CurrencyAmount": 34.48,
                "CurrencyCode": "USD"
            },
            "ProcessingStatus": "Open"
        },
        {
            "BeginningBalance":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "USD"
            },
            "FinancialEventGroupId": "fqlzzk53Ab3bbJr8tfI8X0TAAAAQFT4vugWWBBBB",
            "FinancialEventGroupStart": 1.706494768932E9,
            "OriginalTotal":
            {
                "CurrencyAmount": 56841.84,
                "CurrencyCode": "USD"
            },
            "ProcessingStatus": "Open"
        },
        {
            "AccountTail": "678",
            "BeginningBalance":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "USD"
            },
            "FinancialEventGroupEnd": 1.706494768932E9,
            "FinancialEventGroupId": "vQDBCUXEzvJp17lCoNXRZAAAAdbw4hA-EXMSmGBBBB",
            "FinancialEventGroupStart": 1.706060973251E9,
            "FundTransferDate": 1.70658124607E9,
            "FundTransferStatus": "Succeeded",
            "OriginalTotal":
            {
                "CurrencyAmount": 20198.86,
                "CurrencyCode": "USD"
            },
            "ProcessingStatus": "Closed",
            "TraceId": "2Q2M4AAAAAAAAAA"
        },
        
        {
            "BeginningBalance":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "EUR"
            },
            "FinancialEventGroupId": "cNY51tGJ9O--I-qKiJnHO6dmy1AAAAA0-BBBB-k",
            "FinancialEventGroupStart": 1.686221326939E9,
            "OriginalTotal":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "EUR"
            },
            "ProcessingStatus": "Open"
        },
        {
            "BeginningBalance":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "CAD"
            },
            "FinancialEventGroupId": "QA8oxBDVhYpV-7VQQhOpjh1KsAAAAvdET-ZWAAAA-B",
            "FinancialEventGroupStart": 1.677763011263E9,
            "OriginalTotal":
            {
                "CurrencyAmount": 0.00,
                "CurrencyCode": "CAD"
            },
            "ProcessingStatus": "Open"
        }]
    },
    "Version": "1.0"
}

}

Step 2. Filter the financial event groups with `ProcessingStatus` as `Closed`

Filtering the financial event groups with ProcessingStatus marked as Closed retrieves financial groups that have successfully sent payments.

Step 3. Use `OriginalTotal` structure in the closed financial event group to retrieve the payment amount

For a closed financial group, the OriginalTotal is the total amount of disbursement or charge amount. The CurrencyAmount provides the monetary value, while CurrencyCode provides the The three-digit currency code in ISO 4217 format.

Tutorial 3: Retrieve the financial events that make up a financial event group

The `listFinancialEvents operation can be used to find financial events that make up the financial group that you identified in Tutorial 1 or Tutorial 2.

Step 1. Call `ListFinancialEventsByGroupId`

Call the ListFinancialEventsByGroupId operation with the SellerId and eventGroupId parameters. The response provides the first 100 financial events present in the financial event group and a page token that can be used to call next set of financial events.

Path parameters

Type	Name	Description	Schema	Default
Query	MaxResultsPerPage 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'. Minimum : 1 Maximum : 100	integer (int32)	`100`
Query	PostedAfter optional	A date used for selecting financial events posted after (or at) a specified time. The date-time must be more than two minutes before the time of the request, in ISO 8601 date-time format.	string (date-time)	-
Query	PostedBefore optional	A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than `PostedAfter` and no later than two minutes before the request was submitted, in ISO 8601 date-time format. If `PostedAfter` and `PostedBefore` are more than 180 days apart, no financial events are returned. You must specify the `PostedAfter` parameter if you specify the `PostedBefore` parameter. Default: Now minus two minutes.	string (date-time)	-
Path	eventGroupId required	The identifier of the financial event group to which the events belong.	string	-
Query	NextToken optional	A string token returned in the response of your previous request.	string	-

Request example

{
 "Operation": "com.amazon.mws.finances._2015_05_01#ListFinancialEvents",
 "Service": "com.amazon.mws.finances._2015_05_01#MWSFinancesService",
 "Input": {
 "SellerId": "A354ABCDEFGH",
 "MaxResultsPerPage": 2,
 "FinancialEventGroupId": "vQDBCUXEzvJp17lCoNXRZNq8AWdbw4hA-EXMSmGBcsk"
 }
}

Response

Response properties:

Name	Description	Schema
`ShipmentEventList` optional	A list of shipment events.	ShipmentEventList
`ShipmentSettleEventList` optional	A list of Shipment Settle events.	ShipmentSettleEventList
`RefundEventList` optional	A list of refund events.	ShipmentEventList
`GuaranteeClaimEventList` optional	A list of guarantee claim events.	ShipmentEventList
`ChargebackEventList` optional	A list of chargeback events.	ShipmentEventList
`PayWithAmazonEventList` optional	A list of events related to the seller's Pay with Amazon account.	PayWithAmazonEventList
`ServiceProviderCreditEventList` optional	A list of information about solution provider credits.	SolutionProviderCreditEventList
`RetrochargeEventList` optional	A list of information about Retrocharge or RetrochargeReversal events.	RetrochargeEventList
`RentalTransactionEventList` optional	A list of rental transaction event information.	RentalTransactionEventList
`ProductAdsPaymentEventList` optional	A list of sponsored products payment events.	ProductAdsPaymentEventList
`ServiceFeeEventList` optional	A list of information about service fee events.	ServiceFeeEventList
`SellerDealPaymentEventList` optional	A list of payment events for deal-related fees.	SellerDealPaymentEventList
`DebtRecoveryEventList` optional	A list of debt recovery event information.	DebtRecoveryEventList
`LoanServicingEventList` optional	A list of loan servicing events.	LoanServicingEventList
`AdjustmentEventList` optional	A list of adjustment event information for the seller's account.	AdjustmentEventList
`SAFETReimbursementEventList` optional	A list of SAFETReimbursementEvents.	SAFETReimbursementEventList
`SellerReviewEnrollmentPaymentEventList` optional	A list of information about fee events for the Early Reviewer Program.	SellerReviewEnrollmentPaymentEventList
`FBALiquidationEventList` optional	A list of FBA inventory liquidation payment events.	FBALiquidationEventList
`CouponPaymentEventList` optional	A list of coupon payment event information.	CouponPaymentEventList
`ImagingServicesFeeEventList` optional	A list of fee events related to Amazon Imaging services.	ImagingServicesFeeEventList
`NetworkComminglingTransactionEventList` optional	A list of network commingling transaction events.	NetworkComminglingTransactionEventList
`AffordabilityExpenseEventList` optional	A list of expense information related to an affordability promotion.	AffordabilityExpenseEventList
`AffordabilityExpenseReversalEventList` optional	A list of expense information related to an affordability promotion.	AffordabilityExpenseEventList
`RemovalShipmentEventList` optional	A list of removal shipment event information.	RemovalShipmentEventList
`RemovalShipmentAdjustmentEventList` optional	A comma-delimited list of Removal shipmentAdjustment details for FBA inventory.	RemovalShipmentAdjustmentEventList
`TrialShipmentEventList` optional	A list of information about trial shipment financial events.	TrialShipmentEventList
`TDSReimbursementEventLis`t optional	A list of `TDSReimbursementEvent` items.	TDSReimbursementEventList
`AdhocDisbursementEventList` optional	A list of `AdhocDisbursement` events.	AdhocDisbursementEventList
`TaxWithholdingEventList` optional	A list of `TaxWithholding` events.	TaxWithholdingEventList
`ChargeRefundEventList` optional	A list of charge refund events.	ChargeRefundEventList
`FailedAdhocDisbursementEventList` optional	A list of `FailedAdhocDisbursementEvent`s.	FailedAdhocDisbursementEventList
`ValueAddedServiceChargeEventList` optional	A list of `ValueAddedServiceCharge` events.	ValueAddedServiceChargeEventList
`CapacityReservationBillingEventList` optional	A list of `CapacityReservationBillingEvent` events.	CapacityReservationBillingEventList

Response example

{
  {
    "Output":
    {
        "__type": "com.amazon.mws.finances._2015_05_01#ListFinancialEventsResponse",
        "FinancialEvents":
        {
            "AdhocDisbursementEventList": [],
            "AdjustmentEventList": [
            {
                "AdjustmentAmount":
                {
                    "CurrencyAmount": 41909.78,
                    "CurrencyCode": "USD"
                },
                "AdjustmentType": "ReserveCredit",
                "PostedDate": 1.706060985486E9
            }],
            "AffordabilityExpenseEventList": [],
            "AffordabilityExpenseReversalEventList": [],
            "ChargeRefundEventList": [],
            "ChargebackEventList": [],
            "CouponPaymentEventList": [],
            "DebtRecoveryEventList": [],
            "ExploreOutOfBandPaymentsEventList": [],
            "FBALiquidationEventList": [],
            "FailedAdhocDisbursementEventList": [],
            "GuaranteeClaimEventList": [],
            "ImagingServicesFeeEventList": [],
            "LoanServicingEventList": [],
            "NetworkComminglingTransactionEventList": [],
            "PayWithAmazonEventList": [],
            "PerformanceBondRefundEventList": [],
            "ProductAdsPaymentEventList": [],
            "RefundEventList": [],
            "RemovalShipmentAdjustmentEventList": [],
            "RemovalShipmentEventList": [],
            "RentalTransactionEventList": [],
            "RetrochargeEventList": [],
            "SAFETReimbursementEventList": [],
            "SellerDealPaymentEventList": [],
            "SellerReviewEnrollmentPaymentEventList": [],
            "ServiceFeeEventList": [],
            "ServiceProviderCreditEventList": [],
            "ShipmentEventList": [
            {
                "AmazonOrderId": "111-2233657-11111111",
                "MarketplaceName": "Amazon.com",
                "PostedDate": 1.706061191666E9,
                "SellerOrderId": "111-2233657-11111111",
                "ShipmentItemList": [
                {
                    "ItemChargeList": [
                    {
                        "ChargeAmount":
                        {
                            "CurrencyAmount": 59.99,
                            "CurrencyCode": "USD"
                        },
                        "ChargeType": "Principal"
                    },
                    {
                        "ChargeAmount":
                        {
                            "CurrencyAmount": 3.15,
                            "CurrencyCode": "USD"
                        },
                        "ChargeType": "Tax"
                    },
                    {
                        "ChargeAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "ChargeType": "GiftWrap"
                    },
                    {
                        "ChargeAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "ChargeType": "GiftWrapTax"
                    },
                    {
                        "ChargeAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "ChargeType": "ShippingCharge"
                    },
                    {
                        "ChargeAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "ChargeType": "ShippingTax"
                    }],
                    "ItemFeeList": [
                    {
                        "FeeAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "FeeType": "FBAPerOrderFulfillmentFee"
                    },
                    {
                        "FeeAmount":
                        {
                            "CurrencyAmount": -9.73,
                            "CurrencyCode": "USD"
                        },
                        "FeeType": "FBAPerUnitFulfillmentFee"
                    },
                    {
                        "FeeAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "FeeType": "FBAWeightBasedFee"
                    },
                    {
                        "FeeAmount":
                        {
                            "CurrencyAmount": -6.75,
                            "CurrencyCode": "USD"
                        },
                        "FeeType": "Commission"
                    },
                    {
                        "FeeAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "FeeType": "FixedClosingFee"
                    },
                    {
                        "FeeAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "FeeType": "GiftwrapChargeback"
                    },
                    {
                        "FeeAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "FeeType": "ShippingChargeback"
                    },
                    {
                        "FeeAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "FeeType": "VariableClosingFee"
                    }],
                    "ItemTaxWithheldList": [
                    {
                        "TaxCollectionModel": "MarketplaceFacilitator",
                        "TaxesWithheld": [
                        {
                            "ChargeAmount":
                            {
                                "CurrencyAmount": -3.15,
                                "CurrencyCode": "USD"
                            },
                            "ChargeType": "MarketplaceFacilitatorTax-Principal"
                        }]
                    }],
                    "OrderItemId": "92680125955441",
                    "PromotionList": [
                    {
                        "PromotionAmount":
                        {
                            "CurrencyAmount": -15.0,
                            "CurrencyCode": "USD"
                        },
                        "PromotionId": "PLM-ce8ae94e-3c9b-46f5-91ff-b9bd3aAAAAAAA",
                        "PromotionType": "PromotionMetaDataDefinitionValue"
                    },
                    {
                        "PromotionAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "PromotionId": "PLM-ce8ae94e-3c9b-46f5-91ff-b9bd3aAAAAAAA",
                        "PromotionType": "PromotionMetaDataDefinitionValue"
                    },
                    {
                        "PromotionAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "PromotionId": "PLM-ce8ae94e-3c9b-46f5-91ff-b9bd3aAAAAAAA",
                        "PromotionType": "PromotionMetaDataDefinitionValue"
                    },
                    {
                        "PromotionAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "PromotionId": "PLM-ce8ae94e-3c9b-46f5-91ff-b9bd3aAAAAAAA",
                        "PromotionType": "PromotionMetaDataDefinitionValue"
                    },
                    {
                        "PromotionAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "PromotionId": "PLM-ce8ae94e-3c9b-46f5-91ff-b9bd3aAAAAAAA",
                        "PromotionType": "PromotionMetaDataDefinitionValue"
                    },
                    {
                        "PromotionAmount":
                        {
                            "CurrencyAmount": 0.0,
                            "CurrencyCode": "USD"
                        },
                        "PromotionId": "PLM-ce8ae94e-3c9b-46f5-91ff-b9bd3aAAAAAAA",
                        "PromotionType": "PromotionMetaDataDefinitionValue"
                    }],
                    "QuantityShipped": 1,
                    "SellerSKU": "SBB-TableTop -Gallon"
                }]
            }],
            "ShipmentSettleEventList": [],
            "StorageReservationBillingEventList": [],
            "TDSReimbursementEventList": [],
            "TaxWithholdingEventList": [],
            "TrialShipmentEventList": [],
            "ValueAddedServiceChargeEventList": []
        },
        "NextToken": "e3F1ZXJ5UGFnaW5hdGlvblRva2VuOiJXUndvWm5YcUtGd2loT2U4RUdVQllqQWNUaGVIZGZmaHQ4LXVFSUU4d3Z0VXJXS3hYUnZGUjBYeEM5Z3RYcFN4cWFKSXkteUFrUF9WRURYLVhGV0FycUN5Qlg1U1d6VEhvZ3ZWOGc5OWV2bGR6TW1TcHJaY2JoZmFRN3JnTEFidmhTTGpSSHBiVnhEcjN5WWk1R0VkTzdmUUNsVVZDbWp2NUttczkwQ2RRaUdYUDdxRGNzSV9YTjcwUjV5VWUxS2Ywa0hoZEo4NENFN1V4RmZXanF6LTRWYXFFSWNTS3pRWFpoV3lHdnBIRFQ4YTVJZjUtZU9tMzNzakpVZmtHOFhNdkpGLTk3M2t4cm9YUFFwSkw3OHVDLTNMMGNCLVNoNGhEdV9IZlV6TXlGR2luc05qbFpzZmZnTmo1RHZEUVEwR3Nqd1dtU0h6VVdnWkU4WEVxaFlwTDNMWXE3Y0JTNGdPNkNjV0pEQk8zX3NqRzNuY0F6c3FDc2dEOXVCT2d6YWtFS2Q0VGxjTW5sMkJ5SEplREFod2NuTmN5blkzSW5WVWFTTGRKVFZUeHF2eHRDbm9zc01wd255SGE5OFczTVhlemhuS3p6RDlHNzlFRDhKdWtQTkN1Qk1HcDdFdjJ6LS1yU2UyNGpXekNWVXprTUI1OHA1MWNNaHZLSjNXRHhYbEFjWF94eDdNdmptMF9vRHo1bnhZTjlBel9BVElRV2hkeWpsOHV3MHZQU3RITGJQQ3hRRTYyRnlPTlM2b2dfSEthTVl6LXBqeHpzS1dnOUR3SU1BMnpyZTRDRlBmVEFrSzRKQ01QZzh6NDhhWEcwYUV0bm1vYkNURVNSRUgwNU1Ea2N1cVIzcjNMTTl2ZGt5Z0ozTnh6USIsbWF4UmVzdWx0c1BlclBhZ2U6MCx0b2tlbkNyZWF0aW9uRGF0ZToxNzA2ODMzNDEyOTU1LG1hcmtldHBsYWNlSWQ6bnVsbCxzZWFyY2hRdWVyeTpudWxsLHNlbGxlcklkOiJBMzU0T0VRNVYyQ0w1IixzZWFyY2hRdWVyeUNoZWNrc3VtOm51bGx9"
    },
    "Version": "1.0"
}

}

Updated 18 days ago

What is the Finances API v0?

Key features

Prerequisites

Tutorial 1: Retrieve your current balance

Step 1. Call the ListFinancialEventGroups operation with the following parameters to retrieve the current open balance

Query parameters

Request example

Response

Response example

Step 2. Filter the financial event groups with ProcessingStatus as Open

Step 3. Use OriginalTotal structure in the open financial event group

Tutorial 2: Retrieve the amount and status of a payment

Step 1. Call the ListFinancialEventGroups operation with the following parameters to find the specific financial event group of the payment

Query parameters

Request example

Response

Response example

Step 2. Filter the financial event groups with ProcessingStatus as Closed

Step 3. Use OriginalTotal structure in the closed financial event group to retrieve the payment amount

Tutorial 3: Retrieve the financial events that make up a financial event group

Step 1. Call ListFinancialEventsByGroupId

Path parameters

Request example

Response

Response example

Step 1. Call the `ListFinancialEventGroups` operation with the following parameters to retrieve the current open balance

Step 2. Filter the financial event groups with `ProcessingStatus` as `Open`

Step 3. Use `OriginalTotal` structure in the open financial event group

Step 1. Call the `ListFinancialEventGroups` operation with the following parameters to find the specific financial event group of the payment

Step 2. Filter the financial event groups with `ProcessingStatus` as `Closed`

Step 3. Use `OriginalTotal` structure in the closed financial event group to retrieve the payment amount

Step 1. Call `ListFinancialEventsByGroupId`