What is Pay-by-link
Pay-by-Link is a secure, customizable payment link that enables merchants to generate a unique URL for their customers to complete transactions effortlessly selecting desired payment method. This flexible tool bridges online and offline transactions, providing a versatile way to accept payments independent on consumer's device or environment.
KEy benefits
Flexibility: Generate personalized payment URLs easily for different scenarios.
Security: Ensures data protection and compliance with security standards.
Enhanced Customer Experience: Simplifies the payment process with direct, branded links.
Multi-Channel Acceptance: Use online emails, SMS, QR codes, or in-person print media.
Real-Time Tracking: Monitor payment status and manage transactions efficiently.
Support for Multiple Payment Methods: Accommodates various customer preferences.
Dynamic Data Collection: Users are asked inside payment page for the mandatory data needed to complete the process.
Supported payment methods
PAYONE link currently supports 3 payment methods and currently we are adding much more.
Supported:
Under implementation:
How it works
Link generation is full entangled with Commerce Platform business and domain model. The concept provides you a great flexibility in how a payment for a checkout / order can be completed by the user:
- either link is opened as a standard Commerce checkout page on user's PC ,
- either the link is sent to consumer's portable device via email or SMS,
- or the link is converted into a QR code and presented in-store at the checkout on a Tablet, Android Device or cashier screen
Step 1: Create Commerce case and Checkout with order
A Commerce Case and a Checkout are created together with a single API call . This will contain all necessary information about the customer and products ordered.
No worries if not all the consumer data is available by the time link is created, mandatory information will be asked directly during payment process
POST Commerce Case
POST/v1/{merchantId}/commerce-cases
|
Step 2: Process response
From the API response, you will need the :
- Commerce Case ,
- Checkout and
- Option: Items IDs ( in case is a partial shopping cart payment request )
and with those, you will be using them to generate the Payment Link API call in addition to other parameters briefly explained below.
|
Step 3: payment link generation request
Pay-By-Link gives you a lot of flexibility regarding user handling, data display and the overall behavior towards user payment acceptance and process.
| Parameter | Meaning |
|---|---|
| expirationDate | By default, Links are valid 24 h if this parameter is not used. You can define the link validity by specifying the date by the time this should be active : YYYY-MM-DD'T'HH:mm:ss |
| authorizationMode | Defines the type of process you want to enable with the payment. Either a funds Reservation and later when goods are delivered a Capture is expected or you decide to do immediately a complete process by triggering a Sale. |
| paymentMethods | You define what Payment Methods should be presented to the user based on available ones for your business. |
| returnUrl | If this is populated by you, then after order is completed, the customer will be sent back to you and not land on our confirmation page. In case is not sent, then we will present by default a Success or Failed page and user would close it at the end. No worries, in all the cases, you will receive a Webhook notification for each payment transaction. |
| termsUrl | URL to your Terms and Conditions which the consumer needs to read and by continuing the payment process , he implicitly agree. |
| logoUrl | Your URL from where your company's logo is being displayed inside Payment Link page. Please make sure this is publicly available. |
| autoRedirection | With boolean values, it allows you to define if a user Is to be returned to your website ( conditioned by returnUrl presence ) via a button , that user actively comes back to you OR implicit when transaction is finished. In Short we are asking to know if the user should come to you via our Confirmation Page or he is expected to get the payment result from your website. |
| orderType | You have the chance to define if the Payment is for complete Shopping cart or for partial. If partial then you would need to pass in items field, the ids previously received form us for the items expected to be paid with this link. |
| orderReferences | Contains mandatory merchantReference field which will be used inside the Webhook message so you could be updated about transaction status |
| retryNumber | Defines the maximum number of payment attempts allowed with this payment link. This is required in order to prevent fraudulent link misusage for payment method testing. |
POST Pay By Link
POST/v1/${mid}/commerce-cases/${commerceCaseId}/checkouts/${checkoutId}/pay-by-link
|
and the response contains the needed information to continue as a redirectionUrl ( the actual endpoint where consumer needs to be sent to ) and paymentLinkId for any GET requests later on if needed.
|