Ana içeriğe geç

Create Payment Request

POST https://uygulama.vomsis.com/api/vpos/v3/request-payment

Bu servis ile gönderilen istek parametreleri ile bir ödeme talebi (payment link) oluşturulur.


Headers

FieldTypeDescription
AuthorizationStringZorunlu. Bearer {access_token} formatında gönderilmelidir.

Request Parameters

FieldTypeRequiredDescription
titleStringOpsiyonelTahsilat başlığı. Girilmezse Yeni Ödeme değeri verilir.
amountStringZorunluTutar 0’dan büyük olmalı. Örnek: "10.50"
expire_dateStringOpsiyonelTalebin geçerli olacağı son tarih. Format: dd.mm.yyyy. Boş bırakılırsa 3 ay sonrası kabul edilir.
emailStringOpsiyonelE-posta gönderilecek müşteriye ait mail adresi.
phoneStringOpsiyonelSMS gönderilecek müşteriye ait telefon numarası. Örnek: 05551234567
sms_notificationBooleanOpsiyoneltrue gönderilirse müşteriye SMS bildirimi yapılır.
mail_notificationBooleanOpsiyoneltrue gönderilirse müşteriye e-posta bildirimi yapılır.
langStringOpsiyonelBildirim metinlerinin dili. Alabileceği değerler: en, de, it, es, tr. Varsayılan: tr.
max_installmentsIntegerOpsiyonelÖdeme linkinde izin verilecek maksimum taksit sayısı. Varsayılan: 0 (Taksit yok).
currencyStringOpsiyonelPara birimi. Alabileceği değerler: TRY, USD, EUR. Varsayılan: TRY.
inputsObjectOpsiyonelÖdeme talebi formunda müşteriden toplanacak ek dinamik alanları içerir.

Detaylı inputs Yapısı

Bu alanda, ödeme formu üzerinde müşteriden toplanacak fatura veya ek iletişim bilgileri gibi alanları dinamik olarak yönetebilirsiniz. Her bir alan (infoEmails, description, nameSurname vb.) kendi içinde ayarlar içeren bir nesnedir.

  • value (String): Alana önceden doldurulmuş olarak gelecek varsayılan değer.
  • show (String): Alanın ödeme formunda görünüp ("true") görünmeyeceğini ("false") belirler.
  • changable (String): Müşterinin bu alanı değiştirip ("true") değiştiremeyeceğini ("false") belirler.
  • required (String): Müşterinin bu alanı doldurmasının zorunlu ("true") olup olmadığını ("false") belirler.
invoiceType Kullanımı

inputs içerisinde gönderilen invoiceType alanı, toplanacak fatura bilgilerinin yapısını belirler:

  • individual (Bireysel): Müşterinin T.C. kimlik numarası, ad soyad gibi kişisel bilgileri istenir.
  • commercial (Kurumsal): Müşterinin şirket ünvanı, vergi dairesi, vergi numarası gibi kurumsal bilgileri istenir.

Örnek İstekler (Request Examples)

Temel Örnek (Basic)
{
"title": "Yeni Fatura Ödemesi",
"amount": "10.00",
"expire_date": "12.12.2025",
"email": "example@domain.com",
"phone": "05555555555",
"sms_notification": true,
"mail_notification": true,
"lang": "tr",
"max_installments": 2,
"currency": "TRY"
}