Payment Links API

The Payment Links API provides a comprehensive solution for creating and managing payment links within the Access PaySuite Group Payments platform. This API enables merchants to generate secure payment links that can be shared with customers via email, SMS, or other channels, supporting both one-time and recurring payment scenarios.

Base URL

Sandbox

https://group.pay.accessacloud.com/paylinks-payment-demo

Production

https://group.pay.accessacloud.com/paylinks-payment

Authentication

All API requests require authentication using an API key. This is provided to the SoftCo's during the registration. The subscription key must be supplied in the HTTP header of all API requests to identify and authorize your platform account.

x-api-key: {API_KEY}

Authorisation

All API requests require the following headers:

Header	Type	Required	Description
merchantId	string	required	Customer identifier as provided during customer onboarding
Content-Type	string	required	Must be application/json (for POST/PUT requests)

Endpoints

🗃Create Payment Link

1 item

🗃Create Payment Links (Batch)

1 item

🗃Update Payment Link

3 items

🗃Fetch all Payment Links

2 items

📄️Cancel Payment Link

Deletes (cancels) a payment link. This operation performs a soft delete, changing the payment link status to "Cancelled" rather than permanently removing it from the system. This preserves audit trails and payment history.

📄️Health Check

Check the health of the Payment Links API.

📄️Webhooks

Webhooks let your systems receive real-time notifications when a payment link's payment status

Error Handling

All endpoints return errors in a consistent format. When an error occurs, the API returns an appropriate HTTP status code along with an error response body.

Error Response Structure

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid parameters",
    "details": {
      "field": "amounts.total",
      "issue": "Total amount must be greater than 30."
    },
    "timestamp": "2024-10-16T15:30:00.0000000Z"
  }
}

Common Error Codes

Code	Description
VALIDATION_ERROR	The request contains invalid or missing parameters
NOT_FOUND	The requested resource does not exist
PAYMENT_LINK_NOT_FOUND	The requested payment link does not exist
PAYMENT_LINK_EXPIRED	The payment link has expired
UNAUTHORIZED	Authentication credentials are missing or invalid
FORBIDDEN	The caller is not authorized to act on the requested merchant or resource
CONFLICT	The operation conflicts with the current state of the resource (e.g. a reused idempotency key)
BUSINESS_ERROR	A business rule prevented the operation
INTERNAL_ERROR	An internal server error occurred

HTTP Status Codes

Status Code	Description
200 OK	Request successful
201 Created	Resource created successfully
207 Multi-Status	Batch request processed; inspect each item for its individual outcome
400 Bad Request	Invalid request parameters
401 Unauthorized	Authentication required
403 Forbidden	The caller is not authorized for the requested resource
404 Not Found	Resource not found
409 Conflict	Request conflicts with current state
500 Internal Server Error	Server error occurred