On This Page
REST API
Pay By Link
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
Pay by Link
on the Business CenterBefore you can add
Pay by Link
, Unified Checkout must be added to the merchant account. To add Unified Checkout, see: Unified Checkout.- Navigate to the Merchant Details Page within Portfolio Management.
- Click theAdd productsbutton.
- Select, and click thePay by LinkAddbutton.
Pay by Link
should appear on the Merchant's product list.Enabling Pay by Link with the REST API
Pay by Link
with the REST APITo 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
Pay by Link
Production Endpoint:
POST
https://api.cybersource.com
/boarding/v1/registrationsTest Endpoint:
POST
https://apitest.cybersource.com
/boarding/v1/registrations{ "productInformation":{ "selectedProducts":{ "payments":{ "unifiedCheckout":{ "subscriptionInformation":{ "enabled":"true" } }, "payByLink":{ "subscriptionInformation":{ "enabled":"true" } } } } } }