GET
View an organization money account (organization)
Organization space User accounts only For: Administrator, Accountant · Permission: money_accounts.retrieve Part of Money accounts and payment methods.

Authorizations

Authorization
string
header
required

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

Path Parameters

moneyAccountId
string
required

Identifier of the money account (27-character KSUID string).

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, name, type, accepted_payment_methods, is_active, provider, provider_reference, supports_incoming, supports_outgoing, organization_id, accounting_account_id, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: companies.

Response

200 - application/json

Resource.

id

Identifier of the money account (27-character KSUID string).

name

Name of the account, unique within the organization.

type

Kind of account: bank or mobile_money.

accepted_payment_methods
any[]

Payment methods this account accepts, derived from its type (bank: bank_transfer, cheque, credit_card; mobile_money: mobile_money) and limited to the methods the organization's pricing plan allows.

is_active
boolean

Whether the account is switched on.

provider

Mobile money provider (orange_money, mtn_momo, moov_money, wave, cinetpay, paydunya, fedapay or other). Only organization sessions see it; null for a bank account.

provider_reference

Free reference of the account at the provider, for mobile money accounts. Only organization sessions see it.

supports_incoming
boolean

Whether the current company may receive payments through the account. Only returned in the company space.

supports_outgoing
boolean

Whether the current company may send payments through the account. Only returned in the company space.

organization_id

Identifier of the organization the record belongs to.

accounting_account_id

Identifier of the matching account in the organization's books, created with the money account. Only organization sessions see it.

companies
array

Companies linked to the account with their directions. Returned only to organization sessions and only when requested with include=companies.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).