Skip to main content
POST
/
paymentLink
Create a new payment link
curl --request POST \
  --url https://rest.staging.nickel.com/paymentLink \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "INV-123",
  "customerId": "<string>",
  "requestedAmountCents": 12055,
  "dueDate": "2023-12-25",
  "feePassthroughPercent": 100,
  "creditCardEnabled": true,
  "achEnabled": true,
  "amountEditable": false
}
'
{
  "id": "clkqzo2y1000cx9tfohoiodq1",
  "requestedAmountCents": 12055,
  "name": "INV-123",
  "status": "ACTIVE",
  "payments": [
    {
      "id": "<string>",
      "status": "SUCCEEDED",
      "fees": [
        {
          "type": "CREDIT_CARD_FEE",
          "amountInCents": 290
        }
      ],
      "amountInCents": 10000,
      "chargedAmountInCents": 10290,
      "platformFeeInCents": 290,
      "paymentLinkId": "<string>",
      "paymentMethod": {
        "id": "<string>",
        "achDetails": {
          "bankName": "JP Morgan Chase",
          "routingNumber": "<string>",
          "accountNumberLastFour": "<string>"
        },
        "cardDetails": {
          "brand": "visa",
          "last4": "<string>",
          "holderName": "<string>",
          "expMonth": "2",
          "expYear": "2030"
        },
        "billingDetails": {
          "name": "<string>",
          "companyName": "<string>",
          "street": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "email": "<string>"
        }
      },
      "disbursement": {
        "id": "<string>",
        "status": "PENDING",
        "amountInCents": 10000,
        "bankName": "JP Morgan Chase",
        "accountNumberLastFour": "<string>",
        "paymentIds": [
          "clkqzo2y1000cx9tfohoiodq1"
        ],
        "createdAt": "2023-12-25",
        "paidAt": "2023-12-25"
      },
      "refunds": [
        {
          "id": "<string>",
          "amountCents": 515,
          "refundDate": "2023-11-07T05:31:56Z",
          "voided": true
        }
      ],
      "createdAt": 123,
      "estimatedDisbursementDate": "<string>"
    }
  ],
  "url": "https://nickel.nickelpayments.com/pay/Ahndhz",
  "completedAmountCents": 123,
  "dueDate": "2023-12-25",
  "customerId": "<string>",
  "feePassthroughPercent": 100,
  "creditCardEnabled": true,
  "achEnabled": true,
  "amountEditable": false
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Create a new payment link

​
name
string
required
Example:

"INV-123"

​
customerId
string
required
​
requestedAmountCents
integer<int64>
Example:

12055

​
dueDate
string<date>
​
feePassthroughPercent
integer

Percent (0-100) of the card processing fee passed through to the payer for this payment link; the remainder is absorbed by your organization. Omit to inherit the customer/organization setting.

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 inherit the organization setting.

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 inherit the organization setting.

Example:

true

​
amountEditable
boolean

Whether the payer can edit the payment amount at checkout. Omit to inherit the organization default.

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
​
url
string<uri>
required
Example:

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

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

Present only when a customer is associated with the payment link. May be omitted from the response entirely.

​
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