Skip to main content
POST
Apply a check deposit to a payment link

Authorizations

Authorization
string
header
required

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

Path Parameters

checkDepositId
string
required

The deposit's id from List check deposits or Deposit a check.

Body

application/json

The payment link the check pays.

Example:

"cmq7ab3cd000gsf02e5f6g7h8"

amountCents
integer<int64>

Cents to apply. Defaults to the smaller of the deposit's unappliedAmountCents and what the payment link has left to pay.

Required range: x >= 1
Example:

100000

externalReferenceId
string

Your own id for this application. A repeat with the same id on the same payment link returns the existing application instead of applying the deposit again, and one that differs from it (another amount, another deposit, or money received outside Nickel) is a 409. Voiding the application frees the id.

Maximum string length: 255
Example:

"apply_8f3a2c"

Response

The application and the re-derived payment link

externalPayment
object
required