Retrieve a payout
Fetches the payout record Knit holds for one payout.
GET
https://api-prod.useknit.io/api/v1/payouts/{id}
Path parameters
idstringrequired
The payout's id, as returned when it was created.
Request
cURL
curl "https://api-prod.useknit.io/api/v1/payouts/8e5697e3-8265-455b-984a-0eb40e10b0f9" \
-H "Authorization: Bearer $KNIT_ACCESS_TOKEN" \
-H "Accept: application/json"Response
200 OK
{
"statusCode": 200,
"message": "Payout retrieved successfully",
"data": {
"id": "8e5697e3-8265-455b-984a-0eb40e10b0f9",
"businessId": "b7b93a40-4e18-4e97-9c5f-8a7a4fd0df92",
"network": "MATIC_MAINNET",
"token": "USDT",
"amount": "25.500000000000000000",
"toAddress": "0x56adfcc254ab3b8142a275c1837bcffaff5aa38b",
"merchantReference": "INV-2045",
"transactionHash": "0xb0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f70819",
"status": "COMPLETED",
"info": null,
"createdAt": "2024-08-27T13:44:20.000000Z",
"updatedAt": "2024-08-27T13:47:03.000000Z"
},
"success": true
}statusstring
PENDING, PROCESSING, COMPLETED, or FAILED.
transactionHashstring | null
Populated once the transfer is on-chain. null before then.
infostring | null
Detail about a failure. null on healthy payouts.
This returns Knit's stored record. For a live check against the settlement layer, use Get payout status.
Errors
| Status | Cause |
|---|---|
401 | Missing or invalid token, IP not allow-listed, or missing payouts:read |
403 | The payout exists but belongs to another business |
404 | No payout with that ID |
