Ana içeriğe geç

retrieve-banks

POST /api/{team}/gateway/retrieve-banks

Hareketleri okunabilen bankaları döndürür; hiçbir şeyi değiştirmez. Her banka, create-bank-account isteğinde bank_account.provider olarak gönderilen id'sini ve bank_account.settings nesnesinde beklediği alanları (fields) taşır. Akış: Banka Hareketleri rehberi.

Ön koşullar​

  • Banka Hareketleri modülü açık olmalıdır; değilse 403.

Kimlik doğrulama​

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

İstek​

Gövde boştur:

{}

SDK örnekleri​

not

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

use Gurmehub\Odemehub\Request\RetrieveBanks;

$banks = $client->retrieveBanks(new RetrieveBanks());

foreach ($banks->banks[0]->fields as $field) {
$field->key; // settings anahtarı, ör. client_id
$field->label;
}

Yanıt​

{
"result": { "successful": true, "message": null },
"banks": [
{
"id": "enpara",
"title": "Enpara",
"fields": [
{ "key": "client_id", "required": true, "label": "Client ID" },
{ "key": "client_secret", "required": true, "label": "Client Secret" },
{ "key": "access_token", "required": true, "label": "Access Token" },
{ "key": "refresh_token", "required": true, "label": "Refresh Token" }
]
}
]
}
AlanTipAçıklama
banks[].idstringBankanın kimliği. create-bank-account isteğinde bank_account.provider olarak gönderilir. Şu an yalnızca enpara.
banks[].titlestringBankanın adı.
banks[].fields[].keystringbank_account.settings nesnesindeki anahtar.
banks[].fields[].requiredbooleanHesap eklenirken zorunlu mu.
banks[].fields[].labelstringAlanın bankadaki adı.

Enpara'nın bu bilgileri nasıl verdiği: Enpara'dan kimlik bilgileri.

HTTP durum kodları​

KodDurum
200Liste döndü.
401API anahtarı ya da imza geçersiz.
403Çalışma alanı işlem yapamıyor ya da Banka Hareketleri modülü kapalı.
429İstek sınırı aşıldı.