Przejdź do treści
Ostatnia aktualizacja

Kanały płatności

Każdy submerchant ma własny zestaw kanałów płatności (BLIK, przelewy, karty, PayPal, płatności odroczone itp.). Zarządzasz nimi przez API SimPay Flow - zwykle w panelu ustawień swojej aplikacji, w którym submerchant sam wybiera, jakie metody płatności chce oferować.

Wszystkie operacje na kanałach są dostępne wyłącznie dla submerchantów w statusie flow_submerchant_active.

Domyślne kanały

Po akceptacji onboardingu submerchant automatycznie otrzymuje aktywne i włączone kanały dla wszystkich metod płatności, które mają aktywną stawkę domyślną w Twojej usłudze Flow (zobacz Prowizje). Kanały dla metod włączonych później musisz zarejestrować.

Lista kanałów submerchanta

GET /flow/{flowServiceId}/submerchants/{submerchantId}/payment-channels zwraca wszystkie kanały submerchanta wraz z:

PoleOpis
idID kanału, np. blik, blik-level0, paypal
statusStatus kanału: new, in_progress, active, rejected
enabledCzy kanał jest włączony (widoczny dla płacących)
typeredirect - płatność na bramce SimPay, whitelabel - płatność bezpośrednio na Twojej stronie
commissionProwizja SimPay (simpay) oraz Twoja prowizja (flow) - zobacz Prowizje
extraDodatkowe dane dla wybranych kanałów (BLIK OneClick, BLIK Płatności Powtarzalne, PayPal)

Kanał jest dostępny dla płacących tylko wtedy, gdy ma status active i jest włączony (enabled: true).

Włączanie i wyłączanie kanałów

Aktywne kanały włączasz i wyłączasz żądaniem PATCH /flow/{flowServiceId}/submerchants/{submerchantId}/payment-channels:

curl -X PATCH "https://api.simpay.pl/flow/{flowServiceId}/submerchants/user-123/payment-channels" \
  -H "Authorization: Bearer TWÓJ_TOKEN_API" \
  -H "Content-Type: application/json" \
  -d '{
    "channels": [
      { "slug": "blik", "enabled": true },
      { "slug": "paypal", "enabled": false }
    ]
  }'

Kanały, które nie istnieją, nie są jeszcze aktywne lub nie mają aktywnej prowizji w Twojej usłudze Flow, są pomijane bez błędu.

Rejestracja nowego kanału

  1. Pobierz listę kanałów, które submerchant może zarejestrować: GET .../payment-channels/available-for-registration. Lista zawiera tylko kanały, dla których Twoja usługa Flow ma aktywną prowizję i których submerchant jeszcze nie ma.
  2. Zarejestruj wybrany kanał: POST .../payment-channels/register z id kanału.
curl -X POST "https://api.simpay.pl/flow/{flowServiceId}/submerchants/user-123/payment-channels/register" \
  -H "Authorization: Bearer TWÓJ_TOKEN_API" \
  -H "Content-Type: application/json" \
  -d '{ "id": "paypo" }'

Po rejestracji:

  • kanał, który nie wymaga weryfikacji (needs_verification: false), od razu otrzymuje status active,
  • kanał, który wymaga weryfikacji, otrzymuje status new i trafia do weryfikacji przez SimPay (lub zgłoszenia do operatora metody płatności). O zmianie statusu poinformujemy webhookiem flow_submerchant_payment_channel:status_changed.
Kanał jest domyślnie wyłączony

Nowo zarejestrowany kanał ma enabled: false. Po jego aktywacji włącz go przez PATCH .../payment-channels.

Niektóre kanały (requires_company: true) są dostępne tylko dla submerchantów z zarejestrowaną działalnością gospodarczą. Dla działalności nierejestrowanej API zwróci błąd CHANNEL_REQUIRES_COMPANY.

Kanały specjalne

BLIK Level 0 + OneClick

  1. Zarejestruj i aktywuj kanał blik-level0.
  2. Wyślij POST .../payment-channels/register z "id": "blik-level0-oneclick".
  3. Status zgłoszenia OneClick znajdziesz w extra.blikOneClick kanału blik-level0: PENDING_REGISTRATION → REGISTERED_WAITING_ACTIVATION → ACTIVE (lub REJECTED).

OneClick jest dostępny wyłącznie dla submerchantów z zarejestrowaną działalnością gospodarczą. Więcej o samej usłudze: BLIK Level 0 + OneClick.

BLIK Płatności Powtarzalne

Aktywne modele płatności powtarzalnych (A - AUTO, O - OPEN, M - MANUAL) znajdziesz w extra.blikRecurrent.models kanału blik-recurrent. Więcej: BLIK Płatności Powtarzalne.

PayPal

Dla kanału paypal ustaw adres email konta PayPal submerchanta żądaniem PUT .../payment-channels/paypal. Aktualny adres znajdziesz w extra.paypalCheckoutEmail.

Poprzednia strona
Następna strona