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

Működés

Használja a Refund hívást egy sikeres tranzakció összegének teljes vagy részleges visszatérítésére. Visszatérítésre csak bizonyos fizetési szolgáltatóknál van lehetőség, továbbá ezt a funkciót jellemzően külön kell igényelni az adott fizetési szolgáltatótól.

Próbálja ki ezt a funkciót!

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

MűveletHTTP kérésAdatok

Refund

POST

method=Refund json={JSON encode-olt paraméterek}

API kérés paraméterek

A Refund kérés a következő paraméterekkel rendelkezik (a TransactionId és Amount átadása kötelező):

ParaméterTípusÉrtékLeírás

TransactionId

string

32 karakter hosszú md5 hash

A tranzakció azonosítója a BIG FISH Payment Gateway rendszerében.

Amount

number

egyedi értékek

Visszatérítésre kerülő összeg az eredeti tranzakció pénznemében.

Extra

string

egyedi értékek

Egyéb illetve szolgáltató specifikus adatok.

(További részletekről az Extra adatok pontban olvashat.)

Mintakód

A tranzakció összegének részleges vagy teljes visszatérítése Refund használatával:

curl --url 'https://system-test.paymentgateway.hu/api/payment/' \
  --user 'sdk_test:86af3-80e4f-f8228-9498f-910ad' \
  --user-agent 'Refund | merchant-store.com | PHP | 7.3.0' \
  --request 'POST' \
  --data 'method=Refund' \
  --data 'json=
    {
        "TransactionId":"a4d6f6f27f2116da21da62d705dbd7ef",
        "Amount":100
    }'

API válasz paraméterek

A Refund kérés eredményét JSON formában válaszoljuk meg. A válasz a következő paramétereket tartalmazza:

ParaméterTípusÉrtékLeírás

TransactionId

string

32 karakter hosszú md5 hash

A tranzakció azonosítója a BIG FISH Payment Gateway rendszerében.

ResultCode

string

A visszatérítés beküldésének eredménye a következők egyike lehet:

  • SUCCESSFUL

Hiba esetén a következő eredménykódok jelölik a hiba okát:

  • InactiveStore

  • MissingParameter

  • MissingRemoteAddress

  • UnauthorizedAccess

  • UnauthorizedRemoteAddress

  • UnknownStore

  • UnknownTransaction

  • WrongApikey

(Továbbá a szolgáltatókra vonatkozó specifikus eredménykódok is megjelenhetnek itt.)

Jelzi a visszatérítés beküldésének eredményét:

  • SUCCESSFUL: a visszatérítés beküldése sikeres

ResultMessage

string

leírás

Az egyes ResultCode értékek szöveges magyarázata.

RefundRequestId

string

egyedi értékek

A visszatérítés kérésének azonosítója a fizetési szolgáltató rendszerében.

(Egyes fizetési szolgáltatóknál nem rendelkezik értékkel.)

RefundTransactionId

string

egyedi értékek

A visszatérítés azonosítója a fizetési szolgáltató rendszerében.

(Egyes fizetési szolgáltatóknál nem rendelkezik értékkel.)

RefundAuthorizationCode

string

egyedi értékek

A visszatérítés engedélyszáma a fizetési szolgáltató rendszerében.

(Egyes fizetési szolgáltatóknál nem rendelkezik értékkel.)

RefundId

string (35 karakter)

egyedi értékek

A visszatérítés egyedi 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 Refund kérésre adott válasz:

{
    "TransactionId": "a4d6f6f27f2116da21da62d705dbd7ef",
    "ResultCode": "SUCCESSFUL",
    "ResultMessage": null,
    "RefundRequestId": null,
    "RefundTransactionId": null,
    "RefundAuthorizationCode": null
    "RefundId": "rf_b0fd9b0381bb54568870a6c22d6a086f",
    "ResultMessage": null,
    "ResponseId": "3202109280600047707"
}

Last updated