Skip to main content
POST
/
api
/
v1
/
payments
/
{transaction_id}
/
refund
cURL
curl -X POST https://vpos-sandbox.payven.com.tr/api/v1/payments/8e3f5c12-9a7b-4c8d-bc4e-2c963f66afa6/refund \
  -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

Path Parameters

​
transaction_id
string<uuid>
required

Body

application/json

İade isteği gövdesi. Tam veya kısmi iade için kullanılır.

​
amount
integer<int64>
required

İade tutarı — kuruş cinsinden. Orijinal işlemden küçük veya eşit olmalı.

Example:

5000

​
transaction_id
string<uuid>

İade edilecek işlemin Payven kimliği. URL'deki path parametresi ile aynı olmalı.

​
currency
string | null

ISO 4217. Genelde orijinal işlemle aynı; varsayılan TRY.

Example:

"TRY"

​
reason
string | null

İade sebebi (serbest metin, audit log'una düşer).

Example:

"Müşteri talebi — ürün iadesi"

​
reason_code
enum<string>

Yapısal iade sebebi: customer_request, duplicate, fraud, defective, other.

Available options:
CustomerRequest,
OutOfStock,
DuplicateCharge,
ProductDefect,
Fraud,
WrongAmount,
Other
Example:

"customer_request"

​
extra_properties
object

Konnektör-spesifik özel alanlar.

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.