WebsiteStatusSupportPostman workspacePricingDocumentation hub survey
Documentation
Sign up

Payment Links on the Dashboard

Suggest Edits

Activate Payment Links

📘

Only certain roles can activate Payment Links.

To use Payment Links, you must first activate the service:

  1. Log in to the Peach Payments Dashboard.
  2. In the left navigation menu, click Payment Links.
  3. Click Activate Payment Links.

This activates the Payment Links service and enables you to create payment links.

Create a payment link

📘

Only certain roles can create and cancel payment links.

Create and send payment links on the Dashboard as follows:

  1. In the left navigation menu, click Create payment link or click Payment Links > Create > Single payment link. The Create payment link window opens.

    Create payment link.

    Create payment link.

  2. Enter the payment link details, customer information, and advanced options, then click Create payment link.

  3. A summary page appears and the payment link is automatically sent to the recipient through the communication mode chosen.

Create bulk payment links

📘

Only certain roles can create bulk payment links.

The following video showcases how to create and send bulk payment links:

Create and send up to 1000 payment links on the Dashboard as follows:

  1. Click Payment Links > Create > Bulk payment links.
  2. In the Upload bulk file window that appears, click Download template.
  3. Unzip the samples.zip file, fill out the full_sample.csv file, deleting unnecessary parameters and not adding any of your own, then save it. Ensure that you adhere to the restrictions described in the Bulk payment links CSV parameters section.
  4. In the Upload bulk file window, click Choose file, select the filled out CSV, and click Open.
  5. In the Upload bulk file window, click Process.

A new section appears in the My links section highlighting the status of the bulk file.

🚧

If the status of the bulk payment file is Completed with errors, see the Payment Links FAQ for details on how to identify and resolve the errors.

View payment link status

View the status of payment links on Payment Links > My links.

Link status in Dashboard.

Link status in Dashboard.

To view the detailed link status, select a transaction. A details panel shows more information on the payment link.

Detailed link status.

Detailed link status.

Search for a payment link

Search for a payment link as follows:

  1. In the left navigation menu, click Payment Links > My links.
  2. Enter the partial customer name or invoice ID, or full payment link ID or bulk ID into the search bar. The search results appear as you type.

Filter payment links

Filter payment links by date, amount, status, or sending options as follows:

  1. In the left navigation menu, click Payment Links > My links.
  2. Click Today and select a predefined range, for example, Last 30 days. Otherwise, click the first date field and select the date from which you want to filter, then click the date to which you want to filter.
  3. Click Filters to expand the filter section.
  4. In the Amount section, select the appropriate option from the list, for example, Greater than. Enter the amount, for example, 1000 to filter transactions greater than 1000.
  5. In the Status section, select the appropriate statuses that you want to filter for, for example, Initiated and Processing.
  6. In the Sending options section, click More. Select the sending options that you want to filter for, for example, Email.
  7. Click Apply.

This applies the filters that you selected.

Click the Clear button to remove all the filters.

Filter bar.

Filter bar.

Cancel a payment link

📘

Only certain roles can cancel payment links.

Cancel a payment link that is in the initiated state on the Dashboard as follows:

  1. Go to Payment Links > My links.
  2. Click the payment link that you want to cancel.
  3. In the details panel that appears, click Cancel link in the upper right of the screen.
  4. In the confirmation window that appears, click Confirm.

The payment link's status changes to cancelled and customers cannot pay using the link.

Download payment links

You can download an export of up to 20 000 payment links from the Dashboard.

Export the payment links that you are viewing as follows:

  1. Go to Payment Links > My links.
  2. Select filters to display the payment links that you're interested in.
  3. Click the Download a CSV button in the upper right of the screen.

You device downloads the payment links CSV.

Payment Links settings

Edit payment link templates

📘

Only certain roles can edit payment link templates.

You can edit the email and SMS templates, but not the WhatsApp template.

  1. Go to the Payment Links Settings page.
  2. Scroll to the Email or SMS section.
  3. Edit the email, using the placeholder values where applicable.
  4. Click Save.

📘

If necessary, you can use the Revert to default buttons to return the templates to their original states.

Add a webhook

📘

Only certain roles can add a Payment Links webhook.

To learn more about webhooks, see the Webhooks section.

Configure a Payment Links webhook using the Dashboard as follows:

  1. Log in to the Peach Payments Dashboard.
  2. In the left navigation menu, click Payment Links.
  3. Select the Settings tab, scroll down to the Webhooks section, and click + Add webhook.
  4. Enter your webhook URL into the URL field and click Verify. Dashboard sends a verification code to your webhook URL.
  5. Enter the verification code into the Code field and click Verify.

The webhook URL is now verified and appears in the Webhooks section.

Create API credentials

📘

Only certain roles can create API credentials.

  1. Log in to the Peach Payments Dashboard.
  2. In the left navigation menu, click Payment Links.
  3. Select the Settings tab, scroll down to the API credentials section, and click + Create API credentials.

Your client ID, client secret, merchant ID, and entity ID appear in the API credentials section.

Payment Links API credentials.

Payment Links API credentials.

📘

Use the Refresh API credentials button to create new API credentials, for example, if someone compromised your credentials.

Add terms of service

You can make it mandatory that your customers have to agree to your terms of service before being able to pay payment links.

📘

Only certain roles can add and configure your terms of service.

Add and configure your terms of service for payment links on the Dashboard as follows:

  1. Log in to the Peach Payments Dashboard.
  2. In the left navigation menu, click Payment Links.
  3. Select the Settings tab, scroll down to the Legal policy section, and paste your terms of service in the Terms of service field, adhering to the 30 000 character count restriction.
  4. To make it mandatory that your customers have to agree to your terms of service before making payment, select the Require your customers to consent to your terms of service check box and click Save. Not selecting the check box displays the terms of service link to your customers but does not require that they accept them.

A link to your terms of service appears on the payment link page. If you made it mandatory, your customers now need to accept your terms of service before they can pay a payment link.

Updated 3 months ago