aid_settlements_list
List settlements
scopes:
- admin:billing
- read:billing
- admin:reports
- read:reports
- admin:settlements
- read:settlements
Path parameters
An id that uniquely identifies the account.
Query parameters
A limit on the number of objects to be returned. Limit can range between 1 and 1000 items, and the default is 10 items.
cursor for use in pagination. starting_after_id is an object ID that defines your place in the list, included in the last_evaluated_key.
For instance, if you make a list request and receive 100 objects, ending with obj_foo and settled_at=2021-02-02, your subsequent call can include starting_after_id=obj_foo&starting_after_date=2021-02-02 in order to fetch the next page of the list.
Note that you need to use the created_at as value for starting_after_date if used in combination with item_created_at.gte or item_created_at.lte
Must be used together with starting_after_date
cursor for use in pagination. starting_after_date is the settled_at or created_at from the last_evaluated_key that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo and settled_at=2021-02-02, your subsequent call can include starting_after_id=obj_foo&starting_after_date=2021-02-02 in order to fetch the next page of the list.
Must be used together with starting_after_id
Settlement created after, the settled_at value
Settlement created before a date, the settled_at value
Filter by Settlement created_at value, cannot be combined with created_at.gte query parameter
Filter by Settlement created_at value, cannot be combined with created_at.lte query parameter
The payment provider
The seller id to filter on
Will try to match the search to settlement_id.
Response
Settlements List
Example response
{
"items": [
{
"attachments": [
{
"content_type": "application/xml",
"created_by": "payex"
}
],
"amounts": [
{
"currency": "NOK"
}
]
}
]
}