payin.successful event.
The checkout URL is built from the link’s slug:
Create a link
POST /v1/payment-links · needs the payins:write scope
How far above
amount a payment may be and still count as paid in full. Minor units.How far below
amount a payment may be and still count as paid in full. Minor units.Response · 201
Fixed and open amounts
- Fixed amount. Set
amount. The checkout charges exactly that. A payer cannot change it. - Open amount. Leave
amountout. The payer enters what they want to pay.
What the payer sees
The hosted checkout shows your title, description and amount, then the payment methods you allowed. For a bank transfer it shows the account to pay into. For a card it collects the card and any PIN or one-time code. When the payment finishes it sends the payer toredirectUrl if you set one.
You never handle card numbers.
Know when you are paid
Each payment through a link is a pay-in. ItsmerchantReference is paylink- followed by the link’s slug, so you can match it to the link.
- Receive
payin.successful. - Match
data.merchant_reference, for examplepaylink-invoice-1042-k3x9qa, to your link. - Fetch the pay-in and check
statusandsubStatus. - Fulfil.
Overpayment and underpayment
A bank transfer can arrive for a different amount than the link asked for. On a fixed-amount link, Payve compares what arrived withamount and your two tolerances.
Both tolerances default to
0: any difference, however small, counts as over or under.
The comparison uses the amount received after any transfer levy has been deducted. Set
underpaymentTolerance high enough to cover such deductions, or an exact payment can be treated
as short.How the refund reaches the payer
Payve creates a refund for the excess or for the whole short payment. If the paying account is known, the refund waits for Payve’s review and is then sent there. If it is not known, the checkout asks the payer where to send it.GET /v1/refunds?payinTransactionId={id} shows the refund for a pay-in.
Open-amount links have no expected amount, so no payment is over or under.
Manage links
PATCH and DELETE need the payins:write scope.
To stop a link taking payments without deleting it, set its expiresAt to a time in the past. An expired link’s checkout page returns not found.

