One-Time Passcode
One-time passcode (OTP) is a security feature that requires a four-digit passcode on delivery of some orders. The customer is required to provide the one-time passcode to the driver for acceptance of a delivery. When this feature is enabled for an order, the driver cannot mark the order as delivered until the one-time passcode is entered in the Spark Driver™ app. If the one-time passcode is not provided by the customer, the driver returns the order to the pickup point.
Using the one-time passcode feature is recommended for high value items, as it provides a security layer and ensures that the driver has delivered the order to the customer.
A one-time passcode can be requested only at the time the delivery is booked. Each orderId will have its own passcode. This passcode will not change during the lifespan of the orderId. The passcode will be included in the delivery status webhook response as confirmation.
The client is responsible for communicating the one-time passcode to the customer. Clients must implement their own communication practices, but we recommend that communications regarding one-time passcodes to the customer occur at least at the following times:
- At checkout, notifying the customer about an upcoming one-time passcode communication.
- As soon as the client receives the one-time passcode from Walmart GoLocal's delivery status webhook. The webhook is sent automatically after the delivery is first booked.
- The morning of the delivery. This may be the same day as the initial receipt of the one-time passcode.
- When a delivery driver is en route to the dropoff. The webhook can be sent automatically after the delivery driver's status changes.
Using a One-Time Passcode
To specify using a one-time passcode, when booking a delivery, set each of the addOnServices fields isDropOffOTPRequired
and attendedDelivery
to true
.
"deliveries":
{ ... "addOnServices": { ... "attendedDelivery": true, "isDropOffOTPRequired": true }, ...
}
Notifying the Client
The delivery status webhook is sent to the client app after booking a delivery. The one-time passcode will be included in all delivery status webhooks. The following is an example response snippet. The passcode is in the field dropOffOTP
.
"otpDetails":
{ "dropOffOTP": "4826"
}
Updated 8 days ago