Create external payments - Karat Help Center

Create external payments

cURL

curl --request POST \
  --url https://payouts.api.trykarat.com/external-payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalPayments": [
    {
      "recipientId": "9c1f7b2a-3d4e-4f5a-8b6c-1d2e3f4a5b6c",
      "amount": 50000,
      "description": "Paid via PayPal",
      "date": "2026-06-15",
      "paymentMethod": "paypal",
      "platform": "Upwork"
    }
  ],
  "idempotencyKey": "ext-2026-06-15-001"
}
'

Python

import requests

url = "https://payouts.api.trykarat.com/external-payments"

payload = {
    "externalPayments": [
        {
            "recipientId": "9c1f7b2a-3d4e-4f5a-8b6c-1d2e3f4a5b6c",
            "amount": 50000,
            "description": "Paid via PayPal",
            "date": "2026-06-15",
            "paymentMethod": "paypal",
            "platform": "Upwork"
        }
    ],
    "idempotencyKey": "ext-2026-06-15-001"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    externalPayments: [
      {
        recipientId: '9c1f7b2a-3d4e-4f5a-8b6c-1d2e3f4a5b6c',
        amount: 50000,
        description: 'Paid via PayPal',
        date: '2026-06-15',
        paymentMethod: 'paypal',
        platform: 'Upwork'
      }
    ],
    idempotencyKey: 'ext-2026-06-15-001'
  })
};

fetch('https://payouts.api.trykarat.com/external-payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://payouts.api.trykarat.com/external-payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'externalPayments' => [
        [
                'recipientId' => '9c1f7b2a-3d4e-4f5a-8b6c-1d2e3f4a5b6c',
                'amount' => 50000,
                'description' => 'Paid via PayPal',
                'date' => '2026-06-15',
                'paymentMethod' => 'paypal',
                'platform' => 'Upwork'
        ]
    ],
    'idempotencyKey' => 'ext-2026-06-15-001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

Go

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://payouts.api.trykarat.com/external-payments"

payload := strings.NewReader("{\n  \"externalPayments\": [\n    {\n      \"recipientId\": \"9c1f7b2a-3d4e-4f5a-8b6c-1d2e3f4a5b6c\",\n      \"amount\": 50000,\n      \"description\": \"Paid via PayPal\",\n      \"date\": \"2026-06-15\",\n      \"paymentMethod\": \"paypal\",\n      \"platform\": \"Upwork\"\n    }\n  ],\n  \"idempotencyKey\": \"ext-2026-06-15-001\"}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Responses

Success Response 201

{
  "data": {
    "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Error Responses

Error Response 400

{
  "error": {
    "message": "amount: amount must be positive"
  }
}

Error Response 401

{
  "error": {
    "message": "Invalid api key"
  }
}

Error Response 404

{
  "error": {
    "message": "Payment intent not found"
  }
}