Discord

Twitter

Payman API Documentation

API & SDKs

Dashboard

Support

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

x payman api secret

Get current agent's spendable balance of a specific currency

Introduction

Start integrating Payman in less than 5 minutes

Quickstart

Add your AI Agent to your account to give it access to capital

Register AI Agent

Have your AI initiate payments via Payman

Sending Payments

Agent to Agent Payments

Enable direct user funding for your AI Agent

Customer Deposits

Powerful spending controls through an easy-to-use dashboard

Agent Spending Controls

Securely fund your AI Agent while maintaining full control

Funding Sources

Receiving responses

Start using Payman in your Node.js environment

Installation

Send Payments

Your AI Agents list of sending funds to pre-approved payees

Search Available Payees

Add new payment destinations for your AI Agent to send funds

Create a Payee

Give your AI Agent the ability to collect funds

Get how much your AI Agent can spend (per agent or per customer)

Get Balances

Start using Payman in your Python environment

Authentication

Error Handling

Pagination

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

Send Payment

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

Create Payee

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.

Search Payees

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).

SDKs

APIs

API Endpoints

Get Spendable Balance for Currency

Authorizations

Path Parameters

Response