Update an external payment - Karat Help Center

Update an external payment

cURL

curl --request PATCH \  
  --url https://payouts.api.trykarat.com/external-payments/{external_payment_id} \  
  --header 'Authorization: Bearer <token>' \  
  --header 'Content-Type: application/json' \  
  --data '
{
  "amount": 55000,
  "description": "Updated amount"
}
'

Python

import requests

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

payload = {
    "amount": 55000,
    "description": "Updated amount"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript (Fetch API)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({amount: 55000, description: 'Updated amount'})
};

fetch('https://payouts.api.trykarat.com/external-payments/{external_payment_id}', 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/{external_payment_id}",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "PATCH",\
  CURLOPT_POSTFIELDS => json_encode([\
    'amount' => 55000,\
    'description' => 'Updated amount'\
  ]),\
  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/{external_payment_id}"

payload := strings.NewReader("{\n  \"amount\": 55000,\n  \"description\": \"Updated amount\"\n}")

req, _ := http.NewRequest("PATCH", 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))
}

Java (Unirest)

HttpResponse<String> response = Unirest.patch("https://payouts.api.trykarat.com/external-payments/{external_payment_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 55000,\n  \"description\": \"Updated amount\"\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://payouts.api.trykarat.com/external-payments/{external_payment_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 55000,\n  \"description\": \"Updated amount\"\n}"

response = http.request(request)
puts response.read_body

Response Codes

Response Structure

Success Response

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 123,
    "description": "<string>",
    "date": "2023-12-25",
    "paymentMethod": "<string>",
    "platform": "<string>",
    "receiptFileName": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "recipient": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com"
    }
  }
}

Error Responses

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

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

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

Authorizations

Authorization

Path Parameters

Body Parameters