Submerchant Payout
POST
/v1/payoutsOptionalPay a submerchant out. A parent merchant passes submerchantId; the server sources the destination IBAN/holder from the submerchant record (a submerchant's own key can only pay itself). Routes to the submerchant's ledger accounts and lower limits.
Authentication
Signature Pattern
HMAC-SHA256(secretKey, "{timestamp}\nPOST\n/v1/payouts\n{sha256(body)}")| Header | Value | Description |
|---|---|---|
X-Api-Key | pk_live_a1b2c3d4e5f6g7h8 | Merchant public API key |
X-Signature | {hmac_sha256_hex} | Hex HMAC-SHA256 request signature |
X-Timestamp | 2026-04-13T10:00:00Z | ISO 8601 UTC request time (±5 min) |
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
submerchantId | string | Required | Submerchant to pay (IBAN/holder sourced server-side) |
rail | string | Required | "fast" | "eft" | "card" |
amountMinor | integer | Required | Amount in kuruş |
currency | string | Required | Always "TRY" |
clientReference | string | Optional | Merchant pass-through reference |
Request Example
JSONRequest Body
{
"submerchantId": "sub_1a2b3c4d",
"rail": "fast",
"amountMinor": 20000,
"currency": "TRY"
}Response Parameters
| Field | Type | Example |
|---|---|---|
payoutId | string | "1a2b3c4d-5e6f-7081-92a3-b4c5d6e7f809" |
status | string | "pending" |
submerchantId | string | "sub_1a2b3c4d" |
Response Example
JSONResponse
{
"payoutId": "1a2b3c4d-5e6f-7081-92a3-b4c5d6e7f809",
"status": "pending",
"submerchantId": "sub_1a2b3c4d"
}Status Codes
200Success
201Created
400Bad Request
401Unauthorized
404Not Found
429Rate Limited
Try itMock
POSThttps://api.pay.sandbox.kvell.group