POST
/
payments
/
customer-deposit-link

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.

customerId
string
required

The ID of the customer to deposit funds for. This can be any unique ID as held within your system.

customerEmail
string

An email address to associate with this customer.

customerName
string

A name to associate with this customer.

feeMode
enum<string>

Determines whether to add any processing fees to the requested amount. If set to INCLUDED_IN_AMOUNT, the customer will be charged the exact amount specified, and fees will be deducted from that before the remainder is deposited in the wallet. If set to ADD_TO_AMOUNT, the customer will be charged the amount specified plus any fees required. Defaults to 'INCLUDED_IN_AMOUNT'.

Available options:
INCLUDED_IN_AMOUNT,
ADD_TO_AMOUNT
memo
string

A memo to associate with any transactions created in the Payman ledger.

metadata
object
walletId
string

The ID of the wallet you would like the customer to add funds to. Only required if the agent has access to more than one wallet.

Response

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

A URL that you can redirect the user to in order to complete the deposit.