StartIFrameResQueryString

Iframe'in içinde açılan bir sayfadan veri göndermek için kullanılan bir yöntemdir. Bu yapı, Iframe üzerinden belirli verilerin URL parametreleri (query string) ile iletilmesini ifade eder. Iframe kullanılarak yapılan entegrasyonlarda veri paylaşımı ve sonuçların geri döndürülmesi gerektiğinde kullanılır.

URL

POST /api/Payment/StartIFrameResQueryString

Servise gönderilen parametreler şu şekildedir:

Parametre	Tip	Uzunluk	Zorunluluk	Açıklama
merchantId	int	64	Evet	Üye işyeri numarası
totalAmount	string	64	Evet	Ödeme yapılacak tutar
memberId	int	64	Evet	Üye Id
userCode	string	64	Evet	Kullanıcı bilgisi
txnType	string	64	Evet	txnType
currency	string	64	Evet	Ödemenin tahsil edileceği para birimi
orderId	string	64	Evet	Üye işyeri tarafındaki, ödemeye ilişkin sipariş numarasıdır. Sorgulama servislerinde bu id ile sorgulama yapabilirsiniz.
rnd	string	64	Evet	Hash hesaplamasında kullanılan random numaradır.
hash	string	2048	Evet	İşlemin güvenliği için oluşturulan hash bilgisidir.
webUrl	string	255	Evet	webUrl
description	string	255	Evet	Açıklama
requestIp	string	64	Evet	İstek Ip Adresi
okUrl	string	255	Evet	İşlem başarılı olursa yönlendirilecek url
failUrl	string	255	Evet	İşlem başarısız olursa yönlendirilecek url
masterPassGsmNumber	string	12	Hayır	Ödemeyi masterpass'e tanımlı kart ile tamamlamak için bu alana ödeme alınacak kullanıcının telefon numarası girilir.

Servisten dönen parametreler şu şekildedir:

Parametre	Tip	Uzunluk	Açıklama
isSuccess	boolean	-	İşlem başarılı (true) ; işlem başarısız (false) bilgisi döner
message	string	255	isSuccess: true olması durumunda "İşlem başarılıdır." ; false olması durumunda alınan hata mesajı gelmektedir.
errorCode	string	5	isSuccess: true olması durumunda null ; false olması durumunda alınan hata codu gelmektedir.
requestId	string	64	Sistem tarafından isteğe ait unique ID bilgisidir.
data	array	-	Dizi olarak aşağıdaki parametreler dönmektedir

Örnek JSON formatında istek ve cevap aşağıdaki gibidir:

İstek

{
  "merchantId": 97163,
  "totalAmount": "1000",
  "memberId": 1,
  "userCode": "[e-mail]",
  "txnType": "Auth",
  "currency": "949",
  "orderId": "{{$guid}}",
  "rnd": "2023031321541332",
  "hash": "2023031321541332",
  "webUrl": "google.com",
  "description": "deneme",
  "requestIp": "string",
  "okUrl": "https://webhook.site/c67d51a7-51a4-4b85-bc06-896ec9ed4b58",
  "failUrl": "https://webhook.site/c67d51a7-51a4-4b85-bc06-896ec9ed4b58",
  "masterPassGsmNumber":"905421234567"
}

Cevap

Başarılı request sonucunda ödeme url'i dönmektedir.

{
    "isSuccess": true,
    "message": "İşlem başarılıdır.",
    "errorCode": null,
    "requestId": "52235662-fbdb-4c3c-86c7-393c26f6c951",
    "data": {
        "url": "https://testahlsanalpos.ahlpay.com.tr/MasterPassView/index.html?orderId=14bfabc6-a8b1-4e5e-944a-d7bb18fc5101"
    }
}