Zlecenie zwrotu
- Joanna Wołosz
Zlecenie zwrotu pieniędzy za daną transakcję.
POST /v1/izi/transaction/{transaction_id}/refund
Parameters
Nazwa pola | Opis | Typ | Wymagalność | Dodatkowe uwagi |
X-Command-ID | Unikalny identyfikator potrzebny do sprawdzenia idempotencji. | string($uuid)
| Y |
|
transaction_id | Unikalny identyfikator transakcji przypisany przez dostawcę usług płatniczych. | string($uuid)
| Y |
|
Request
Nazwa pola | Opis | Typ | Wymagalność | Dodatkowe uwagi |
external_refund_id | Identyfikator zamówienia refundacji przypisany przez merchanta. | string | O |
|
refund_amount | Kwota do zwrotu. Jeśli nie zostanie określona, zostanie zażądany pełny zwrot pieniędzy. | number | O |
|
additional_business_data | Dodatkowe dane związane ze zleceniem zwrotu. | object | O |
|
additional_business_data.additional_data | string | O |
| |
signature | Sygnatura* | string | Y |
|
Sygnatura*:
Podpis wiadomości wymagany do weryfikacji autentyczności żądania. Obliczany przez połączenie wartości nagłówka X-Command-ID, zmiennej ścieżki transaction_id, wszystkich wartości pól treści żądania (ignorując pole podpisu) w kolejności alfanumerycznej i sekretu merchanta (jeśli którakolwiek z wartości ma wartość null, powinna być traktowana jako pusty ciąg). Końcowy podpis to zapisany małymi literami szesnastkowy skrót funkcji skrótu zastosowanej do połączonej wiadomości.
Obsługiwane funkcje hash to: SHA-512
Domyślna funkcja hash: SHA-512 SHA-512
Jeśli używana jest inna niż domyślna funkcja skrótu, podpis musi być poprzedzony jej identyfikatorem i znakiem "_".
Merchant Secret, to losowy ciąg znaków, który znajdziesz w panelu merchanta w zakładce Konfiguracja Merchant Transaction API secret.
Przykład 1:
Merchant Secret: 0051db3ab9ea4351bfebbcbe1adcc045
X-Command-ID: f3daf649-30bd-4578-a3bc-89ee822e2887
transaction_id: c50c3756-7ca1-431d-8b4e-4fc322b18548
request_body: { "signature": "TBD", "refund_amount": 1.23, "external_refund_id": "0b374857-2096-46e0-a9d6-26f313073d32", "additional_business_data": { "key1": "value1", "key2": "value2", } }
Intermediate signature: f3daf64930bd-4578-a3bc-89ee822e2887c50c3756-7ca1-431d-8b4e-4fc322b18548key1value1key2value20b374857-2096-46e0-a9d6-26f313073d321.230051db3ab9ea4351bfebbcbe1adcc045
Valid Signatures: 1832a9a561c7f95782e8e10da5f6d181d31b4537ba168fb2bf903cd3cb9455433e6537b4f2da7bd0ec129888a265d609acf6efa1144763f2085866604db63ecd
SHA-512_1832a9a561c7f95782e8e10da5f6d181d31b4537ba168fb2bf903cd3cb9455433e6537b4f2da7bd0ec129888a265d609acf6efa1144763f2085866604db63ecd
Przykład 2:
Merchant Secret: 0051db3ab9ea4351bfebbcbe1adcc045
X-Command-ID: f3daf649-30bd-4578-a3bc-89ee822e2887
transaction_id: c50c3756-7ca1-431d-8b4e-4fc322b18548
request_body: { "signature": "TBD", "refund_amount": null, "external_refund_id": null }
Intermediate signature: f3daf649-30bd-4578-a3bc-89ee822e2887c50c3756-7ca1-431d-8b4e-4fc322b185480051db3ab9ea4351bfebbcbe1adcc045
Valid Signatures: 186c45bb02603c37325233a8e5471adda94eed27caeb27f3289c678c48a496367db1937d045d8421d914b94502d92d3a9a2fe52e566fbcb8a2e6330add4a663c
SHA-512_186c45bb02603c37325233a8e5471adda94eed27caeb27f3289c678c48a496367db1937d045d8421d914b94502d92d3a9a2fe52e566fbcb8a2e6330add4a663c
Response
Nazwa pola | Opis | Typ | Wymagalność | Dodatkowe uwagi |
external_refund_id | Identyfikator zamówienia refundacji przypisany przez merchanta. | string | Y |
|
refund_amount | Kwota do zwrotu. Jeśli nie zostanie określona, zostanie zażądany pełny zwrot pieniędzy. | number | Y |
|
status | Bieżący status zwrotu Enum: [ PENDING, SUCCESS, FAILED ] | string | Y |
|
description | Opis zlecenia zwrotu środków | string | Y |
|