Passer au contenu principal
POST
/
v2
/
order
/
{order_uuid}
/
upcharge
Upcharge amount by order
curl --request POST \
  --url https://sandbox.gateway.sezzle.com/v2/order/{order_uuid}/upcharge \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intent": "AUTH",
  "upcharge_amount": {
    "amount_in_cents": 5000,
    "currency": "USD"
  }
}
'
{
  "uuid": "6c9db5d4-d09a-4224-860a-b5438ac32ca8"
}
Cette API est en cours de développement et n’est pas encore disponible pour une utilisation en production. Les détails de cette page sont susceptibles de changer.

​
Aperçu

Le endpoint de supplément vous permet de facturer un montant supplémentaire sur une commande autorisée existante. Cela est utile lorsque le total final de la commande dépasse le montant initialement autorisé (par exemple, en raison d’ajustements de prix basés sur le poids, de services ajoutés ou de modifications des frais d’expédition).

​
Comportement clé

  • Une nouvelle commande distincte est créée pour le montant du supplément uniquement. La commande originale n’est pas libérée ni modifiée.
  • Le montant du supplément est facturé à l’acheteur en un paiement unique (Pay In Full).
  • Le total cumulé de tous les suppléments sur une commande donnée ne doit pas dépasser 15 % du montant autorisé initial.
  • La devise du supplément doit correspondre à la devise de la commande originale.
  • L’UUID retourné est l’UUID de la nouvelle commande de supplément et peut être utilisé avec d’autres endpoints de l’API Order (par exemple, capture, remboursement).
  • Les deux commandes restent associées — vous pouvez interroger la relation via le Get Order endpoint:
    • Sur la commande de supplément, la réponse inclut is_upcharge: true et parent_order_uuid faisant référence à la commande originale.
    • Sur la commande originale, la réponse inclut un tableau upcharges répertoriant l’UUID et le montant de chaque commande de supplément.

​
Exigences de validation

  • La commande originale doit avoir une autorisation approuvée.
  • intent doit être soit AUTH soit CAPTURE.
  • upcharge_amount doit inclure un amount_in_cents et currency valides.

​
Exemple

Pour une commande originale de 100,00 USD :
  • Supplément cumulé maximum autorisé : 15,00 USD (15 % de 100,00)
  • Un supplément unique de 10,00 est accepté, laissant une capacité de supplément restante de 5,00.
  • Un supplément ultérieur de 6,00 serait rejeté (le cumul de 16,00 dépasse la limite de 15 %).

Autorisations

​
Authorization
string
header
requis

The authentication token generated from providing API Keys to Sezzle Gateway

En-têtes

​
Sezzle-Request-Id
string

Unique client-generated ID to enforce idempotency

Paramètres de chemin

​
order_uuid
string
requis

The Order UUID to upcharge (order.uuid from session response)

Corps

application/json
​
intent
enum<string>
requis
  • Use CAPTURE if payment should be captured immediately upon shopper authorization
  • Use AUTH if there is any post-authorization validation needed prior to capture, such as inventory validation or regulatory requirements, or if merchant policy is to charge the payment method at time of shipment
    • Submit a capture request via the API or your Merchant Dashboard before the authorization expires.
    • The authorization expiration window can be set from 30 minutes up to 7 days in your Merchant Dashboard Settings.
  • If not specified, the value will default to CAPTURE
Options disponibles:
AUTH,
CAPTURE
​
upcharge_amount
object
requis

The amount to upcharge. The cumulative total of all upcharges on a given order must not exceed 15% of the original order amount. Currency must match the original order.

Réponse

Successful Operation

​
uuid
string

The UUID of the new upcharge order. This UUID can be used with other Order API endpoints (e.g., capture, refund).