# Anulowanie linku płatności

**POST /{merchantId}/payment/cancel**




## Servers
- Środowisko produkcyjne: https://api.imoje.pl/v1/merchant (Środowisko produkcyjne)
- Środowisko testowe: https://sandbox.api.imoje.pl/v1/merchant (Środowisko testowe)


## Authentication methods
- Token autoryzacyjny


## Parameters

### Path parameters
- **merchantId** (string)
  Identyfikator klienta


### Body: application/json (object)

- **serviceId** (string(uuid))
  Identyfikator sklepu jako `UUID v4`
- **paymentId** (string(uuid))
  Identyfikator linku płatności jako `UUID v4`


## Responses
### 200
Zapytanie wykonane poprawnie


#### Body: application/json (object)
- **id** (string(uuid))
  Identyfikator linku płatności jako `UUID v4`
- **url** (string)
  Adres przekierowania do płatności
- **serviceId** (string(uuid))
  Identyfikator sklepu jako `UUID v4`
- **orderId** (string)
  Numer zamówienia
- **title** (string)
  Tytuł transakcji
- **simp** (string)
  Numer rachunku SIMP przy włączonej usłudze płatności masowych
- **amount** (integer)
  Kwota transakcji w najmniejszej jednostce waluty np. **grosze**.
- **currency** (string)
  Status
- **status** (string)
  Status
- **isActive** (boolean)
  Informacja czy link płatności jest aktywny
- **validTo** (integer | null)
  Data ważności transakcji jako **timestamp w sekundach**. Brak realizacji płatności do tego czasu spowoduje jej anulowanie. Jeżeli nie jest przekazane to transakcja ważna jest do czasu ustawionego w parametrze *Aktywność płatności* w Panelu Administracyjnym imoje (ustawienia sklepu) lub po upływie 15 miesięcy. Przekazanie parametru `validTo`= `NULL` powoduje brak wygaśnięcia transakcji z pominięciem ustawień w parametrze *Aktywność płatności* na Panelu Administracyjnym imoje (ustawienia sklepu). **Minimalny** czas ważności linku to **60 sekund**.
- **created** (integer | null)
  Data utworzenia jako timestamp
- **modified** (integer | null)
  Data modyfikacji jako timestamp
- **isGenerated** (boolean)
  Informacja czy link płatności został wygenerowany z poziomu panelu imoje.
- **isUsed** (boolean)
  Informacja czy link płatności został użyty.
- **usedAt** (integer)
  Data użycia linku płatności jako timestamp
- **isConfirmVisited** (boolean)
  Informacja czy płatnik odwiedził stronę potwierdzenia płatności w bramce imoje.
- **confirmVisitedAt** (integer | null)
  Data przejścia na stronę potwierdzenia płatności w bramce imoje jako timestamp.
- **returnUrl** (string(uri))
  Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku nie rozstrzygnięcia statusu transakcji. Adres musi być zgodny ze standardem URL `RFC 3986`.
- **failureReturnUrl** (string(uri))
  Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku wystąpienia błędu płatności. Adres musi być zgodny ze standardem URL `RFC 3986`.
- **successReturnUrl** (string(uri))
  Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku dokonania płatności z powodzeniem. Adres musi być zgodny ze standardem URL `RFC 3986`.
- **notificationUrl** (string(uri))
  Dynamiczny adres notyfikacji, możliwość ustawienia konkretnego adresu dla pojedynczej transakcji.
  Adresy zawierające `localhost` oraz porty zostaną odrzucone.
- **customer** (object)
  Dane płatnika
- **transactions** (array[object])
  Lista transkacji przypisanych do linku płatności.

### 400
Link nie może być anulowany


#### Body: application/json (object)
- **apiErrorResponse** (object)



[Powered by Bump.sh](https://bump.sh)