Generate Customer Deposit Link
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.
Authorizations
Body
The amount to generate a checkout link for. For example, '10.00' for USD is $10.00 or '1.000000' USDCBASE is 1 USDC.
The ID of the customer to deposit funds for. This can be any unique ID as held within your system.
An email address to associate with this customer.
A name to associate with this customer.
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'.
INCLUDED_IN_AMOUNT
, ADD_TO_AMOUNT
A memo to associate with any transactions created in the Payman ledger.
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
A URL that you can redirect the user to in order to complete the deposit.