Query Accounts APIs

get

Query accounts

Query parameters

filterstringOptional

page[size]stringOptional

page[number]stringOptional

sortstringOptional

Responses

200

Response to /api/v2.0/account

application/json

record_countintegerOptional

The total number of records in the dataset. The record count may return zero if there are no records in the dataset.

page_numberintegerRequired

The number of the page within the complete dataset. This is indexed from 1.

continuationstringOptional

page_countintegerOptional

The largest page number that yield an empty page. The page count may return zero if there are no records in the dataset.

page_sizeintegerRequired

The size of page that was requested (or defaulted). This is the maximum number of records that will be returned in the page.

get/api/v2.0/account

GET /api/v2.0/account HTTP/1.1
Accept: */*

200

Response to /api/v2.0/account

{
  "record_count": 1,
  "page_number": 1,
  "page": [
    {
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "created_at": "2026-01-01T00:00:00.000Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "product_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "product_version": "text",
      "reference": "text",
      "status": "PENDING",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "continuation": "text",
  "page_count": 1,
  "page_size": 1
}

get

Returns list of account by uuids or external references

Query parameters

idsstring · uuid[]Optional

refsstring[]Optional

Responses

200

Response to /api/v2.0/account/list

application/json

created_atstring · date-timeRequired

The time at which the account was created in the XYB system.

currencystringRequired

The currency in which the account is denominated.

default_walletstringOptional

Default wallet code of the account

idstring · uuidRequired

A globally unique identifier for the account, generated on creation.

namestringRequired

Customer defined name of the account.

product_uuidstring · uuidRequired

Product UUID of the account

product_versionstringRequired

Product Version of the account

referencestringRequired

A globally unique identifier for the account.

statestring · enumRequired

One of the Account States.

Possible values:

state_idstring · uuidOptional

An globally unique identifier that is updated on each recorded change of the state field to match the id of the associated AccountStateChange.

updated_atstring · date-timeRequired

The time at which the account was updated in the XYB system.

get/api/v2.0/account/list

GET /api/v2.0/account/list HTTP/1.1
Accept: */*

200

Response to /api/v2.0/account/list

[
  {
    "account_coordinates": [
      {
        "coordinates": {
          "acceptor": {
            "acquirer_id": "text",
            "facilitator_id": "text",
            "id": "text",
            "mcc": "text",
            "terminal_id": "text"
          },
          "banking": {
            "account_code": "text",
            "account_number": "text",
            "account_type": "text",
            "balance_account_number": "text",
            "bank_code": "text",
            "bic": "text",
            "bic_bank_code": "text",
            "bic_branch_code": "text",
            "bic_location_code": "text",
            "branch_code": "text",
            "country_code": "text",
            "currency": "text",
            "iban": "text",
            "national_id": "text",
            "owner_account_number": "text",
            "routing_code": "text"
          },
          "external": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "internal": {
            "account_id": "123e4567-e89b-12d3-a456-426614174000",
            "account_reference": "text",
            "card_id": "123e4567-e89b-12d3-a456-426614174000",
            "contact_account_id": "text",
            "currency_code": "text",
            "legacy_account_id": 1
          },
          "reference": "text"
        },
        "external": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tags": [
          "text"
        ]
      }
    ],
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "created_at": "2026-01-01T00:00:00.000Z",
    "currency": "text",
    "default_wallet": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "jurisdictions": [
      {
        "classification": "INTERNATIONAL",
        "country_code": "text"
      }
    ],
    "name": "text",
    "owner": {
      "affiliation": "CUSTOMER",
      "aspects": [
        {
          "aspect": {},
          "identifier": "123e4567-e89b-12d3-a456-426614174000",
          "relation": "text"
        }
      ],
      "reference": "text",
      "type": "INDIVIDUAL"
    },
    "product_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "product_version": "text",
    "reference": "text",
    "state": "PENDING",
    "state_changes": [
      {
        "account_id": "123e4567-e89b-12d3-a456-426614174000",
        "applied_at": "2026-01-01T00:00:00.000Z",
        "external_reference": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "previous_state": "PENDING",
        "reason": "text",
        "state": "PENDING"
      }
    ],
    "state_id": "123e4567-e89b-12d3-a456-426614174000",
    "updated_at": "2026-01-01T00:00:00.000Z",
    "wallets": [
      {
        "account_balance": "text",
        "available_balance": "text",
        "code": "text",
        "currency": "text",
        "hold_balance": "text",
        "updated_at": "2026-01-01T00:00:00.000Z"
      }
    ]
  }
]

get

Deletes an account by idRef

Path parameters

customerTypestringRequired

referencestringRequired

Responses

200

Response to /api/v2.0/account/owner/{customerType}/{reference}

application/json

created_atstring · date-timeRequired

The time at which the account was created in the XYB system.

currencystringRequired

The currency in which the account is denominated.

default_walletstringOptional

Default wallet code of the account

idstring · uuidRequired

A globally unique identifier for the account, generated on creation.

namestringRequired

Customer defined name of the account.

product_uuidstring · uuidRequired

Product UUID of the account

product_versionstringRequired

Product Version of the account

referencestringRequired

A globally unique identifier for the account.

statestring · enumRequired

One of the Account States.

Possible values:

state_idstring · uuidOptional

An globally unique identifier that is updated on each recorded change of the state field to match the id of the associated AccountStateChange.

updated_atstring · date-timeRequired

The time at which the account was updated in the XYB system.

get/api/v2.0/account/owner/{customerType}/{reference}

GET /api/v2.0/account/owner/{customerType}/{reference} HTTP/1.1
Accept: */*

200

Response to /api/v2.0/account/owner/{customerType}/{reference}

[
  {
    "account_coordinates": [
      {
        "coordinates": {
          "acceptor": {
            "acquirer_id": "text",
            "facilitator_id": "text",
            "id": "text",
            "mcc": "text",
            "terminal_id": "text"
          },
          "banking": {
            "account_code": "text",
            "account_number": "text",
            "account_type": "text",
            "balance_account_number": "text",
            "bank_code": "text",
            "bic": "text",
            "bic_bank_code": "text",
            "bic_branch_code": "text",
            "bic_location_code": "text",
            "branch_code": "text",
            "country_code": "text",
            "currency": "text",
            "iban": "text",
            "national_id": "text",
            "owner_account_number": "text",
            "routing_code": "text"
          },
          "external": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "internal": {
            "account_id": "123e4567-e89b-12d3-a456-426614174000",
            "account_reference": "text",
            "card_id": "123e4567-e89b-12d3-a456-426614174000",
            "contact_account_id": "text",
            "currency_code": "text",
            "legacy_account_id": 1
          },
          "reference": "text"
        },
        "external": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tags": [
          "text"
        ]
      }
    ],
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "created_at": "2026-01-01T00:00:00.000Z",
    "currency": "text",
    "default_wallet": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "jurisdictions": [
      {
        "classification": "INTERNATIONAL",
        "country_code": "text"
      }
    ],
    "name": "text",
    "owner": {
      "affiliation": "CUSTOMER",
      "aspects": [
        {
          "aspect": {},
          "identifier": "123e4567-e89b-12d3-a456-426614174000",
          "relation": "text"
        }
      ],
      "reference": "text",
      "type": "INDIVIDUAL"
    },
    "product_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "product_version": "text",
    "reference": "text",
    "state": "PENDING",
    "state_changes": [
      {
        "account_id": "123e4567-e89b-12d3-a456-426614174000",
        "applied_at": "2026-01-01T00:00:00.000Z",
        "external_reference": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "previous_state": "PENDING",
        "reason": "text",
        "state": "PENDING"
      }
    ],
    "state_id": "123e4567-e89b-12d3-a456-426614174000",
    "updated_at": "2026-01-01T00:00:00.000Z",
    "wallets": [
      {
        "account_balance": "text",
        "available_balance": "text",
        "code": "text",
        "currency": "text",
        "hold_balance": "text",
        "updated_at": "2026-01-01T00:00:00.000Z"
      }
    ]
  }
]

get

Search accounts

Query parameters

searchstringRequired

page[size]stringOptional

page[number]stringOptional

sortstringOptional

Responses

200

Response to /api/v2.0/account/search

application/json

record_countintegerOptional

The total number of records in the dataset. The record count may return zero if there are no records in the dataset.

page_numberintegerRequired

The number of the page within the complete dataset. This is indexed from 1.

continuationstringOptional

page_countintegerOptional

The largest page number that yield an empty page. The page count may return zero if there are no records in the dataset.

page_sizeintegerRequired

The size of page that was requested (or defaulted). This is the maximum number of records that will be returned in the page.

get/api/v2.0/account/search

GET /api/v2.0/account/search?search=text HTTP/1.1
Accept: */*

200

Response to /api/v2.0/account/search

{
  "record_count": 1,
  "page_number": 1,
  "page": [
    {
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "created_at": "2026-01-01T00:00:00.000Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "product_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "product_version": "text",
      "reference": "text",
      "status": "PENDING",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "continuation": "text",
  "page_count": 1,
  "page_size": 1
}

get

Returns single account by idRef

Path parameters

idRefstringRequired

Responses

200

Response to /api/v2.0/account/{idRef}

application/json

created_atstring · date-timeRequired

The time at which the account was created in the XYB system.

currencystringRequired

The currency in which the account is denominated.

default_walletstringOptional

Default wallet code of the account

idstring · uuidRequired

A globally unique identifier for the account, generated on creation.

namestringRequired

Customer defined name of the account.

product_uuidstring · uuidRequired

Product UUID of the account

product_versionstringRequired

Product Version of the account

referencestringRequired

A globally unique identifier for the account.

statestring · enumRequired

One of the Account States.

Possible values:

state_idstring · uuidOptional

An globally unique identifier that is updated on each recorded change of the state field to match the id of the associated AccountStateChange.

updated_atstring · date-timeRequired

The time at which the account was updated in the XYB system.

get/api/v2.0/account/{idRef}

GET /api/v2.0/account/{idRef} HTTP/1.1
Accept: */*

200

Response to /api/v2.0/account/{idRef}

{
  "account_coordinates": [
    {
      "coordinates": {
        "acceptor": {
          "acquirer_id": "text",
          "facilitator_id": "text",
          "id": "text",
          "mcc": "text",
          "terminal_id": "text"
        },
        "banking": {
          "account_code": "text",
          "account_number": "text",
          "account_type": "text",
          "balance_account_number": "text",
          "bank_code": "text",
          "bic": "text",
          "bic_bank_code": "text",
          "bic_branch_code": "text",
          "bic_location_code": "text",
          "branch_code": "text",
          "country_code": "text",
          "currency": "text",
          "iban": "text",
          "national_id": "text",
          "owner_account_number": "text",
          "routing_code": "text"
        },
        "external": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "internal": {
          "account_id": "123e4567-e89b-12d3-a456-426614174000",
          "account_reference": "text",
          "card_id": "123e4567-e89b-12d3-a456-426614174000",
          "contact_account_id": "text",
          "currency_code": "text",
          "legacy_account_id": 1
        },
        "reference": "text"
      },
      "external": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tags": [
        "text"
      ]
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "created_at": "2026-01-01T00:00:00.000Z",
  "currency": "text",
  "default_wallet": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "jurisdictions": [
    {
      "classification": "INTERNATIONAL",
      "country_code": "text"
    }
  ],
  "name": "text",
  "owner": {
    "affiliation": "CUSTOMER",
    "aspects": [
      {
        "aspect": {},
        "identifier": "123e4567-e89b-12d3-a456-426614174000",
        "relation": "text"
      }
    ],
    "reference": "text",
    "type": "INDIVIDUAL"
  },
  "product_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "product_version": "text",
  "reference": "text",
  "state": "PENDING",
  "state_changes": [
    {
      "account_id": "123e4567-e89b-12d3-a456-426614174000",
      "applied_at": "2026-01-01T00:00:00.000Z",
      "external_reference": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "previous_state": "PENDING",
      "reason": "text",
      "state": "PENDING"
    }
  ],
  "state_id": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "wallets": [
    {
      "account_balance": "text",
      "available_balance": "text",
      "code": "text",
      "currency": "text",
      "hold_balance": "text",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

get

Checks if an account exists by idRef

Path parameters

idRefstringRequired

Responses

200

Response to /api/v2.0/account/{idRef}/exists

No content

get/api/v2.0/account/{idRef}/exists

GET /api/v2.0/account/{idRef}/exists HTTP/1.1
Accept: */*

200

Response to /api/v2.0/account/{idRef}/exists

No content