Payment Links+ API
Payment Links vs Payment Links+
Omise offers two different Payment Links products:
| Feature | Payment Links | Payment Links+ |
|---|---|---|
| API Server | https://api.omise.co/links | https://linksplus-api.omise.co |
| Templates | No | Yes - create reusable templates |
| Custom Webhooks | Account-level only | Per-link custom webhooks |
| Team Management | No | Yes - team_id based |
| Documentation | Payment Links API | This page |
If you're using the standard Omise API at api.omise.co, see Payment Links API instead.
Create and manage Payment Links+ programmatically using the dedicated Links+ API. This API provides template-based link creation, custom webhooks, and advanced features.
Base URLโ
https://linksplus-api.omise.co
Authenticationโ
All requests require authentication using your Secret Key via HTTP Basic Auth or Bearer token.
# Using Basic Auth
curl https://linksplus-api.omise.co/external/links \
-u skey_test_xxx:
# Using Bearer Token
curl https://linksplus-api.omise.co/external/links \
-H "Authorization: Bearer skey_test_xxx"
API Endpointsโ
Linksโ
| Method | Endpoint | Description |
|---|---|---|
| POST | /external/links | Create a payment link |
| GET | /external/links/:link_id | Retrieve a payment link |
| GET | /external/:team_id/links | List all payment links |
Templatesโ
| Method | Endpoint | Description |
|---|---|---|
| GET | /external/templates/:template_id | Retrieve a template |
| GET | /external/:team_id/templates | List all templates |
Webhooksโ
Payment Links+ supports up to 3 webhook endpoints per payment:
- System webhook - Configured at the account level
- Dashboard webhook - Configured in the Omise Dashboard
- Custom webhook - Specified per link via the
custom_webhookparameter
Webhook Payloadโ
When a payment is completed, all configured webhooks receive the payment event:
{
"event": "payment.completed",
"link_id": 789,
"payment": {
"id": "chrg_test_xxx",
"amount": 100000,
"currency": "thb",
"status": "successful"
},
"timestamp": "2026-02-14T10:35:00Z"
}
HTTPS Required
Custom webhook URLs must use HTTPS. HTTP URLs will be rejected.
Response Codesโ
| Code | Description |
|---|---|
| 200 OK | Request successful |
| 400 Bad Request | Invalid parameters or missing required fields |
| 401 Unauthorized | Invalid or missing API key |
| 404 Not Found | Resource not found |
| 500 Internal Server Error | Server error, retry later |
Related Resourcesโ
- Payment Links Overview - Learn about Payment Links features
- Creating Links - Create links via dashboard
- Webhooks Guide - Set up webhook notifications