Update Payment Link (Non-Financial)

Updates non-financial details of an existing payment link. This endpoint allows partial updates - only the fields provided in the request will be updated. Financial details (amounts) cannot be updated through this endpoint; use the financial-details endpoint instead.

Endpoint

PUT /api/v1/paymentLinks/{id}

Header Parameters

Parameter	Type	Required	Description
x-api-key	string	required	PaySuite provided API key
merchantId	string	required	Customer identifier as provided during customer onboarding
Content-Type	string	required	Must be application/json

Path Parameters

Parameter	Type	Required	Description
id	uuid	required	Unique identifier for the payment link

Request Parameters

All request parameters are optional for partial updates:

Parameter	Type	Required	Description
customer	object	optional	Customer information (see Customer object in POST endpoint)
description	string max(500)	optional	Payment link description
externalReference	string max(100)	optional	External reference identifier
externalUrl	string max(1000)	optional	URL to redirect after payment completion
dates	object	optional	Payment dates (see Dates object in POST endpoint)
metadata	object	optional	Additional metadata as key-value pairs

Response Parameters

Status Code: 200 OK

Returns the complete updated payment link object with the same structure as the POST /paymentLinks response.

Example Request

{
  "description": "Invoice #INV-2024-001 - Consulting Services (Updated)",
  "externalUrl": "https://example.com/invoices/INV-2024-001/updated",
  "dates": {
    "requestedDate": "2024-10-16T00:00:00Z",
    "dueDate": "2024-12-31T00:00:00Z",
    "linkExpiryDate": "2025-01-31T23:59:59Z"
  },
  "metadata": {
    "projectId": "PROJ-456",
    "department": "Professional Services",
    "updated": "true"
  }
}

Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "paymentLinkId": "PL-20241016153000-a1b2c3",
  "divisionAccountId": "6F2A9C31-8B45-4E0B-9C77-12AF34D9B201",
  "merchantId": "A91C4B87-3D0E-4B46-8E52-9BD4E57EAA98",
  "customer": {
    "id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
    "name": "John Smith",
    "email": "[email protected]",
    "phone": "+44 20 7946 0958",
    "address": {
      "line1": "123 High Street",
      "line2": "Apartment 4B",
      "city": "London",
      "state": "Greater London",
      "postalCode": "SW1A 1AA",
      "country": "GB"
    }
  },
  "description": "Invoice #INV-2024-001 - Consulting Services (Updated)",
  "externalReference": "INV-2024-001",
  "externalUrl": "https://example.com/invoices/INV-2024-001/updated",
  "amounts": {
    "currency": "GBP",
    "subtotal": 125000,
    "total": 125000
  },
  "dates": {
    "requestedDate": "2024-10-16T00:00:00Z",
    "dueDate": "2024-12-31T00:00:00Z",
    "linkExpiryDate": "2025-01-31T23:59:59Z"
  },
  "currencyCode": "GBP",
  "statusCode": "created",
  "statusChangedAt": "2024-10-16T15:30:00Z",
  "paymentLinkUrl": "https://group.pay.accessacloud.com/pay/550e8400-e29b-41d4-a716-446655440000",
  "paidAmount": 0,
  "lastAccessedAt": null,
  "accessCount": 0,
  "items": [
    {
      "id": "9b2e7c14-4f1a-4d3b-8a21-6c0f5e2d1a77",
      "description": "Consulting Services - October 2024",
      "quantity": 10,
      "unitPrice": 12500,
      "amount": 125000,
      "offlinePaidAmount": 0
    }
  ],
  "metadata": {
    "projectId": "PROJ-456",
    "department": "Professional Services",
    "updated": "true"
  },
  "createdAt": "2024-10-16T15:30:00Z",
  "updatedAt": "2024-10-16T16:45:00Z",
  "createdBy": "api-key-user",
  "updatedBy": "api-key-user",
  "version": 1
}

Status Code: 400 Bad Request

Returned when the request validation fails.

Status Code: 404 Not Found

Returned when no payment link is found for the given id.

Important Notes

• Only payment links with status created can be updated
• Financial details (amounts, items) cannot be updated through this endpoint; use the Update Financial Details endpoint instead
• Non-financial updates are logged in the payment link's history for audit purposes