Introduksyon
Ang Payman API ay isang JSON REST API. Lahat ng request ay pupunta sa https://payman33.com/v1 gamit ang HTTPS.
Pagpapatunay
Ipadala ang access token na natanggap mo nung nag-create ka ng account bilang bearer token. Ito ay ipinapakita lang minsan at hindi ma-reissue, kaya panatilihing sikreto at huwag ilagay sa client-side code.
Authorization: Bearer pm_live_xxxxxxxxxxxxxxxxMagpadala ng mensahe
POST /messages
| Patlang | Uri | Deskripsyon |
|---|---|---|
to | string[] | Mga tatanggap sa E.164 format. Hanggang 10,000 kada request. |
text | string | Body ng mensahe: isang SMS, hanggang 160 characters (GSM-7), o 70 kung may ibang letra o emoji. Mas mahabang text ay tatanggihan. |
schedule_at | string | Opsiyonal na ISO-8601 time para magpadala mamaya, hanggang 30 araw sa hinaharap. |
callback_url | string | Opsiyonal na HTTPS URL na tatanggap ng delivery reports. |
{
"id": "msg_01J9Z3K8V2",
"status": "queued",
"recipients": 1,
"segments": 1,
"cost": 0.0063
}Magdagdag ng Idempotency-Key header para ligtas na mag-retry: ang parehong key sa loob ng 24 oras ay magbabalik ng orihinal na response imbes na magpadala ulit.
Status ng mensahe
GET /messages/{id}
Mga status: queued, tapos sent, tapos delivered o failed. Ang scheduled message ay mananatiling scheduled hanggang maipadala; kanselahin ito (at mabawi ang bayad) gamit ang POST /messages/{id}/cancel.
Webhooks
Kapag dumating ang delivery report, POST namin ito sa iyong callback_url. Bawat request ay may X-Payman-Signature header: ang HMAC-SHA256 ng body gamit ang iyong webhook secret (Dashboard, API tab), para ma-verify mo. Ang failed deliveries ay iri-retry hanggang 3 beses.
{
"id": "msg_01J9Z3K8V2",
"to": "+14155550123",
"status": "delivered",
"delivered_at": "2026-10-09T08:12:03Z"
}Balanse
GET /balance
Ibinabalik ang iyong kasalukuyang balance sa USDT. Ang mga presyo ay nakalista sa USD; 1 USDT = 1 USD.
Mga error
| HTTP | Kodigo | Kahulugan |
|---|---|---|
| 400 | invalid_request | Nawawala o maling format ang field. |
| 401 | unauthorized | Nawawala o hindi wasto ang API key. |
| 402 | insufficient_balance | Mag-top up para makapagpadala. |
| 403 | verification_required | Naabot na ng hindi pa na-verify na account ang limit ng recipient ngayon. |
| 404 | not_found | Walang ganong mensahe sa iyong account. |
| 429 | rate_limited | Sobrang daming request. Subukan ulit pagkatapos ng Retry-After header. |
Mga limitasyon sa rate
Ang default na limitasyon ay 50 request kada segundo kada account. Gamitin ang bulk sends (maraming numero sa to) para sa malalaking kampanya. Ang unverified accounts ay makakapagpadala sa hanggang 500 tatanggap kada araw.