Get the current agent's own spendable balance for a specific currency. A balance is considered spendable if it has been verified as having arrived in the Payman wallet and is reduced according to any  applicable spend limit controls. The balance will be returned in the  currency's full units (e.g. '1.00' is $1 in USD, '1.000000' is 1 USDC). 

Get Balance

x payman api secret

Bad Requesst - the request body or parameters are invalid.

Unauthorized - the caller is not authenticated.  Please check the API key and Agent ID headers.

Forbidden - the caller does not have sufficient permissions

Not found - the requested entity does not exist

Internal server error - an unknown error occurred while processing the request. Please try again or contact support.

Get current agent's spendable balance of a specific currency

Payman AI Documentation

Built-in controls for AI Agents to safely send payments

Quickstart

Quickly integrate PaymanAI's SDK into your AI Agent

Setup & Installation

Your AI Agent can add approved payees it can send money to - humans, AI agents, or crypto wallets

Create Payees

Send money to approved payees with your AI Agent

Send Payments

The search function allows your AI Agent to find who it is approved to pay.

Search Payees

The balances function allows your AI Agent to check how much money it can spend.

Check Balances

Create an AI-powered application that extracts payment details from bills and processes payments

Bill Pay AI Agent

Get your Access key to connect your AI Agent to Payman

Get Access Key

REST API for AI Agents to interact with the Payman platform

API Reference

Error Handling

Sends funds from an agent controlled wallet to a payee.

Send Payment

Create a new payee (aka payee) for future payments to be sent to

Create Payee

Searches existing payee for potential matches.  Additional confirmation from the user is required to verify the correct payee is selected.

Introduction

Paykit

Learn how to register and configure your AI Agent for payments

Register AI Agent

Enable your AI Agent to send funds securely

Enable instant, zero-fee transfers between AI Agents

Agent-to-Agent Payments

Enable your AI Agent to accept and manage customer funds

Customer Deposits

Configure powerful safety controls for your AI Agent's spending

Spending Controls

Add funds to your AI Agent's wallet securely

Funding Sources

Add payment capabilities to your Vercel AI SDK application

Vercel AI SDK

Use Paykit with OpenAI's function calling

OpenAI SDK

Anthropic

LangChain

Get real-time updates for your AI Agent's activities

Webhooks

Learn how to integrate Payman's Node.js SDK into your application

Node.js SDK

Learn how to send payments using your AI Agent

Learn how to search for existing payment destinations

Learn how to create payment destinations for your AI Agent

Learn how to generate checkout links for customer deposits

Learn how to check available balances for your AI Agent and customers

Learn how to integrate Payman's Python SDK into your application

Python SDK

Authentication

Sends funds from an agent controlled wallet to a payment destination.

Create a new payee (aka payment destination) for future payments to be sent to

Initiates the creation of a checkout link, through which the customer can add funds to the agent's wallet.  For example this could be used to have your customer pay for some activity the agent is going to undertake on their behalf.  The returned JSON checkoutUrl property will contain a URL that the customer can visit to complete the payment.

Generate Customer Deposit Link

Searches existing payee for potential matches.  Additional confirmation from the user is required to verify the correct payment destination is selected.

Get the current agent's own spendable balance for a specific curreny. A balance is considered spendable if it is not reserved for open tasks and has been verified as having arrived in the Payman wallet. The balance will be returned in the  currency's full units (e.g. '1.000000' is 1 USDC). 

Get Spendable Balance for Currency

Get a customer's spendable balance for a specific curreny. A balance is considered spendable if it is not reserved for open tasks and has been verified as having arrived in the Payman wallet. The balance will be returned in the  currency's full units (e.g. '1.000000' is 1 USDC). The customer ID provided can be either a Payman customer ID or the customer ID you provided when you first referenced the customer (e.g. when creating a checkout link or creating a task).

Overview

For Developers

Guides

APIs

API Endpoints

Get Balance

Authorizations

Path Parameters

Response