Skip to main content
GET
Get withdrawal limits

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}$

Query Parameters

schema
string
required

Payout schema identifier.

Required string length: 1 - 512
currency
string

Optional withdrawal currency filter.

Pattern: ^[A-Z]{3}$
account_type
string

Optional account-type filter.

Required string length: 1 - 128

Response

The normalized withdrawal limits.

Current provider-stated withdrawal economics for one payout schema.

currency
string
required

Withdrawal currency.

Pattern: ^[A-Z]{3}$
minimum_amount
string
required

Minimum withdrawal amount.

Pattern: ^(?:0|[1-9]\d*)(?:\.\d+)?$
maximum_amount
string
required

Maximum withdrawal amount.

Pattern: ^(?:0|[1-9]\d*)(?:\.\d+)?$
fee_fixed
string
required

Fixed withdrawal fee.

Pattern: ^(?:0|[1-9]\d*)(?:\.\d+)?$
fee_basis_points
string
required

Variable fee in basis points.

Pattern: ^(?:0|[1-9]\d*)(?:\.\d+)?$
rail
string
required

Normalized payout rail.

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

Memo support and bounds.

purpose_codes
string[]
required

Accepted purpose codes.

Maximum array length: 256
Required string length: 1 - 128