Create a payment link at the door

POST

/rounds/{id}/stops/{stopId}/payment-link

curl --request POST \
  --url https://example.com/rounds/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/stops/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/payment-link \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

A customer who would rather pay online than hand over notes. The driver makes a link for what is owed on this drop, on the business’s connected payment-provider account, and shows it to the customer to pay from their own phone. Emailed as well when there is an address. A driver may only do this on their own round.

Authorizations

• sessionCookie
  deliveries:write
• apiKey
  deliveries:write

Parameters

Path Parameters

id

required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

stopId

required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

200

The link to show them

Media typeapplication/json

object

url

required

string format: uri

amountPence

required

integer

Example ^generated

{
  "url": "https://example.com",
  "amountPence": 1
}

401

Not signed in

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Not found

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Already paid, nothing to pay, or the business cannot take payment yet

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

Media typeapplication/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}

503

Payments are not configured on this installation

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}