Bank Accounts — Proposed Guide

Planned API — Reference Only

Bank Accounts: A proposed bank-account reference should represent a provider-held instrument, not publish an account number. The ordinary API…

Overview

A proposed bank-account reference should represent a provider-held instrument, not publish an account number. The ordinary API representation should contain only necessary masked metadata.

Key concepts

Use a non-secret reference and distinguish account owner from the employee requesting reimbursement. Keep verification evidence separate.

Implementation considerations

Do not enter bank details into this website. This page provides no collection form, account connection or provider onboarding flow.

Illustrative data model

This local fixture shows a possible representation for the concepts above. It is not an endpoint response, production configuration or a claim that the described capability is implemented.

JSON fixture

Fictional concept fixture

{
  "reference_only": true,
  "topic": "Bank Accounts",
  "payment_method_id": "payment_method_example_123",
  "masked_label": "masked label example",
  "verification_status": "verification status example",
  "country": "US"
}

Design review checklist

Document which organization owns the bank accounts representation and which actor may view or change it.
Test the boundaries of payment method id, masked label, verification status, country using synthetic values, including missing or inconsistent references.
Before future implementation, obtain an approved contract and review failure behavior. This documentation does not authorize production activation.

Proposed data types

Illustrative field dictionary
Name	Type	Description
payment_method_id	string	Stable fictional payment method reference; not a secret and not evidence that a resource exists.
masked_label	string	Illustrative masked label value; interpret it only within the proposed topic-specific model described above.
verification_status	string	Illustrative verification status value; interpret it only within the proposed topic-specific model described above.
country	string	Illustrative country code; it does not establish regional product availability.

Payment Methods

Reimbursements & Payments

Bank Account Verification