STK Push Collections

Get a single Tanzania collection

GET
/api/v1/tz/collections/single

Retrieve the details of a single TZ collection using the requestId you received when it was initiated.

This endpoint additionally requires a Device-Id header identifying the calling client.

Authorization

bearerAuth
AuthorizationBearer <token>

The access_token returned by POST /api/v1/get-token.

In: header

Query Parameters

requestId*string

The unique ID of the transaction, returned when it was created.

Formatuuid

Header Parameters

Device-Id*string

A unique identifier for the calling device or client.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/tz/collections/single?requestId=cd3e5b37-8f23-465e-a720-b2a78f2b62c1" \  -H "Device-Id: example-my-device-id"
{  "status": 200,  "message": "Success",  "data": {    "id": 1,    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",    "merchantRequestId": "29115-34620561-1",    "checkoutRequestId": "ws_CO_191220191020363925",    "phoneNumber": "0745362174",    "description": "string",    "organisation": {      "id": 2,      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",      "name": "Maina Properties Limited Ke",      "phoneNumber": "254745362174",      "email": "maina@gmail.com",      "uniqueReference": "4780606",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "amount": 10,    "status": "PENDING",    "accountReference": "string",    "responseCode": 0,    "responseDescription": "string",    "customerMessage": "string",    "callbackUrl": "http://example.com",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}