Skip to main content

Accounts and tokens

These endpoints report on what you have provisioned through Account Tokenization:

EndpointUse it toScope
pba/accountsList accounts, with their devices and static tokensaccounts.read
pba/customer/accountsGet every account of one customercustomers.read
pba/static-tokensList static tokens (virtual and physical cards)tokens.read
pba/devicesList devicestokens.read
pba/secure-device-walletsList secure device wallets, one row eachtokens.read
pba/accounts/secure-wallet-idsFind secure device wallet IDs by your account or customer referencestokens.read
pba/devices/accountFind the account behind secure device wallet IDstokens.read

All paths start with POST /v1/reporting/rest/. See Making a request for how filters and pagination work.

Which endpoint to use​

Several endpoints return the same records with fewer filters. They exist for quick lookups, and for access tokens that only have one of the scopes.

You wantUseInstead of
Accounts, filtered any waypba/accounts
All accounts of one customer, in one call, with only the customers.read scopepba/customer/accountspba/accounts with customerId
Devices, filtered any waypba/devices
One row per secure device wallet, even when the wallet has had several devicespba/secure-device-walletspba/devices
Only the secure device wallet IDs for some of your account or customer referencespba/accounts/secure-wallet-idspba/devices with tenantAccountRef or tenantCustomerRef
The account behind secure device wallet IDspba/devices/accountpba/devices with secure_device_wallet_id

If your access token has accounts.read and tokens.read, pba/accounts and pba/devices cover every case above.

note

Some filter names on these endpoints are singular, such as customerId and status, but they still take a list of values.

List accounts​

POST /v1/reporting/rest/pba/accounts returns accounts newest first, each with its devices and static tokens.

FieldTypeDescription
accountIdstring[]Open Fabric account IDs.
customerIdstring[]Open Fabric customer IDs.
tenantAccountRefstring[]Your account references.
statusstring[]Account statuses.
created_at_gtestringOnly accounts created at or after this time.
created_at_ltstringOnly accounts created before this time.
limitintegerDefault 10, maximum 500.
offsetintegerDefault 0.
Request
{ "tenantAccountRef": ["ACC-20031"] }
Response
{
"pba_accounts": [
{
"account_id": "9f8e7d6c-5b4a-4321-8fed-cba987654321",
"customer_id": "5a3f1c1e-7c1b-4f36-9d5b-3f0f2b1d9c11",
"tenant_account_ref": "ACC-20031",
"tenant_customer_ref": "CUST-881",
"status": "active",
"billing_currency_code": "SGD",
"billing_address": { "address_line_1": "1 Raffles Place", "city": "Singapore", "post_code": "048616", "country_code": "SG" },
"provisioned_by": "pat",
"created_at": "2026-09-02T08:15:30.112",
"updated_at": "2026-09-02T08:15:30.112",
"devices": [
{
"device_id": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
"device_name": "Pixel 9",
"status": "active",
"locked": false,
"tenant_account_device_ref": "DEV-77",
"secure_device_wallet_id": "sdw_01J9Z0Q4X3",
"created_at": "2026-09-02T08:16:01.500",
"updated_at": "2026-09-02T08:16:01.500"
}
],
"static_tokens": []
}
],
"pba_accounts_aggregate": { "aggregate": { "count": 1 } }
}

This endpoint always returns the total count. It does not accept withCount.

Get a customer's accounts​

POST /v1/reporting/rest/pba/customer/accounts returns every account of one customer, with its devices and static tokens. It returns the same accounts as List accounts with one customerId, with these differences:

  • It requires customers.read instead of accounts.read.
  • It has no pagination and no total count.
  • It only filters by customer.
FieldTypeDescription
customerIdstringRequired. The Open Fabric customer ID.
Request
{ "customerId": "5a3f1c1e-7c1b-4f36-9d5b-3f0f2b1d9c11" }

The response is { "pba_accounts": [ … ] }, with the same account fields as List accounts except tenant_customer_ref. Each static token here also includes dpan_token.

caution

Always send customerId. If you leave it out, the endpoint does not filter by customer: it returns accounts of all your customers, up to 500.

List static tokens​

POST /v1/reporting/rest/pba/static-tokens returns static tokens (virtual and physical cards), newest first.

FieldTypeDescription
idstring[]Static token IDs.
tenantTokenRefstring[]Your token references.
tenantAccountRefstring[]Your account references.
tenantCustomerRefstring[]Your customer references.
customerIdstring[]Open Fabric customer IDs.
typestring[]static_token (virtual cards) or physical_card. Omit for both.
created_at_gtestringOnly tokens created at or after this time.
created_at_ltstringOnly tokens created before this time.
limitintegerDefault 10, maximum 500.
offsetintegerDefault 0.

The response is pba_static_tokens, plus the total count in pba_static_tokens_aggregate. Each token has:

FieldDescription
static_token_id, tenant_token_refThe token, by Open Fabric ID and by your reference.
account_id, tenant_account_ref, customer_id, tenant_customer_refThe account and customer it belongs to.
dpan_redacted_number, dpan_expiryThe masked device PAN and its expiry.
fpan_redacted_number, fpan_expiryThe masked funding PAN and its expiry.
card_id, card_name, card_printed_name, card_type, card_reference_idCard details.
billing_name, billing_addressBilling details.
instrument, provisioned_byHow the token was provisioned.
typestatic_token for a virtual card, physical_card for a physical card.
provisioning_statusWhere issuance has reached; completed once the card is issued.
card_program_idThe Card Program the card was issued under.
status, lockedThe token's status, and whether it is locked.
created_at, updated_atTimestamps.

The response never contains a full PAN. To display card details, see Display a virtual card.

List devices​

POST /v1/reporting/rest/pba/devices returns devices, newest first.

FieldTypeDescription
device_idstring[]Open Fabric device IDs.
tenant_account_device_refstring[]Your device references.
secure_device_wallet_idstring[]Secure device wallet IDs.
tenantAccountRefstring[]Your account references, matched on the device's account.
tenantCustomerRefstring[]Your customer references, matched on the device's account.
customerIdstring[]Open Fabric customer IDs, matched on the device's account.
created_at_gtestringOnly devices created at or after this time.
created_at_ltstringOnly devices created before this time.
withCountbooleanInclude the total count. Default true.
limitintegerDefault 10, maximum 500.
offsetintegerDefault 0.

The response is pba_devices, plus pba_devices_aggregate when withCount is true. Each device has device_id, account_id, device_name, dpan_redacted_number, dpan_expiry, tenant_account_device_ref, secure_device_wallet_id, provisioned_by, status, locked, created_at and updated_at. It also has account, which holds tenant_account_ref and tenant_customer_ref.

List secure device wallets​

POST /v1/reporting/rest/pba/secure-device-wallets takes the same filters as List devices, and returns the same fields. The difference is that it returns one row per secure device wallet, not per device. When a wallet has had several devices, for example after your customer set up the app again, only the most recently created device is returned.

Results are sorted by secure_device_wallet_id. This endpoint ignores limit and offset, and returns at most 500 wallets. Narrow large result sets with filters, such as a created_at range.

Find secure device wallet IDs​

POST /v1/reporting/rest/pba/accounts/secure-wallet-ids returns only the secure device wallet IDs of accounts matching your references, grouped by account, with no pagination. Use it before calling an API that takes a secure device wallet ID, such as lock a secure device wallet.

List devices with tenantAccountRef or tenantCustomerRef returns the same IDs, with full device details.

FieldTypeDescription
tenantCustomerRefsstring[]Your customer references.
tenantAccountRefsstring[]Your account references.
Request
{ "tenantCustomerRefs": ["CUST-881"] }
Response
{
"pba_accounts": [
{ "devices": [ { "secure_device_wallet_id": "sdw_01J9Z0Q4X3" } ] }
]
}

Find the account of a secure device wallet​

POST /v1/reporting/rest/pba/devices/account does the reverse: it returns the device and account behind each secure device wallet ID.

FieldTypeDescription
secureDeviceWalletIdsstring[]Required. Secure device wallet IDs.
Request
{ "secureDeviceWalletIds": ["sdw_01J9Z0Q4X3"] }
Response
{
"pba_devices": [
{
"tenant_account_device_ref": "DEV-77",
"secure_device_wallet_id": "sdw_01J9Z0Q4X3",
"account": {
"account_id": "9f8e7d6c-5b4a-4321-8fed-cba987654321",
"tenant_customer_ref": "CUST-881",
"tenant_account_ref": "ACC-20031"
}
}
]
}

GraphQL queries​

Each endpoint is built on one of the queries below. The fields you send in the request body fill in its query. To fetch fewer fields or combine data, send your own version to the GraphQL endpoint.

pba-accounts.graphql
# /v1/reporting/rest/pba/accounts (POST)
#
# Scope: accounts.read
# Hasura query: allowed-queries/get-pba-accounts-post (REST url: pba/accounts)
#
# Generated from slice-graphql-service src/schema/v1/metadata/query_collections.yaml
# by docs/scripts/sync-reporting-graphql.mjs. Do not edit by hand.
query RestQuery ($limit: Int = 10, $offset: Int = 0, $accountId: [bpchar!], $customerId: [bpchar!], $tenantAccountRef: [String!], $status: [String!], $created_at_gte: timestamp = "2020-01-01", $created_at_lt: timestamp = "2120-01-01") {
pba_accounts(order_by: {created_at: desc}, limit: $limit, offset: $offset, where: {account_id: {_in: $accountId}, customer_id: {_in: $customerId}, tenant_account_ref: {_in: $tenantAccountRef}, status: {_in: $status}, created_at: {_gte: $created_at_gte, _lt: $created_at_lt}}) {
account_id
customer_id
tenant_account_ref
tenant_customer_ref
status
billing_currency_code
billing_address
provisioned_by
created_at
updated_at
devices {
device_id
device_name
status
locked
tenant_account_device_ref
secure_device_wallet_id
created_at
updated_at
}
static_tokens {
static_token_id
dpan_token_id
dpan_redacted_number
dpan_expiry
status
locked
created_at
updated_at
}
}
pba_accounts_aggregate(where: {account_id: {_in: $accountId}, customer_id: {_in: $customerId}, tenant_account_ref: {_in: $tenantAccountRef}, status: {_in: $status}, created_at: {_gte: $created_at_gte, _lt: $created_at_lt}}) {
aggregate {
count
}
}
}