Comment on page

Kétlépcsős tranzakció lezárása (Close)

Működés
Használja a Close hívást egy kétlépcsős tranzakció lezárásához. A Close segítségével jelezheti a fizetési szolgáltató számára, hogy a vásárló számláján korábban befoglalt összeget teljes egészében megterhelje, részben terhelje meg vagy szabadítsa fel.
​Próbálja ki ezt a funkciót!​
API kérés paraméterek
Az API kérés általános információi
Művelet
HTTP kérés
Adatok
Close
POST
method=Close

json={JSON encode-olt paraméterek}
Terhelés
Teljes összeg terhelésére a Close hívás során két lehetőség van (elég csupán az egyiket alkalmazni):
a hívás során ne adja át az ApprovedAmount paramétert
amennyiben mégis átadja az ApprovedAmount paramétert, annak értéke legyen 0
Mindkét eljárás jelzi a fizetési szolgáltató számára, hogy a korábban befoglalt teljes összeggel terhelje meg a vásárló számláját.
Részterhelés
Részösszeg terheléséhez, a Close hívás során adja át a terhelni kívánt részösszeget az ApprovedAmount paraméterben. Ilyen esetben kizárólag az ApprovedAmount-ban megadott részösszeg kerül terhelésre. Az eredetileg befoglalt összeg és a részösszeg közötti különbözet automatikusan feloldásra kerül a vásárló számláján (többszörös, egymást követő részösszeg terhelésre ezért nincs lehetőség).
Részösszeg terhelését csak bizonyos fizetési szolgáltatók támogatják. Ez a funkció jelenleg a következő szolgáltatóknál érhető el:
Barion Smart Gateway
Global Payments
K&H Bank
PayPal REST
SimplePay
UniCredit
Viva Wallet
Wordline - Saferpay
Feloldás
Foglalás feloldásához, a Close hívás során adja át az Approved paramétert, melynek értéke legyen "false". Ennek hatására a fizetési szolgáltató feloldja a teljes korábban befoglalt összeget a vásárló számláján (ezért részösszeg feloldására nincs lehetőség).
API kérés paraméterek
A Close kérés paraméterei közül a TransactionId átadása kötelező:
Paraméter
Típus
Érték
Leírás
TransactionId
string

(32 karakter)
32 karakter hosszú md5 hash
A tranzakció azonosítója a BIG FISH Payment Gateway rendszerében.
Approved
string
“true” (alapért.)
“false”
Jelzi a befoglalt összeg terhelését vagy feloldását.

“true” esetén a fizetési szolgáltató ténylegesen megterheli a korábban befoglalt összeget (vagy részösszeget) a vásárló számláján
“false” esetén a fizetési szolgáltató feloldja a korábban befoglalt teljes összeget a vásárló számláján
ApprovedAmount
number
szabadon választható

(de legfeljebb az eredeti tranzakció összege)
Jelzi a terhelni kívánt részösszeg mértékét.

Ha ez a paraméter nem kerül átadásra, vagy az átadott értéke “0”, akkor a fizetési szolgáltató a teljes korábban befoglalt összeggel terheli meg a vásárló számláját.

(Amennyiben az Approved paraméter átadása ”false” értékkel történik, úgy az ApprovedAmount paraméterben átadott érték nem lesz figyelembe véve és a teljes összeg feloldásra kerül a vásárló számláján.)
Mintakód
Kétlépcsős tranzakció lezárása Close használatával:
curl --url 'https://system-test.paymentgateway.hu/api/payment/' \
  --user 'sdk_test:86af3-80e4f-f8228-9498f-910ad' \
  --user-agent 'Close | merchant-store.com | PHP | 7.3.0' \
  --request 'POST' \
  --data 'method=Close' \
  --data 'json=
    {
        "TransactionId":"a4d6f6f27f2116da21da62d705dbd7ef",
        "Approved":"true"
    }'
API válasz paraméterek
A Close 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
TransactionId
string

(32 karakter)
32 karakter hosszú md5 hash
A tranzakció azonosítója a BIG FISH Payment Gateway rendszerében.
ResultCode
string
Az eredménykód a következők egyike lehet:
SUCCESSFUL
Hiba esetén a következő eredménykódok jelölik a hiba okát a BIG FISH Payment Gateway rendszerében:
InactiveStore
InactiveProvider
MissingParameter
MissingRemoteAddress
UnauthorizedAccess
UnauthorizedRemoteAddress
UnknownStore
UnknownTransaction
WrongApike
WrongParameter
(Továbbá a szolgáltatókra vonatkozó specifikus eredménykódok is megjelenhetnek itt.)
Jelzi a végleges terhelés, vagy a befoglalt összeg feloldásának eredményét.
​
SUCCESSFUL: a befoglalt összeg végleges terhelése, részterhelése vagy feloldása sikeres.
ResultMessage
string
leírás
Az egyes ResultCode értékek szöveges magyarázata, hibaüzenet esetén.
Approved
boolean
true
false
Az Close hívás során megadott Approved paraméter értéke.
ApprovedAmount
number
értékét rendszerünk adja vissza
A terhelt összeg vagy részösszeg.
​
(Maximum értéke az előzetesen befoglalt összeg.)
ReservedAmount
number
vásárlás során kerül meghatározásra
A vásárlás során eredetileg befoglalt összeg.
ResponseId
integer
egyedi értékek
A válaszüzenet egyedi azonosítója a BIG FISH Payment Gateway rendszerében.
Mintakód
A fenti Close kérésre adott sikeres válasz:
{
    "TransactionId": "a4d6f6f27f2116da21da62d705dbd7ef",
    "ResultCode": "SUCCESSFUL",
    "Approved": true,
    "ApprovedAmount": 100,
    "ReservedAmount": 100,
    "ResultMessage": null,
    "ResponseId": "3202109280600047705"
}

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

Paraméter	Típus	Érték	Leírás
`TransactionId`	string (32 karakter)	32 karakter hosszú md5 hash	A tranzakció azonosítója a BIG FISH Payment Gateway rendszerében.
`Approved`	string	“true” (alapért.) “false”	Jelzi a befoglalt összeg terhelését vagy feloldását. “true” esetén a fizetési szolgáltató ténylegesen megterheli a korábban befoglalt összeget (vagy részösszeget) a vásárló számláján “false” esetén a fizetési szolgáltató feloldja a korábban befoglalt teljes összeget a vásárló számláján
`ApprovedAmount`	number	szabadon választható (de legfeljebb az eredeti tranzakció összege)	Jelzi a terhelni kívánt részösszeg mértékét. Ha ez a paraméter nem kerül átadásra, vagy az átadott értéke “0”, akkor a fizetési szolgáltató a teljes korábban befoglalt összeggel terheli meg a vásárló számláját. (Amennyiben az `Approved` paraméter átadása `”false”` értékkel történik, úgy az `ApprovedAmount` paraméterben átadott érték nem lesz figyelembe véve és a teljes összeg feloldásra kerül a vásárló számláján.)

Paraméter	Típus	Érték	Leírás
`TransactionId`	string (32 karakter)	32 karakter hosszú md5 hash	A tranzakció azonosítója a BIG FISH Payment Gateway rendszerében.
`ResultCode`	string	Az eredménykód a következők egyike lehet: SUCCESSFUL Hiba esetén a következő eredménykódok jelölik a hiba okát a BIG FISH Payment Gateway rendszerében: InactiveStore InactiveProvider MissingParameter MissingRemoteAddress UnauthorizedAccess UnauthorizedRemoteAddress UnknownStore UnknownTransaction WrongApike WrongParameter (Továbbá a szolgáltatókra vonatkozó specifikus eredménykódok is megjelenhetnek itt.)	Jelzi a végleges terhelés, vagy a befoglalt összeg feloldásának eredményét. SUCCESSFUL: a befoglalt összeg végleges terhelése, részterhelése vagy feloldása sikeres.
`ResultMessage`	string	leírás	Az egyes `ResultCode` értékek szöveges magyarázata, hibaüzenet esetén.
`Approved`	boolean	true false	Az `Close` hívás során megadott `Approved` paraméter értéke.
`ApprovedAmount`	number	értékét rendszerünk adja vissza	A terhelt összeg vagy részösszeg. (Maximum értéke az előzetesen befoglalt összeg.)
`ReservedAmount`	number	vásárlás során kerül meghatározásra	A vásárlás során eredetileg befoglalt összeg.
`ResponseId`	integer	egyedi értékek	A válaszüzenet egyedi azonosítója a BIG FISH Payment Gateway rendszerében.

Tranzakció részletes adatainak lekérdezése (Details)

Tranzakció összegének visszatérítése (Refund)

Last modified 2mo ago