Skip to main content
PUT
/
paymentLink
/
{paymentLinkId}
Update an existing payment link.
curl --request PUT \
  --url https://virtserver.swaggerhub.com/nickel-ace/apiv1/1.0.0/paymentLink/{paymentLinkId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestedAmountCents": 12055,
  "name": "INV-123",
  "dueDate": "2023-12-25"
}
'
{
  "name": "INV-123",
  "customerId": "<string>",
  "id": "clkqzo2y1000cx9tfohoiodq1",
  "requestedAmountCents": 12055,
  "dueDate": "2023-12-25",
  "status": "ACTIVE",
  "payments": [
    {
      "id": "<string>",
      "status": "SUCCEEDED",
      "fees": [
        {
          "feeType": "Credit Card Fee",
          "amountCents": 290
        }
      ],
      "amountInCents": 10000,
      "chargedAmountInCents": 10290,
      "platformFeeInCents": 290,
      "paymentLinkId": "<string>",
      "paymentMethod": {
        "id": "<string>",
        "type": "ACH",
        "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>",
          "countryCode": "<string>"
        }
      },
      "disbursement": {
        "id": "<string>",
        "status": "PENDING",
        "amountInCents": 10000,
        "bankName": "JP Morgan Chase",
        "accountNumberLastFour": "<string>",
        "paymentIds": [
          "clkqzo2y1000cx9tfohoiodq1"
        ]
      },
      "refunds": [
        {
          "id": "<string>",
          "amountCents": 515,
          "refundDate": "2023-12-25",
          "void": true
        }
      ]
    }
  ],
  "url": "https://nickel.nickelpayments.com/pay/Ahndhz",
  "attachments": [
    {
      "id": "<string>",
      "url": "<string>"
    }
  ]
}

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>

Response

Successful operation

name
string
required
Example:

"INV-123"

customerId
string
required
id
string
Example:

"clkqzo2y1000cx9tfohoiodq1"

requestedAmountCents
integer<int64>
Example:

12055

dueDate
string<date>
status
string
Example:

"ACTIVE"

payments
object[]
url
string<uri>
Example:

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

attachments
object[]