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.
- PHP
- Node.js
- Python
- Java
- cURL
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;
}
const banks = await client.retrieveBanks();
for (const field of banks.banks[0].fields) {
field.key; // settings anahtarı, ör. client_id
field.label;
}
banks = client.retrieve_banks()
for field in banks.banks[0].fields:
field.key # settings anahtarı, ör. client_id
field.label
import com.odemehub.request.RetrieveBanks;
var banks = client.retrieveBanks(new RetrieveBanks());
for (var field : banks.getBanks().get(0).getFields()) {
field.getKey(); // settings anahtarı, ör. client_id
field.getLabel();
}
URI_PATH="/api/$ODEMEHUB_TEAM/gateway/retrieve-banks"
BODY='{}'
TIMESTAMP=$(date +%s)
SIGNATURE=$(printf '%s\n%s\n%s\n%s' "$TIMESTAMP" "POST" "$URI_PATH" "$BODY" | openssl dgst -sha256 -hmac "$ODEMEHUB_API_SECRET" | sed 's/^.* //')
curl -X POST "https://sandbox.odemehub.com$URI_PATH" \
-H "Content-Type: application/json" \
-H "X-Api-Key: $ODEMEHUB_API_KEY" \
-H "X-Timestamp: $TIMESTAMP" \
-H "X-Signature: $SIGNATURE" \
--data-raw "$BODY"
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" }
]
}
]
}
| Alan | Tip | Açıklama |
|---|---|---|
banks[].id | string | Bankanın kimliği. create-bank-account isteğinde bank_account.provider olarak gönderilir. Şu an yalnızca enpara. |
banks[].title | string | Bankanın adı. |
banks[].fields[].key | string | bank_account.settings nesnesindeki anahtar. |
banks[].fields[].required | boolean | Hesap eklenirken zorunlu mu. |
banks[].fields[].label | string | Alanın bankadaki adı. |
Enpara'nın bu bilgileri nasıl verdiği: Enpara'dan kimlik bilgileri.
HTTP durum kodları
| Kod | Durum |
|---|---|
200 | Liste döndü. |
401 | API 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ı. |