Create General Payment Link
Create a general payment link. Unlike a customer-specific payment link, the customer and payment currency are supplied later during checkout.
-H "x-api-key: your_secret_key"POST {{host}}/v1/pay/generalRequest Body
| Field | Data Type | Required | Description |
|---|---|---|---|
| metadata | array | Yes | Line items. Each item requires name, amount, and quantity. Amounts are in your settlement currency. |
| feeBearer | string | No | MERCHANT or CUSTOMER. |
| taxChargeable | string | No | INCLUSIVE or EXCLUSIVE. |
| taxEnabled | boolean | No | Enables provider automatic tax where supported. Defaults to true. |
{
"metadata": [
{
"name": "Website design",
"amount": 100,
"quantity": 1
}
],
"feeBearer": "CUSTOMER",
"taxChargeable": "EXCLUSIVE",
"taxEnabled": true
}{
"status": true,
"message": "Success",
"code": 201,
"data": {
"reference": "KYSHI-1778623597453",
"status": "PENDING",
"paymentLink": {
"id": "f6cbda33-1a40-4f2e-a211-fd87bd86cc4a",
"code": "GPL_abc123",
"url": "https://pay.kyshi.co/GPL_abc123",
"expiresAt": null
},
"amount": {
"value": 100,
"currency": "USD"
}
}
}Updated 7 days ago
