Deposit links

Apply deposit to invoice

Puts the deposit against one of your invoices.

Paid: the payment is applied to the invoice now. 200, and applied is true.
Processing: a bank debit the customer has confirmed and that has not landed yet, which takes 2 to 4 business days. The deposit is queued against the invoice and applied automatically when the money arrives. 202, with apply_to_invoice_uuid set and applied still false until then.

Any other status has collected nothing and is refused.

While queued, the invoice lists the deposit as a pending payment, and automatic card or bank charges on the invoice take it into account, so the customer is not charged again for money already on its way. Nothing is credited to the invoice until the money lands: a bank debit can still be returned. If it is, the queue is dropped with it and the link reopens.

A deposit larger than the invoice is applied in full, and the remainder stays as credit on that invoice, the same as any overpayment.

Safe to retry: applying a deposit to the invoice it is already applied or queued to returns the same result.

PUT

deposit_links

{uuid}

invoice

Apply deposit to invoice

curl --request PUT \
  --url https://api.staging.streamlinedpayments.com/api/v1/deposit_links/{uuid}/invoice \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>' \
  --data '
{
  "invoice_uuid": "8d2c4a17-6b3e-4f95-a1d0-7e9c5b2f4a63"
}
'

const options = {
  method: 'PUT',
  headers: {
    'X-App-Id': '<api-key>',
    'X-Api-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({invoice_uuid: '8d2c4a17-6b3e-4f95-a1d0-7e9c5b2f4a63'})
};

fetch('https://api.staging.streamlinedpayments.com/api/v1/deposit_links/{uuid}/invoice', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/deposit_links/{uuid}/invoice"

payload = { "invoice_uuid": "8d2c4a17-6b3e-4f95-a1d0-7e9c5b2f4a63" }
headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/deposit_links/{uuid}/invoice")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"invoice_uuid\": \"8d2c4a17-6b3e-4f95-a1d0-7e9c5b2f4a63\"\n}"

response = http.request(request)
puts response.read_body

{
  "uuid": "3b8e5f21-7a44-4c19-9e02-1d5c7b3a6f08",
  "status": "open",
  "amount": 250000,
  "currency": "USD",
  "url": "https://app.streamlinedpayments.com/d/dep_7K3M9QP2ATX4",
  "short_url": "https://s9d.cc/dep_7K3M9QP2ATX4",
  "expires_at": "2026-09-15T00:00:00Z",
  "description": "50% deposit",
  "reference": "PO-4821",
  "metadata": {
    "deal_id": "148003921"
  },
  "created_at": "2026-08-16T14:22:05Z",
  "paid_at": null,
  "customer": {
    "uuid": "c1f0a92b-4d63-4e88-b0a7-2f9e4c6d1b35",
    "display_name": "Northwind Traders"
  },
  "applied": false,
  "apply_to_invoice_uuid": null,
  "payment": null
}

Authorizations

X-App-Id

string

header

required

App ID for authentication

X-Api-Key

string

header

required

API Key for authentication

Path Parameters

uuid

string

required

Body

application/json

invoice_uuid

string

required

The invoice to apply the deposit to. It must belong to the same customer as the deposit, be in the same currency, and not be voided.

Response

Applied. Returns the link with applied true.

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.

uuid

string

Identifies the link everywhere in this API.

status

enum<string>

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.

Available options:

open,

processing,

paid,

failed,

expired,

canceled,

refunded

amount

integer

Amount requested, in cents.

currency

enum<string>

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.

Available options:

USD,

CAD,

EUR,

GBP,

AUD

url

string

The payable URL. Always present and always works.

short_url

string | null

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.

expires_at

string<date-time>

description

string | null

Shown to the payer.

reference

string | null

Your own reference.

metadata

object | null

created_at

string<date-time>

paid_at

string<date-time> | null

customer

object

Show child attributes

applied

boolean

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.

apply_to_invoice_uuid

string | null

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.

payment

object | null

The money that settled this link. Null until it has been paid.

Show child attributes

Example:

{
  "uuid": "8f2a1c34-9d21-4b7e-a0f5-6c1d8e3b7a92",
  "amount": 249988,
  "source": "wire",
  "invoice_identifier": null,
  "attached_by": "auto_match",
  "amount_matches_link": false
}

⌘I

Apply deposit to invoice

curl --request PUT \
  --url https://api.staging.streamlinedpayments.com/api/v1/deposit_links/{uuid}/invoice \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>' \
  --data '
{
  "invoice_uuid": "8d2c4a17-6b3e-4f95-a1d0-7e9c5b2f4a63"
}
'

const options = {
  method: 'PUT',
  headers: {
    'X-App-Id': '<api-key>',
    'X-Api-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({invoice_uuid: '8d2c4a17-6b3e-4f95-a1d0-7e9c5b2f4a63'})
};

fetch('https://api.staging.streamlinedpayments.com/api/v1/deposit_links/{uuid}/invoice', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/deposit_links/{uuid}/invoice"

payload = { "invoice_uuid": "8d2c4a17-6b3e-4f95-a1d0-7e9c5b2f4a63" }
headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/deposit_links/{uuid}/invoice")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"invoice_uuid\": \"8d2c4a17-6b3e-4f95-a1d0-7e9c5b2f4a63\"\n}"

response = http.request(request)
puts response.read_body

{
  "uuid": "3b8e5f21-7a44-4c19-9e02-1d5c7b3a6f08",
  "status": "open",
  "amount": 250000,
  "currency": "USD",
  "url": "https://app.streamlinedpayments.com/d/dep_7K3M9QP2ATX4",
  "short_url": "https://s9d.cc/dep_7K3M9QP2ATX4",
  "expires_at": "2026-09-15T00:00:00Z",
  "description": "50% deposit",
  "reference": "PO-4821",
  "metadata": {
    "deal_id": "148003921"
  },
  "created_at": "2026-08-16T14:22:05Z",
  "paid_at": null,
  "customer": {
    "uuid": "c1f0a92b-4d63-4e88-b0a7-2f9e4c6d1b35",
    "display_name": "Northwind Traders"
  },
  "applied": false,
  "apply_to_invoice_uuid": null,
  "payment": null
}

Orders

Customers

Customer applications

Customer groups

Customer files

Customer addresses

Payouts

Invoices

Transactions

Products

Deposit links

Webhooks

Apply deposit to invoice

Authorizations

Path Parameters

Body

Response