--- title: PayByLink via Judopay Portal slug: paybylink-via-judopay-portal docTags: createdAt: 2025-03-14T15:47:02.299Z --- 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. 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: ::Image[]{src="https://api.archbee.com/api/optimize/O_JUvBuqRy8kfJt7vTm8V-OdZxIG2AgsXIGziR2pjp6-20250818-102912.png" size="70" width="487" height="183" position="center" alt="paybylink qr code" darkWidth="487" darkHeight="183" showCaption="false"} 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 also add your logo to the payment page, to provide a seamless payment journey for your consumer. Contact [customer support](mailto\:help@judopay.com) to arrange for your logo to be added. :::hint{type="info"} You can generate as many PayByLink payments as you need. Each generated link can only be used to take a **single **payment. ::: You can create a link via the: - [Create PayByLink via API](docId:44rRmA0kRzsQsVnri7Qbw) - [PayByLink via Judopay Portal](docId\:FR-wtitYYgtkcxLuDdma8) *** ## 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 - Filter and view a **list **of all your PayByLink links - Check the payment **status **of a link **To create a new PayByLink payment**: ::Image[]{src="https://api.archbee.com/api/optimize/QGXTyW3MgdNcMjdEa0v8r/J6uTtU87fc_NNKDSxnsC--20260511-092559.png" size="70" width="692" height="844" position="center" alt="create link via portal" darkWidth="692" darkHeight="844" showCaption="false"} :::::WorkflowBlock :::WorkflowBlockItem From the side menu, select **PayByLink**. ::: :::WorkflowBlockItem All existing PayByLink transactions for your account are displayed by the `judoId` used to create the payment link. Displaying: - Your Payment Reference - Expiry Date - Amount - Status Click the **Create Link** button. ::: ::::WorkflowBlockItem The Create a Link form appears. Enter the following details: - **Location** Required**** If you have access to more than one `judoId`, you will see a Location drop down list made up of the **JudoId + truncated Trading Name**. Select the location based on the JudoId. From the selected JudoId, the form will automatically update: \- Currency depending on enabled ECOM routes. \- Extra fields if MCC = 6012 / 6051 / 7299. - **Consumer Reference** Required :::Paragraph{indent="1"} A unique reference to anonymously identify the consumer. ::: - **Payment Reference** Required :::Paragraph{indent="1"} 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 :::Paragraph{indent="1"} The amount to process. Format: Two decimal places. **If you are looking to process currencies that use a different structure than two decimal places, please contact Judopay for support.** ::: - **Currency** Required :::Paragraph{indent="1"} Identifies the currency of the transaction. Please contact Judopay if you need additional currencies for your transaction. ::: - **Expiry Date** Required :::Paragraph{indent="1"} The expiry date of the PayByLink payment Format: DD/MM/YYYY Must be in the future, and within a year. ::: :::: :::WorkflowBlockItem Click the **Create **button. ::: :::WorkflowBlockItem The **Success **screen appears. ::: :::WorkflowBlockItem Click on either the: - **Copy the link to the clipboard**: The link can now be shared with the consumer. The consumer will be directed to the payment screen, to enter their card details. - **Download QR Code**: Add the QR code to any printed materials. The code will link to the payment link. ::: ::::: *** ### Filter and View your PayByLink List From the Judopay Portal, you can: - View a **list **of all your PayByLink links - **Filter **the list by: - Location (judoId) - PayByLink status ::Image[]{src="https://api.archbee.com/api/optimize/QGXTyW3MgdNcMjdEa0v8r/vHIopgyCLACgf8V1cdyUZ-20260511-132912.png" size="80" width="909" height="1000" position="center" alt="view and filter paybylink list" darkWidth="909" darkHeight="1000" showCaption="false"} ::::WorkflowBlock :::WorkflowBlockItem From the side menu, select **PayByLink**. All existing PayByLink transactions for your account are listed. Displaying: - Your Payment Reference - Expiry Date - Amount - Status ::: :::WorkflowBlockItem Select the **Filter **button ::: :::WorkflowBlockItem You have the option to filter by Location (judoId), or PayByLink status. **Location Dropdown** If you have access to more than one `judoId`, you will see a Location drop down list made up of the **JudoId + truncated Trading Name**. Filter the location based on the JudoId. **** **PayByLink Status** Options: - All Statuses - Active - Paid - Expired - Cancelled ::: :::WorkflowBlockItem All PayByLink links are filtered and displayed using the Location or PayByLink status. For the purpose of this exercise, the list is filtered using the PayByLink status **Paid**. ::: :::: :::hint{type="warning"} The **Expiry Date** column is hidden when the PayByLink list is viewed within a small screen. ::: ::Image[]{src="https://api.archbee.com/api/optimize/O_JUvBuqRy8kfJt7vTm8V-Z5y4SOoH_2N5srZDQtrK--20250818-143321.png" size="20" width="244" height="500" position="flex-start" alt="pay by link small screen view" darkWidth="244" darkHeight="500" showCaption="false"} *** ## Account Funding Transactions :::hint{type="info"} If your account is **not **configured for AFT, the PaybyLink flow remains unchanged. ::: Account Funding Transactions (AFT) are **required **for merchants operating in specific **money movement and financial services categories**, as defined by card schemes. For these merchants, additional data **must be** included in payment requests to ensure transactions are processed in line with scheme and acquirer requirements. Failure to provide the [required AFT fields](docId:5ol_pTSGBHVGKwJwD0gHg) may result in transactions being **declined, flagged, or subject to additional scrutiny**. :::hint{type="info"} AFT information is configured by the merchant when creating the payment link and is automatically applied during payment processing. ::: *** ### Important to Consider - AFT requirements apply only to merchants with supported MCCs. For more information, see ***[Applicable Merchants](docId:5ol_pTSGBHVGKwJwD0gHg).*** - These requirements are defined by the **card schemes and acquirers**, and apply across all supported gateways. - Missing or invalid AFT data may result in: - Transaction declines - Validation errors - Acquirer flags - To submit AFT data, merchants **must **upgrade to Judopay's **Transaction** **API** **Version** **6.25 **or higher. - For more information, see [Transaction API](https://docs.judopay.com/api-reference/api-reference). *** ### Creating a PayByLink with AFT Data The **Account Funding Information** section is displayed **only **for merchants configured with supported MCCs. For more information, see [Applicable Merchants.](docId:5ol_pTSGBHVGKwJwD0gHg) :::hint{type="info"} If your account is **not **configured for AFT, this section will not appear and the PaybyLink flow remains unchanged. ::: ![aft paybylink](https://api.archbee.com/api/optimize/QGXTyW3MgdNcMjdEa0v8r/eMabD79hxX2458R9NG1uf-20260514-134305.png) **From the Judopay Portal**: :::::WorkflowBlock :::WorkflowBlockItem From the side menu, select **PayByLink**. ::: :::WorkflowBlockItem All existing PayByLink transactions for your account are displayed by the `judoId` used to create the payment link. Displaying: - Your Payment Reference - Expiry Date - Amount - Status Click the **Create Link** button. ::: ::::WorkflowBlockItem The **Create a Link** form appears. *The **AFT Recipient Information Section **is also displayed for merchants configured with supported MCCs.* Enter the following details: - **Location** Required**** If you have access to more than one `judoId`, you will see a Location drop down list made up of the **JudoId + truncated Trading Name**. Select the location based on the JudoId. From the selected JudoId, the form will automatically update: \- Currency depending on enabled ECOM routes. \- Extra fields if MCC = 6012 / 6051 / 7299. - **Consumer Reference** Required :::Paragraph{indent="1"} A unique reference to anonymously identify the consumer. ::: - **Payment Reference** Required :::Paragraph{indent="1"} 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 :::Paragraph{indent="1"} The amount to process. Format: Two decimal places. **If you are looking to process currencies that use a different structure than two decimal places, please contact Judopay for support.** ::: - **Currency** Required :::Paragraph{indent="1"} Identifies the currency of the transaction. Please contact Judopay if you need additional currencies for your transaction. ::: - **Expiry Date** Required :::Paragraph{indent="1"} The expiry date of the PayByLink payment Format: DD/MM/YYYY Must be in the future, and within a year. ::: :::: :::WorkflowBlockItem **AFT Recipient Information Section.** Enter the following details: - **First Name** Recipient's first name. - **Address Line 1** Recipient's address. - **Country Code** Recipient's country Format: ISO alpha-2. - **State** Required only for US & Canada - **Account ID** Recipient's account identifier. - **Business Application ID** Indicates the purpose of the transaction.**** Select from the following values:** ** - AA – Account to account - FD – Funds disbursement - FT – Funds transfer - PD – Payroll - TU – Top up - WT – Digital wallet - **Account Type** Indicates the recipient's account type.**** Select from the following values: - 00 - Other - 01 - TRN & BAN - 02 - IBAN - 03 - Card (first6 & last4) - 06 - BAN & BIC (SWIFT code) ::: :::WorkflowBlockItem Click the **Create **button. ::: :::WorkflowBlockItem The **Success **screen appears. Click on either the: - **Copy the link to the clipboard**: The link can now be shared with the consumer. The consumer will firstly be directed to the new Billing Information screen required for the additional recipient information, and lastly the payment screen, to enter their card details. - **Download QR Code**: Add the QR code to any printed materials. The code will link to the payment link. ::: ::::: If you are unsure which Business Application ID or Account Type values should be used for your transaction, **contact your acquirer**. *** ### Validation Rules For any missing or invalid information **inline validation messages** will be displayed. If only **partial **AFT fields have been populated, validation rules will prevent the creation of the payment link. :::hint{type="warning"} If none of the AFT fields are completed, the PaybyLink flow remains **unchanged**. If **any **AFT field is populated: - **All **required AFT fields **must **also be completed. - **Partial **AFT field submissions are **not **supported. - Business Application ID and Account Type must be valid supported values. - Some Business Application ID and Account Type combinations may not be allowed. Your acquirer is responsible for confirming the appropriate configuration for your transaction scenarios. **Partial submissions are not allowed**. ::: *For the purpose of this exercise, the ****Address Line 1**** field has been partially completed, leaving the remaining AFT fields empty, which will cause a validation error:* ::Image[]{src="https://api.archbee.com/api/optimize/QGXTyW3MgdNcMjdEa0v8r/8nujkASNh8EpOaIqQKY1N-20260511-092349.png" size="60" width="667" height="373" position="center" alt="pbl validation rules" darkWidth="667" darkHeight="373" showCaption="false"}