SIsilverflow
Bins

List Bin Configurations

This operation can return all Bin Configurations, one page at a time.

Requires agents:GetBin permission.

get/bins/{binKey}/configurations

Request

Path parameters

binKeystring required

A key assigned by Silverflow to uniquely identify a Bin.

Uniquely identifies a Bin.

Query parameters

sortOrder'asc' | 'desc'

The sort order, __asc__ending or __desc__ending

limitinteger

The number of items to return

offsetTokenstring

The offset token. This token is returned in the response of previous request.

validFromstring date-time

Filter configurations by their validity start date. Only configurations with a validFrom date greater than or equal to this value will be returned. Must be in ISO 8601 date-time format.

Response

A (paged) list of Bin Configurations

offsetTokenstring
moreItemsboolean

Example response

{
  "offsetToken": "Q29uZ3JhdHVhbHRpb25zISBZb3Ugc3VjY2Vzc2Z1bGx5IGJhc2U2NC1kZWNvZGVkIHRoZSB2YWx1ZS4gWW91J3JlIG9uIGEgcm9sbCBzbyBrZWVwIGdvaW5nIQ==",
  "configs": [
    {
      "key": "bcf-2exampleXzQHq7MZ6pf0",
      "status": "active",
      "binKey": "bin-1exampleNghq6YgC3E4p",
      "defaultSettlementCurrency": {
        "code": "EUR"
      },
      "additionalSettlementCurrencies": [],
      "validFrom": "2022-01-26T13:50:12.640Z",
      "created": "2022-01-26T13:50:12.640Z",
      "version": 2
    },
    {
      "key": "bcf-1exampleRrRpVqRw0bH9",
      "status": "active",
      "binKey": "bin-1exampleNghq6YgC3E4p",
      "defaultSettlementCurrency": {
        "code": "EUR"
      },
      "additionalSettlementCurrencies": [
        {
          "code": "USD"
        },
        {
          "code": "GBP"
        }
      ],
      "settlementServices": [
        {
          "currency": "EUR",
          "code": "080"
        }
      ],
      "validFrom": "2022-03-01T12:00:00.00Z",
      "created": "2022-03-03T16:43:49.607Z",
      "lastModified": "2022-03-04T11:19:51.164Z",
      "version": 2
    }
  ],
  "moreItems": false
}

Changes

No recorded changes to this operation across all 1 revision of this API.