API reference
Open a collection
Mints a reference and a dedicated USD deposit account. expectedAmount is advisory — a mismatch is reported later, never refused here.
Authorization
partner-key X-OnLink-Key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/collections" \ -H "Content-Type: application/json" \ -d '{ "currency": "USD", "partnerReference": "sunday-offering-2026-09", "payerLabel": "St Mark\'s Sunday offering" }'{ "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"}