OnLink
API reference

List your collections

GET
/v1/collections

Authorization

partner-key
X-OnLink-Key<token>

In: header

Query Parameters

reference?string
status?string

Value in

  • "open"
  • "received"
  • "crediting"
  • "credited"
  • "refunded"
  • "expired"
from?string

Inclusive lower bound on creation time, ISO 8601.

to?string

Exclusive upper bound on creation time, ISO 8601.

Response Body

application/json

curl -X GET "https://example.com/v1/collections"
[  {    "id": "a1b2c3d4-0000-4000-8000-000000000001",    "reference": "DEMO-7K3Q2M",    "status": "open",    "currency": "USD",    "depositInstructions": {      "beneficiaryName": "Sandbox Business",      "bankName": "Bank of Nowhere",      "routingNumber": "021000021",      "accountNumber": "****0350",      "rails": [        "ach_push",        "fednow",        "wire"      ],      "depositMessage": "BRGBFRC25ZJZ4RAVXEZK"    },    "fee": {      "percentBps": 175,      "flatMinor": 30,      "capMinor": 2000,      "currency": "USD"    },    "expectedAmount": "100.00",    "grossAmount": "100.00",    "feeAmount": "1.18",    "netAmount": "98.82",    "createdAt": "2026-09-22T17:38:46.915Z"  }]