Set payment status

This page provides details on how to set a status for a package that requires a payment check.

By adding external_payment_confirmation parameter in Create Delivery for the relevant package, will let our system know that this package must have payment status

The courier will be able to deliver the package only when the status is "completed"

In case the status is pending for a long period of time (i.e. if the client is unable to pay), the courier won’t be able to deliver and will set the package as not_delivered

In case the status is failed, the courier can ask a client to settle a payment, and if the customer can’t pay, then the courier will set the package as not_delivered (see Finite Response Examples).

For enabling this option, please contact our account manager.

Resource

POST /v1/delivery/deliveries/payment-status

Authorization

OAuth 2.0 bearer token with Delivery scope.

Query Parameters

Name	Type	Description
business_id	string	Unique identifier representing a Business. (ex: IL-7436) (equivalent to company_id in response body)

Body Parameters

Name	Type	Description
status	string	The payment status can be one of the following: pending - the payment wasn't confirmed yet completed - the payment completed failed - the payment failed
uuid	string	Delivery id received when creating a new delivery
date	timestamp	The time and date of the request time format

Request

{
  "status": "completed",
   "uuid": "DR-619f159cc8fb4671ab7027966bd2c22e",
   "date": "2020-10-01T12:30:57.91491Z"
}

Response

{
    "ok": true
}

Sandbox

Resource:

POST /v1/delivery_sandbox/deliveries/payment-status

More info can be found here