search
Page cover

Create and configure Pay links

Payment API - Paylink - API specification- calling our Payment API POST /api/paylink will return a Pay link URL configured to your specific parameters that when ‘clicked’ will render our FrontStream Payment Form your customers can use to make payments.

Key Details:

  • API Version: v1

  • Endpoint: /api/paylink

  • Method: POST

  • Purpose: Returns a configured 'clickable' Pay Link URL for accepting payments.

Responses:

  • 200 (Success): Returns a pay link URL.

  • 400 (Bad Request): If pay link creation throws exception.

  • 404 (Not Found): If pay link data is not found.

Components:

  • PayLinkUrl Response: Returns the pay link URL.

  • BrokenRule: Represents an error in pay link url creation with an error code and message.

  • ProblemDetails: Details for any error response, including status, title, and description.

hashtag
Create, configure, and return Pay Link URL

See how to create and configure your Pay Link URL through the POST /api/paylink here:

Pay Linkschevron-right

PreviousAPI referencesNextSearch for a Charity for your Donation

Last updated