OnLink
API reference

Read a transfer

GET
/v1/transfers/{id}

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/string"
{  "id": "bd9f1e6a-0000-4000-8000-000000000010",  "status": "awaiting_confirmation",  "rail": "mpesa",  "amount": {    "currency": "KES",    "value": "1500.00"  },  "fee": {    "currency": "KES",    "value": "1500.00"  },  "destination": {    "accountNumber": "254712345678",    "accountName": "Jane Wanjiku",    "bankCode": "11"  },  "nameVerification": "verified",  "verifiedAccountName": "JANE WANJIKU",  "partnerReference": "PS-TRF-000123",  "failureCode": "PROVIDER_REJECTED",  "createdAt": "2026-09-11T00:00:00.000Z",  "confirmedAt": "2026-09-11T00:02:00.000Z",  "settledAt": "2026-09-11T00:05: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"  }}