Skip to main content
Read a capability

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Minimum string length: 1
capability_id
enum<string>
required
Available options:
pay_by_bank_uk_eu,
pay_by_bank_us,
payto_au,
virtual_accounts

Query Parameters

include
enum<string>[]

Link fields to hydrate into entities, comma-separated. Sending it replaces the default, which is required_agreements.

Available options:
required_agreements
view
enum<string>
default:full

The representation to answer with.

Available options:
full

Response

The capability, in the full view.

result
object
required
entities
object
required

Included linked resources, keyed by URI.

not_included
object[]
required