.. _Agreements:
Sözleşme tiplerini sorgulama
----------------------------
Akifast uygulamasında ödeme oturumu oluşturulduktan sonra bu oturum oluşturulurken kullanılan veriler ve kullanıcının seçtiği adres vs. bilgileri aşağıdaki şekilde sözleşme sorgulamak için üye iş yerine gönderilir.
Akifast uygulaması ödeme oturumu oluştururken gönderilen ``query_agreement_types_url`` parametresi ile belirtilen adrese aşağıdaki parametreleri POST isteği olarak iletir.
.. note:: Eğer üye iş yerinden dönen cevap null ise Akifast uygulamasında 500 Internal Server Error hatası gönderiliyor!
.. list-table:: İstek Parametreleri ve Açıklamaları
:width: 600px
:widths: 15 15 70
:header-rows: 1
* - Parametre
- Tip
- Açıklama
* - basket_id
- string
- Ödeme oturumu oluşturulurken gönderilen sepet idsi.
* - conversation_id
- string
- Ödeme oturumu oluştururken üye iş yeri tarafından gönderilen bumerang değer.
* - order_id
- string
- Üye iş yeri tarafındaki sipariş numarası.
* - language
- string
- Kullanıcının seçtiği dil seçeneği.
.. list-table:: Dönüş Değerleri ve Açıklamaları
:width: 600px
:widths: 25 15 60
:header-rows: 1
* - Dönüş Değeri
- Tip
- Açıklama
* - agreements[0].code
- string
- sözleşmenin kodu.
* - agreements[0].text
- string
- sözleşmenin adı / açıklaması.
**Örnek İstek:**
.. code-block:: json
{
"order_id": "20220407134221",
"language": "tr",
"conversation_id": "kdLEMDASDPRI23445D",
"basket_id": "B-202111191524"
}
**Örnek Cevap:**
.. code-block:: json
{
"agreements":[
{
"code":"OBF",
"text":"Ön Bilgilendirme Formu"
},
{
"code":"MSS",
"text":"Mesafeli Satış Sözleşmesi"
}
]
}
Sözleşme sorgulama
------------------
Akifast uygulamasında ödeme oturumu oluşturulduktan sonra bu oturum oluşturulurken kullanılan veriler ve
kullanıcının seçtiği adres vs. bilgileri aşağıdaki şekilde sözleşme sorgulamak için üye iş yerine gönderilir.
Akifast uygulaması ödeme oturumu oluştururken gönderilen ``query_agreements_url`` parametresi ile belirtilen adrese
``?code=`` ile birlikte aşağıdaki parametreleri POST isteği olarak iletir.
.. note:: Eğer üye iş yerinden dönen cevap null ise Akifast uygulamasında 500 Internal Server Error hatası gönderiliyor!
.. list-table:: İstek Parametreleri ve Açıklamaları
:width: 600px
:widths: 15 15 70
:header-rows: 1
* - Parametre
- Tip
- Açıklama
* - order_id
- string
- Üye iş yeri tarafındaki sipariş numarası
* - session_token
- string
- Üye iş yerinin aldığı ödeme oturumu anahtarı
* - shipping_address
- Address Objesi
- Kullanıcının seçtiği kargo adresi
* - billing_address
- Address Objesi
- Kullanıcının seçtiği fatura adresi
* - user
- akipay_user objesi
- İşlem sahibi kullanıcının bilgileri
* - shipping_option_key
- string
- Kullanıcın seçtiği kargo seçeneği
* - language
- string
- Kullanıcının seçtiği dil seçeneği
* - conversation_id
- string
- Ödeme oturumu oluştururken üye iş yeri tarafından gönderilen bumerang değer
* - basket_id
- string
- Ödeme oturumu oluşturulurken gönderilen sepet idsi
.. list-table:: Dönüş Değerleri ve Açıklamaları
:width: 600px
:widths: 25 15 60
:header-rows: 1
* - Dönüş Değeri
- Tip
- Açıklama
* - agreements[0].code
- string
- sözleşmenin kodu.
* - agreements[0].text
- string
- sözleşmenin adı / açıklaması
* - agreements[0].agreement_body
- string
- sözleşmenin html metni
**Örnek İstek:**
.. code-block:: json
{
"order_id": "20220407134221",
"session_token": "c8aac38d-ed78-471c-83e3-83a9d00586e7",
"shipping_address": {
"name": "Utku",
"surname": "YILDIZ",
"phone_number": "905369513702",
"postal_code": "123",
"notes": null,
"company_name": null,
"address_title": "Mük Adres",
"tax_no": null,
"tax_office": null,
"is_default": true,
"line": "Falanca sokak filanca bina ÅŸurada bir yer.",
"address_type": "CUSTOMER",
"country": {
"name": "Türkiye",
"code": "TR"
},
"city": {
"name": "AYDIN",
"code": "AYDIN"
},
"town": {
"name": "SÖKE",
"code": "AYDIN_SOKE"
},
"district": {
"name": "KONAK MAH",
"code": "1309246"
},
"status": "ACTIVE",
"hash_data": "33225F04656FCB8933BC5DD9939C9F256E8838F63C67AFDA06DA240E03EC9DFC"
},
"billing_address": {
"name": "Utku",
"surname": "YILDIZ",
"phone_number": "905369513702",
"postal_code": "123",
"notes": null,
"company_name": null,
"address_title": "Mük Adres",
"tax_no": null,
"tax_office": null,
"is_default": true,
"line": "Falanca sokak filanca bina ÅŸurada bir yer.",
"address_type": "CUSTOMER",
"country": {
"name": "Türkiye",
"code": "TR"
},
"city": {
"name": "AYDIN",
"code": "AYDIN"
},
"town": {
"name": "SÖKE",
"code": "AYDIN_SOKE"
},
"district": {
"name": "KONAK MAH",
"code": "1309246"
},
"status": "ACTIVE",
"hash_data": "33225F04656FCB8933BC5DD9939C9F256E8838F63C67AFDA06DA240E03EC9DFC"
},
"user": {
"name": "Utku",
"surname": "YILDIZ",
"gender": null,
"email": "utku.yildiz2@akinon.com",
"birth_date": null,
"identity_number": null,
"phone_number": "+905369513702",
"phone": {
"country_phone_code": "+90",
"national_phone_number": "5369513702"
},
"akinon_user_id": "0FA16FF875464259A56FE7FDA305C7D7",
"status": "ACTIVE",
"verification_date": "2022-03-29T14:06:13.88+00:00",
"email_verified": false
},
"shipping_option_key": "13",
"language": "tr",
"conversation_id": "kdLEMDASDPRI23445D",
"basket_id": "B-202111191524"
}
**Örnek Cevap:**
.. code-block:: json
{
"code":"OBF",
"text":"Ön Bilgilendirme Formu",
"agreement_body":"<html><body><p>Örnek Sözleşme Metni</p></body></html>"
}
Sözleşmeleri sorgulama
----------------------
Akifast uygulamasında ödeme oturumu oluşturulduktan sonra bu oturum oluşturulurken kullanılan veriler ve
kullanıcının seçtiği adres vs. bilgileri aşağıdaki şekilde sözleşme sorgulamak için üye iş yerine gönderilir.
Akifast uygulaması ödeme oturumu oluştururken gönderilen ``query_agreements_url`` parametresi ile belirtilen adrese
aşağıdaki parametreleri POST isteği olarak iletir.
.. note:: Eğer üye iş yerinden dönen cevap null ise Akifast uygulamasında 500 Internal Server Error hatası gönderiliyor!
.. list-table:: İstek Parametreleri ve Açıklamaları
:width: 600px
:widths: 15 15 70
:header-rows: 1
* - Parametre
- Tip
- Açıklama
* - order_id
- string
- Üye iş yeri tarafındaki sipariş numarası
* - session_token
- string
- Üye iş yerinin aldığı ödeme oturumu anahtarı
* - shipping_address
- Address Objesi
- Kullanıcının seçtiği kargo adresi
* - billing_address
- Address Objesi
- Kullanıcının seçtiği fatura adresi
* - user
- akipay_user objesi
- İşlem sahibi kullanıcının bilgileri
* - shipping_option_key
- string
- Kullanıcın seçtiği kargo seçeneği
* - language
- string
- Kullanıcının seçtiği dil seçeneği
* - conversation_id
- string
- Ödeme oturumu oluştururken üye iş yeri tarafından gönderilen bumerang değer
* - basket_id
- string
- Ödeme oturumu oluşturulurken gönderilen sepet idsi
.. list-table:: Dönüş Değerleri ve Açıklamaları
:width: 600px
:widths: 25 15 60
:header-rows: 1
* - Dönüş Değeri
- Tip
- Açıklama
* - agreements[0].code
- string
- sözleşmenin kodu.
* - agreements[0].text
- string
- sözleşmenin adı / açıklaması
* - agreements[0].agreement_body
- string
- sözleşmenin html metni
**Örnek İstek:**
.. code-block:: json
{
"order_id": "20220407134221",
"session_token": "c8aac38d-ed78-471c-83e3-83a9d00586e7",
"shipping_address": {
"name": "Utku",
"surname": "YILDIZ",
"phone_number": "905369513702",
"postal_code": "123",
"notes": null,
"company_name": null,
"address_title": "Mük Adres",
"tax_no": null,
"tax_office": null,
"is_default": true,
"line": "Falanca sokak filanca bina ÅŸurada bir yer.",
"address_type": "CUSTOMER",
"country": {
"name": "Türkiye",
"code": "TR"
},
"city": {
"name": "AYDIN",
"code": "AYDIN"
},
"town": {
"name": "SÖKE",
"code": "AYDIN_SOKE"
},
"district": {
"name": "KONAK MAH",
"code": "1309246"
},
"status": "ACTIVE",
"hash_data": "33225F04656FCB8933BC5DD9939C9F256E8838F63C67AFDA06DA240E03EC9DFC"
},
"billing_address": {
"name": "Utku",
"surname": "YILDIZ",
"phone_number": "905369513702",
"postal_code": "123",
"notes": null,
"company_name": null,
"address_title": "Mük Adres",
"tax_no": null,
"tax_office": null,
"is_default": true,
"line": "Falanca sokak filanca bina ÅŸurada bir yer.",
"address_type": "CUSTOMER",
"country": {
"name": "Türkiye",
"code": "TR"
},
"city": {
"name": "AYDIN",
"code": "AYDIN"
},
"town": {
"name": "SÖKE",
"code": "AYDIN_SOKE"
},
"district": {
"name": "KONAK MAH",
"code": "1309246"
},
"status": "ACTIVE",
"hash_data": "33225F04656FCB8933BC5DD9939C9F256E8838F63C67AFDA06DA240E03EC9DFC"
},
"user": {
"name": "Utku",
"surname": "YILDIZ",
"gender": null,
"email": "utku.yildiz2@akinon.com",
"birth_date": null,
"identity_number": null,
"phone_number": "+905369513702",
"phone": {
"country_phone_code": "+90",
"national_phone_number": "5369513702"
},
"akinon_user_id": "0FA16FF875464259A56FE7FDA305C7D7",
"status": "ACTIVE",
"verification_date": "2022-03-29T14:06:13.88+00:00",
"email_verified": false
},
"shipping_option_key": "13",
"language": "tr",
"conversation_id": "kdLEMDASDPRI23445D",
"basket_id": "B-202111191524"
}
**Örnek Cevap:**
.. code-block:: json
{
"agreements":[
{
"code":"OBF",
"text":"Ön Bilgilendirme Formu",
"agreement_body":"<html><body><p>Örnek Sözleşme Metni</p></body></html>"
},
{
"code":"MSS",
"text":"Mesafeli Satış Sözleşmesi",
"agreement_body":"<html><body><p>Örnek Sözleşme Metni</p></body></html>"
}
]
}