Cancel deposit link
Cancels the link. The URL stops working immediately; the record is kept, so a link that has taken money stays auditable. Only an open link can be canceled.
Authorizations
App ID for authentication
API Key for authentication
Path Parameters
Response
Canceled. Returns the link with status canceled.
A request for money from a customer before any invoice exists.
The customer pays the URL by card or bank debit. The money lands as an unapplied
payment and posts to no accounting system until someone applies it to an invoice,
at which point applied turns true.
Identifies the link everywhere in this API.
Where the link is in its life.
processing means a bank debit was taken and is still settling, 2 to 4 business
days. The money has not arrived; it becomes paid on its own.
failed is terminal. The customer cannot retry the same link and you issue a new one.
A lapsed link reports expired even before the sweeper rewrites it, so this always
agrees with whether the URL still works.
open, processing, paid, failed, expired, canceled, refunded Amount requested, in cents.
Currency to collect in. Defaults to the customer's, then the company's, then USD.
Narrower than the currencies elsewhere in this API: a deposit must be payable by card or bank debit, and every one of these is two-decimal.
USD, CAD, EUR, GBP, AUD The payable URL. Always present and always works.
Shortened form of the same URL. Null when the shortener was unreachable at
creation, so fall back to url rather than treating null as an error.
Shown to the payer.
Your own reference.
Whether the money has been applied to an invoice.
Separate from status, and not a problem state: paid with applied: false is
where a deposit sits until someone maps it to an invoice. When the deposit was
collected the invoice did not exist, so nothing picks one on its own. Apply it with
PUT /deposit_links/{uuid}/invoice, or in the Streamlined app.
The invoice a processing deposit is queued against, via
PUT /deposit_links/{uuid}/invoice. It is applied there when the money lands, at
which point this goes null and applied turns true. Null when nothing is queued.
The money that settled this link. Null until it has been paid.