Przejdź do głównej treści
POST
/
api
/
pay
/
plugin
/
webhook
Zarejestruj webhook
curl --request POST \
  --url https://gateway-api.sandbox.paymove.io/api/pay/plugin/webhook \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "PaymentSuccessHook",
  "endpoint": "https://merchant-shop.com/api/payments/webhook",
  "method": "POST",
  "requestTemplate": {
    "orderId": "{{externalId}}",
    "price": "{{price}}"
  },
  "responseTemplate": {
    "status": "ok"
  },
  "expectedCode": 200,
  "expectedResponse": "{ \"status\": \"ok\" }",
  "retries": 3,
  "partnerId": "{{partnerId}}",
  "type": "PAYMENT",
  "headers": {
    "Content-Type": [
      "application/json"
    ]
  }
}
'

Autoryzacje

X-API-KEY
string
header
wymagane

Klucz API dostarczony przez Paymove po zakończeniu procesu KYC. Przykład: pm_sbx_sk_2f38b0c1e74c466db3d1a9b7ff8c41f2

Treść

application/json
name
string
wymagane
Przykład:

"PaymentSuccessHook"

endpoint
string<uri>
wymagane

URL, na który będą wysyłane powiadomienia

method
enum<string>
wymagane
Dostępne opcje:
POST
requestTemplate
object
wymagane

Szablon payloadu webhooka. Zmienne w formacie {{zmienna}}: {{externalId}} — orderId merchanta, {{price}} — kwota.

expectedCode
integer
wymagane
Przykład:

200

partnerId
string
wymagane
type
enum<string>
wymagane
Dostępne opcje:
PAYMENT
responseTemplate
object

Oczekiwana struktura odpowiedzi od merchanta

expectedResponse
string
Przykład:

"{ \"status\": \"ok\" }"

retries
integer

Liczba ponownych prób w przypadku niepowodzenia

Przykład:

3

headers
object

Odpowiedź

201

Webhook zarejestrowany