Payments / Paginator / GetAccountBalance
GetAccountBalance¶
- class Payments.Paginator.GetAccountBalance¶
paginator = client.get_paginator('get_account_balance')
- paginate(**kwargs)¶
Creates an iterator that will paginate through responses from
Payments.Client.get_account_balance().See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( balanceType='INVOICES_DUE'|'INVOICES_PAST_DUE'|'OUTSTANDING_CREDIT_MEMOS', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
balanceType (string) –
[REQUIRED]
The balance to retrieve. You can specify only one balance type in a single request. Each balance adds up the
outstandingbalance of the records that have the statusOUTSTANDING. A record that isPROCESSING,SETTLED, orCANCELEDisn’t included, even when part of its amount is outstanding. The following values are valid:INVOICES_DUE– The outstanding balance of yourOUTSTANDINGinvoices that aren’t past their due date, wheredueStatusisDUE.INVOICES_PAST_DUE– The outstanding balance of yourOUTSTANDINGinvoices that are past their due date, wheredueStatusisPAST_DUE.OUTSTANDING_CREDIT_MEMOS– The outstanding balance of yourOUTSTANDINGcredit memos: the credit that isn’t yet applied to an invoice.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextTokenwill be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextTokenfrom a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'accountBalances': [ { 'amount': { 'value': 'string', 'currency': 'string' }, 'merchantOfRecord': 'string' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
accountBalances (list) –
The balance, as one amount for each merchant of record and currency. This list is empty when your account has nothing in the requested balance.
(dict) –
An amount of the balance that
GetAccountBalancereturns: the total for one merchant of record in one currency.amount (dict) –
The amount, in the currency that the records making up this balance were issued in.
value (string) –
The amount, as a decimal string, such as
10.99. The number of decimal places can differ between amounts, for example0.0and1000.24.currency (string) –
The ISO 4217 currency code for the amount (for example,
USD).
merchantOfRecord (string) –
The merchant of record that issued the invoices or credit memos that make up this amount.
NextToken (string) –
A token to resume pagination.