Skip to main content
POST
/
api
/
v1
/
payments
cURL
curl -X POST https://vpos-sandbox.payven.com.tr/api/v1/payments \
  -H "Authorization: Bearer $PAYVEN_TOKEN" \
  -H "Idempotency-Key: order-1001" \
  -d '{ ...payload... }'
{
  "transaction_id": "8e3f5c12-9a7b-4c8d-bc4e-2c963f66afa6",
  "status": "completed",
  "is_success": true,
  "message": "İşlem başarıyla tamamlandı",
  "error_code": "bank_declined",
  "provider_error_code": "51",
  "extra_properties": {}
}

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

Non-3D ödeme veya pre-auth oluşturma isteği gövdesi.

​
amount
object
required

İşlem tutarı ve para birimi. Tutar kuruş cinsindendir (15000 = ₺150,00).

​
installment
integer<int32>
required

Taksit sayısı. 1 = peşin. Banka & BIN desteği gereklidir; desteklenmeyen taksit invalid_installment ile reddedilir.

Example:

1

​
card
object
required

Kart bilgileri — Luhn checksum geçerli olmalı, son kullanma tarihi gelecekte olmalı.

​
external_id
string | null

Sizin sisteminizdeki sipariş kimliği. İdeal olarak Idempotency-Key ile aynı seed'den üretin.

Example:

"ORDER-1001"

​
basket_id
string | null

Sepet kimliği — raporlama ve mutabakat için.

Example:

"BASKET-2026-001"

​
description
string | null

İşlem açıklaması. Banka ekstresi açıklamasına yansıyabilir.

Example:

"Sipariş ödemesi"

​
buyer
object

Müşteri bilgileri. ip_address fraud kuralları için kritiktir.

​
billing_address
object

Fatura adresi. Bazı bankalar/3DS senaryoları için risk skoruna girer.

​
shipping_address
object

Teslimat adresi. Fiziksel ürünlerde fraud sinyali olarak kullanılır.

​
basket_items
object[] | null

Sepet kalemleri. 3DS 2.x mesajlaşmasında risk skoruna katkı sağlar.

​
operation_type
enum<string>

sale (varsayılan, anında çekim) veya pre_auth (ön provizyon — sonradan /capture gerekir).

Available options:
Sale,
PreAuth,
PostAuth,
Void,
Refund,
Recurring
Example:

"sale"

​
extra_properties
object

Konnektör-spesifik özel alanlar (advanced). Genelde boş bırakın.

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

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