Bins

List Bins

This operation can return all Agent Bins, one page at a time.

Requires agents:ListBins permission.

get/bins

Request

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.

Response

A (paged) list of Bins

offsetTokenstring
moreItemsboolean

Example response

{
  "offsetToken": "Q29uZ3JhdHVhbHRpb25zISBZb3Ugc3VjY2Vzc2Z1bGx5IGJhc2U2NC1kZWNvZGVkIHRoZSB2YWx1ZS4gWW91J3JlIG9uIGEgcm9sbCBzbyBrZWVwIGdvaW5nIQ==",
  "bins": [
    {
      "key": "bin-1iXRhbDjrT2Yxvo0mSZN",
      "status": "active",
      "description": "Example Acquirer - Mastercard",
      "acquirerIdCode": 222222,
      "acquirerBin": 555555,
      "acquirerCountryCode": {
        "alpha3": "DEU",
        "alpha2": "DE",
        "numeric": "276"
      },
      "acquirerAgentKey": "cgt-1nUP5yspouqwUHYSZo9V",
      "network": "mastercard",
      "messageSystem": "DMS",
      "shared": false,
      "created": "2020-08-24T14:15:22.014Z",
      "lastModified": "2020-08-24T21:39:01.957Z",
      "version": 2
    },
    {
      "key": "bin-1mCKWvpBRrRpVqRw0bH9",
      "status": "active",
      "description": "Example Acquirer - Visa",
      "acquirerIdCode": 444444,
      "acquirerBin": 444444,
      "bid": 55555555,
      "acquirerCountryCode": {
        "alpha3": "DEU",
        "alpha2": "DE",
        "numeric": "276"
      },
      "network": "visa",
      "messageSystem": "DMS",
      "shared": false,
      "created": "2020-08-24T14:15:22.014Z",
      "lastModified": "2020-08-24T21:39:01.957Z",
      "version": 2
    }
  ]
}

Changes

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