Fizetőeszköz-regisztráció lekérdezése
Használja a
GetPaymentRegistrations
funkciót egy adott vásárlóhoz tartozó összes regisztrált fizetőeszköz lekérdezéséhez. Sikeres lekérdezés esetén a válasz a következő adatokat tartalmazza:- a fizetőeszköz-regisztráció típusa
- a vásárláshoz tartozó regisztrált fizetőeszköz(ök) adatai
- a fizetőeszköz-regisztráció(k) során létrejött referencia tranzakció(k) adatai
Az érvénytelenített fizetőeszköz-regisztrációk és a lejárt fizetőeszközök adatait nem adjuk vissza.
Művelet | HTTP kérés | Adatok |
---|---|---|
GetPaymentRegistrations | POST | method= GetPaymentRegistrations
json={JSON encode-olt paraméterek} |
Az API kérésekhez kapcsolódó paramétereket két táblázatba soroljuk fel a könnyebb átláthatóság kedvéért. Természetesen az egyes paraméterek megjelenhetnek ugyanabban az API kérésben.
Az API paraméterek felosztása a következő:
- kötelező paraméterek
- opcionális paraméterek
Paraméter | Típus | Érték | Leírás |
---|---|---|---|
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 |
| A tranzakcióhoz tartozó fizetési szolgáltató. |
UserId | string | szabadon választott
(kivéve e-mail címek és személyes adatok) | A fizetőeszköz-regisztrációhoz használt vásárló-azonosító a kereskedő áruházában. |
Paraméter | Típus | Érték | Leírás |
---|---|---|---|
PaymentRegistrationType | string |
| A fizetőeszköz-regisztráció típusa. |
Adott vásárlóhoz tartozó fizetőeszköz-regisztrációk lekérdezése
GetPaymentRegistrations
kérés használatával:curl --url 'https://system-test.paymentgateway.hu/api/payment/' \
--user 'sdk_test:86af3-80e4f-f8228-9498f-910ad' \
--user-agent 'GetPaymentRegistrations | merchant-store.com | PHP | 7.3.0' \
--request 'POST' \
--data 'method=GetPaymentRegistrations' \
--data 'json=
{
"StoreName":"sdk_test",
"ProviderName":"Barion2",
"UserId":"BF-TEST-USER-REG"
}'
A
GetPaymentRegistrations
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 |
---|---|---|---|
JSON object | egyedi értékek | Fizetőeszköz-regisztrációkat és a hozzájuk tartozó referencia tranzakciókat tartalmazó objektum. | |
ResultCode | string | A regisztráció sikeresen lekérdezve:
Sikertelen lekérdezés esetén:
| Jelzi a lekérdezés eredményét. Sikertelen lekérdezé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. |
ResponseId | integer | egyedi értékek | A válaszüzenet egyedi azonosítója a BIG FISH Payment Gateway rendszerében. |
Az alábbi adatok a
Data
nevű paraméterben, fizetőeszköz-regisztráció típusonként bontva kerülnek átadásra:Paraméter | Leírás |
---|---|
ReferenceTransactionId | A fizetőeszköz-regisztrációhoz kapcsolódó tranzakció azonosítója a BIG FISH Payment Gateway rendszerében. |
AutoCommit | A referencia tranzakció végrehajtási módja, mely jelenthet azonnali terhelést vagy az összeg előzetes befoglalását. |
Currency | A referencia tranzakció devizaneme. |
PaymentDevice | A regisztrált fizetőeszköz típusa:
|
PaymentDeviceBrand | A regisztrált fizetőeszköz márkája. |
PaymentDeviceNumber | A regisztrált fizetőeszköz azonosító száma, pl. a bankkártya utolsó 4 számjegye, számlaszám, stb. |
PaymentDeviceExpiration | A regisztrált fizetőeszköz lejárati ideje. |
RegistrationExpiration | A fizetőeszköz-regisztráció érvényességének vége. |
RecurringFrequency | A rákövetkező fizetések gyakorisága. |
FixAmount | Jelzi, hogy a rákövetkező fizetések megegyeznek vagy nem egyeznek meg a referencia tranzakció összegével. |
Created | A referencia tranzakció létrehozásának időpontja. |
A sikeres fizetőeszköz-regisztráció lekérdezésre adott válasz:
{
"Data": {
"CIT": [
{
"ReferenceTransactionId": "42a8b536eb3acd9f780d5a96de1b022b",
"AutoCommit": 0,
"Currency": "HUF",
"PaymentDevice": "BankCard",
"PaymentDeviceBrand": "Visa",
"PaymentDeviceNumber": "5559",
"PaymentDeviceExpiration": "2022-02-28",
"RegistrationExpiration": null,
"RecurringFrequency": 0,
"FixAmount": null,
"Created": "2021-05-27 11:34:03"
}
],
"MIT": [
{
"ReferenceTransactionId": "e44dcb0cefeaab4b3211c9ea5e2e6222",
"AutoCommit": 1,
"Currency": "HUF",
"PaymentDevice": "BankCard",
"PaymentDeviceBrand": "Visa",
"PaymentDeviceNumber": "5559",
"PaymentDeviceExpiration": "2022-01-31",
"RegistrationExpiration": "2021-12-12",
"RecurringFrequency": 2,
"FixAmount": 1,
"Created": "2021-05-26 13:48:11"
}
]
},
"ResultCode": "SUCCESSFUL",
"ResultMessage": null
"ResponseId": "3202109280600047720"
}