Ana içeriğe geç

Mağaza Sayfası Oluşturma

Bilgi

Başlamadan önce bu isteği yaparken token oluşturulması gerekmektedir. Nasıl oluşturulacağını bilmiyorsanız lütfen örnek token oluşturma sayfasına göz atın.

İstek Adresi#

POST https://api.paylith.com/v1/token

İstek Parametreleri#

ParametreTipAçıklama
localestringDil seçeneğidir. Alabildiği değerler "tr" veya "en" dir. Varsayılan olarak "tr" gelmektedir.
apiKeystringSisteme kayıtlı olan mağazanın api gizli anahtarı
tokenstringDokümantasyonda yer alan token oluşturma sayfasına bakınız
conversationIdstringİstek esnasında gönderip, sonuçta alabileceğiniz bir değer, eşleşme yapmak için kullanılır
userIdintegerÜye işyeri tarafındaki kullanıcıya ait ID
userEmailstringÜye işyeri tarafındakı kullanıcıya ait sisteminize kayıtlı e-posta adresini belirtir
userPhonestringEğer sistemde tanımlanmış mağazaya sms doğrulaması kapatılmışsa bu parametre gönderilmelidir.
userIpAddressstringÜye işyeri tarafındaki kullanıcıya ait IP adresi
redirectUrlstringBaşarılı ödeme sonrasında yönlendirme yapılacak adres. Eğer bos bırakılırsa mağazaya ait alan adına yönlendirme yapar

Örnek İstek Verisi#

{
"apiKey": "apiKey",
"token": "token",
"conversationId": "conversationId", // Ödeme eşleştirmesi için kullanılır.
"userId": 1, // Üye işyeri tarafındakı kullanıcıya ait ID.
"userEmail": "[email protected]", // Üye işyeri tarafındaki kullanıcıya ait e-posta adresi.
"userIpAddress": "127.0.0.1" // Üye işyeri tarafındakı kullanıcının ip adresi.
}

Cevap Parametreleri#

ParametreTipAçıklama
statusstringİşlem durumunu belirtir. ("success" veya "failure" değerlerini alır)
statusCodeintegerİşlem durumu ile ilgili http kodunu belirtir
tokenstringİşlem sırasında gönderdiğiniz "token" değerini belirtir
paymentLinkintegerOrtak ödeme sayfası bağlantısını belirtir
orderIdintegerÖdeme işlemine ait sistem tarafından verilen benzersiz değerdir.

Örnek Cevaplar#

Olumlu Örnek Cevap#

https://api.paylith.com/v1/token
{
"status": "success",
"token": "foo",
"paymentLink": "https://paylith.com/payment/v1/token/foo",
"orderId": 1,
"statusCode": 200
}

Olumsuz Örnek Cevap#

https://api.paylith.com/v1/token
{
"status": "failure",
"error": {
"message": "Gönderilen `token` doğru değil!"
}
}