URL Expired

The URL for this request expired after 30 days.

cursor

string

The cursor to use for pagination. Identifies your place on the list

limit

integer

1 to 100

Defaults to 25

Maximum number of items to return

accept

string

enum

Defaults to application/hal+json

Generated from available response content types

application/hal+jsonapplication/problem+json

Allowed:

application/hal+json``application/problem+json

`200 Subaccounts list retrieved successfully

object

_embedded

object

required

subaccounts

array of objects

required

subaccounts*

object

_links

object

required

_links object

accountId

uuid

required

The unique identifier of the account related to this entity.

id

uuid

required

The unique identifier of this subaccount entity.

name

string

required

The name of this subaccount entity.

createdAt

date-time

required

Date and time when this resource was created, in UTC, following ISO 8601 format.

updatedAt

date-time

required

Date and time when this resource was last updated, in UTC, following ISO 8601 format.

configurations

object

required

Subaccount network and regional configurations which determine the available networks and geographies during card enrollment.

configurations object

verificationPolicy

object

Admin-managed card verification policy for this subaccount. Overrides the parent account's policy when set. null or absent means no subaccount-level override.

verificationPolicy object

enrollmentPolicy

object | null

Enrollment policy for an account or subaccount. Two groups of fields:

Unified-SDK rails (cardEnrollment, bankEnrollment, bulkEnrollment) — which

enrollment options the unified SDK renders. Customer-writable per subaccount via

PATCH /subaccounts/{subaccountId}; account-level defaults are admin-managed. Rails

resolve live per field (subaccount value if set, else account) and reads are SPARSE:

only explicitly-configured rail fields are returned — an absent field means "not configured here" and the SDK falls back to the host page's client configuration, then

its card-only default.

Admin fields (spinwheelEnabled, programBins) — whether the Spinwheel enrollment option is offered, and which card-program BINs identify the customer's program. Managed only on the internal enrollment-policy endpoints.

Fields are optional and nullable; absent fields leave the current value unchanged, explicit null clears a field.

enrollmentPolicy object | null

bankLinkingPolicy

object

Admin-managed bank-linking policy. On reads, fields are the EFFECTIVE values — per-field live resolution against the parent account (subaccount field if set, else account, else null). A whole-null policy means neither level has one set. The credit-only system default (accountTypes: [credit]) is applied downstream at bank-link creation, not materialized in this read.

bankLinkingPolicy object

_links

object

required

self

object

required

self object

next

object

next object

`400 The server cannot or will not process the request due to something that is perceived to be a client error

`401 Authentication credentials were either missing or incorrect

`403 Authentication credentials used do not have have permissions to perform the request

`404 The requested resource was not found on the server

`500 The server encountered an unexpected condition that prevented it from fulfilling the request

Updated about 2 months ago

ShellNodeRubyPHPPython

Bearer

xxxxxxxxxx

curl --request GET \

--url 'https://api.astrada.co/subaccounts?limit=25' \

--header 'accept: application/hal+json'

xxxxxxxxxx

{

"_links": {
    "self": {
      "href": "/subaccounts"
    }
  },

"_embedded": {
    "subaccounts": [
      {
        "_links": {
          "self": {
            "href": "/subaccounts/81e7c267-0927-4234-a2bd-78cef799de54"
          }
        },
        "accountId": "073fe1bb-3350-46ad-b3a6-32afb3780994",
        "id": "81e7c267-0927-4234-a2bd-78cef799de54",
        "name": "Subaccount A",
        "createdAt": "2024-05-01T17:08:43.810Z",
        "updatedAt": "2024-05-01T17:08:43.810Z",
        "configurations": {
          "VISA": {
            "countries": [
              "USA",
              "CAN"
            ],
            "single-enrollment": {
              "countries": [
                "USA",
                "CAN"
              ],
              "blockedCardTypes": [
                "CONSUMER"
              ],
              "blockedFundingCardTypes": [
                "DEBIT"
              ]
            },
            "bulk-enrollment": {
              "countries": [
                "USA",
                "CAN"
              ],
              "blockedCardTypes": [
                "CONSUMER"
              ],
              "blockedFundingCardTypes": [
                "DEBIT"
              ]
            }
          },
          "MASTERCARD": {
            "countries": [
              "USA"
            ],
            "single-enrollment": {
              "countries": [
                "USA"
              ],
              "blockedCardTypes": [],
              "blockedFundingCardTypes": []
            },
            "bulk-enrollment": {
              "countries": [
                "USA"
              ],
              "blockedCardTypes": [],
              "blockedFundingCardTypes": []
            }
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "/subaccounts/3788493c-49f5-4f5e-9152-56abc2a4e153"
          }
        },
        "accountId": "073fe1bb-3350-46ad-b3a6-32afb3780994",
        "id": "3788493c-49f5-4f5e-9152-56abc2a4e153",
        "name": "Subaccount B",
        "createdAt": "2024-05-01T17:08:43.810Z",
        "updatedAt": "2024-05-01T17:08:43.810Z",
        "configurations": {
          "VISA": {
            "countries": [
              "USA",
              "CAN"
            ],
            "single-enrollment": {
              "countries": [
                "USA",
                "CAN"
              ],
              "blockedCardTypes": [],
              "blockedFundingCardTypes": [
                "DEBIT"
              ]
            },
            "bulk-enrollment": {
              "countries": [
                "USA",
                "CAN"
              ],
              "blockedCardTypes": [],
              "blockedFundingCardTypes": []
            }
          },
          "MASTERCARD": {
            "countries": [
              "USA"
            ],
            "single-enrollment": {
              "countries": [
                "USA"
              ],
              "blockedCardTypes": [
                "CONSUMER"
              ],
              "blockedFundingCardTypes": []
            },
            "bulk-enrollment": {
              "countries": [
                "USA"
              ],
              "blockedCardTypes": [],
              "blockedFundingCardTypes": []
            }
          }
        }
      }
    ]
  }
}