mandate-portal

Portal Topup Initiate

Initiate a PayPal top-up for a mandate.

Returns an approval_url — redirect the user's browser there. After approval, PayPal redirects to return_url with ?token=<paypal_order_id>. Then call POST /topup/capture with that token.

post/mandate/portal/{mandate_id}/topup/initiate

Request

  • Base URL: https://api.algovoi.co.uk (the document declares no server; this is the origin it was published from)
  • URL: https://api.algovoi.co.uk/mandate/portal/{mandate_id}/topup/initiate
  • Auth: none declared

Path parameters

mandate_idstring uuid required

Query parameters

tenant_idstring uuid nullable

Request body

amount_minorinteger required

Top-up amount in GBP pence

return_urlstring required

URL to redirect after PayPal approval

cancel_urlstring required

URL to redirect on cancellation

Response

Successful Response

mandate_idstring uuid required
paypal_order_idstring required
approval_urlstring required
amount_minorinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.