Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Identity servisinden alinan Keycloak JWT. Format: Authorization: Bearer <token>. Token alma: POST /api/v1/auth/{slug}/token

Body

application/json
external_id
string | null
amount
object | null

Tutar nesnesi — kuruş cinsinden tam sayı + ISO 4217 para birimi.

installment
integer<int32>
card
object | null
buyer
object | null

Müşteri bilgileri — fraud sinyalleri ve banka risk skoru için.

description
string | null
frequency
string | null
interval
integer<int32>
total_payment_count
integer<int32>
start_date
string<date-time> | null
extra_properties
object | null

Response

OK

Yazma operasyonlarından (POST /payments, /refund, /void, /capture) dönen sonuç.

transaction_id
string<uuid>
required

Payven tarafından atanan benzersiz işlem kimliği. Sorgulama / aksiyon endpoint'lerinde URL parametresi olarak kullanılır.

Example:

"8e3f5c12-9a7b-4c8d-bc4e-2c963f66afa6"

status
string | null

İşlemin mevcut durumu: pending, pending_3ds, authorized, completed, failed, voided, refunded, partially_refunded.

Example:

"completed"

is_success
boolean

Operasyon başarılı mı? Geçiş döneminde tutuluyor — yeni kodlarda HTTP status kodunu konuşturun (2xx başarı, 4xx/5xx hata).

Example:

true

message
string | null

İnsan-okur durum mesajı.

Example:

"İşlem başarıyla tamamlandı"

error_code
string | null

Yalnızca başarısız işlemlerde dolar — Payven canonical hata kodu.

Example:

"bank_declined"

provider_error_code
string | null

Yalnızca başarısız işlemlerde dolar — bankanın orijinal yanıt kodu.

Example:

"51"

extra_properties
object | null

Banka-spesifik ek alanlar: auth_code, host_reference, provider_transaction_id, processed_at vb.