VyaFac is a powerful and secure payment gateway API designed to streamline transaction processing. Developers can leverage OpenAPI specifications to manage products, pricing options with tax plans, and customer accounts along with their payment methods. The API also enables the creation and management of subscriptions and payment links, providing a seamless and efficient payment experience.
VyaFac API (1.0.0)
Download OpenAPI description
Languages
Servers
Mock server
https://docs.vyafac.com/_mock/openapi/
- Mock server
https://docs.vyafac.com/_mock/openapi/payment-links
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.vyafac.com/_mock/openapi/payment-links?limit=100' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "status": "success", "message": "Payment links retrieved successfully", "data": [ { … } ], "code": 200, "timestamp": "2025-02-27T12:30:00+00:00", "version": "1.0.0" }
- Mock server
https://docs.vyafac.com/_mock/openapi/payment-links
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.vyafac.com/_mock/openapi/payment-links \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"max_payments": null,
"success_message": "Thank you for your purchase!",
"inactive_message": "This donations link is closed please look for newer links.",
"trial_days": 10,
"redirect_url": null,
"products": [
{
"product_id": "pro_mUMe9iAzjoEm5GgArWL3lIG0",
"pricing_option_id": "price_ZGhjedgcbI0lE9B1nQH5k234",
"quantity": 5
}
]
}'Response
application/json
{ "status": "success", "message": "Payment link created successfully", "data": { "id": "pl_keImLPRRNAVFC4MxKi7xEZaD", "name": "Premium Membership Payment Link" }, "code": 200, "timestamp": "2025-02-27T12:35:00+00:00", "version": "1.0.0" }
- Mock server
https://docs.vyafac.com/_mock/openapi/payment-links
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://docs.vyafac.com/_mock/openapi/payment-links \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"ids": [
"pl_leDom1TwRazXqqNJF8WtspyR"
]
}'Response
application/json
{ "status": "success", "message": "Payment link deleted successfully", "data": null, "code": 200, "timestamp": "2025-02-27T12:40:00+00:00", "version": "1.0.0" }
- Mock server
https://docs.vyafac.com/_mock/openapi/payment-links/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.vyafac.com/_mock/openapi/payment-links/pl_keImLPRRNAVFC4MxKi7xEZaD \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "status": "success", "message": "Payment link details retrieved successfully", "data": { "id": "pl_keImLPRRNAVFC4MxKi7xEZaD", "name": "Premium Membership Payment Link" }, "code": 200, "timestamp": "2025-02-27T12:45:00+00:00", "version": "1.0.0" }
- Mock server
https://docs.vyafac.com/_mock/openapi/payment-links/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
https://docs.vyafac.com/_mock/openapi/payment-links/pl_keImLPRRNAVFC4MxKi7xEZaD \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Premium Membership Payment Link",
"max_payments": 100,
"inactive_message": "This link is no longer active",
"success_message": "Thank you for your purchase!",
"trial_days": 14
}'Response
application/json
{ "status": "success", "message": "Payment link updated successfully", "data": { "id": "pl_keImLPRRNAVFC4MxKi7xEZaD", "name": "Premium Membership Payment Link" }, "code": 200, "timestamp": "2025-02-27T12:50:00+00:00", "version": "1.0.0" }