PayByLink

PayByLink is an easy way to request and accept payments. Just add the link to your emails, SMS, or invoices that you send out to your consumers. You do not need to have a website or a mobile app to be able to use PayByLink.

3D Secure is built-in, ensuring any card payments meets the Strong Customer Authentication (SCA) compliance requirement.

You can also add your logo to the payment page, to provide a seamless payment journey for your consumer. Contact customer support to arrange for your logo to be added.

Note

You can generate as many PayByLink payments as you need. Each generated link can only be used to take a single payment.

You can also generate a QR code linking to the payment link. Download the QR code and add the QR Code image to any printed materials:

The consumer clicks on the link, and is re-directed to the payment page hosted by Judopay. This means you do not require any integration, and also reduces your PCI scope.

Once the payment is complete, a message is presented to the consumer to let them know the transaction status. You can choose to set a success or failure URL for the consumer to be redirected to.

You can create a link via the:

Create PayByLink via API

Create a payment link:

Add the link to your emails, SMS, or invoices sent to your consumers.

Caution

Check your API key is 3D Secure enabled. For any queries, please contact customer support.

Target endpoint:

https://api-sandbox.judopay.com/webpayments/payments

HTTP Method: POST

Request Parameters:

Parameter	Description
`judoId` String Required	Unique ID supplied by Judopay. Specific to a merchant and/or location. Format: 100100100 Maximum length 9 characters. Do not include spaces or dashes.
`amount` Decimal Required	The amount to process. Format: Two decimal places For currencies using a different structure please contact Judopay for support.
`currency` String Required	The currency of the transaction. Any ISO 4217 alphabetic currency code: GBP USD EUR
`yourConsumerReference` String Required	Unique reference to anonymously identify your customer. Advisable to use GUIDs. Must be below 40 characters.
`yourPaymentReference` String Required	Your unique reference for this payment. Format: Maximum length 50 characters. This value should be unique in order to protect your customers against duplicate transactions. With a server side integration, if a payment reference is not supplied, the transaction will not be processed.
`expiryDate` String Optional	The expiry date of the PayByLink payment. Format: YYYYY-MM-DD Must be in the future and within a year. The payment link will be valid for half an hour if a date is not specified.
`isPayByLink` Boolean Optional	To distinguish between web payments and PayByLink transactions. Set to: true for a PayByLink transaction to display in the PayByLink section of the Judopay Portal.

Parameter

Description

judoId

String

Required

Unique ID supplied by Judopay.

Specific to a merchant and/or location.

Format:

100100100
Maximum length 9 characters.
Do not include spaces or dashes.

amount

Decimal

Required

The amount to process.

Format:

Two decimal places

For currencies using a different structure please contact Judopay for support.

currency

String

Required

The currency of the transaction.

Any ISO 4217 alphabetic currency code:

yourConsumerReference

String

Required

Unique reference to anonymously identify your customer.

Advisable to use GUIDs.

Must be below 40 characters.

yourPaymentReference

String

Required

Your unique reference for this payment.

Format:

Maximum length 50 characters.

This value should be unique in order to protect your customers against duplicate transactions.

With a server side integration, if a payment reference is not supplied, the transaction will not be processed.

expiryDate

String

Optional

The expiry date of the PayByLink payment.

Format:

YYYYY-MM-DD
Must be in the future and within a year.

The payment link will be valid for half an hour if a date is not specified.

isPayByLink

Boolean

Optional

To distinguish between web payments and PayByLink transactions.

Set to: true for a PayByLink transaction to display in the PayByLink section of the Judopay Portal.

Response Model

PayByLink

Parameter	Description
`payByLinkUrl` String	The short URL of the PayByLink payment form.
`postUrl` String	The root URL of the payment link.
`reference` String	Unique identifier of the payment. This can be used to query payment details.

Parameter

Description

payByLinkUrl

String

The short URL of the PayByLink payment form.

postUrl

String

The root URL of the payment link.

reference

String

Unique identifier of the payment.

This can be used to query payment details.

Create PayByLink via the Judopay Portal

From the Judopay Portal you can:

Create a PayByLink payment
Generate a QR code that links to the payment link
View a list of all your PayByLink links
Check the payment status of a link

To create a new PayByLink payment:

Step	Description
	From the side menu, select PayByLink.
	All existing PayByLink transactions for your account are listed. Displaying: Your Payment Reference Expiry Date Amount Status Click the Create Link button.
	The Create a Link form appears. Enter the following details: Consumer Reference Required A unique reference to anonymously identify the consumer. Payment Reference Required Your reference for this PayByLink transaction. This value should be unique in order to protect your consumers against duplicate transactions. Consumer Name Optional The name of the consumer for whom you are creating the PayByLink transaction. Consumer Email Optional The email address of the consumer for whom you are creating the PayByLink transaction. Amount Required The amount to process. Format: Two decimal places. Please note: If you are looking to process currencies that use a different structure than two decimal places, please contact Judopay for support. Currency Required Identifies the currency of the transaction. Please contact Judopay if you need additional currencies for your transaction. Expiry Date Required The expiry date of the PayByLink payment Format: DD/MM/YYYY Must be in the future, and within a year.
	Click the Create button.
	The Success screen appears.
	Click on either the: Copy the link to the clipboard: The link can now be shared with the consumer. Download QR Code: Add the QR code to any printed materials. The code will link to the payment link. To create a new link, click the Create another link button. The Create a Link form will appear.