Search
K
Links

Kifizetés (PayOut)

A PayOut segítségével a kereskedő kifizetést tud kezdeményezni a vásárló bankkártyájára (ellenirányú tranzakció). A kifizetés feltétele a kedvezményezett bankkártya előzetes regisztrációja vagy verifikációja. A regisztráció (vagy verifikáció) során létrejön a referencia tranzakció, mely segítségével rendszerünkben beazonosíthatóvá válik a kedvezményezett bankkártya.
További részletekért látogassa meg a következő oldalakat:
A regisztrált (verifikált) bankkártya segítségével nem csak kifizetés, de CIT és MIT típusú fizetési tranzakció is létrehozható.
További részletekért látogassa meg a következő oldalakat:
Korábban regisztrált bankkártya esetén a kifizetéshez szükséges referencia tranzakció már rendelkezésre áll rendszerünkben a kifizetés végrehajtásához.
A PayOut működése nagyban hasonlít a tranzakciók összegének visszatérítéséhez, amiről a következő oldalon olvashat:

Egyedi jellemzők

A PayOut használata előtt vegye figyelembe a szolgáltatás egyedi jellemzőit:
  • egy referencia tranzakció tetszőleges számú kifizetésre használható fel
  • a kifizetés összege tetszőleges (meghaladhatja a referencia tranzakció összegét is)
  • a kifizetés használata nem időkorlátos, a kereskedő bármikor indíthat ellenirányú tranzakciót
  • a sikeres kifizetés átfutási ideje maximum 30 perc (az összeg jellemzően 1-2 percen belül megjelenik a kedvezményezett számláján)
  • a kifizetés menete különböző kártyatípusoknál a következő:
    • bankkártya (debit) esetén a kifizetés összege a kártyához tartozó folyószámlán kerül jóváírásra
    • hitelkártya (credit) esetén a kifizetés összege a kártyához tartozó hitelkeret-tartozás összegét csökkenti
PayOut használatát jelenleg csak a Global Payments fizetési szolgáltató támogatja.

Működés

Használja a Payout műveletet kifizetés (ellenirányú tranzakció) létrehozásához a PayOut segítségével.

API kérés paraméterek

Az API kérés általános információi

Művelet
HTTP kérés
Adatok
Payout
POST
method=Payout json={JSON encode-olt paraméterek}

Kötelező paraméterek

Paraméter
Típus
Érték
Leírás
PayoutType
string
  • B2P
  • WIN
Jelzi a kifizetés jogi típusát (a típusok technikailag azonosak). (Kizárólag a fizetési szolgáltatóval kötött szerződésben meghatározott típus használható kifizetésre.) Jellemzők:
  • B2P: általános kifizetés (pl. visszatérítés, kártérítés, stb.)
  • WIN: nyeremény kifizetés szerencsejáték esetén
ReferenceTransactionId
string
egyedi értékek
A fizetőeszköz regisztrációhoz kapcsolódó tranzakció azonosítója a BIG FISH Payment Gateway rendszerében.
Amount
number
szabadon választható
A kifizetés összege. (Magyar forint (HUF) esetén értéke egész szám.)
Info
string
egyedi értékek
A vásárlás és a vásárló adatai az erős ügyfél-hitelesítéshez (PSD2/SCA). Az SCA "Általános vásárlói adatok" kötelező paramétereinek megadása kötelező.

Opcionális paraméterek

Paraméter
Típus
Érték
Leírás
OrderId
string (255 karakter)
szabadon választható, egyedi érték
A megrendelés azonosítója a kereskedő áruházában.
(Lehetővé teszi a tranzakció visszakeresését, használata erősen javasolt.)
AdditionalMessage
string (65 karakter)
egyedi értékek
A kifizetéshez megadható egyedi üzenet (a közlemény mezőben jelenik meg a kedvezményezettnél).
ModuleName
string (32 karakter)
egyedi értékek
A kereskedő oldalán használt szervízcsomag, programnyelv, keretrendszer, modul, stb. megnevezése.
ModuleVersion
string (8 karakter)
verziószám
A kereskedő oldalán használt szervízcsomag, programnyelv, keretrendszer, modul, stb. verziószáma.

Mintakód

Kifizetés (ellenirányú tranzakció) indítása Payout használatával:
curl --url 'https://system-test.paymentgateway.hu/api/payment/' \
--user 'sdk_test:86af3-80e4f-f8228-9498f-910ad' \
--user-agent 'Payout | merchant-store.com | PHP | 7.3.0' \
--request 'POST' \
--data 'method=Payout' \
--data 'json=
{
"PayoutType":"B2P",
"ReferenceTransactionId":"dced1a3238b58787843c82123086f614",
"Amount":200,
"OrderId":"BF-TEST-PAYOUT",
"AdditionalMessage":"BF-TEST-PAYOUT-MESSAGE",
"Info":"eyJDdXN0b21lciI6eyJHZW5lcmFsIjp7IkZpcnN0TmFtZSI6IkpvaG4iLCJMYXN0TmFtZSI6IkRvZSIsIkVtYWlsIjoidGVzdEB0ZXN0bWFpbC5jb20ifX19"
}'

API válasz paraméterek

Az Payout kérés eredményét JSON formában válaszoljuk meg. A válasz a következő paramétereket tartalmazza:
Paraméter
Típus
Érték
Leírás
ResultCode
string
Az összeg kifizetésének elindítása sikeresen megtörtént:
  • SUCCESSFUL
Az összeg kifizetésének elindítása sikertelen volt:
  • ERROR
  • FunctionNotImplemented
  • InactiveStore
  • InactiveProvider
  • MissingParameter
  • MissingRemoteAddress
  • UnauthorizedAccess
  • UnauthorizedRemoteAddress
  • UnknownReferenceTransaction
  • UnknownStore
  • WrongApikey
  • WrongParameter
(Továbbá a szolgáltatókra vonatkozó specifikus eredménykódok is megjelenhetnek itt.)
Jelzi a kifizetés elindításának eredményét.
Sikertelen kifizetés esetén a paraméter értéke jelzi a hiba okát.
ResultMessage
string
leírás
Az egyes ResultCode értékek szöveges magyarázata.
StoreName
string
A BIG FISH Payment Gateway szerződésben kerül meghatározásra.
Rendszerünkben tárolt egyedi bolt azonosító.
ProviderName
string
  • GP
A tranzakcióhoz kiválasztott fizetési szolgáltató. (Ezt a funkciót jelenleg csak a Global Payments támogatja.)
PayoutType
string
  • B2P
  • WIN
Jelzi a kifizetés jogi típusát.
PayoutId
string
egyedi értékek
A kifizetés azonosítója a BIG FISH Payment Gateway rendszerében.
OrderId
string
szabadon választható, egyedi érték
A megrendelés azonosítója a kereskedő áruházában.
(Lehetővé teszi a tranzakció visszakeresését.)
UserId
string
szabadon választható (kivéve e-mail címek)
A vásárló azonosítója a kereskedő áruházában.
(Lehetővé teszi a tranzakció visszakeresését.)
AdditionalMessage
string
egyedi értékek
A kifizetéshez megadott egyedi üzenet (a közlemény mezőben jelenik meg a kedvezményezettnél).
Amount
number
egyedi értékek
Kifizetésre kerülő összeg.
AuthCode
string
egyedi értékek
A kifizetés engedélyszáma, amely a fizetési szolgáltató rendszerében jön létre.
Currency
string (3 karakter)
  • HUF (alapért.)
  • EUR
  • USD
  • ...
A fizetés devizaneme.
(Értékei fizetési szolgáltatónként és szerződésenként eltérőek lehetnek.)
Created
string
dátum
A kifizetés létrehozásának időpontja.
ReferenceTransactionId
string
egyedi értékek
A fizetőeszköz regisztrációhoz kapcsolódó tranzakció azonosítója a BIG FISH Payment Gateway rendszerében.
ResponseId
integer
egyedi értékek
A válaszüzenet egyedi azonosítója a BIG FISH Payment Gateway rendszerében.

Mintakód

A fenti Payout kérésre adott válasz:
{
"ResultCode": "SUCCESSFUL",
"ResultMessage": null,
"StoreName": "sdk_test",
"ProviderName": "GP",
"PayoutType": "B2P",
"PayoutId": "po_ab70474b13a6e96bc42840cfd6d4ae91",
"OrderId": "BF-TEST-PAYOUT",
"UserId": "BF-TEST",
"AdditionalMessage": "BF-TEST-PAYOUT-MESSAGE",
"Amount": 200,
"Currency": "HUF",
"AuthCode": "G913DO",
"Created": "2021-07-19 11:23:01",
"ReferenceTransactionId": "dced1a3238b58787843c82123086f614",
"ResponseId": "3202109280600047724"
}