Webhooki transakcyjne

W artykule opisano endpoint i strukturę danych, jakie merchant powinien zaimplementować aby otrzymywać informacje o zwrotach, płatnościach i rozliczeniach.

Merchant Refunds Receiver API

Endpoint

POST /events

Nagłówki

• Content-Type: application/json

• X-Signature: <calculated_signature>

• X-API-Version: <api_version>

Sygnatura

Sygnatura jest wyliczana poprzez połączenie wartości nagłówka X-API-Version, wartości wymienionych poniżej pól treści żądania w kolejności alfanumerycznej oraz merchant secret (Jeżeli któraś z wartości jest pusta, wtedy powinna być traktowana jako pusty ciąg znaków.). Końcowa sygnatura to szesnastkowy skrót funkcji skrótu SHA-512 zastosowany do połączonej wiadomości, zapisany małymi literami. W celu weryfikacji sygnatury należy porównać wyliczoną wartość z wartością nagłówka X-Signature.

Request Body

Opis parametrów

• eventType (string): Typ eventu (np. REFUND, REFUND_DECLINED, PAYMENT_AUTHORIZED, PAYMENT_DECLINED, SETTLEMENT).

• eventData (object): Dane powiązane z eventem
  
  Wspólne parametry:

  • amount (object, wymagany):

    • value (string): Całościowa kwota płatności będąca sumą payload.amount.value i payload.additionalFundingAmount.value.

    • currency (string): Waluta płatności

  • merchantId (string, wymagany): Wartość merchant ID nadana przez InPost

  • eventDateTime (string, wymagany): Data i czas wystąpienia eventu

  • createdDate (string, wymagany): Data i czas utworzenia płatności .{}
    
    Parametry określone dla Payment/Payment Declined:

  • status (string, wymagany): Status płatności (DECLINED, AUTHORIZED).{}

  • payment (object, wymagany):

    • id (string, wymagany): ID płatności

    • method (string, wymagany): Nazwa metody płatności, która została użyta

    • reference (string): Referencja płatności

  • orderReference (string): Referencja zamówienia (parametr opcjonalny dla payment-related events).{}

  • zonedCreatedDate (string, wymagany): Data i godzina wraz ze strefą czasową, kiedy płatność została utworzona.{}
    
    Parametry określone dla Settlement:

  • settlementId (string, wymagany): Zewnętrzny ID płatności

  • transferReference (string): Numer referencyjny przelewu
    
    Parametry określone dla Refund:

  • status (string): Status zwrotu (np. REFUNDED, DECLINED).{}

  • operationId (string): Wartość ID operacji powiązanej z płatnością

  • refundReference (string): Numer referencyjny zwrotu

  • payment (object, wymagany):

    • id (string, wymagany): ID płatności

    • method (string, wymagany): Nazwa użytej metody płatności

    • reference (string): Referencja płatności

Przykład dla REFUND:

Przykład dla REFUND_DECLINED: 

Przykład dla PAYMENT_AUTHORIZED:

Przykład dla PAYMENT_DECLINED:

Przykład dla SETTLEMENT: