POST
Flag an escrow for review

Authorizations

Authorization
string
header
default:sk_test_docs_246e232c64ccc7a001bf61ec0f2e6ab0
required

Authorization: Bearer <secret key>. Secret keys belong to your organisation, are shown once when created in the dashboard, and are scoped (see x-required-scope on each operation). Keep them on your server. Live keys are issued after your business is verified. Publishable keys (pk_) are only for @ketapay/checkout and don't work here.

Headers

Idempotency-Key
string
required

Unique key for this operation. Retries with the same key return the first result.

Maximum string length: 255
Example:

"7f3e2a10-6c4d-4b8e-9a1f-2d5c8e7b6a40"

Path Parameters

id
string<uuid>
required

Body

application/json
reason
enum<string>
required
Available options:
fraudulent_listing,
banned_seller,
banned_buyer,
suspicious_activity,
other
note
string | null

What you know. Only KetaPay sees it.

Maximum string length: 1000

Response

Flag recorded

id
string<uuid>
required
object
string
required
Allowed value: "flag"
escrow_id
string<uuid>
required
reason
enum<string>
required
Available options:
fraudulent_listing,
banned_seller,
banned_buyer,
suspicious_activity,
other
note
string | null
required
status
enum<string>
required
Available options:
pending_review,
reviewed
created_at
string<date-time>
required