Skip to main content
POST
/
api
/
v1
/
checkout
/
sessions
cURL
curl -X POST https://vpos-sandbox.payven.com.tr/api/v1/checkout/sessions \
  -H "Authorization: Bearer $PAYVEN_TOKEN" \
  -H "Idempotency-Key: order-1001" \
  -d '{ ...payload... }'
{
  "session_id": "<string>",
  "checkout_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

Body

application/json

Hosted checkout oturum isteği. Müşteri kart bilgisini Payven sayfasında girer.

​
amount
integer<int64>
required

İşlem tutarı — kuruş cinsinden.

Example:

15000

​
currency
string | null
required

ISO 4217 para birimi.

Example:

"TRY"

​
merchant_name
string | null

Hosted checkout sayfasında gösterilecek bayi adı.

Example:

"Acme Online"

​
allowed_installments
integer<int32>[] | null

Müşteriye sunulacak taksit seçenekleri ([1, 3, 6] gibi). Boş ise sadece peşin.

​
description
string | null

Sayfada gösterilecek açıklama.

Example:

"Sipariş ödemesi"

​
external_id
string | null

Sizin sipariş kimliğiniz.

Example:

"ORDER-1001"

​
basket_id
string | null

Sepet kimliği.

Example:

"BASKET-2026-001"

​
customer_email
string | null

Müşteri e-posta adresi (makbuz için).

Example:

"musteri@example.com"

​
customer_phone
string | null
​
metadata
object
​
payment_mode
enum<string>
Available options:
Non3D,
ThreeDSecure,
ThreeDPay,
ThreeDPayHosting
​
allow_pre_auth
boolean
​
is_test_session
boolean
​
success_url
string | null
​
cancel_url
string | null

Response

Created

​
session_id
string | null
​
checkout_url
string | null
​
expires_at
string<date-time>