Skip to main content
POST
/
api
/
v1
/
payments
/
order-link
cURL
curl -X POST https://vpos-sandbox.payven.com.tr/api/v1/payments/order-link \
  -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

Pay-by-link oluşturma isteği. SMS/e-posta ile paylaşılan ödeme linki üretir.

​
amount
integer<int64>
required

Tutar — kuruş cinsinden.

Example:

15000

​
currency
string | null
required

ISO 4217 para birimi.

Example:

"TRY"

​
installment
integer<int32>

İzin verilen maksimum taksit.

Example:

6

​
callback_url
string | null

Ödeme tamamlandığında server-to-server callback için HTTPS URL'iniz.

​
return_url
string | null

Müşterinin ödeme sonrası yönlendirileceği sayfa.

​
description
string | null

Linkte gösterilecek açıklama.

Example:

"Sipariş #1001"

​
external_id
string | null

Sizin sipariş kimliğiniz.

Example:

"ORDER-1001"

​
customer_email
string | null

Müşteri e-postası.

Example:

"musteri@example.com"

​
customer_phone
string | null
​
extra_properties
object

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.