API DocsAPI Docs / Payments / Deposit

POST /api/v1/payments/deposit

Creates a deposit request for the authenticated user to add funds to their account.

Permission	Description
`payments.view_own`	Access the payment system
`payments.deposit`	Deposit money into own account

Name	Type	Required	Description	Example
amount	decimal	Yes	Amount to deposit	250.00
description	string	No	Description for the deposit	"Top-up"

{
  "amount": 250.00,
  "description": "Top-up"
}

Returns a payment gateway link for the user to complete the deposit process.

{
  "link": "https://payment-gateway.example.com/redirect/abc123"
}