Lister les webhooks

GET

webhooks

List webhooks

curl --request GET \
  --url https://sandbox.gateway.sezzle.com/v2/webhooks \
  --header 'Authorization: <api-key>'

import requests

url = "https://sandbox.gateway.sezzle.com/v2/webhooks"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://sandbox.gateway.sezzle.com/v2/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.gateway.sezzle.com/v2/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.gateway.sezzle.com/v2/webhooks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.gateway.sezzle.com/v2/webhooks")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.gateway.sezzle.com/v2/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "uuid": "747cf28a-bb5c-46a8-a288-d9b006fd6113",
    "links": [
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks",
        "rel": "create",
        "method": "POST"
      },
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks",
        "rel": "list",
        "method": "GET"
      },
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
        "rel": "self",
        "method": "GET"
      },
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
        "rel": "self",
        "method": "PATCH"
      },
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
        "rel": "self",
        "method": "DELETE"
      }
    ],
    "url": "https://example.com/webhooks",
    "events": [
      "customer.tokenized"
    ]
  }
]

[
  {
    "code": "bad_request",
    "message": "bad request"
  }
]

[
  {
    "code": "unauthorized",
    "message": "authorization not accepted"
  }
]

[
  {
    "code": "record_not_found",
    "message": "not found"
  }
]

[
  {
    "code": "invalid",
    "message": "Unprocessable entity"
  }
]

Événements Webhook valides

Nous acceptons les événements Webhook suivants

Événement	Déclencheur
`customer.tokenized`	Un client est tokenisé
`order.authorized`	Une commande est autorisée par Sezzle
`order.captured`	Une commande est capturée par Sezzle
`order.refunded`	Une commande est remboursée par Sezzle
`dispute.merchant_input_requested`	Un litige est déposé par un acheteur et la contribution du marchand est requise
`dispute.deadline_approaching`	Un litige est transféré en avis final par Sezzle
`dispute.closed.customer_win`	L’acheteur gagne le litige et la commande est remboursée
`dispute.closed.merchant_win`	Le marchand gagne le litige et il est résolu en sa faveur
`dispute.closed.neutral`	Aucun gagnant clair n’est déterminé et le litige est résolu de manière neutre

Autorisations

Authorization

string

header

requis

The authentication token generated from providing API Keys to Sezzle Gateway

Réponse

Successful Operation

url

string

requis

The URL you are using to receive webhooks

events

enum<string>[]

requis

An array of webhook events you wish to subscribe to

Options disponibles:

customer.tokenized,

order.authorized,

order.captured,

order.refunded,

dispute.merchant_input_requested,

dispute.deadline_approaching,

dispute.closed.customer_win,

dispute.closed.merchant_win,

dispute.closed.neutral

uuid

string

The unique identifier for this response

links

object[]

Available API links prefilled with UUID with accompanying method

Hide child attributes

links.href

string

requis

The fully qualified URL for the API endpoint

links.rel

enum<string>

The relationship type indicating the purpose of this link (e.g., 'self' for the current resource, 'create' for creating a new resource, 'list' for listing resources)

Options disponibles:

self,

capture,

checkout,

create,

customer,

list,

order,

preapprove,

refund,

release,

session

links.method

enum<string>

The HTTP method to use when calling this API endpoint

Options disponibles:

GET,

POST,

PATCH,

DELETE

Exemple:

[
  {
    "uuid": "747cf28a-bb5c-46a8-a288-d9b006fd6113",
    "links": [
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks",
        "rel": "create",
        "method": "POST"
      },
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks",
        "rel": "list",
        "method": "GET"
      },
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
        "rel": "self",
        "method": "GET"
      },
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
        "rel": "self",
        "method": "PATCH"
      },
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
        "rel": "self",
        "method": "DELETE"
      }
    ],
    "url": "https://example.com/webhooks",
    "events": ["customer.tokenized"]
  }
]

Obtenir un webhookGet a single webhook you are subscribed to by its UUID

⌘I

List webhooks

curl --request GET \
  --url https://sandbox.gateway.sezzle.com/v2/webhooks \
  --header 'Authorization: <api-key>'

import requests

url = "https://sandbox.gateway.sezzle.com/v2/webhooks"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://sandbox.gateway.sezzle.com/v2/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.gateway.sezzle.com/v2/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.gateway.sezzle.com/v2/webhooks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.gateway.sezzle.com/v2/webhooks")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.gateway.sezzle.com/v2/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "uuid": "747cf28a-bb5c-46a8-a288-d9b006fd6113",
    "links": [
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks",
        "rel": "create",
        "method": "POST"
      },
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks",
        "rel": "list",
        "method": "GET"
      },
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
        "rel": "self",
        "method": "GET"
      },
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
        "rel": "self",
        "method": "PATCH"
      },
      {
        "href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
        "rel": "self",
        "method": "DELETE"
      }
    ],
    "url": "https://example.com/webhooks",
    "events": [
      "customer.tokenized"
    ]
  }
]

[
  {
    "code": "bad_request",
    "message": "bad request"
  }
]

[
  {
    "code": "unauthorized",
    "message": "authorization not accepted"
  }
]

[
  {
    "code": "record_not_found",
    "message": "not found"
  }
]

[
  {
    "code": "invalid",
    "message": "Unprocessable entity"
  }
]

Référence API

Tokenisation

v1 (obsolète)

Lister les webhooks

Événements Webhook valides

Autorisations

Réponse

​Événements Webhook valides

Autorisations

Réponse

Événements Webhook valides