API reference

This catalog is generated from the packed @capxul/sdk public surface. It contains one page for each of the 96 callable owners: createCapxulClient and every public method reachable from CapxulClient.

Every method page starts with its practical availability, then records usage or current unavailable behavior, the exact signature, parameters, return type, errors, source location, and React SDK equivalent when one exists.

Account

• Add an address-book entry — client.account.addressBook.add — Use the Core SDK to add an address-book entry.
• Get an address-book entry — client.account.addressBook.get — Use the Core SDK to get an address-book entry.
• Hide an address-book entry — client.account.addressBook.hide — Use the Core SDK to hide an address-book entry.
• Label an address-book entry — client.account.addressBook.label — Use the Core SDK to label an address-book entry.
• List address-book entries — client.account.addressBook.list — Use the Core SDK to list address-book entries.
• Unhide an address-book entry — client.account.addressBook.unhide — Use the Core SDK to unhide an address-book entry.
• Get account lifecycle — client.account.getLifecycle — Read the personal Account setup lifecycle.
• Approve an inbox request — client.account.inbox.approve — Use the Core SDK to approve an inbox request.
• Decline an inbox request — client.account.inbox.decline — Use the Core SDK to decline an inbox request.
• List inbox requests — client.account.inbox.list — Use the Core SDK to list inbox requests.
• Get deposit instructions — client.account.profile.depositInstructions — Use the Core SDK to get deposit instructions.
• Get the profile — client.account.profile.get — Use the Core SDK to get the profile.
• Cancel a request — client.account.requests.cancel — Use the Core SDK to cancel a request.
• Get a request — client.account.requests.get — Use the Core SDK to get a request.
• Issue a request — client.account.requests.issue — Use the Core SDK to issue a request.
• List requests — client.account.requests.list — Use the Core SDK to list requests.
• Retry account setup — client.account.retrySetup — Use the Core SDK to retry account setup.
• Read account balance — client.accounts.read — Read the personal Account balance as domain Money.
• Load the smart account — client.smartAccount.loadCurrent — Use the Core SDK to load the smart account.
• Provision a smart account — client.smartAccount.provision — Use the Core SDK to provision a smart account.

Activity

• Annotate activity — client.activity.annotate — Add an accounting annotation to one activity row.
• Get activity details — client.activity.get — Read the details for one activity row.
• List activity — client.activity.list — List activity rows, bounded by a time range and filters.
• Summarize activity — client.activity.summary — Total one window of activity into per-currency in, out, net and pending-in buckets.

Authentication

• Check OTP availability — client.auth.canSendOtp — Use the Core SDK to check OTP availability.
• Get the session — client.auth.getSession — Use the Core SDK to get the session.
• Sign in — client.auth.signIn — Start email sign-in and request a one-time code.
• Sign out — client.auth.signOut — Use the Core SDK to sign out.
• Verify an OTP — client.auth.verifyOtp — Verify a one-time code and establish a session.

Client setup

• Read current holdings — client.holdings.current — Read the current native-token and USDX holdings.
• Read the primary holding — client.holdings.primary — Read the designated display holding.
• Set org logo — client.media.setOrgLogo — Use the Core SDK to set org logo.
• Set profile image — client.media.setProfileImage — Use the Core SDK to set profile image.
• Upload image — client.media.uploadImage — Use the Core SDK to upload image.
• Health — client.system.health — Use the Core SDK to health.
• Create a client — createCapxulClient — Create a production Core SDK client from a publishable key.

Destinations

• Add a destination — client.destinations.add — Use the Core SDK to add a destination.
• List destinations — client.destinations.list — Use the Core SDK to list destinations.
• Remove a destination — client.destinations.remove — Use the Core SDK to remove a destination.

Documents

• Render a payment document — client.paymentDocuments.render — Use the Core SDK to render a payment document.
• Verify a payment document — client.paymentDocuments.verify — Use the Core SDK to verify a payment document.

Identity

• Get the current user — client.currentUser.get — Use the Core SDK to get the current user.
• Load the current identity — client.identity.loadCurrent — Use the Core SDK to load the current identity.
• Username available — client.identity.usernameAvailable — Use the Core SDK to username available.
• Get personal deposit instructions — client.me.depositInstructions — Use the Core SDK to get personal deposit instructions.
• Get the personal profile — client.me.get — Use the Core SDK to get the personal profile.

Offramp

• Get an offramp quote — client.offramp.quote — Offramp quotes are not currently available; the method returns NOT_IMPLEMENTED.
• Get offramp status — client.offramp.status — Offramp status is not currently available; the method returns NOT_IMPLEMENTED.

Onboarding

• Complete Organization onboarding — useCapxulAuth().createOrganization — Use the React SDK facade to reach claimed Account and ready Organization lifecycle before returning {ok:true,orgId}; durable setup failures return {ok:false,reason} and remain in useCapxulIdentity() with their recorded retryability.
• Complete personal onboarding — useCapxulAuth().completePersonal — Use the React SDK facade to refresh the Profile, ensure claimed or counterfactual Account readiness, and return {ok:true}.

Organizations

• Create an Organization — client.createOrg — Create an Organization and return its public view.
• Get the Organization Account — client.org(orgId).account.get — Use the Core SDK to get the Organization Account.
• Add an address-book entry — client.org(orgId).addressBook.add — Use the Core SDK to add an address-book entry.
• Get an address-book entry — client.org(orgId).addressBook.get — Use the Core SDK to get an address-book entry.
• Hide an address-book entry — client.org(orgId).addressBook.hide — Use the Core SDK to hide an address-book entry.
• Label an address-book entry — client.org(orgId).addressBook.label — Use the Core SDK to label an address-book entry.
• List address-book entries — client.org(orgId).addressBook.list — Use the Core SDK to list address-book entries.
• Unhide an address-book entry — client.org(orgId).addressBook.unhide — Use the Core SDK to unhide an address-book entry.
• View the audit log — client.org(orgId).auditLog — Organization audit-log listing is not currently available; the method returns NOT_IMPLEMENTED.
• Get Organization lifecycle — client.org(orgId).getLifecycle — Read one Organization's durable setup lifecycle.
• Approve an inbox request — client.org(orgId).inbox.approve — Approve an Organization inbox request with a Budget Permission.
• Decline an inbox request — client.org(orgId).inbox.decline — Use the Core SDK to decline an inbox request.
• List inbox requests — client.org(orgId).inbox.list — Use the Core SDK to list inbox requests.
• Invite a member — client.org(orgId).invite — Use the Core SDK to invite a member.
• Get your own standing — client.org(orgId).me — Use the Core SDK to get your own standing.
• List members — client.org(orgId).members — Use the Core SDK to list members.
• Make a payment — client.org(orgId).payments.pay — Use the Core SDK to make a payment.
• Make Organization payments — client.org(orgId).payments.payBatch — Use the Core SDK to make Organization payments.
• Assign a Permission — client.org(orgId).permissions.assign — Assign a Permission to an Account.
• Change a Permission — client.org(orgId).permissions.change — Change an Organization Permission.
• Create a Permission — client.org(orgId).permissions.create — Create an Organization Permission.
• Get a Permission — client.org(orgId).permissions.get — Read one Organization Permission.
• List Permissions — client.org(orgId).permissions.list — List Organization Permissions.
• Replace a Permission — client.org(orgId).permissions.replace — Replace the Organization Permission set.
• Revoke a Permission assignment — client.org(orgId).permissions.revoke — Revoke a Permission assignment.
• Get deposit instructions — client.org(orgId).profile.depositInstructions — Use the Core SDK to get deposit instructions.
• Get the profile — client.org(orgId).profile.get — Use the Core SDK to get the profile.
• Cancel a request — client.org(orgId).requests.cancel — Use the Core SDK to cancel a request.
• Get a request — client.org(orgId).requests.get — Use the Core SDK to get a request.
• Issue a request — client.org(orgId).requests.issue — Use the Core SDK to issue a request.
• List requests — client.org(orgId).requests.list — Use the Core SDK to list requests.
• Retry Organization setup — client.org(orgId).retrySetup — Resume one Organization's durable setup lifecycle.
• List roles — client.org(orgId).roles — Use the Core SDK to list roles.
• Get Organization treasury — client.org(orgId).treasury — Use the Core SDK to get Organization treasury.
• List Organizations — client.orgs — List Organizations for the current session.
• Accept pending invitations — client.orgs.detectAndAcceptPendingInvitations — Use the Core SDK to accept pending invitations.

Payments

• Cancel a payment — client.payments.cancel — Cancel a recoverable Commitment.
• Claim a payment — client.payments.claim — Use the Core SDK to claim a payment.
• Create a Commitment — client.payments.createCommitment — Use the Core SDK to create a Commitment.
• Get a payment — client.payments.get — Use the Core SDK to get a payment.
• List payments — client.payments.list — Use the Core SDK to list payments.
• Make a payment — client.payments.pay — Record a validated-recipient payment through the Core SDK.
• Redirect a payment — client.payments.redirect — Use the Core SDK to redirect a payment.

Recipients

• Resolve a handle — client.handles.resolve — Use the Core SDK to resolve a handle.
• Create a payee — client.payees.create — Use the Core SDK to create a payee.
• Get a payee — client.payees.get — Use the Core SDK to get a payee.
• Resolve a payee — client.payees.resolve — Use the Core SDK to resolve a payee.
• Resolve a target — client.targets.resolve — Use the Core SDK to resolve a target.