Request payment

Send a customer a payment request with a link to pay by card.

POST https://cotlet.dev/api/v1/podium/payment/request

write Confirm

Sends a payment request to a phone number or an email address, as Request payment does on the Payments page. The customer gets a payment link by text, or by email when you pass an email address. invoice_number and description appear on the request. The request reaches a customer and asks for money. By default you confirm each call; you can switch that off for this tool.

Parameters

Parameters: request_payment
NameTypeDescription
location string string Location ID from list_locations. Needed when your account has more than one location.
to string required string Customer phone number or email address.
amount number required number Amount to request, as you would type it in the request form.
description string string What the payment is for.
invoice_number string string Your invoice number, shown on the request.

Request

cURL
curl -X POST https://cotlet.dev/api/v1/podium/payment/request \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"to","amount":1}'
Python
result = client.call("podium", "request_payment", {"to":"to","amount":1})
Node.js
const result = await cotlet.call('podium', 'request_payment', {"to":"to","amount":1});
CLI
cotlet call podium request_payment --data '{"to":"to","amount":1}'

Example response

JSON

{
  "payment_request_id": "pay_3c19",
  "invoice_number": "INV-1042",
  "amount": 480,
  "status": "pending",
  "sent_via": "text"
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.