API reference
Read a batch, with every item outcome
Authorization
partner-key X-OnLink-Key<token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/transfers/batch/string"{ "id": "be9f1e6a-0000-4000-8000-000000000040", "status": "awaiting_confirmation", "itemCount": 0, "acceptedCount": 0, "failedCount": 0, "items": [ { "transferId": "bd9f1e6a-0000-4000-8000-000000000010", "idempotencyKey": "trf-2026-09-16-000123", "accepted": true, "failureCode": "TRANSFER_NAME_MISMATCH" } ], "createdAt": "2026-09-16T00:00:00.000Z", "confirmedAt": "2026-09-16T00:02:00.000Z", "confirmation": { "id": "df9f1e6a-0000-4000-8000-000000000030", "channel": "email", "deliveredTo": "o***@partner.co.ke", "expiresAt": "2026-09-11T00:15:00.000Z", "resendAvailableAt": "2026-09-11T00:00:15.000Z" }}