ONonlink
Partner API

Read a batch, with every item outcome

get/v1/transfers/batch/{id}

Request

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

Path parameters

idstring required

Response

The batch.

idstring required

The batch id.

status'awaiting_confirmation' | 'confirmed' | 'processing' | 'completed' | 'failed' | 'expired' required

The batch status.

itemCountnumber required

Total items submitted, valid or not.

acceptedCountnumber required

Items that reached a successful terminal state.

failedCountnumber required

Items refused at submit or failed by the executor.

createdAtstring date-time required

ISO-8601 instant the batch was created.

confirmedAtstring date-time

ISO-8601 instant the batch was confirmed: when its confirmation code was verified, or, when confirmation is waived for your account, when the batch was created already confirmed.

Example response

{
  "id": "be9f1e6a-0000-4000-8000-000000000040",
  "status": "awaiting_confirmation",
  "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",
    "webhookDelivery": {
      "status": "delivered",
      "attempts": 1,
      "lastAttemptAt": "2026-09-11T00:00:02.000Z"
    },
    "waiverNotApplied": "key_without_ip_allowlist"
  }
}

Changes

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