Sign in
account-stores

aid_account_management_stores_get

Get details about the account stores

scopes:

  • admin:accounts
  • read:accounts
get/accounts/{aid}/stores

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

Query parameters

payout_destination_idstring[]

Filter by Payout Destination ID

terminal_idstring[]

Filter by Terminal ID

includesstring[]

Include related data. Use operator_payout_destinations to include payout destinations for terminal operators associated with this store.

statusstring[]

Filter stores by status

starting_afterstring

cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, end the result contains paging_token=pt1, your subsequent call can include starting_after=pt1 in order to fetch the next page of the list.

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.

Response

List of stores

starting_afterstring

Example response

{
  "stores": [
    {
      "terminals_summary": [
        {
          "count": 1
        }
      ],
      "organization": {
        "country": "NO"
      },
      "phone_number": "+4799999999",
      "address": {
        "address_line": "Sommerkroveien 34",
        "address_line_2": "PB 123",
        "postal_code": "0349",
        "postal_place": "Oslo",
        "country": "NO"
      },
      "coordinates": {
        "latitude": 59.949923,
        "longitude": 10.766888
      },
      "payout_destination": {
        "payout_destination_id": "PD032",
        "merchant_category_code": "2741"
      },
      "store_id": "S312",
      "operator_payout_destinations": [
        {
          "merchant_category_code": "2741"
        }
      ]
    }
  ]
}

Changes

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