ÖHVPS

https://ohvps.github.io/
Admin
ÖHVPS (Ödeme Hizmetleri Veri Paylaşım Servisleri) is a Turkish API documentation for payment...
Tokens:151,889
Snippets:1,062
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /hesaplar ve GET /hesaplar/{hspRef}

Source: https://ohvps.github.io/v2.0.0/contents/hesap-bilgisi-hizmeti.html

Tüm hesapların listesini veya belirli bir hesabın detaylı bilgilerini sorgulamak için kullanılır.

```APIDOC
## GET /hesaplar
## GET /hesaplar/{hspRef}

### Description
Bu erişim noktalarından tüm hesapların veya belirli bir hesabın bilgileri sorgulanır. İzin türüne göre (Temel veya Detaylı) dönen HesapBilgileri nesnesi içeriği değişir.

### Method
GET

### Endpoint
/hesaplar
/hesaplar/{hspRef}

### Parameters
#### Path Parameters
- **hspRef** (string) - Zorunlu - HHS tarafından hesap için atanan biricik tanımlayıcı (uuid).

#### Query Parameters
- **syfKytSayi** (N3) - İsteğe bağlı - Sayfa başına istenen kayıt sayısı (Maksimum 100).
- **syfNo** (N3) - İsteğe bağlı - Cevapta dönecek sayfa numarası (1'den başlar).
- **srlmKrtr** (AN3..50) - İsteğe bağlı - Sıralama kriteri (Değer: hspRef).
- **srlmYon** (AN1) - İsteğe bağlı - Sıralama yönü (A: Azalan, Y: Artan).

### Response
#### Success Response (200)
- **rizaNo** (string) - Rıza numarası.
- **hspTml** (object) - Temel Hesap Bilgileri nesnesi.
- **hspDty** (object) - Koşullu: Detay Hesap Bilgileri nesnesi.
```

--------------------------------

### GET /olay-abonelik

Source: https://ohvps.github.io/v2.0.0/contents/olay-bildirim.html

Mevcut olay aboneliklerini listeler.

```APIDOC
## GET /olay-abonelik

### Description
YÖS'ün mevcut olay aboneliklerini görüntülemesini sağlar.

### Method
GET

### Endpoint
/olay-abonelik

### Response
#### Success Response (200)
- **OlayAbonelik** (object) - Abonelik bilgileri
```

--------------------------------

### GET /kartlar ve GET /kartlar/{kartRef}

Source: https://ohvps.github.io/v2.0.0/contents/hesap-bilgisi-hizmeti.html

Tüm kartların listelenmesi veya belirli bir kartın detay bilgilerinin sorgulanması için kullanılır.

```APIDOC
## GET /kartlar

### Description
Sistemdeki tüm kartların listesini sorgular. İlgili sorgu için 07 izin türü gereklidir.

### Method
GET

### Endpoint
/kartlar

### Query Parameters
- **syfKytSayi** (integer) - İsteğe bağlı - Sayfa başına kayıt sayısı
- **syfNo** (integer) - İsteğe bağlı - Sayfa numarası
- **kartTipi** (string) - İsteğe bağlı - Kart tipi filtresi (Örn: K)

### Response
#### Success Response (200)
- **KartBilgileri** (object) - Kart detaylarını içeren nesne

---

## GET /kartlar/{kartRef}

### Description
Belirli bir kartın detay bilgilerini sorgular.

### Method
GET

### Endpoint
/kartlar/{kartRef}

### Path Parameters
- **kartRef** (string) - Required - Sorgulanacak kartın referans numarası

### Response
#### Success Response (200)
- **KartBilgileri** (object) - Kart detaylarını içeren nesne
```

--------------------------------

### GET /bakiye ve GET /hesaplar/{hspRef}/bakiye

Source: https://ohvps.github.io/v2.0.0/contents/hesap-bilgisi-hizmeti.html

Tüm hesapların veya belirli bir hesabın bakiyesini sorgulamak için kullanılan uç noktalar.

```APIDOC
## GET /bakiye
## GET /hesaplar/{hspRef}/bakiye

### Description
Tüm hesapların veya belirli bir hesabın bakiyesini sorgular. İstek sonucunda BakiyeBilgileri nesnesi döner.

### Method
GET

### Endpoint
/bakiye
/hesaplar/{hspRef}/bakiye

### Parameters
#### Path Parameters
- **hspRef** (string) - Required - Sorgulanacak hesabın referans numarası.

#### Query Parameters
- **syfKytSayi** (N3) - Optional - Sayfa başına istenen kayıt sayısı (Maksimum 100).
- **syfNo** (N3) - Optional - İstenen sayfa numarası.
- **srlmKrtr** (AN3..50) - Optional - Sıralama kriteri (Örn: hspRef).
- **srlmYon** (AN1) - Optional - Sıralama yönü (A: Azalan, Y: Artan).

### Response
#### Success Response (200)
- **BakiyeBilgileri** (Object) - Hesap bakiye bilgilerini içeren nesne.

#### Error Handling
- **TR.OHVPS.Connection.InvalidToken**: Geçersiz erişim belirteci.
- **TR.OHVPS.Resource.NotFound**: Hesap bulunamadı veya rıza uyuşmazlığı.
- **TR.OHVPS.Resource.ConsentMismatch**: Rıza durumu uygun değil.
- **TR.OHVPS.Resource.ConsentRevoked**: Rıza iptal edilmiş veya sonlandırılmış.
- **TR.OHVPS.Business.PermissionTypeNotSupported**: Gerekli izin türü (03) bulunmuyor.
```

--------------------------------

### GET /olay-abonelik

Source: https://ohvps.github.io/v2.0.0/contents/olay-bildirim.html

YÖS'e ait aktif durumdaki olay abonelik bilgilerini sorgular.

```APIDOC
## GET /olay-abonelik

### Description
YÖS'ün aktif durumdaki abonelik bilgilerini sorgulamak için kullanılır. Başarılı işlem HTTP 200 kodu ile döner.

### Method
GET

### Endpoint
/olay-abonelik

### Response
#### Success Response (200)
- **olayAbonelikNo** (AN1..64) - Z - YÖS özelinde oluşturulan tekil tanımlayıcı.
- **olusturmaZamani** (ISODateTime) - Z - Olay Abonelik nesnesinin oluşturulma zaman damgası.
- **guncellemeZamani** (ISODateTime) - Z - Olay Abonelik nesnesinin güncelleme zaman damgası.
- **katilimciBlg** (Kompleks) - Z - Katılımcı bilgileri (hhsKod, yosKod).
- **abonelikTipleri** (Array) - Z - YÖS'ün abone olduğu olay ve kaynak listesi (olayTipi, kaynakTipi).
```

--------------------------------

### GET /kart-bilgileri

Source: https://ohvps.github.io/v2.0.0/contents/hesap-bilgisi-hizmeti.html

Sistemdeki kart bilgilerini listelemek için kullanılan uç nokta.

```APIDOC
## GET /kart-bilgileri

### Description
Kullanıcıya ait kart bilgilerini listeler. Sayfalama ve kart tipi filtreleme desteklenir.

### Method
GET

### Endpoint
/kart-bilgileri

### Parameters
#### Query Parameters
- **syfKytSayi** (N3) - İsteğe bağlı - Sayfa başına istenen kayıt sayısı (Maksimum 100).
- **syfNo** (N3) - İsteğe bağlı - İstenen sayfa numarası (1'den başlar).
- **kartTipi** (AN1) - İsteğe bağlı - Sorgulanacak kart tipi (Banka, Kredi, Ön Ödemeli).

### Response
#### Success Response (200)
- **rizaNo** (AN1..128) - Rıza numarası.
- **kartRef** (AN5..40) - Kart referans numarası (UUID).
- **kartNo** (AN15..16) - Maskelenmiş kart numarası.
- **asilKartNo** (AN15..16) - Bağlı olduğu asıl kart numarası (Koşullu).
- **kartTipi** (AN1) - Kart tipi kodu.
- **altKartTipi** (AN1) - Alt kart tipi kodu.
- **kartFormu** (AN1) - Kartın fiziksel/dijital durumu.
- **kartTuru** (AN1) - Bireysel (B) veya Ticari (T).
- **kartStatu** (AN1) - Kartın güncel statüsü.
- **kartSahibi** (AN3..140) - Kart sahibi adı.
- **kartTicariUnvan** (AN3..140) - Ticari unvan (Koşullu).
- **kartUrunAdi** (AN3..140) - Kart ürün adı.
- **ekstreTurleri** (Array) - Ekstre türleri listesi.
- **kartRumuz** (AN3..140) - Kart rumuzu (İsteğe bağlı).
- **kartSema** (AN1) - Kart şeması.
```

--------------------------------

### GET /olay-abonelik/{olayAbonelikNo}/iletilemeyen-olaylar

Source: https://ohvps.github.io/v2.0.0/contents/olay-bildirim.html

Anlık iletilemeyen olayları sorgular.

```APIDOC
## GET /olay-abonelik/{olayAbonelikNo}/iletilemeyen-olaylar

### Description
HHS anlık iletemediği olaylarını biriktirerek, bu endpoint ile YÖS'e sunar.

### Method
GET

### Endpoint
/olay-abonelik/{olayAbonelikNo}/iletilemeyen-olaylar

### Parameters
#### Path Parameters
- **olayAbonelikNo** (string) - Required - Abonelik numarası

#### Query Parameters
- **Sayfalama** (object) - Optional - Sayfalama parametreleri

### Response
#### Success Response (200)
- **Olaylar** (object) - İletilemeyen olaylar listesi
```

--------------------------------

### GET /kart-hareketleri

Source: https://ohvps.github.io/v2.0.0/contents/hesap-bilgisi-hizmeti.html

Belirtilen kriterlere göre kart hareketlerini sorgulamak için kullanılan uç nokta.

```APIDOC
## GET /kart-hareketleri

### Description
Kart hareketlerini belirli dönem, ekstre türü ve filtreleme kriterlerine göre sorgular.

### Method
GET

### Endpoint
/kart-hareketleri

### Parameters
#### Query Parameters
- **ekstreTuru** (AN3) - Optional - Ekstre para birimi (TRY, USD, EUR, GBP). Varsayılan: TRY.
- **syfKytSayi** (N3) - Optional - Sayfa başına kayıt sayısı (Maksimum 100).
- **syfNo** (N3) - Optional - İstenen sayfa numarası.
- **brcAlc** (AN1) - Optional - Borç/Alacak göstergesi (B: Borç, A: Alacak, N: Finansal olmayan).
- **srlmYon** (AN1) - Optional - Sıralama yönü (A: Azalan, Y: Artan).

### Response
#### Success Response (200)
- **kartRef** (AN5..40) - Kart referans numarası (UUID).
- **donemDegeri** (N3) - Sorgulanan dönem değeri.
- **donemBaslangicTarihi** (ISODate) - Dönem başlangıç tarihi.
- **donemBitisTarihi** (ISODate) - Dönem bitiş tarihi.
- **ekstreTuru** (AN3) - Ekstre türü.
- **ekstreBorcu** (Kompleks) - Ekstre borç bilgisi (tutar, paraBirimi).
- **asgariOdemeTutari** (Kompleks) - Asgari ödeme tutarı (tutar, paraBirimi).
```

--------------------------------

### Özel Anahtarı PKCS8 Formatına Çevirme (openssl)

Source: https://ohvps.github.io/v2.0.0/contents/ekler.html

Java gibi bazı sistemlerin PKCS8 formatındaki özel anahtarlara ihtiyaç duyması durumunda kullanılır. Bu komut, mevcut özel anahtarı PKCS8 formatına dönüştürür.

```bash
openssl pkcs8 -topk8 -inform PEM -in private.pem -out private_key.pem –nocrypt
```

--------------------------------

### Installment Information

Source: https://ohvps.github.io/v2.0.0/contents/hesap-bilgisi-hizmeti.html

Details related to installment payments, including total amount, number of installments, and installment period.

```APIDOC
## GET /websites/ohvps_github_io/installment

### Description
Retrieves installment-related information for a transaction.

### Method
GET

### Endpoint
/websites/ohvps_github_io/installment

### Parameters
#### Query Parameters
- **toplamTaksitTutari** (Complex:ToplamTaksitTutari) - Optional - The total amount for installment transactions. This field should only be provided if the transaction is an installment-based one. It is mandatory for credit card types and should not be provided for debit or prepaid card types.
- **tutar** (AN1..25) - Required - The installment amount. Regex pattern: '^[\-+]?\d{1,18}$|^[\-+]?\d{1,18}\.\d{1,5}$'.
- **paraBirimi** (AN3) - Required - The currency of the transaction.
- **toplamTaksitSayisi** (N2) - Optional - The total number of installments for the transaction. This field should only be provided if the transaction is an installment-based one. It is mandatory for credit card types and should not be provided for debit or prepaid card types.
- **taksitDonemi** (N2) - Optional - The current installment period for installment transactions. For example, if the 2nd installment of a 3-installment transaction has been processed, this should be sent as 2. It is mandatory for credit card types and should not be provided for debit or prepaid card types.
- **saticiKategoriKodu** (AN4) - Optional - The Seller Category Code (MCC). It is mandatory to send if available, and mandatory for purchase transactions. It is mandatory for credit and debit card types if a value is to be returned according to the condition.

### Response
#### Success Response (200)
- **toplamTaksitTutari** (Complex:ToplamTaksitTutari) - Total installment amount.
- **tutar** (AN1..25) - Installment amount.
- **paraBirimi** (AN3) - Currency code.
- **toplamTaksitSayisi** (N2) - Total number of installments.
- **taksitDonemi** (N2) - Current installment period.
- **saticiKategoriKodu** (AN4) - Seller Category Code (MCC).
```

--------------------------------

### PSU-Fraud-Check JWT Header Example

Source: https://ohvps.github.io/v2.0.0/contents/ekler.html

This is an example of a JWT formatted header for PSU-Fraud-Check. Ensure the JWT is signed correctly for secure communication.

```text
eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwczovL2FwaWd3LmJrbS5jb20udHIiLCJleHAiOjE2NjU0NzU1NjIsImlhdCI6MTY2NTM4OTE2MiwiYm9keSI6ImE2NGIxOWY5NWVlYjFmYjBhMGEzZTJkYmJjNmUzZDg0NzJjNTIxODRkNDU0MzQxN2RkYzZkMTU2ZmM1YzU1NzEifQ.Q65PI_1fTEzzBMirvmJvXgVX3orhhZ4_UqujtGdHkU7me-1ymIjvPrzy3kfyER1pedFb7HDCBuPvYoqjX8eUnpiiZsxfzCiEa0McIhoFeUOggq-O8VihItp8bLr2DWwQ9JHN1-WXB2mL31KAKFAL1VY9-DXuAdT-RfE_SLYsl2ycmNy4ti4XvfDvvlE56ZsieFZ727VuwR8wi7F0kKDc6UhjaMF9xcUeAM1fxX-bmcOaOo1NZGC0vvgjNZKz_OJrN-q8VhWYnQPiJ7wY7S9IG8bHIkBImKSVf8LuOEvl8u0BZzADLH1iOBd9x2l1plyI_NLPTrnOqhWhKlljkkJBCg
```

--------------------------------

### GET /yos

Source: https://ohvps.github.io/v2.0.0/contents/hhs-yos-api.html

Retrieves a list of all YÖS institutions in an array format. This endpoint can be used to get a general overview of all available YÖS data.

```APIDOC
## GET /yos

### Description
Retrieves a list of all YÖS institutions in an array format. This endpoint can be used to get a general overview of all available YÖS data.

### Method
GET

### Endpoint
/yos

### Response
#### Success Response (200)
- **Yos** (Array[object]) - An array containing detailed information for each YÖS institution, following the structure described in the `GET /yos/{yosKod}` endpoint.

#### Response Example
```json
{
  "Yos": [
    {
      "kod": "2501",
      "unv": "Example University",
      "marka": "ExUni",
      "roller": ["obhs", "hbhs"],
      "adresler": [
        {
          "yetYntm": "Y",
          "adresDetaylari": [
            {
              "tmlAdr": "https://example.com/auth",
              "aciklama": "WEB bireysel"
            }
          ]
        }
      ],
      "acikAnahtar": "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----",
      "apiBilgileri": [
        {
          "api": "ods",
          "surum": "s1.0"
        }
      ],
      "logoBilgileri": [
        {
          "logoTur": "MainLogo",
          "logoAdr": "https://via.placeholder.com/150?text=0001",
          "logoArkaPlan": "D",
          "logoFormat": "PNG"
        }
      ],
      "durum": "A"
    },
    {
      "kod": "2502",
      "unv": "Another University",
      "marka": "AnUni",
      "roller": ["obhs"],
      "adresler": [],
      "acikAnahtar": "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----",
      "apiBilgileri": [],
      "logoBilgileri": [],
      "durum": "P"
    }
  ]
}
```
```

--------------------------------

### GET /duzenli-odeme-emri/{talimatNo}/odeme-plani

Source: https://ohvps.github.io/v2.0.0/contents/duzenli-odeme-emri-hizmeti.html

Belirli bir düzenli ödeme emrine ait ödeme planını görüntülemek için kullanılır.

```APIDOC
## GET /duzenli-odeme-emri/{talimatNo}/odeme-plani

### Description
ÖBHS, bu erişim adresi aracılığıyla düzenli ödeme planını görüntüleyebilir. İptal edilen bir ödeme emri rızasına dair talimat ödeme planı görüntülenemeyecektir.

### Method
GET

### Endpoint
/duzenli-odeme-emri/{talimatNo}/odeme-plani

### Parameters
#### Path Parameters
- **talimatNo** (string) - Required - Ödeme planı sorgulanacak talimat numarası.

### Response
#### Success Response (200)
- **DuzenliOdemeEmriPlani** (object) - Ödeme planı detaylarını içeren nesne.

#### Response Fields
- **odmSiraNo** (string) - Ödeme sıra numarası.
- **odmTtr** (string) - Ödeme tutarı.
- **grckOdmTtr** (string) - Gerçekleşen ödeme tutarı (Koşullu).
- **prBrm** (string) - Ödeme tutarı para birimi.
- **odmTlmtTrh** (string) - Ödeme talimat tarihi.
- **odmGrckZmn** (string) - Ödeme gerçekleşme zamanı (Koşullu).
- **odmDrm** (string) - Ödeme durumu.
```

--------------------------------

### POST /duzenli-odeme-emri

Source: https://ohvps.github.io/v2.0.0/contents/duzenli-odeme-emri-hizmeti.html

Ödeme Hizmeti Sağlayıcısı (ÖSP) tarafından, Ödeme Hizmeti Sağlayıcısı (ÖSP) tarafından yetkilendirilmiş bir düzenli ödeme emri oluşturmak için kullanılır. Bu işlem, Ödeme Hizmeti Sağlayıcısı (ÖSP) tarafından Güçlü Kimlik Doğrulama (GKD) ile yetkilendirilmiş bir düzenli ödeme emri oluşturur.

```APIDOC
## POST /duzenli-odeme-emri

### Description
Bu API, ÖHK'nın Güçlü Kimlik Doğrulama ile işlemi yetkilendirmesi sonrasında, ÖBHS'nin DuzenliOdemeEmri kaynağını oluşturmasını sağlar. Düzenli Ödeme emri (DuzenliOdemeEmri) uygun ödeme kaynağına POST isteği yapılarak başlatılır.

### Method
POST

### Endpoint
/duzenli-odeme-emri

### Parameters
#### Request Body
- **rzBlg** (Kompleks: RizaBilgileri) - Zorunlu - Rıza Bilgileri
  - **> rizaNo** (AN1..128) - Zorunlu - OdemeEmriRızasi nesnesinin oluşturulması esnasında HHS kaynak sunucusu tarafından atanan biricik tanımlayıcı
  - **> olusZmn** (ISODateTime) - Zorunlu - OdemeEmriRizasi nesnesinin oluşturulma zamanı
  - **> rizaDrm** (AN1) - Zorunlu - **TR.OHVPS.DataCode.RizaDurumu** sıralı veri tipini değerlerinden birini alır.
- **katilimciBlg** (Kompleks:KatilimciBilgisi) - Zorunlu - Katılımcılara atanmış kod bilgileridir.
  - **> hhsKod** (AN4) - Zorunlu - İsteğin iletildiği Hesap Hizmeti Sağlayıcısının kodudur. (Nezdinde ÖH bulunduran kuruluş kodu. Örneğin, Banka, Elektronik Para Kuruluşu ve Ödeme Kuruluşu)
  - **> yosKod** (AN4) - Zorunlu - İsteği gönderen Yetkili Ödeme Hizmeti Sağlayıcısı (YÖS) kodudur.
- **gkd** (Kompleks:Gkd) - Zorunlu - Güçlü Kimlik Doğrulama bilgileri
  - **> yetYntm** (AN1) - Zorunlu - **TR.OHVPS.DataCode.GkdTur** sıralı veri türü değerlerinden birini alır.
  - **> yonAdr** (AN1..1024) - Koşullu - Yönlendirmeli güçlü kimlik doğrulama için zorunludur. HHS, müşteri uygulama / tarayıcısını yönlendirmeli akışta bu alanda belirtilen YÖS adresine yönlendirir.
  - **> ayrikGkd** (Kompleks:AyrikGkd) - Koşullu - Ayrık güçlü kimlik doğrulama için zorunlu. yetYntm = A gönderilmiş ise ayrikGkd nesnesinin dolu gönderilmesi zorunludur. yetYntm = Y için bu nesne iletilmemelidir.
    - **> > ohkTanimTip** (AN8) - Koşullu - ÖHK'nın HHS uygulaması tarafından tanınmasını sağlayacak tanım tipleridir. İstek içerisindeki veri değiştirilmeden iletilir.
    - **> > ohkTanimDeger** (AN1..30) - Koşullu - ÖHK'nın HHS uygulaması tarafından tanınmasını sağlayacak tanım değeridir. ohkTanimTip'i ile uyumlu değerdir. İstek içerisindeki veri değiştirilmeden iletilir.
  - **> hhsYonAdr** (AN1..1024) - Koşullu - Yönlendirmeli akış türünde GKD doğrulama bilgilerinin girilebilmesi için uygulamadan açılacak yönlendirme sayfasının adresi. Ayrık GKD akışında bu alan dönülmemelidir.

### Request Example
```json
{
  "rzBlg": {
    "rizaNo": "string",
    "olusZmn": "2023-10-27T10:00:00Z",
    "rizaDrm": "K"
  },
  "katilimciBlg": {
    "hhsKod": "string",
    "yosKod": "string"
  },
  "gkd": {
    "yetYntm": "A",
    "yonAdr": "https://example.com/redirect",
    "ayrikGkd": {
      "ohkTanimTip": "string",
      "ohkTanimDeger": "string"
    },
    "hhsYonAdr": "https://example.com/hhs/redirect"
  }
}
```

### Response
#### Success Response (200)
- **tlmtNo** (string) - Oluşturulan düzenli ödeme emrinin takip numarası.
- **rizaDrm** (string) - Rıza Durumu: "Yetki Ödeme Emrine/Talimata Dönüştü"

#### Response Example
```json
{
  "tlmtNo": "1234567890",
  "rizaDrm": "Yetki Ödeme Emrine/Talimata Dönüştü"
}
```

### Error Handling
- **TR.OHVPS.Connection.InvalidToken**: Geçerli bir Erişim Belirteci yok.
- **TR.OHVPS.Resource.InvalidFormat**: İstek mesajındaki alanlar ÖHVPS API İlke ve Kuralları'na uymuyor.
- **TR.OHVPS.Connection.InvalidASPSP**: HHS kodu, istek başlığındaki x-aspsp-code değeri ile aynı değil.
- **TR.OHVPS.Connection.InvalidTPP**: yosKod, geçerli bir Ödeme Hizmeti Sağlayıcısı Kodu değil veya istek başlığındaki x-tpp-code değeri ile aynı değil.
- **TR.OHVPS.Resource.ConsentMismatch**: Rıza durumu 'B', 'Y' veya 'E' ise.
- **TR.OHVPS.Resource.ConsentRevoked**: Rıza durumu 'I' veya 'S' ise.
- **TR.OHVPS.Business.FieldMismatch**: Düzenli Ödeme Emri rızasında gönderilen değerlerden farklı bir değer gönderildi.
```

--------------------------------

### Static URL Example for Consent Verification

Source: https://ohvps.github.io/v2.0.0/contents/duzenli-odeme-emri-hizmeti.html

This is an example of a static URL format used for consent verification. The URL includes a base path and a consent identifier.

```text
https://xbank.com.tr/ohvps/cb54834e36f742d09af3d534ece3352a
```

--------------------------------

### POST /erisim-belirteci

Source: https://ohvps.github.io/v2.0.0/contents/ileri-tarihli-odeme-emri-hizmeti.html

Acquires an access token, specifically for GKD (Yetkilendirme Kodu). The scope must be 'odeme_emri'.

```APIDOC
## POST /erisim-belirteci

### Description
Acquires an access token, specifically for GKD (Yetkilendirme Kodu). The scope must be 'odeme_emri'.

### Method
POST

### Endpoint
/erisim-belirteci

### Parameters
#### Request Body
- **ErisimBelirteciIstegi** (object) - Required - The request object for acquiring an access token.

### Request Example
```json
{
  "example": "ErisimBelirteciIstegi object details"
}
```

### Response
#### Success Response (200)
- **ErisimBelirteci** (object) - The access token details.

#### Response Example
```json
{
  "example": "ErisimBelirteci object details"
}
```
```

--------------------------------

### Dynamic URL Example for Consent Verification

Source: https://ohvps.github.io/v2.0.0/contents/duzenli-odeme-emri-hizmeti.html

This is an example of a dynamic URL format for consent verification. It includes a base path, a specific endpoint, and a consent identifier as a query parameter.

```text
https://xbank.com.tr/ohvps/gkd?rizano=cb54834e36f742d09af3d534ece3352a
```

--------------------------------

### GET /odeme-emri/{odemeEmriNo}

Source: https://ohvps.github.io/v2.0.0/contents/odeme-emri-baslatma-hizmeti.html

Belirli bir ödeme emrinin durumunu ve detaylarını sorgulamak için kullanılır.

```APIDOC
## GET /odeme-emri/{odemeEmriNo}

### Açıklama
Bu uç nokta, belirtilen ödeme emri numarası (`odemeEmriNo`) ile bir ödeme emrinin durumunu ve detaylarını sorgulamak için kullanılır. Bu, ödeme işleminin takibi için önemlidir.

### Method
GET

### Endpoint
/odeme-emri/{odemeEmriNo}

### Parameters
#### Path Parameters
- **odemeEmriNo** (string) - Required - Sorgulanacak ödeme emrinin numarası.

### Response
#### Success Response (200)
- **OdemeEmri** (object) - Ödeme emri bilgilerini içeren yanıt nesnesi.

#### Response Example
```json
{
  "example": "OdemeEmri response body"
}
```
```

--------------------------------

### GET /hesaplar

Source: https://ohvps.github.io/v2.0.0/contents/hesap-bilgisi-hizmeti.html

Kullanıcının hesap bilgilerini listeler.

```APIDOC
## GET /hesaplar

### Description
Kullanıcıya ait hesap bilgilerini listeler.

### Method
GET

### Endpoint
/hesaplar

### Parameters
#### Query Parameters
- **Sayfalama** (string) - Optional - Sayfalama parametreleri.

### Response
#### Success Response (200)
- **HesapBilgileri** (array) - Hesap bilgileri listesi.
```

--------------------------------

### POST /erisim-belirteci

Source: https://ohvps.github.io/v2.0.0/contents/erisim-belirteci.html

GKD sonrası dönülen yetkilendirme kodu ile yeni bir erişim belirteci oluşturur veya mevcut bir erişim belirtecini yenileme belirteci kullanarak yeniler.

```APIDOC
## POST /erisim-belirteci

### Description
Bu uç nokta, YÖS'ün HHS nezdinde erişim belirteci oluşturması veya yenilemesi için kullanılır. Başarılı bir GKD işlemi sonrası alınan yetkilendirme kodu veya mevcut bir yenileme belirteci ile istekte bulunulur.

### Method
POST

### Endpoint
/erisim-belirteci

### Parameters
#### Request Body
- **rizaNo** (string) - Required - Rıza nesnesinin oluşturulması esnasında HHS kaynak sunucusu tarafından atanan biricik tanımlayıcı.
- **rizaTip** (string) - Required - Rıza tipi (O, H, I, D).
- **yetTip** (string) - Required - Yetki tipi (yet_kod veya yenileme_belirteci).
- **yetKod** (string) - Conditional - GKD işleminden dönen tek kullanımlık yetkilendirme kodu (yetTip = 'yet_kod' ise zorunludur).
- **yenilemeBelirteci** (string) - Conditional - Erişim belirtecinin yenilenmesi amacıyla kullanılır (yetTip = 'yenileme_belirteci' ise zorunludur).

### Request Example
{
  "rizaNo": "123456789",
  "rizaTip": "H",
  "yetTip": "yet_kod",
  "yetKod": "abc123xyz"
}

### Response
#### Success Response (200)
- **erisimBelirteci** (string) - Sonraki servis çağrılarında kullanılan erişim belirteci.
- **gecerlilikSuresi** (number) - Erişim belirtecinin saniye cinsinden geçerlilik süresi.
- **yenilemeBelirteci** (string) - Yenileme belirteci.
- **yenilemeBelirteciGecerlilikSuresi** (number) - Yenileme belirtecinin saniye cinsinden geçerlilik süresi.

#### Response Example
{
  "erisimBelirteci": "eyJhbGci...",
  "gecerlilikSuresi": 3600,
  "yenilemeBelirteci": "ref_abc123",
  "yenilemeBelirteciGecerlilikSuresi": 86400
}
```

--------------------------------

### GET /hesaplar/{hspRef}

Source: https://ohvps.github.io/v2.0.0/contents/hesap-bilgisi-hizmeti.html

Belirli bir hesap referansı (hspRef) üzerinden hesap bilgilerini sorgular.

```APIDOC
## GET /hesaplar/{hspRef}

### Description
Müşteri rızası tesis edilmiş kullanıcı için HHS'ye erişilebilir hesap bilgilerini sorgular.

### Method
GET

### Endpoint
/hesaplar/{hspRef}

### Parameters
#### Path Parameters
- **hspRef** (string) - Required - Sorgulanacak hesabın referans numarası.

### Response
#### Success Response (200)
- **HesapBilgileri** (object) - Hesap bilgilerini içeren nesne.

#### Error Handling
- **TR.OHVPS.Resource.InvalidFormat**: Parametre değerleri hatalı gönderildiğinde.
- **TR.OHVPS.Connection.InvalidToken**: Geçersiz erişim belirteci durumunda.
- **TR.OHVPS.Resource.NotFound**: hspRef bulunamadığında veya rıza ile eşleşmediğinde.
- **TR.OHVPS.Resource.ConsentMismatch**: Rıza durumu uygun olmadığında.
- **TR.OHVPS.Resource.ConsentRevoked**: Rıza iptal edildiğinde veya sonlandırıldığında.
- **TR.OHVPS.Business.PermissionTypeNotSupported**: '01: Temel Hesap Bilgisi' izin türüne sahip olunmadığında.
```

--------------------------------

### GET /yetkilendirme-kodu

Source: https://ohvps.github.io/v2.0.0/contents/olay-bildirim.html

Retrieves the authorization code after a successful AYRIK_GKD_BASARILI event.

```APIDOC
## GET /yetkilendirme-kodu

### Description
Retrieves the authorization code (yetkod) after the user has successfully authenticated in the HHS system.

### Method
GET

### Endpoint
/yetkilendirme-kodu

### Parameters
#### Query Parameters
- **rizaNo** (string) - Required - The consent identifier.
- **rizaTip** (string) - Required - The type of consent (O, H, I, D).
```

--------------------------------

### GET /ileri-tarihli-odeme-emri-rizasi/{RizaNo}

Source: https://ohvps.github.io/v2.0.0/contents/ileri-tarihli-odeme-emri-hizmeti.html

Mevcut durumunu kontrol etmek için oluşturulan bir IleriTarihliOdemeEmriRizasi kaynağının durumunu isteğe bağlı olarak alabilirsiniz. Gönderen hesap bilgisi, ADIM 2 sonrasında HHS ekranından seçildiği akışta bu API isteği ile güncellenir.

```APIDOC
## GET /ileri-tarihli-odeme-emri-rizasi/{RizaNo}

### Description
ÖBHS, mevcut durumunu kontrol etmek için, oluşturulan bir IleriTarihliOdemeEmriRizasi kaynağının durumunu isteğe bağlı olarak alabilir. Gönderen Hesap Bilgisinin, ADIM 2 (İleri Tarihli Ödeme Emri Rızasının Yetkilendirilmesi) sonrasında HHS ekranından seçildiği akışta “IleriTarihliOdemeEmriRizasi” nesnesi güncellenir ve ÖBHS bu isteği yaparak güncel gönderen hesap bilgisi bilgisini de içeren “IleriTarihliOdemeEmriRizasi” nesnesini çekmelidir.

### Method
GET

### Endpoint
/ileri-tarihli-odeme-emri-rizasi/{RizaNo}

### Parameters
#### Path Parameters
- **RizaNo** (string) - Required - İleri Tarihli Ödeme Emri Rızasının benzersiz numarası.

### Response
#### Success Response (200)
- **IleriTarihliOdemeEmriRizasiİstegi** (object) - Başarılı bir sorgulama sonucunda dönen nesne.

#### Response Example
```json
{
  "example": "IleriTarihliOdemeEmriRizasiİstegi nesnesi içeriği"
}
```

#### Error Response (404)
- **TR.OHVPS.Resource.NotFound** - Sorgulama yapılan İleri Tarihli Ödeme Emri HHS tarafında bulunmuyor ise bu hata döner.
```
Tokens:
Raw