Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.payven.com.tr/llms.txt

Use this file to discover all available pages before exploring further.

Konfigürasyon, bir konnektör tipini kendi banka anlaşmanız için ayarladığınız credential setidir (üye işyeri numarası, şifreler, store key, terminal ID, vb.). Her konnektörün birden fazla konfigürasyonu olabilir (örn. farklı merchant’lar için farklı credential’lar).

Endpoint’ler

İşlemEndpoint
ListeGET /api/v1/connector-configurations
DetayGET /api/v1/connector-configurations/{id}
OluşturPOST /api/v1/connector-configurations
GüncellePUT /api/v1/connector-configurations/{id}
SilDELETE /api/v1/connector-configurations/{id}
Bağlantı testiPOST /api/v1/connector-configurations/{id}/test
Aktif/pasifPATCH /api/v1/connector-configurations/{id}/status

Oluşturma

Konfigürasyon şeması her konnektör için farklıdır. Önce şemayı çekin:
GET /api/v1/connector-configurations/schemas/GarantiVPOS
Şemada zorunlu alanlar dönülür (örn. MerchantId, TerminalId, StoreKey). Sonra konfigürasyon oluşturun:
curl -X POST https://vpos.payven.com.tr/api/v1/connector-configurations \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-Tenant-Id: $TENANT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Garanti — Acme E-Ticaret",
    "connectorCode": "GarantiVPOS",
    "environment": "Production",
    "credentials": {
      "MerchantId": "1234567",
      "TerminalId": "00012345",
      "StoreKey": "***",
      "ProvUser": "PROVAUT",
      "ProvPass": "***"
    },
    "merchantId": "3fa85f64-..."
  }'

Bağlantı testi

Credential’ların doğru olup olmadığını anlamak için canlı bağlantı testi:
POST /api/v1/connector-configurations/{id}/test
Yanıt: connection.successful: true/false ve banka tarafından dönen ham yanıt.

Credential maskeleme

Credential alanları yanıtlarda maskelenmiş halde döner (***...***). Açık değer yalnızca:
  • Oluşturma yanıtında bir kez (sadece create eden için)
  • Konsoldaki “Düzenle” akışında re-entry istediğinizde
görünür. Sızıntı önleme için tasarlanmıştır.

Aktif/pasif

PATCH /api/v1/connector-configurations/{id}/status
{ "active": false }
Pasif konfigürasyonlar yönlendirme havuzundan çıkarılır. Test ortamında geçici devre dışı bırakma için faydalıdır.