Ana içeriğe geç

create-bank-account

POST /api/{team}/gateway/create-bank-account

Banka hesabını çalışma alanınıza ekler. ödemehub gönderilen kimlik bilgilerini önce bankada, o IBAN'ın bugünkü hareketlerini isteyerek dener. Banka kabul ederse hesap eklenir ve bir token alır; hareketleri bu token'la retrieve-bank-transactions ile sorarsınız. Hesap eklendiğinde son 7 günün hareketleri okunur. Akış: Banka Hareketleri rehberi.

Ön koşullar​

  • Banka Hareketleri modülü açık olmalıdır; değilse 403.
  • IBAN çalışma alanında daha önce eklenmemiş olmalıdır; eklenmişse 422.

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": {
"provider": "enpara",
"name": "Tahsilat Hesabı",
"iban": "TR33 0006 1005 1978 6457 8413 26",
"settings": {
"client_id": "...",
"client_secret": "...",
"access_token": "...",
"refresh_token": "..."
}
}
}
AlanTipZorunluAçıklama
bank_account.providerstringevetBankanın kimliği, retrieve-banks yanıtındaki id. Şu an yalnızca enpara.
bank_account.namestringevetHesabın adı; listelerde ve panelde görünür. En çok 255 karakter.
bank_account.ibanstringevetBoşluklar silinip harfler büyütüldükten sonra TR ile başlayan 26 karakter (TR + 24 rakam). Yanıtta bu biçimde döner.
bank_account.settingsobjectevetBankanın istediği kimlik bilgileri; anahtarlar retrieve-banks yanıtındaki fields[].key. Her biri string, en çok 4000 karakter. Enpara için client_id, client_secret, access_token, refresh_token: Enpara'dan kimlik bilgileri.

bank_account nesnesinde tanımlı olmayan bir anahtar gönderilirse istek 422 ile reddedilir. settings içindeki tanımsız anahtarlar yok sayılır.

SDK örnekleri​

not

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

use Gurmehub\Odemehub\Request\CreateBankAccount;

$created = $client->createBankAccount(new CreateBankAccount(
provider: 'enpara',
name: 'Tahsilat Hesabı',
iban: 'TR33 0006 1005 1978 6457 8413 26',
settings: [
'client_id' => getenv('ENPARA_CLIENT_ID'),
'client_secret' => getenv('ENPARA_CLIENT_SECRET'),
'access_token' => getenv('ENPARA_ACCESS_TOKEN'),
'refresh_token' => getenv('ENPARA_REFRESH_TOKEN'),
],
));

$created->bankAccount?->token; // banka reddettiyse null; mesajı $created->result->message

Yanıt​

{
"result": { "successful": true, "message": null },
"bank_account": {
"token": "5c1e9a72-3b4d-4f8e-a6c2-1d7b9e0f3a54",
"provider": "enpara",
"name": "Tahsilat Hesabı",
"iban": "TR330006100519786457841326",
"synced_at": null,
"last_error": null,
"created_at": "2026-10-26T08:12:00.000000Z"
}
}

Alanlar: Banka hesabı nesnesi. Yeni eklenen hesapta synced_at null'dır; ilk okuma bitince dolar.

Banka kimlik bilgilerini reddederse yanıt yine 200'dür ve hesap eklenmez:

{
"result": {
"successful": false,
"message": "Sorgulanan hesap, yetki verilen hesaplar arasında bulunmamaktadır."
},
"bank_account": null
}

result.message bankanın kendi mesajıdır; bankaya ulaşılamazsa Bankaya ulaşılamadı. olur. Bilgileri düzeltip isteği yeniden gönderebilirsiniz.

HTTP durum kodları​

KodDurum
200İstek işlendi; sonuç result.successful içinde.
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ı. Bankaya bir şey gönderilmedi.
429İstek sınırı aşıldı.

Hatalar​

AlanMesaj
bank_account.ibanIBAN TR ile başlayan 26 karakter olmalı. / Bu IBAN zaten ekli.

retrieve-banks'te olmayan bir bank_account.provider ve eksik bir kimlik bilgisi (ör. bank_account.settings.refresh_token) de kendi alanında 422 alır.