Skip to main content
POST
/
send_link
Text the caller a pay link
curl --request POST \
  --url https://ringup.dev/api/tools/send_link \
  --header 'Content-Type: application/json' \
  --header 'X-Caller-Number: <x-caller-number>' \
  --header 'X-Ringup-Merchant: <x-ringup-merchant>' \
  --data '
{
  "amount_cents": 1900
}
'
{
  "ok": true,
  "sent_to": "+14155550142",
  "link": "https://ringup.dev/pay"
}

Headers

​
X-Caller-Number
string
required

The caller's phone number in E.164, templated from the platform's caller-ID variable. Never model-generated.

Example:

"+14155550142"

​
X-Ringup-Merchant
string
required

The dialed number in E.164 (resolved to a merchant server-side) or an explicit merchant id.

Example:

"tonys-pizza"

​
X-Call-Id
string

The platform's call id. Used for charge idempotency: retries within a call can never double-charge.

Body

application/json
​
amount_cents
number

Order total in cents.

Response

200 - application/json

Confirmation the text was sent.

​
ok
boolean
​
sent_to
string
​
link
string