ONonlink
Partner API

Read a collection

get/v1/collections/{id}

Request

  • Base URL
    https://sandbox.onlink.africa
  • Auth
    API key in header X-OnLink-Key

Path parameters

idstring required

Response

The collection.

idstring required
referencestring required
status'open' | 'received' | 'crediting' | 'credited' | 'refunded' | 'expired' | 'cancelled' required

Where the collection is in its lifecycle. open: the deposit instructions are live and no deposit has arrived. received: a deposit has arrived and been matched to this collection; your fee is applied and the net amount is known. crediting: the deposit has been received and the net amount is being paid into your account; it becomes credited when the payout settles, or returns to received if the payout did not go through, and is then retried. credited: the net amount has been paid into your account (collection.received is sent at this point). refunded: the deposit was returned to the sender. expired: we closed the collection before any deposit arrived. Do not hand its deposit instructions out again: a deposit sent to them afterwards is not attributed to this collection. cancelled: the collection was cancelled before any deposit arrived. Do not hand its deposit instructions out again: a deposit sent to them afterwards is not attributed to this collection.

currencystring required
partnerReferencestring nullable required

Your own reference for this collection: the partnerReference you sent when you opened it, or the latest value if the collection was edited since (an open collection can be edited from the OnLink web app), or null for a collection opened before it was stored. Echoed back for your own matching; OnLink never uses it to look anything up.

labelstring nullable required

Your own label for this collection: the payerLabel you sent when you opened it, or the latest value if the collection was edited since (an open collection can be edited from the OnLink web app), or null for a collection opened before it was stored. For your own records; never sent to the contributor.

expectedAmountstring
grossAmountstring
feeAmountstring
netAmountstring
createdAtstring required

Example response

{
  "id": "a1b2c3d4-0000-4000-8000-000000000001",
  "reference": "DEMO-7K3Q2M",
  "status": "open",
  "currency": "USD",
  "partnerReference": "campaign-2026-09",
  "label": "September community appeal",
  "depositInstructions": {
    "beneficiaryName": "Sandbox Business",
    "bankName": "Bank of Nowhere",
    "routingNumber": "000000000",
    "accountNumber": "00000000123456",
    "rails": [
      "ach_push",
      "fednow",
      "wire"
    ],
    "depositMessage": "SBX0DEPOSITMESSAGE"
  },
  "fee": {
    "percentBps": 100,
    "flatMinor": 50,
    "capMinor": 2000,
    "currency": "USD"
  },
  "expectedAmount": "100.00",
  "grossAmount": "100.00",
  "feeAmount": "1.50",
  "netAmount": "98.50",
  "createdAt": "2026-09-22T17:38:46.915Z"
}

Changes

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