Skip to main content
GET
Get a beneficiary virtual account

Authorizations

DPoP
string
header
required

Per-request RFC 9449 DPoP proof signed with ES256. Protected requests use Authorization: DPoP your_access_token_here. Create a new proof for the exact method and normalized target URI, and include the server nonce when challenged.

Authorization
string
header
required

OAuth 2.0 with RFC 9700 security practices. Discover exact environment endpoints from /.well-known/openid-configuration and /.well-known/oauth-authorization-server, and discover the resource from /.well-known/oauth-protected-resource. Authorization-code clients use PKCE S256, the exact environment resource, nonce with openid, and DPoP binding. Confidential clients also require PAR and private_key_jwt. Access and refresh tokens are sender-constrained with DPoP. purchases:execute is unavailable and omitted from this scope registry.

Headers

X-Request-Id
string

Optional caller request identifier. Unsafe values are replaced with a generated UUID.

Pattern: ^[A-Za-z0-9._~-]{8,128}$

Path Parameters

id
string<uuid>
required

API-owned opaque beneficiary identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

The beneficiary’s safe virtual-account economics.

Safe virtual-account economics without deposit addresses, memos, provider IDs, or keys.

beneficiary_id
string<uuid>
required

API-owned opaque beneficiary identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
currency_in
string
required

Accepted funding asset or currency.

Pattern: ^[A-Z][A-Z0-9._-]{0,31}$
currency_out
string
required

Payout asset or currency.

Pattern: ^[A-Z][A-Z0-9._-]{0,31}$
rail_out
string
required

Normalized payout rail.

Required string length: 1 - 128
Pattern: ^[a-z0-9]+(?:[._-][a-z0-9]+)*$
minimum_amount
string
required

Minimum source amount.

Pattern: ^(?:0|[1-9]\d{0,37})(?:\.\d{1,18})?$
maximum_amount
string
required

Maximum source amount.

Pattern: ^(?:0|[1-9]\d{0,37})(?:\.\d{1,18})?$
fee_fixed
string
required

Fixed provider fee.

Pattern: ^(?:0|[1-9]\d{0,37})(?:\.\d{1,18})?$
fee_basis_points
string
required

Variable provider fee in basis points.

Pattern: ^(?:0|[1-9]\d{0,37})(?:\.\d{1,18})?$
application_fee_basis_points
string | null
required

Application fee in basis points, or null when this read does not state it.

Pattern: ^(?:0|[1-9]\d{0,37})(?:\.\d{1,18})?$
purpose_codes
string[]
required

Accepted purpose codes.

Maximum array length: 500

Non-empty safe display text.

Required string length: 1 - 4096