Payment links: creation, publication and tracking
Understand NeoPay link creation and publication without confusing either step with a confirmed payment.
Prepare the request
A link describes the product, its reference, amount, currency and payment page information. Check the application mode and the payment methods available for that account and currency. Subscription and amount options depend on your configuration.
Existing API resources
The API keeps the same addresses and methods. Listing links and reading details are read operations; creation and publication change a link. Prepare these operations in a Test application before any live use.
GET /api/links
GET /api/links/{id}
POST /api/links
PATCH /api/links/{id}/publish
PATCH /api/links/{id}/unpublish
PATCH /api/links/{id}/closeRead the response, then check publication
Creation and publication responses expose fields including id, status, slug and link in the JSON resource. The link field contains the payment address to use. Also check status: having an address alone does not confirm that the link is published.
Publication may be refused with HTTP 409 and an explanatory code. Do not automatically switch a Test application to Live to work around a refusal. Correct the required configuration in the same environment.
Share and track
From your merchant space, share the link, its QR code or its embedded button as needed. None of these sharing methods confirms a payment. Check the transaction status in NeoPay afterwards.