> ## Documentation Index > Fetch the complete documentation index at: https://docs.stableyard.fi/llms.txt > Use this file to discover all available pages before exploring further. # Get bank account requirements by country > Read each country's bank account fields and whether linking is available there. Returns one entry per country with its currency, `implementation` (`supported` or `planned`), `available` flag, `unavailableReason`, and a strict JSON Schema for the bank fields. The field schemas are the same ones server validation uses. Use the actual country code, not `EU` or `AU` as a bloc identifier. Availability requires an implemented adapter, configured storage with a recent successful KMS write probe for every implemented country, and an enabled route for your app. Probe results are cached for up to 30 seconds, so a link can still fail if availability changes in between. Planned bank and shortcut-identifier profiles never enable money movement. Then [link the bank account](/api-reference/bank-accounts/link-bank-account). See [Off-ramps](/payments/off-ramps). ## OpenAPI ````yaml openapi.json GET /v2/accounts/{accountId}/bank-account-requirements openapi: 3.1.0 info: title: Stableyard Partner API version: 2.0.0-staging x-stableyard-api-version: '2026-09-09' x-stableyard-supported-api-versions: - '2026-09-09' summary: Backend API for UPAs, Payments, activity, and optional financial products. description: > Use this API from a trusted partner backend with an app ID and app secret. ## Recommended integration 1. Call `GET /v2/partners/config` to verify credentials and discover enabled capabilities. 2. Create a UPA only when your product needs a persistent Stableyard account. 3. Create a receive or send Payment with `POST /v2/payments`. 4. Redirect a payer to the returned `paymentUrl` or pass the Payment credentials to an official Stableyard interface SDK. 5. Process signed webhooks and fetch the Payment by ID for reconciliation. Checkout execution and account-bound browser endpoints are intentionally documented in the separate Interfaces & SDKs reference. Console endpoints are dashboard implementation details and are not part of the partner integration contract. x-stableyard-documentation-surface: partner servers: - url: https://prod-api.stableyard.fi description: Production - url: https://staging-api-v2.stableyard.fi description: Staging - url: http://localhost:3001 description: Local security: [] tags: - name: Authentication x-displayName: API authentication description: Verify your app ID and app secret before calling UPA APIs. - name: Accounts x-displayName: UPA Accounts description: Create Universal Payment Accounts and manage account settings. - name: Deposit Addresses description: Create reusable receive addresses and verify inbound deposits. - name: Identity & KYC description: >- Verify the UPA email and run provider-neutral identity verification. Managed vaults and fiat payment rails use this same verified UPA identity. - name: Vaults description: >- Create Safe/Zodiac controlled stablecoin vaults and manage policy updates for accounts. - name: Payments description: >- Create escrow-first payments, issue partner-authenticated send instructions or executions, power public checkout, and reconcile collection through final account settlement. - name: Balances & Transactions description: >- Read Stableyard-posted financial activity. Balances are ledger projections of activity Stableyard processed; they are not live balances of externally controlled wallets. paths: /v2/accounts/{accountId}/bank-account-requirements: get: tags: - Accounts summary: Get country-specific bank fields and linking availability description: >- Field schemas are shared with server validation. availability requires an implemented adapter, configured storage with a recent successful KMS write probe for every implemented country, and an enabled app route. KMS probe results are cached for up to 30 seconds; an actual link write can still fail if availability changes. Planned bank and shortcut-identifier profiles never enable money movement. Use the actual country code, not EU or AU as a bloc identifier. operationId: getBankAccountRequirements parameters: - name: accountId in: path required: true schema: type: string example: acct_123 description: Canonical account id returned by the Accounts API. - name: Stableyard-Version in: header required: false schema: type: string enum: - '2026-09-09' description: >- Optional contract-version assertion. Omit it to use the app environment's pinned version. A different supported version is accepted only after that environment is explicitly migrated. responses: '200': description: Bank field requirements headers: Stableyard-Version: description: >- Effective date-based Stableyard API contract version for this response. schema: type: string enum: - '2026-09-09' content: application/json: schema: $ref: '#/components/schemas/BankAccountRequirementsResponse' examples: requirements: value: version: 1 accountId: acct_123 countries: - country: PH name: Philippines currency: PHP implementation: supported schema: type: object additionalProperties: false properties: country: type: string const: PH currency: type: string const: PHP accountHolderName: type: string title: Recipient name minLength: 1 maxLength: 160 beneficiaryType: type: string title: Beneficiary type enum: - individual - business default: individual bankName: type: string title: Bank name minLength: 1 maxLength: 160 bankCode: type: string title: Bank code minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_-]+$ x-bank-directory: true accountNumber: type: string title: Account number minLength: 4 maxLength: 34 pattern: ^[0-9]{4,34}$ writeOnly: true x-normalize: digits rail: type: string const: bank_transfer default: bank_transfer required: - country - currency - accountHolderName - bankName - bankCode - accountNumber alternatives: - id: gcash label: GCash mobile number fields: identifier: type: string title: GCash mobile number minLength: 1 maxLength: 160 writeOnly: true resourceType: payment_rail_identifier available: false - id: maya label: Maya mobile number fields: identifier: type: string title: Maya mobile number minLength: 1 maxLength: 160 writeOnly: true resourceType: payment_rail_identifier available: false available: true unavailableReason: null '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '424': $ref: '#/components/responses/FailedDependency' '429': $ref: '#/components/responses/TooManyRequests' security: - partnerBasicAuth: [] components: schemas: BankAccountRequirementsResponse: type: object additionalProperties: false required: - version - accountId - countries properties: version: type: integer const: 1 accountId: type: string countries: type: array items: type: object additionalProperties: false required: - country - name - currency - implementation - schema - alternatives - available - unavailableReason properties: country: type: string pattern: ^[A-Z]{2}$ name: type: string currency: type: string pattern: ^[A-Z]{3}$ implementation: type: string enum: - supported - planned available: type: boolean unavailableReason: type: - string - 'null' schema: type: object additionalProperties: true description: >- Strict JSON Schema for country-specific bank fields, including normalization and bank-directory annotations. alternatives: type: array items: type: object additionalProperties: false required: - id - label - fields - resourceType - available properties: id: type: string label: type: string fields: type: object additionalProperties: true resourceType: type: string const: payment_rail_identifier available: type: boolean const: false ErrorResponse: type: object additionalProperties: false required: - error properties: error: type: object additionalProperties: false required: - code - message properties: code: type: string minLength: 1 maxLength: 128 example: bad_request message: type: string minLength: 1 maxLength: 1000 example: The request is invalid details: {} responses: BadRequest: description: Bad request headers: Stableyard-Version: description: >- Effective date-based Stableyard API contract version for this response. schema: type: string enum: - '2026-09-09' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: example: summary: BadRequest response value: error: code: bad_request message: The request is invalid details: example Unauthorized: description: Unauthorized headers: Stableyard-Version: description: >- Effective date-based Stableyard API contract version for this response. schema: type: string enum: - '2026-09-09' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: example: summary: Unauthorized response value: error: code: bad_request message: The request is invalid details: example Forbidden: description: The app secret does not include the required scope headers: Stableyard-Version: description: >- Effective date-based Stableyard API contract version for this response. schema: type: string enum: - '2026-09-09' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: example: summary: Forbidden response value: error: code: bad_request message: The request is invalid details: example NotFound: description: Not found headers: Stableyard-Version: description: >- Effective date-based Stableyard API contract version for this response. schema: type: string enum: - '2026-09-09' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: example: summary: NotFound response value: error: code: bad_request message: The request is invalid details: example Conflict: description: Conflict headers: Stableyard-Version: description: >- Effective date-based Stableyard API contract version for this response. schema: type: string enum: - '2026-09-09' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: example: summary: Conflict response value: error: code: bad_request message: The request is invalid details: example FailedDependency: description: Required chain, network, or provider configuration is missing headers: Stableyard-Version: description: >- Effective date-based Stableyard API contract version for this response. schema: type: string enum: - '2026-09-09' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: example: summary: FailedDependency response value: error: code: bad_request message: The request is invalid details: example TooManyRequests: description: >- Rate limit, payment-option limit, selection cooldown, or temporary abuse block headers: Stableyard-Version: description: >- Effective date-based Stableyard API contract version for this response. schema: type: string enum: - '2026-09-09' Retry-After: description: Seconds until the caller should retry. schema: type: integer minimum: 1 RateLimit-Limit: description: Quota for the most constrained policy. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requests remaining in that policy window. schema: type: integer minimum: 0 RateLimit-Reset: description: Seconds until that policy window resets. schema: type: integer minimum: 0 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: example: summary: TooManyRequests response value: error: code: bad_request message: The request is invalid details: example securitySchemes: partnerBasicAuth: type: http scheme: basic description: >- HTTP Basic auth. Username is the Stableyard app ID. Password is the app secret. The optional Stableyard-Version request header must match the environment pin. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.