Skip to login Skip to content
Developer Cybersource Logo

Getting started

Find tailored resources to kickstart your integration

API Reference

Use our live console to test and start building with our APIs

 

Accept payments

Online or In-person payment acceptance made easy

Technology partners

Register to get onboard our sandbox environment as a Tech partner or explore our pre-built integrations

Resources

Create seamless scalable payment experiences with interactive tools and detailed documentation

Documentation hub

Explore developer guides and best practices for integration with our platform

SDKs

Get pre-built samples to build or customize your integrations to fit your business needs

Demo hub

Access to variety of our product demos 

Testing

Signup for sandbox and use testing resources before going live

Sandbox signup

Create a sandbox to test our APIs

 

Testing guide

Guide with sandbox testing instructions and processor specific testing trigger data

Response codes

Understand all different error codes that REST API responds with

Support

Find resources and guidance to build, test, and deploy on our platform

Frequently asked questions

Find answers to commonly-asked questions about our APIs and platform

Contact us

Connect with our team of experts to troubleshoot or go-live to Production

Developer community

Connect and share with community of developers 

 

AI Assistant

Menu
  • Recent Revisions to This Document
  • About This Guide
  • VISA Platform Connect: Specifications and Conditions for Resellers/Partners
  • Boarding Registration
    • Requirements
    • Understanding Accounts and Organizations
    • Understanding Organization IDs
  • Product Templates
    • Adding Templates
  • Creating Organizations
    • Creating a Merchant Account
    • Adding a Transacting Organization to an Existing Organization
  • Using the Business Center to Search for Organizations
    • Search Results
    • Sorting and Filtering Search Results
    • Viewing an Organization's Hierarchy
  • Managing Organization Information Using the Business Center
    • Viewing and Editing an Organization's Business Details Using the Business Center
    • Viewing and Editing an Organization's Processor Details Using the Business Center
  • Updating an Organization's Products Using the Business Center
    • Adding a Product to an Organization Using the Business Center
    • Modifying a Product for an Organization Using the Business Center
    • Removing a Product from an Organization Using the Business Center
  • Updating an Organization's Information Using the API
    • Required Fields for Updating an Organization's Information
    • Requesting the Update Using the API
    • Example: Updating an Organization's Information Using the API
  • Product Enablement and Configuration Using the PECS API
    • Adding a New Product to an Existing Organization Using the API
    • Updating Batch Group Using the PECS API
    • Adding a Processor Using the PECS API
    • Deleting a Processor Using the PECS API
  • Using the Business Center to Change an Organization's Status
  • Switching Merchants
  • Sending a Registration Email
  • Using the API to Retrieve a List of Organizations
    • Retrieving a List of Organizations
    • Using Query Parameters to Filter Results
    • Example: Retrieving a List of Organizations Using the API
  • Using the API to Retrieve the Details of an Organization
    • Required Fields for Retrieving the Details of an Organization
    • Retrieving the Details of One Organization
    • Example: Retrieving an Organization
  • Extending the Hierarchy
    • Hierarchy Example
    • Adding a Structural Organization to a Merchant Organization
  • Product Boarding Template Reference
    • Account Updater Templates
    • Card Processing Templates
    • Customer Invoicing
    • ACH Templates
    • Fraud Management Essentials Templates
    • Gift Card Templates
    • Payer Authentication Templates
    • Pay By Link
    • Secure Acceptance Templates
    • Token Management Service Templates
    • Unified Checkout
    • Virtual Terminal Templates
  • Reason Codes
  • Supported Time Zones
REST API

Pay By Link

  • Recent Revisions to This Document
  • About This Guide
  • VISA Platform Connect: Specifications and Conditions for Resellers/Partners
  • Boarding Registration
    • Requirements
    • Understanding Accounts and Organizations
    • Understanding Organization IDs
  • Product Templates
    • Adding Templates
  • Creating Organizations
    • Creating a Merchant Account
      • Using the Business Center to Create a Merchant Account
        • Adding Merchant Account Information
        • Setting Up the Transacting Organization and Products
      • Using the API to Create a Merchant Account
        • Using the API to Create a Merchant Organization
          • Required Fields for Boarding a Merchant Organization
          • Creating a Merchant Account Using the API
          • Example: Creating a Merchant Organization Using the API
        • Using the API to Add a Transacting Organization to a New Merchant Organization
          • Required Fields for Adding a Transacting Organization to an Existing Organization
          • Adding a Transacting Organization to an New Merchant Organization Using the API
          • Example: Creating a Transacting Organization Using the API
    • Adding a Transacting Organization to an Existing Organization
      • Using the Business Center to Add an Additional Transacting Organization to an Existing Merchant Organization
        • Configuring the Transacting Organization and Products
      • Using the API to Add a Transacting Organization to an Existing Organization
        • Required Fields for Adding a Transacting Organization to an Existing Organization
        • Adding a Transacting Organization to an Existing Organization Using the API
        • Example: Creating a Transacting Organization Using the API
  • Using the Business Center to Search for Organizations
    • Search Results
    • Sorting and Filtering Search Results
    • Viewing an Organization's Hierarchy
  • Managing Organization Information Using the Business Center
    • Viewing and Editing an Organization's Business Details Using the Business Center
    • Viewing and Editing an Organization's Processor Details Using the Business Center
  • Updating an Organization's Products Using the Business Center
    • Adding a Product to an Organization Using the Business Center
    • Modifying a Product for an Organization Using the Business Center
    • Removing a Product from an Organization Using the Business Center
  • Updating an Organization's Information Using the API
    • Required Fields for Updating an Organization's Information
    • Requesting the Update Using the API
    • Example: Updating an Organization's Information Using the API
  • Product Enablement and Configuration Using the PECS API
    • Adding a New Product to an Existing Organization Using the API
      • Required Fields for Adding a New Products
      • Example: Adding a New Product to an Existing Organization Using the PECS API
    • Updating Batch Group Using the PECS API
      • Required Fields for Updating a Batch Group Using the PECS API
      • Example: Updating a Batch Group Using the API
    • Adding a Processor Using the PECS API
      • Required Fields for Adding a Processor Using the PECS API
      • Example: Adding a Processor Using the PECS API
    • Deleting a Processor Using the PECS API
      • Required Fields for Deleting a Processor Using the PECS API
      • Example: Deleting a Processor Using the PECS API
  • Using the Business Center to Change an Organization's Status
  • Switching Merchants
  • Sending a Registration Email
  • Using the API to Retrieve a List of Organizations
    • Retrieving a List of Organizations
    • Using Query Parameters to Filter Results
    • Example: Retrieving a List of Organizations Using the API
  • Using the API to Retrieve the Details of an Organization
    • Required Fields for Retrieving the Details of an Organization
    • Retrieving the Details of One Organization
    • Example: Retrieving an Organization
  • Extending the Hierarchy
    • Hierarchy Example
    • Adding a Structural Organization to a Merchant Organization
      • Using the Business Center to Add a Structural Organization to an Existing Merchant
        • Adding the Structural Organization
        • Creating a Transacting Organization and Products
      • Using the API to Add a Structural Organization to a Merchant Organization
        • Required Fields for Boarding a Structural Organization
        • Creating a Structural Organization Using the API
        • Example: Creating a Structural Organization Using the API
  • Product Boarding Template Reference
    • Account Updater Templates
    • Card Processing Templates
      • Configuring a Card Processing Template
      • Processor-Specific Fields
    • Customer Invoicing
    • ACH Templates
    • Fraud Management Essentials Templates
    • Gift Card Templates
    • Payer Authentication Templates
    • Pay By Link
    • Secure Acceptance Templates
    • Token Management Service Templates
    • Unified Checkout
    • Virtual Terminal Templates
  • Reason Codes
  • Supported Time Zones
On This Page
Pay by Link
provides merchants an easy and fast way to sell products or accept donations without any coding.

Prerequisites

Unified Checkout
must be enabled for the merchant. Before
Unified Checkout
can be enabled for a merchant, it must be enabled at the portfolio level.
When you attempt to enable
Pay by Link
without enabling
Unified Checkout
, the boarding calls will fail with the error
<>
.
To enable
Unified Checkout
at the portfolio level, talk to your sales representative.
Pay by Link
must be enabled at the portfolio level before in can be added to merchant accounts. To enable at
Pay by Link
the portfolio level, contact your sales representative.

Enabling
Pay by Link
on the Business Center

Before you can add
Pay by Link
, Unified Checkout must be added to the merchant account. To add Unified Checkout, see: Unified Checkout.
  1. Navigate to the Merchant Details Page within Portfolio Management.
  2. Click the
    Add products
    button.
  3. Select
    Pay by Link
    , and click the
    Add
    button.
Pay by Link
should appear on the Merchant's product list.

Enabling
Pay by Link
with the REST API

To enable
Unified Checkout
:
Set the
productInformation.selectedProducts.payments.payByLink.subscriptionInformation.enabled
field to
yes
When enabling both
Pay by Link
and
Unified Checkout
at the same time, you can include both products in the same request.

REST Example: Enabling
Pay by Link

Production Endpoint:
POST
https://api.cybersource.com
/boarding/v1/registrations
Test Endpoint:
POST
https://apitest.cybersource.com
/boarding/v1/registrations
{ "productInformation":{ "selectedProducts":{ "payments":{ "unifiedCheckout":{ "subscriptionInformation":{ "enabled":"true" } }, "payByLink":{ "subscriptionInformation":{ "enabled":"true" } } } } } }
Back to top

Visa

Cybersource.com

Terms + conditions

Cookie policy

Privacy notice

Your privacy rights

© 2024 Cybersource. All rights reserved. All brand names and logos are the property of their respective owners, are used for identification purposes only, and do not imply product endorsement or affiliation with Cybersource.