Update Payment Link

Authorizations

requestToken

string

header

required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

payLinkId

string

required

ID for the payment link.

Body

contactUs

object

ContactUs section of payment link page

contactUs.emailLabel

string | null

Custom content for email

contactUs.enabled

boolean

Toggles whether the section or element is enabled.

contactUs.header

string | null

Header text for section

contactUs.order

integer | null

Order of element or section in container.

Required range: x > 0

contactUs.paymentIcons

boolean

Flag indicating if icons for accepted card brands will be shown

contactUs.phoneLabel

string | null

Custom content for phone number

logo

object

Logo section of payment link page

logo.enabled

boolean

Toggles whether the section or element is enabled.

logo.order

integer | null

Order of element or section in container.

Required range: x > 0

messageBeforePaying

object

Message section of payment link page

messageBeforePaying.enabled

boolean

Toggles whether the section or element is enabled.

messageBeforePaying.label

string | null

Label to display for section or element

messageBeforePaying.order

integer | null

Order of element or section in container.

Required range: x > 0

notes

object

Notes section of payment link page

notes.enabled

boolean

Toggles whether the section or element is enabled.

notes.header

string | null

Header text for section

notes.order

integer | null

Order of element or section in container.

Required range: x > 0

notes.placeholder

string | null

Placeholder text for input field

notes.value

string | null

Pre-populated value for input field

page

object

Page header section of payment link page

page.description

string | null

Page description in header

page.enabled

boolean

Toggles whether the section or element is enabled.

page.header

string | null

Page header

page.order

integer | null

Order of element or section in container.

Required range: x > 0

paymentButton

object

Payment button section of payment link page

paymentButton.enabled

boolean

Toggles whether the section or element is enabled.

paymentButton.label

string | null

Label to display for section or element

paymentButton.order

integer | null

Order of element or section in container.

Required range: x > 0

paymentMethods

object

Payment methods section of payment link page

paymentMethods.allMethodsChecked

boolean

Flag indicating if all allowed payment methods will be pre-selected.

paymentMethods.enabled

boolean

Toggles whether the section or element is enabled.

paymentMethods.header

string | null

Header text for section

paymentMethods.methods

object

paymentMethods.methods.amex

boolean

When true, American Express is accepted.

paymentMethods.methods.applePay

boolean

When true, Apple Pay is accepted.

paymentMethods.methods.discover

boolean

When true, Discover is accepted.

paymentMethods.methods.eCheck

boolean

When true, ACH is accepted.

paymentMethods.methods.mastercard

boolean

When true, Mastercard is accepted.

paymentMethods.methods.visa

boolean

When true, Visa is accepted.

paymentMethods.order

integer | null

Order of element or section in container.

Required range: x > 0

paymentMethods.settings

object

Settings for wallet payment methods.

paymentMethods.settings.applePay

object

paymentMethods.settings.applePay.buttonStyle

enum<string>

default:

black

The Apple Pay button style. See Apple Pay Button Style for more information.

Available options:

black,

white-outline,

white

paymentMethods.settings.applePay.buttonType

enum<string>

default:

pay

The text on Apple Pay button. See Apple Pay Button Type for more information.

Available options:

plain,

buy,

donate,

check-out,

book,

continue,

top-up,

order,

rent,

support,

contribute,

tip,

pay

paymentMethods.settings.applePay.language

enum<string>

default:

en-US

The Apple Pay button locale. See Apple Pay Button Language for more information.

Available options:

en-US,

ar-AB,

ca-ES,

zh-CN,

zh-HK,

zh-TW,

hr-HR,

cs-CZ,

da-DK,

de-DE,

nl-NL,

en-AU,

en-GB,

fi-FI,

fr-CA,

fr-FR,

el-GR,

he-IL,

hi-IN,

hu-HU,

id-ID,

it-IT,

ja-JP,

ko-KR,

ms-MY,

nb-NO,

pl-PL,

pt-BR,

pt-PT,

ro-RO,

ru-RU,

sk-SK,

es-MX,

es-ES,

sv-SE,

th-TH,

tr-TR,

uk-UA,

vi-VN

review

object

Review section of payment link page

review.enabled

boolean

Toggles whether the section or element is enabled.

review.header

string | null

Header text for section

review.order

integer | null

Order of element or section in container.

Required range: x > 0

settings

object

Settings section of payment link page

settings.color

string | null

An HTML color code in format #RRGGBB

settings.customCssUrl

string | null

Complete URL to a custom CSS file to be loaded with the page

settings.language

string | null

Two-letter code following ISO 639-1

settings.pageLogo

object

Object containing logo file to upload/ use in page

settings.pageLogo.fContent

string | null

Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB.

settings.pageLogo.filename

string | null

The name of the attached file.

settings.pageLogo.ftype

enum<string> | null

The MIME type of the file (if content is provided)

Available options:

pdf,

doc,

docx,

jpg,

jpeg,

png,

gif,

txt

settings.pageLogo.furl

string | null

Optional url provided to show or download the file remotely

settings.redirectAfterApprove

boolean

Flag indicating if the capability for redirection in the page will be activated

settings.redirectAfterApproveUrl

string | null

Complete URL where the page will be redirected after completion

Response

200 - application/json

isSuccess

boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseData

string

If isSuccess = true, this contains the payment link identifier. If isSuccess = false, this contains the reason of the error.

responseText

string | null

Response text for operation: 'Success' or 'Declined'.

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

Authorizations

Path Parameters

Body

Response