Generate payment link
Payment links can be requested from either the Sandbox or Production environment. We recommend starting with Sandbox, where you can choose one of the model banks and test the end-to-end process without making real payments:
- Sandbox
- Production
POST https://api.sandbox.volt.io/pay-by-link
POST https://api.volt.io/pay-by-link
The above endpoint is based on the v2/payments endpoint. If you have already integrated Gateway, you can expect it to work the same way. The only difference is that you don’t need to redirect the shopper anywhere; checkoutUrl
is your payment link.
Note also that the payment link generated using pay-by-link is valid for 30 days, whereas v2/payments is for 30 minutes.
Authorisation
Pay by Link uses Volt’s REST API. See the authentication section here: API Reference | Volt Developer Hub.
Request Body
This endpoint takes exactly the same request structure as Request payment – Request body | Volt Developer Hub. Please refer to this section of developer documentation for further information.
{
"currencyCode": "EUR",
"amount": "100",
"type": "BILL",
"uniqueReference": "uniquereference",
"payer": {
"reference": "payerreference"
}
}
Example of the response:
{
"id": "uuid",
"checkoutUrl": "http://checkout.rc.volt.io/{paymentId}?auth=jwtToken"
}
The response contains two attributes:
|
This is an identification of your payment request. |
checkoutUrl |
This url can be passed to your client. It will start the actual payment process and remain valid for 30 days. |
The status codes are exactly the same as in Request Payment. Please refer to this section: Request a Payment – Response
- On this page
- Generate payment link