Skip to main content
POST
Add payment method
This account operation requires a user-authorized human:actions OAuth grant. It has no personal AI ID in its public path. Enrollment is bound to an immutable payment request and requires explicit save consent. The hosted provider collects card or bank details; this API never accepts them. A verified method can be listed under Account → Personal, but enrollment itself does not charge or settle the request. A standalone setup without a thread request is not available yet. This integration remains release-gated until account ownership migration and live provider verification are complete.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
request
string
required

An immutable payment request from an account-owned thread.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9_-]+$
method
enum<string>
required

Funding method to enroll through the hosted provider.

Available options:
card,
bank

Explicit permission to save the verified method.

Allowed value: "save_payment_method"
idempotencyKey
string
required
Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$

Response

Authorized account metadata only.

setup
string
required
Required string length: 1 - 200
Pattern: ^[A-Za-z0-9_-]+$
status
enum<string>
required
Available options:
prepared,
dispatching,
awaiting_user,
processing,
verified,
failed,
expired,
cancelled
revision
integer
required
Required range: 0 <= x <= 9007199254740991
expiresAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
url
string<uri>
paymentMethodId
string
Required string length: 1 - 200
Pattern: ^[A-Za-z0-9_-]+$
Last modified on October 5, 2026