Evenbead docs
Contents

Payments

13 operations. All areas

GET/v1/online-payments/settings

The payments add-on: whether online payments are on, Stripe's status for the company's account (requirements due, charges and payouts enabled), payment methods, the accounts payments post to and what Stripe holds per the books

  • Operation getPaymentsSettings
  • Scope: read
  • Read
Responses
  • 200 Settings (object)
  • Errors 400, 401, 403, 409, 429, 500, 503 (Error: error.type, message)

POST/v1/online-payments/settings

Switch online payments on or off; accept cards and/or bank payments (ACH); allow part payments on new pay links; choose the clearing, fees, refunds and chargebacks accounts (created when first switched on unless given) and the bank account payouts arrive in. The company's own owner or CPA, signed in (agents, AI apps and firm members refused). Not an MCP tool.

  • Operation updatePaymentsSettings
  • Scope: admin
  • Write: sets a value, no Idempotency-Key needed
Request body
  • enabled boolean
  • accept_card boolean
  • accept_ach boolean
  • accept_stablecoin boolean
  • allow_partial boolean
  • clearing_account string
  • fees_account string
  • refunds_account string
  • chargebacks_account string
  • payout_bank_account_id string | null
Responses
  • 200 Settings (object)
  • Errors 400, 401, 403, 409, 422, 429, 500, 503 (Error: error.type, message)

POST/v1/online-payments/onboarding

Set up payments: makes the company's own Stripe account (once) and returns Stripe's hosted onboarding page, where the business gives Stripe its identity and bank details (Evenbead never sees them). The company's own owner or CPA, signed in (agents, AI apps and firm members refused). Not an MCP tool.

  • Operation startPaymentsOnboarding
  • Scope: admin
  • Write: sets a value, no Idempotency-Key needed
Request body

Empty object {}.

Responses
  • 200 Send the person's browser to url (single use, a few minutes) (object)
  • Errors 400, 401, 403, 409, 422, 429, 500, 503 (Error: error.type, message)

POST/v1/online-payments/sync

Read the company's Stripe account state now (after onboarding). The company's own owner or CPA, signed in (agents, AI apps and firm members refused). Not an MCP tool.

  • Operation syncPayments
  • Scope: admin
  • Write: sets a value, no Idempotency-Key needed
Request body

Empty object {}.

Responses
  • 200 Settings (object)
  • Errors 400, 401, 403, 409, 422, 429, 500, 503 (Error: error.type, message)

GET/v1/online-payments

Payments customers made online (card and bank), newest first: status, fees, refunds, disputes and whether each is in the books

  • Operation listOnlinePayments
  • Scope: read
  • Read
Parameters
  • document_id query, string
  • status query, "pending" | "succeeded" | "failed"
  • limit query, integer
Responses
  • 200 Payments (object)
  • Errors 400, 401, 403, 409, 429, 500, 503 (Error: error.type, message)

GET/v1/online-payments/charges/{id}

One online payment: its refunds, disputes and every Stripe balance transaction with what it became in the books

  • Operation getOnlinePayment
  • Scope: read
  • Read
Parameters
  • id path, string, required
Responses
  • 200 The payment (object)
  • Errors 400, 401, 403, 404, 409, 429, 500, 503 (Error: error.type, message)

POST/v1/online-payments/charges/{id}/refund

Refund all or part of an online payment to the customer's card or bank (our 0.3% goes back in proportion; Stripe keeps its fee). Books: a credit memo to the refunds account and a refund out of the clearing account, posted when Stripe confirms. dry_run shows exactly that. The company's own owner or CPA, signed in (agents, AI apps and firm members refused). Not an MCP tool.

  • Operation refundOnlinePayment
  • Scope: approve
  • Write: needs Idempotency-Key (or dry_run)
Parameters
  • id path, string, required
Request body
  • amount_cents integer
  • reason string, required
  • dry_run boolean
Responses
  • 200 Dry run
  • 201 Asked of Stripe (object)
  • Errors 400, 401, 403, 404, 409, 422, 429, 500, 503 (Error: error.type, message)

GET/v1/online-payments/payouts

Payouts from Stripe to the company's bank, newest first, with the bank line each was matched to

  • Operation listPayouts
  • Scope: read
  • Read
Parameters
  • limit query, integer
Responses
  • 200 Payouts (object)
  • Errors 400, 401, 403, 409, 429, 500, 503 (Error: error.type, message)

GET/v1/online-payments/payouts/{id}

One payout's reconciliation: the payments, fees, refunds and disputes it carried, whether they add up to the deposit, and the bank line it matched

  • Operation getPayout
  • Scope: read
  • Read
Parameters
  • id path, string, required
  • format query, "json" | "csv"
Responses
  • 200 The payout (object)
  • Errors 400, 401, 403, 404, 409, 429, 500, 503 (Error: error.type, message)