Ana içeriğe geç

retrieve-bank-transactions

POST /api/{team}/gateway/retrieve-bank-transactions

Token'larını gönderdiğiniz banka hesaplarının hareketlerini döndürür; hiçbir şeyi değiştirmez. Hareketler eskiden yeniye, sayfa sayfa gelir. Birden çok hesap gönderirseniz hareketleri bankanın kayıt anına (booked_at) göre iç içe sıralanır. Bütün sorgu uçları gibi her zaman sayfalıdır ve yanıtta her zaman pagination döner: Sayfalama. Akış: Banka Hareketleri rehberi.

Hareketler ödemehub'ın sakladığı kayıtlardan döner. ödemehub her hesabı saatte bir bankadan okur; yanıt bankanın en fazla yaklaşık bir saat gerisindedir. Hesap eklendiğinde son 7 günün hareketleri okunur; daha eskisi gelmez.

Kimlik doğrulama​

X-Api-Key, X-Timestamp, X-Signature, Content-Type: application/json. Ayrıntılar: Kimlik Doğrulama ve İmza.

İstek​

{
"bank_account_tokens": ["5c1e9a72-3b4d-4f8e-a6c2-1d7b9e0f3a54"],
"created_from": "2026-10-20",
"created_to": "2026-10-26",
"page": 1,
"per_page": 50
}
AlanTipZorunluAçıklama
bank_account_tokensarrayevetHesapların token'ları (UUID), 1–50 tane. Başka bir çalışma alanının token'ı hiçbir şey bulmaz.
created_fromstringhayırBaşlangıç günü, YYYY-MM-DD. created_to ile birlikte gönderilir.
created_tostringhayırBitiş günü, YYYY-MM-DD. created_from ile birlikte gönderilir; ondan önce olamaz. Aralık iki gün dahil en fazla 7 gündür.
pageintegerhayırSayfa, 1'den başlar. Gönderilmezse 1.
per_pageintegerhayırSayfadaki hareket sayısı, 1–250. Gönderilmezse page gönderildiyse 50, page de gönderilmediyse 250.

Tarihler çalışma alanının saat dilimindedir ve bankanın hareketi kaydettiği günü (booked_at) süzer, ödemehub'ın okuduğu anı değil. Tarih gönderilmezse bugün dahil son 7 gün listelenir. Eşleşen hareket yoksa liste boştur.

SDK örnekleri​

not

Örneklerdeki $client / client nesnesinin kurulumu: İstemciyi Kurmak.

use Gurmehub\Odemehub\Request\RetrieveBankTransactions;

$list = $client->retrieveBankTransactions(new RetrieveBankTransactions(
bankAccountTokens: [$bankAccountToken],
createdFrom: '2026-10-20',
createdTo: '2026-10-26',
page: 1,
));

$list->bankTransactions[0]->amount; // "22164.96" giren, "-40.00" çıkan
$list->pagination->hasMorePages();

Bütün sayfaları okumak için page'i pagination.last_page'e kadar artırın: Hareketleri okuma.

Yanıt​

{
"result": { "successful": true, "message": null },
"created_from": "2026-10-20",
"created_to": "2026-10-26",
"pagination": {
"page": 1,
"per_page": 50,
"total": 2,
"last_page": 1
},
"bank_transactions": [
{
"token": "9a3f1c6e-7b2d-4e5a-8c1f-0d6e4b2a7c93",
"bank_account_token": "5c1e9a72-3b4d-4f8e-a6c2-1d7b9e0f3a54",
"booked_at": "2026-10-24T07:15:00.000000Z",
"value_date": "2026-10-24",
"amount": "22164.96",
"currency": "TRY",
"balance_after": "48210.35",
"description": "Gelen FAST",
"sender_description": "Fatura 2026-118",
"counterparty_iban": "TR120001000000000012345678",
"counterparty_tax_number": "1234567890"
},
{
"token": "2e8b5d14-6f3a-4c7e-9b0d-1a5c7e3f9d28",
"bank_account_token": "5c1e9a72-3b4d-4f8e-a6c2-1d7b9e0f3a54",
"booked_at": "2026-10-25T11:40:00.000000Z",
"value_date": "2026-10-25",
"amount": "-40.00",
"currency": "TRY",
"balance_after": "48170.35",
"description": "EFT ücreti",
"sender_description": null,
"counterparty_iban": null,
"counterparty_tax_number": null
}
]
}
AlanTipAçıklama
created_from, created_tostringListenin kapsadığı günler, YYYY-MM-DD; tarih gönderilmediyse son 7 gün.
pagination.pageintegerBu sayfa.
pagination.per_pageintegerSayfadaki en fazla hareket sayısı.
pagination.totalintegerBütün sayfalardaki hareket sayısı.
pagination.last_pageintegerSon sayfa; hareket yoksa 1. page last_page'ten küçükse sonraki sayfa vardır.
bank_transactions[]arrayHareket nesneleri, eskiden yeniye. last_page'ten büyük bir sayfa boş liste döner.

Hareket nesnesi​

AlanTipAçıklama
tokenstringHareketin token'ı. Aynı hareket her sorguda aynı token'la döner.
bank_account_tokenstringHareketin ait olduğu hesabın token'ı.
booked_atstringBankanın hareketi kaydettiği an, ISO 8601 UTC.
value_datestring | nullValör günü, YYYY-MM-DD.
amountstringİki ondalıklı, işaretli tutar: hesaba giren para artı ("22164.96"), çıkan para eksi ("-40.00").
currencystringTRY, USD, EUR, GBP.
balance_afterstring | nullHareketten sonraki bakiye.
descriptionstring | nullBankanın açıklaması.
sender_descriptionstring | nullGönderenin yazdığı açıklama.
counterparty_ibanstring | nullKarşı tarafın IBAN'ı.
counterparty_tax_numberstring | nullKarşı tarafın vergi ya da T.C. kimlik numarası.

HTTP durum kodları​

KodDurum
200Liste döndü; eşleşen hareket yoksa boş.
401API anahtarı ya da imza geçersiz.
403Çalışma alanı işlem yapamıyor ya da Banka Hareketleri modülü kapalı.
422Doğrulama hatası.
429İstek sınırı aşıldı.

Hatalar​

AlanMesaj
created_toBitiş tarihi başlangıç tarihinden önce olamaz. / Tarih aralığı en fazla 7 gün olabilir.

Boş ya da 50'den fazla bank_account_tokens, UUID olmayan bir token, 250'den büyük per_page ve 1'den küçük page de kendi alanında 422 alır.