Przejdź do głównej treści
POST
curl

Autoryzacje

X-API-KEY
string
header
wymagane

Klucz API generowany w Panelu Paymove.

Format: 51 znaków z prefiksem środowiska - sk_test_ w sandboxie, sk_live_ na produkcji. Przykład: sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Klucz przekazuj wyłącznie z serwera. Żądanie wysłane ze strony sklepu zostanie odrzucone - a klucz i tak nigdy nie może trafić do kodu frontendowego.

Parametry ścieżki

orderId
string
wymagane

Wewnętrzny identyfikator zamówienia nadany przez Paymove - pole orderId payloadu webhooka albo odpowiedzi zapytania o status. Nie jest to externalId ani skrót płatności z redirectUrl

Przykład:

"PAY1784798914400"

Treść

application/json

Wszystkie pola są opcjonalne - puste body {} zwraca pełną kwotę płatności. Żądanie nie zawiera productId; produkt i dane rozliczeniowe Paymove odczytuje z płatności.

amountMinor
integer<int64>

Opcjonalnie - kwota zwrotu w groszach jako liczba całkowita. Musi być równa pełnej kwocie płatności: zwroty częściowe nie są obsługiwane, a inna wartość kończy się kodem 400. Pominięcie pola zwraca całą kwotę.

Wymagany zakres: x >= 1
Przykład:

15000

email
string<email>

Opcjonalnie - adres e-mail płatnika, używany przy autoryzacji poprzedzającej zwrot. Bez niego wstawiana jest wartość zastępcza; płatności przyjęte bez adresu e-mail zwracają się poprawnie i bez tego pola.

Przykład:

"klient@example.com"

reason
string

Opcjonalnie - dowolny tekst zapisywany przy zwrocie i zwracany w polu comment

Przykład:

"Klient zrezygnował z zamówienia"

Odpowiedź

Zwrot przyjęty do realizacji

Obiekt zwrotu. POST zwraca jeden taki obiekt, GET tablicę obiektów tego samego typu.

id
string<uuid>

Identyfikator zwrotu w Paymove

Przykład:

"9f2c1b44-6d2f-4f0e-9a71-2b8c5d3e1a90"

type
enum<string>

Zawsze REFUND

Dostępne opcje:
REFUND
orderId
string

Identyfikator SAMEGO ZWROTU w postaci {orderId płatności}-rN. Identyfikator płatności znajdziesz w parentOrderId.

Przykład:

"PAY1784798914400-r1"

parentOrderId
string

orderId zwracanej płatności - ten sam, który podałeś w ścieżce

Przykład:

"PAY1784798914400"

amountMinor
integer<int64>

Zwrócona kwota w groszach. Przy tworzeniu płatności to samo pole nazywa się price

Przykład:

15000

status
enum<string>

Status zwrotu. Jedyny status oznaczający sukces to COMPLETED; CANCELED pisane przez jedno l. Zwrot osiąga stan końcowy zwykle w ciągu kilkudziesięciu sekund.

Dostępne opcje:
INITIALIZED,
PENDING,
WAITING_FOR_EXTERNAL_ACTION,
COMPLETED,
CANCELED,
ERROR
Przykład:

"PENDING"

paymentMethod
string

Metoda płatności, którą zapłacono zwracaną płatność

Przykład:

"BLIK"

partnerId
string<uuid>

Identyfikator partnera, do którego należy płatność

Przykład:

"3a7d1f52-8b64-4c19-9e03-7d2a5f8c1b44"

productId
string<uuid>

UUID produktu, w ramach którego powstała płatność

Przykład:

"891412c8-8717-4449-9543-e34112bec470"

locale
string

Locale płatności

Przykład:

"pl"

comment
string

Tekst przekazany w polu reason żądania

Przykład:

"Klient zrezygnował z zamówienia"

createdAt
string<date-time>

Czas utworzenia zwrotu (ISO 8601, UTC)

Przykład:

"2026-10-06T11:42:03Z"

updatedAt
string<date-time>

Czas ostatniej zmiany statusu zwrotu (ISO 8601, UTC)

Przykład:

"2026-10-06T11:42:04Z"