Skip to main content
PUT
Update an existing payment link

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

ID of paymentLink to return

Body

application/json

Update an existing payment link

requestedAmountCents
integer<int64>
Example:

12055

name
string
Example:

"INV-123"

dueDate
string<date>
feePassthroughPercent
integer | null

Percent (0-100) of the card processing fee passed through to the payer for this payment link. Set to null to clear the per-link override so the link inherits the customer/organization setting. Omit to leave unchanged.

Required range: 0 <= x <= 100
Example:

100

creditCardEnabled
boolean

Whether the payer can pay this link by credit card. Set to false to disable card payments for this link. Omit to leave unchanged.

Example:

true

achEnabled
boolean

Whether the payer can pay this link by ACH/bank transfer. Set to false to disable ACH payments for this link. Omit to leave unchanged.

Example:

true

amountEditable
boolean

Whether the payer can edit the payment amount at checkout. Omit to leave unchanged.

Example:

false

Response

Successful operation

id
string
required
Example:

"clkqzo2y1000cx9tfohoiodq1"

requestedAmountCents
integer<int64>
required
Example:

12055

name
string
required
Example:

"INV-123"

status
string
required
Example:

"ACTIVE"

payments
object[]
required
externalPayments
object[]
required

Live payments recorded against this link outside Nickel (a mailed check, cash). Voided records are omitted. They count toward completedAmountCents alongside payments.

url
string<uri>
required
Example:

"https://nickel.nickelpayments.com/pay/Ahndhz"

completedAmountCents
integer<int64>
required
dueDate
string<date> | null
customerId
string

ID of the customer the payment link belongs to. Omitted for links created in the dashboard without a customer.

feePassthroughPercent
integer | null

Percent (0-100) of the card processing fee passed through to the payer for this payment link. null means no per-link override (the customer/organization setting applies).

Example:

100

creditCardEnabled
boolean | null

Whether the payer can pay this link by credit card. null means no per-link override (the organization setting applies).

Example:

true

achEnabled
boolean | null

Whether the payer can pay this link by ACH/bank transfer. null means no per-link override (the organization setting applies).

Example:

true

amountEditable
boolean

Whether the payer can edit the payment amount at checkout.

Example:

false