Payment Methods — Proposed Guide

Planned API — Reference Only

Payment Methods: A payment-method representation would identify an approved repayment instrument through a non-secret reference. Eligibility can depend on…

Overview

A payment-method representation would identify an approved repayment instrument through a non-secret reference. Eligibility can depend on currency, region and beneficiary authorization.

Key concepts

Separate method identity, validation status and operational availability. Do not store raw banking secrets in ordinary financial resources.

Implementation considerations

No methods can be enrolled here. Future design must document ownership, revocation and which provider is responsible for sensitive instrument data.

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": "Payment Methods",
  "payment_method_id": "payment_method_example_123",
  "method_type": "method type example",
  "currency": "USD",
  "status": "draft"
}

Design review checklist

Document which organization owns the payment methods representation and which actor may view or change it.
Test the boundaries of payment method id, method type, currency, status 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.
method_type	string	Illustrative method type value; interpret it only within the proposed topic-specific model described above.
currency	string	Uppercase ISO 4217 currency code. Determine its minor-unit exponent before monetary conversion.
status	string	Proposed lifecycle value. Its meaning depends on the resource and must not be inferred from HTTP success.

ACH Reimbursements

Reimbursements & Payments

Bank Accounts