Créer une session de carte
Ce point de terminaison crée une session de carte dans notre système, et il renvoie l'URL vers laquelle vous devez rediriger l'utilisateur.Une session de carte représente l'émission d'une carte virtuelle Sezzle à un utilisateur de Sezzle et / ou l'accord d'un utilisateur de Sezzle pour utiliser la carte virtuelle comme paiement.Utilisez les points de terminaison de la session de carte pour créer et mettre à jour une session de carte.
Vous pouvez utiliser ce point de terminaison pour créer une session de carte virtuelle.La réponse comprendra une session uuid
et l'URL du tableau de bord client Sezzle à héberger dans un iframe ou une fenêtre contextuelle.
:::avertissement virtuel uniquement note: Ce point de terminaison doit être utilisé avec notre offre de cartes virtuelles.Il n'est pas destiné au flux d'intégration directe. :::
Point de terminaison
POST https://gateway.sezzle.com/v2/session/card
Propriétés
Objet de session de carte
Paramètre | Requis | TyTaper | Ddescription |
---|---|---|---|
origin | Yes | chaîne | L'origine de la fenêtre de l'hôte |
mode | Yes | chaîne | iframe or popup |
merchant_reference_id | No | chaîne | Généralement un paiement ou un identifiant de panier, actuellement utilisé pour le suivi uniquement |
amount_in_cents | No | int | Le montant de la commande en cents |
currency | No | chaîne | Le code de devise de 3 caractères tel que défini par ISO 4217 |
customer | No | objet | Le client de cette session |
card_response_format | Optional | chaîne | Valeur de token requis pour utiliser le tokenisation |
Objet client
Paramètre | Taper | description |
---|---|---|
chaîne | L'adresse e-mail du client | |
first_name | chaîne | Le prénom du client |
last_name | chaîne | Le nom de famille du client |
phone | chaîne | Le numéro de téléphone du client |
billing_address | objet | L'adresse de facturation du client |
S'adresser à l'objet
Paramètre | Taper | description |
---|---|---|
street | chaîne | La rue et le numéro de l'adresse |
street2 | chaîne | L'APT ou l'unité |
city | chaîne | La ville |
state | chaîne | Le code d'état de 2 caractères |
postal_code | chaîne | Le code de livraison postal |
country_code | chaîne | Le code de pays à 2 caractères |
Objet d'article
Paramètre | Taper | description |
---|---|---|
name | chaîne | Le nom de l'objet |
sku | chaîne | L'identifiant SKU |
quantity | int | La quantité achetée |
price | objet | L'objet de prix |
Objet de prix
Paramètre | Taper | description |
---|---|---|
amount_in_cents | int | Le montant de l'article en cents |
currency | chaîne | Le code de devise de 3 caractères tel que défini par ISO 4217 |
Demander des exemples d'objets
Demande de session de carte
{
"origin": "https://example.com",
"mode": "iframe",
"merchant_reference_id": "merchant-cart-id-max-255",
"amount_in_cents": 1000,
"currency": "USD",
"customer": {
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "6125551234",
"billing_address": {
"street": "123 W Lake St",
"street2": "Unit 104",
"city": "Minneapolis",
"state": "MN",
"postal_code": "55408",
"country_code": "US"
}
},
"items": [
{
"name": "Blue tee",
"sku": "sku123456",
"quantity": 1,
"price": {
"amount_in_cents": 1000,
"currency": "USD"
}
}
]
}
Session de carte tokenisée
{
"origin": "https://example.com",
"mode": "iframe",
"merchant_reference_id": "merchant-cart-id-max-255",
"amount_in_cents": 1000,
"currency": "USD",
+ "card_response_format": "token"
"customer": {
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "6125551234",
"billing_address": {
"street": "123 W Lake St",
"street2": "Unit 104",
"city": "Minneapolis",
"state": "MN",
"postal_code": "55408",
"country_code": "US"
}
},
"items": [
{
"name": "Blue tee",
"sku": "sku123456",
"quantity": 1,
"price": {
"amount_in_cents": 1000,
"currency": "USD"
}
}
],
}
Objet de réponse
La dashboard_url
est une URL vers laquelle le client doit être redirigé.En acceptant les accords, un postmessage sera retourné pour la charge utile des données de la carte.
{
"uuid": "fadbc642-05a4-4e38-9e74-80e325623af9",
"dashboard_url": "https://dashboard.sezzle.com/example?id=0001"
}