Skip to main content
PATCH
/
external-payments
/
{external_payment_id}
Update an external payment
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"
}
'
{
  "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"
    }
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

external_payment_id
string<uuid>
required

The ID of the external payment.

Body

application/json
amount
integer

Amount in cents.

Required range: x >= 1
description
string | null
date
string<date> | null
paymentMethod
string | null
platform
string | null

Response

The updated external payment.

data
object