List deposit links - Streamlined

GET

/

deposit_links

List deposit links

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/deposit_links \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/deposit_links', 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"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

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

{
  "deposit_links": [
    {
      "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
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123
}

Authorizations

X-App-Id

string

header

required

App ID for authentication

X-Api-Key

string

header

required

API Key for authentication

Query Parameters

page

integer

default:1

Page number for pagination.

per_page

integer

default:50

Number of records per page (maximum 200).

Required range: x <= 200

status

enum<string>

Filter by status. Clock-aware: open excludes links whose expiry has passed, and expired includes them, matching the status each link reports.

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

customer_uuid

string

Filter by customer.

reference

string

Filter by your own reference, exact match.

from

string<date>

Only links created on or after this date.

to

string<date>

Only links created on or before this date, inclusive.

Response

Successful operation

deposit_links

object[]

Show child attributes

total

integer

Total matching the filters, not the size of this page.

page

integer

per_page

integer

⌘I

List deposit links

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/deposit_links \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/deposit_links', 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"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

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

{
  "deposit_links": [
    {
      "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
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123
}