Create a payment link
create_payment_linkCreate a shareable hosted payment link that starts a new checkout session per visit. Set a fixed amount or a min/max range, and limit by max uses or expiry date.
Instructions
Create a payment link.
Create a reusable payment link: a hosted page you can share anywhere. Each visit starts its own checkout session. Set a fixed amount, or leave it out and set min_amount / max_amount to let the customer choose. max_uses and expires_at stop the link automatically.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| split | No | Split rule (spl_…) | |
| amount | No | Fixed amount in kobo. Omit and set min/max to let the customer choose. | |
| max_uses | No | Stop accepting payments after this many | |
| metadata | No | ||
| cancel_url | No | ||
| expires_at | No | ||
| max_amount | No | ||
| min_amount | No | ||
| description | No | ||
| success_url | No | ||
| idempotency_key | No | Optional. A unique key for this request; retrying with the same key returns the original result instead of acting twice. One is generated if omitted. |