Skip to main content
POST
Webhook endpoint for provider settlement status updates

Body

application/json
webhook_type
string
required

Webhook type identifier

Example:

"SETTLEMENT_STATUS_UPDATE"

provider_reference_id
string
required

Provider reference ID

Example:

"PROVIDER-TXN-20241122-001"

kotani_reference_id
string
required

Kotani reference ID

Example:

"KOTANI-REF-789"

status
enum<string>
required

Updated settlement status

Available options:
DEPOSIT_INITIATED,
DEPOSIT_CONFIRMED,
PAYMENT_SENT,
PAYMENT_CONFIRMED,
SETTLING,
COMPLETED,
FAILED,
REFUNDED
Example:

"COMPLETED"

timestamp
string
required

Webhook timestamp (ISO 8601)

Example:

"2024-11-22T12:05:00Z"

crypto_payment
object
required

Crypto payment details

settlement_details
object

Settlement details (if successful)

failure_details
object

Failure details (if failed)

refund_details
object

Refund details (if failed and refund initiated)

metadata
object

Transaction metadata

Response

success
boolean
Example:

true

message
string
Example:

"Webhook received and processed."

data
object