Create a payment batch - Karat Help Center

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

cURL

curl --request POST \
  --url https://payouts.api.trykarat.com/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payouts": [\
    {\
      "payeeEmail": "jordan@example.com",\
      "amount": 25000,\
      "description": "October design work",\
      "referenceId": "inv_1042"\
    },\
    {\
      "recipientId": "9c1f7b2a-3d4e-4f5a-8b6c-1d2e3f4a5b6c",\
      "amount": 18000,\
      "description": "Editing — episode 12",\
      "referenceId": "inv_1043"\
    }\
  ],
  "idempotencyKey": "batch-2026-06-17-001"
}
'

Response

201

{
  "data": {
    "batchId": "30d6bb6e-5398-462c-a90c-7b9077f618d4",
    "payouts": [\
      {\
        "id": "0fc50d45-faa8-4d09-aa2a-a9ceb282d7ae",
        "payeeEmail": "jordan@example.com",
        "amount": 25000,
        "description": "October design work",
        "referenceId": "inv_1042"
      },\
      {\
        "id": "6ce6ca0a-31ff-4c74-89f0-87da19e8bb9d",
        "payeeEmail": "casey@example.com",
        "amount": 18000,
        "description": "Editing — episode 12",
        "referenceId": "inv_1043"
      }
    ]
  }
}

Authorizations

Authorization
string

header

required

Pass your API key as a bearer token: Authorization: Bearer <API_KEY>.

Body

payouts
object[]

required

Minimum array length: 1

idempotencyKey
string

Optional key to make the request idempotent. Defaults to a server-generated request ID.

Response

201

The batch was created.