POST
/
payments
/
send-payment

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.

customerEmail
string

An email address to associate with this customer.

customerId
string

The ID of the customer on whose behalf you're transferring funds. This can be any unique ID as held within your system. Providing this will limit the spendableamounts to what the customer has already deposited (unless ignoreCustomerSpendLimits is set to true).

customerName
string

A name to associate with this customer.

ignoreCustomerSpendLimits
boolean

By default Payman will limit spending on behalf of a customer to the amount they have deposited. If you wish to ignore this limit, set this to true.

memo
string

A note or memo to associate with this payment.

metadata
object
paymentDestination
object

A cryptocurrency address-based payment destination

paymentDestinationId
string

The id of the payment destination you want to send the funds to. This must have been created using the /payments/destinations endpoint or via the Payman dashboard before sending. Exactly one of paymentDestination and paymentDestinationId must be provided.

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

Response

200 - application/vnd.payman.v1+json
reference
string
required

The Payman reference of the payment

externalReference
string

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