POST
/
payments
/
send-payment
curl --request POST \
  --url https://agent.payman.ai/api/payments/send-payment \
  --header 'Content-Type: application/json' \
  --header 'x-payman-api-secret: <api-key>' \
  --data '{
  "walletId": "<string>",
  "amountDecimal": 123,
  "payeeId": "<string>",
  "memo": "<string>",
  "metadata": {}
}'
{
  "reference": "<string>",
  "externalReference": "<string>",
  "status": "INITIATED"
}

Authorizations

​
x-payman-api-secret
string
header
required

Body

application/json
​
amountDecimal
number
required

The amount to generate a checkout link for. For example, '10.00' for USD is $10.00 or '1.000000' USDCBASE is 1 USDC.

​
payeeId
string
required

The id of the payee you want to send the funds to. This must have been created using the /payments/payees endpoint or via the Payman dashboard before sending.

​
walletId
string

The ID of the specific wallet from which to send the funds. This is only required if the agent has access to multiple wallets (not the case by default).

​
memo
string

A note or memo to associate with this payment.

​
metadata
object

Response

200
application/vnd.payman.v1+json
The payment was successful.
​
reference
string
required

The Payman reference of the payment

​
status
enum<string>
required

The status of the payment

Available options:
INITIATED,
AWAITING_APPROVAL,
REJECTED
​
externalReference
string

The external reference of the payment if applicable (e.g. a blockchain transaction hash)