-
Garantipay 2.0
Garanti Pay Nedir?
• GarantiPay internet alışverişlerinde müşterinin kart bilgilerini firmayla paylaşmadığı, BonusFlaş uygulaması içinde yer alan hızlı ve kolay bir ödeme yöntemidir.
• İnternet alışverişi sırasında, ödeme seçenekleri adımında bir check out alternatifi olarak yer alır.
• GarantiPay seçeneğini check out sayfasında görünür yerlerde konumlandırmak GarantiPay sadık kullanıcılarının firmada kolayca işlem yapabilmesini sağlar.
• Hem e-commerce(in-web) işlemlerde, hem de m-commerce(in-app) işlemlerde müşteriler bu deneyimi yaşayabilir.
• GarantiPay check out seçildiğinde, müşteri BonusFlaş’a yönlendirilir, işlemini BonusFlaş içinden sonlandırır.
• Müşteri GarantiPay içinden ödemesini tamamlarken Garanti veya diğer banka kartlarını kullanabilir. Aynı zamanda Alışveriş Kredisi ile de ödemesini gerçekleştirebilir. Alışveriş kredisi firmada banka kartı işlemi olarak görünür. Bu sayede müşterinin tüm ödeme ihtiyaçlarına tek yerden çözüm sunar.
Garanti Pay‘in Müşterilerimiz ve Üye İşyerlerimize Faydaları:
• Müşterilerimize kolay, hızlı ve güvenli bir ödeme deneyimi sağlar.
• Müşterilerimizin işlem esnasında cüzdanlarını ve kartlarını yanlarında bulundurma ihtiyacını ortadan kaldırır.
• Ödeme işlemi sırasında kart bilgilerinin üye işyerleri ile paylaşılması ihtiyacı ortadan kaldırır.
• OneClickPayment yapısını kullanmak isteyen ama kart bilgilerini saklamak istemeyen üye işyerlerimiz için bu yapıyı hem mobil uygulamalarından hem de web sitelerinden yapılacak ödemeler için sağlar.
• Mobil Uygulama üzerinden de ürün ve servislerini sağlayan üye işyerlerimize de ödeme çözümü sağlar. Mobil Uygulama üzerinden kredi kartı bilgisinin manuel girişi ile ödemenin yapıldığı yapıya göre işlem sürelerini %70 oranında kısaltarak kullanıcı deneyimine olumlu katkı sağlar.
Örnek Firma Rakamları:
- Alışveriş sıklığını %47 artırır.
- Müşteri başına %56 daha fazla ciro
- Kullanan müşterilerin %88'i tekrar kullanır
- Görünür olduğu firmalarda %30 ciro payı yakalar
Test, Entegrasyon ve Üretim Ortamı URL Bilgileri
| Test | Entegrasyon | Üretim |
|---|---|---|
| https://garantipay- test.garantibbva.com.tr | https://garantipay- integration.garantibbva.com.tr | https://garantipay.garantibbva. com.tr |
IP Tanımları
TEST ve PROD ortamda işlem gönderebilmek, test BonusFlaş uygulamasını indirebilmek için IP tanımlamanız tarafımızca yapılmalı, size işlem cevaplarını dönebilmemiz için firewall kullanıyorsanız bankamız aşağıdaki IP’lerine izin vermeniz gereklidir.
İzin vermeniz gereken bankamız IP bilgileri:
217.68.208.0/20 ; 194.29.208.0/21 ; 91.188.192.0/22 ve 193.218.113.0/24
Tarafımıza iletmeniz gereken IP bilgileri aşağıdadır.
TEST ortamında işlem yapabilmeniz için sabit sunucu IP bilginiz: ………………………………………………………
TEST BonusFlaş uygulamasını indirebilmeniz için sabit IP bilginiz: ………………………………………………………
(Bu alanda cep telefonunuzun bağlı olduğu sabit wifi IP adresi iletilmelidir.)
PROD ortamda işlem yapabilmeniz için sabit sunucu IP
bilginiz: …………………………………………………………
Test BonusFlaş ortamı için IP kayıtlarınız yapıldıktan sonra aşağıdaki bilgiler ile test BonusFlaş uygulamasını indirebilir ve BonusFlaş üzerinden ödeme işlemlerinizi tamamlayabilirsiniz.
| Müşteri No | TCKN | Parola |
|---|---|---|
| 33838408 | 10033838408 | 147852 |
Uygulama Test Linkleri:
Android ve IOS:
https://bonusgw-tst.garanti.com.tr/bonusapp/downloadBonusApp.json
İş yeri web sitesinden veya akıllı telefon uygulaması üzerinden ödeme başlatılmasına göre iki farklı GarantiPay akışı mevcuttur. Bu akışlara Web2App ve App2App denilmektedir.
App2App Akışı
GarantiPay işleminin iş yeri akıllı telefonu üzerinden başlatıldığı akıştır. App2App akışında, müşteri iş yeri akıllı telefon uygulamasından ödeme seçenekleri adımında Garanti Pay ile Öde seçeneğini seçerek ilerletir. Akış ve mesajların detayları aşağıda ilgili bölümdedir. Akış diyagramı:
Web2App Akışı
GarantiPay işleminin iş yeri web sitesi üzerinden başlatıldığı akıştır. Web2App akışında, müşteri iş yeri web sayfasında ödeme seçenekleri adımında GarantiPay ile Öde seçeneğini seçerek ilerletir. Akış ve mesajların detayları aşağıda ilgili bölümdedir. Akış diyagramı:
GP Data İsteği
İş yerinin sipariş ile ilgili bilgileri Garanti Ecommerce Platformuna aktardığı istektir. GarantiPay akışında finansal bilgilerin olduğu bu istek hem web2app hem de app2app akışı için iş yerinin backend sunucuları üzerinden yapılmalıdır.
| Http Method | URL |
|---|---|
| POST | /api/garantipay/v0/init |
İstek Parametreleri
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
| meta | Meta | Evet | İstekle ilgili meta verileri içerir. |
| data | Data | Evet | API Platformun genel işlem veri tipidir. |
Meta
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
| id | String | Evet | Her işlem için üretilen universal unique ID (UUID) değeridir. |
| timestamp | Decimal | Evet | İşlem zamanı bu alanda gönderilir. |
| source | String | Evet | Ecommerce API Platform Source bilgisi |
| clientInfo | ClientInfo[] | Evet | İşlemi yapan kullanıcı ile ilgili bilgilerin gönderildiği alandır. ClientIp, ServerIp, UserId, Channel bilgileri gönderilmelidir. Email bilgisi opsiyoneldir. |
ClientInfo
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
| type | String | Evet | Kullanıcıbilgisinintipi.Bilgitürleri-> ClientIp, ServerIp, UserId, Channel, Email |
| value | String | Evet | Kullanıcı bilgisinin değeri. |
Data
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
| orderId | String | Hayır | Order id bilgisi |
| price | Price | Evet | İşlemin tutar ve tip bilgisi. |
| operation | String | Evet | GarantiPay işlem bilgisi |
| companyName | String | Evet | Mobil uygulamada gösterilecek iş yerinin ismi. |
| orderInfo | String | Hayır | GarantiPay işleminde tutulması istenen bilgileri içerir. |
| timeoutPeriodInSeconds | Decimal | Evet | GarantiPay işleminin tamamlanması için belirlenen maksimum saniyedeğeri.Budeğer minumum 300 saniyegönderilebilir. 300 altında gönderilen değerler için 300 olarak set edilir. |
| bonusflashNotificationInd | Boolean | Evet | Kullanıcıya işlem ile ilgili notification gönderilip gönderilmemesi değeri. |
| returnUrl | ReturnUrl | Evet | GarantiPay ödeme işlemi tamamlanınca işyerine dönülecek web sitesi veya uygulama adresi. |
| notificationUrl | String | Evet | GarantiPay işlemi ile ilgili durum değişikliklerinin bildirileceği adres. |
| customer | Customer | Hayır | GarantiPay işlemini yapan kullanıcı bilgisi. |
| paymentOptions | PaymentOption | Evet | İşlemin ödeme opsiyonlarını içerir. |
Price
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
| amount | String | Evet | İşlem tutarı. |
| currency | Decimal | Evet | İşlem para birimi. Kuruş ayrımı “.” ile sağlanacaktır. Örnek : 1.45 |
ReturnUrl
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
| link | String | Evet | GarantiPay ödeme işlemi tamamlanınca işyerine dönülecek adres. |
| type | String | Evet | Adres bilgisinin tipi: WEB veya Mobil |
Customer
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
| nationalNumber | String | Hayır | Kullanıcı TCKN bilgisidir. |
| gsmNumber | String | Hayır | Kullanıcı GSM numarasıdır. |
Payment Options
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
| threeDSecureCheck | boolean | Evet | İşlemin 3D doğrulamaya yönlenip yönlendirilmemesideğeri. |
| cvcRequired | boolean | Hayır | 3D için cvc değerinin gerekliliğini belirtir. |
| paymentOptionsUrl | String | Hayır | Taksit bilgilerini Kart bazında dinamik yönetmek için gidilen servis url’li. |
| addCampaignInstallme nt | boolean | Evet | Kampanya taksitlerinin eklenmesini belirtir. |
| showOnlyInstallments | boolean | Evet | Sadece taksitli seçenekler gösterilir. |
| installmentOnlyForCom mercialCard | boolean | Evet | Sadece ticari kartlar için taksit yapılır bilgisidir. |
| customerCredit | CustomerCredit | Hayır | Alışveriş kredisi için gerekli bilgiler. |
| Loyalties | Loyalty[] | Hayır | İşlem için geçerli ödül kullanım tipleri. |
CustomerCredit
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
| campaign | String | Evet | İlgili sepet için kullanılacak kampanyakodu,Alfanümerikenaz 2 karakter-en fazla 6 karakter.FirmaürüngamınagöreBankaile birlikte belirlenir. Entegrasyon sırasındaBankatarafındatanımyapılacaktır. |
| term | String | Hayır | Alışveriş sitesinde vade seçimi. Nümerik 2 karakter. |
| category | String | Hayır | Alışveriş sepetindeki ürünlerinin kategori/alt kategori bilgisi. |
| address | String | Hayır | Adres bilgisi, toplam 18 karakter ve son 3 karakter * olacak şekilde iletilecektir. |
Loyalty
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
| type | String | Evet | Ödül tipi. Ödül Tipleri -> bns, bnsfbb, mile, cheque |
| useInd | boolean | Evet | İşlem için ödül kullanımına açık mı bilgisi |
İstek Örneği
{\n \"meta\": {\n \"id\": \"acde070d-8c4c-4f0d-9d8a-162843c10333\",\n \"timestamp\": 1685645139,\n \"source\": \"garantipay\",\n \"clientInfo\": [\n {\n \"type\": \"channel\",\n \"value\": \"WEB\"\n },\n {\n \"type\": \"serverIp\",\n \"value\": \"38.45.490.123\"\n },\n {\n \"type\": \"clientIp\",\n \"value\": \"194.29.214.244\"\n },\n {\n \"type\": \"email\",\n \"value\": \"test@test.com\"\n },\n {\n \"type\": \"userId\",\n \"value\": \"309853331\"\n }\n ]\n },\n \"data\": {\n \"orderId\": \"467645734901236734\",\n \"price\": {\n \"amount\": \"10000\",\n \"currency\": 949\n },\n \"operation\": \"sales\",\n \"companyName\": \"Test company\",\n \"orderInfo\": \"Test order info\",\n \"timeoutPeriodInSeconds\": 300,\n \"bonusflashNotificationInd\": true,\n \"returnUrl\": {\n \"link\": \"https://garantibbva.com.tr/api/ecom/returnUrl\",\n \"type\": \"web\"\n },\n \"notificationUrl\": \"https://test-merchant.com/garantibbva- ecom/api/garantipay/v0/status\",\n \"customer\": {\n \"nationalNumber\": 18007904436,\n \"gsmNumber\": \"5354194523\"\n },\n \"paymentOptions\": {\n \"threeDSecureCheck\": true,\n \"cvcRequired\": false,\n \"paymentOptionsUrl\": \"https://test-merchant.com/garantibbva- ecom/api/payment/v0/options\",\n \"addCampaignInstallment\": true,\n \"showOnlyInstallments\": false,\n \"installmentOnlyForCommercialCard\": false,\n \"customerCredit\": {\n \"campaign\": \"TE\",\n \"term\": \"10\",\n \"category\": \"1301\",\n \"address\": \"ÇAMÇEŞME MAH. T***\"\n },\n \"loyalties\": [\n {\n \"type\": \"bns\",\n \"useInd\": false\n },\n {\n \"type\": \"bnsfbb\",\n \"useInd\": false\n },\n {\n \"type\": \"cheque\",\n \"useInd\": false\n },\n {\n \"type\": \"mile\",\n \"useInd\": false\n }\n ]\n }\n }\n}
GP DATA Dönüş Parametreleri
GarantiPay gpdatarequest cevabı sistemsel bir hata bulunmadığı sürece dönüş değerleri aşağıdaki şekildedir.
| Parametre Adı | Tipi | Zorunlu | Açıklama | ||
|---|---|---|---|---|---|
| id | String | Evet | Her işlem için üretilen universal unique ID (UUID) değeridir. | ||
| source | String | Evet | Ecommerce API Platform Source bilgisi | ||
| timestamp | String | Evet | İşlem zamanı bu alanda gönderilir. | ||
| resultCode | String | Evet | İşlemin sonuç kodu. | ||
| resultMessage | String | Evet | İşlemin sonuç mesajı. | ||
| errors | Error[] | Hayır | İşlem sırasında hata oluştu ise oluşan hataların bilgileridir. Örnek mesajlarda bu alan parse işlemleri için dummy olarak doldurulmuştur. Üretim ortamında hata olmadığında bu alan boş olacaktır. | ||
| response | Response | Hayır | GpDataResponse bilgileri |
Errors
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
| code | String | Evet | Hata kodu. |
| Type | String | Evet | Hata Tipi |
| message | String | Evet | Hata mesajı |
Response
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
| orderId | String | Evet | Order id bilgisi |
| gpayId | String | Evet | GarantiPay id bilgisi |
| status | String | Evet | GarantiPay status |
| redirectUrl | RedirectUrl | Evet | İş yerinin GarantiPay için yönlendirme adresi. |
RedirectUrl
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
| link | String | Evet | GarantiPay ödeme işleminin yönlendirileceği adres. |
| type | String | Evet | Adres bilgisinin tipi: WEB veya Mobil |
Cevap Örneği
{\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"source\": \"garantipay\",\n \"timestamp\": 1685673913,\n \"resultCode\": \"00\",\n \"resultMessage\": \"Success\",\n \"errors\": [\n {\n \"code\": \"0\",\n \"type\": \"info\",\n \"message\": \"No error\"\n }\n ],\n \"response\": {\n \"orderId\": \"467645734901236734\",\n \"gpayId\": \"10210945315100896965591245\",\n \"status\": \"PAYMENT_WAIT\",\n \"redirectUrl\": {\n \"link\": \"https://garantibbva.com.tr/api/ecom/returnUrl\",\n \"type\": \"web\"\n }\n }\n}
