Update a payment (absent fields keep their value; send version for optimistic concurrency)

patch

https://apis.kentro.live/channel/v1/payments/{id}

The amount may change down to what is applied; the method only while nothing is applied. Type, currency and order never change.

Scope: payments:write, channel:write or admin. A permission group made before the Channel API scopes existed grants it as payments:manage.

Idempotency: send Idempotency-Key; a retry with the same key replays the first answer.

Rate limit: write class, 1,200 requests per minute per tenant by default (read class 6,000). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a refusal is 429 rate_limited with Retry-After.

Path Params

string

required

length between 1 and 300

The uuid, a legacy 24-hex id, or ext:: (URL-encoded).

Body Params

version

string

length between 1 and 64

The version read; a stale one is 409 version_conflict.

amount

length ≤ 24

^[0-9]{1,14}(\.[0-9]{1,8})?$

A non-negative decimal amount in currency units ("12.50"); numbers are accepted.

method

enum

transactionId

length between 1 and 255

The provider's transaction or charge id (stored as external_transaction_id).

externalUrl

length between 1 and 500

notes

length ≤ 10000

metadata

object

Merged by key; a null value removes the key.

Headers

Idempotency-Key

string

length between 7 and 50

Any string of 7 to 50 characters that identifies this request (an order number, a webhook id). A retry with the same key and the same body answers the first result with Idempotent-Replayed: true; the same key with a different body is 422 idempotency_key_reused; a concurrent request with the same key is 409 in_progress with Retry-After. Recommended on every write.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Default Response

400Default Response

403Default Response

404Default Response

409Default Response

422Default Response