Create a Payment Link

Generate a new payment link to accept payments from customers. Supports both fixed and variable payment options.

Assuming NO custom domain for Stax Pay, this url should concatenate the following base url and the merchant's website payments token: https://app.staxpayments.com/#/pay/ + merchant_website_payments_token.

/

PARTNERS ONLY If your brand includes a custom domain, your custom domain would replace app.staxpayments.com in this URL value.



Key Features

  • Create links for fixed amounts or allow customers to input their payment amount.
  • Include metadata such as customer details or purpose.
  • Specify expiration dates for added control.

Usage Notes

Custom Metadata: Add optional metadata to personalize links for specific use cases.

Expiration Settings: Ensure links have a valid expiration date, if required, to avoid misuse.

URL Construction:

  • No Custom Domain: For merchants without a custom domain, concatenate the following to generate the payment link URL:
    <https://app.staxpayments.com/#/pay/> + merchant_website_payments_token
  • Custom Domain (Partners Only): For brands with a custom domain, replace app.staxpayments.com with your custom domain in the URL structure.

Security: Validate all required attributes in the request to prevent errors.


Response Structure

CodeResponseReason
201CreatedThe payment link was successfully created.
400Bad RequestMissing required parameters.
401UnauthorizedAuthentication failed.
500Internal Server ErrorUnexpected server error occurred.

Important Considerations

Custom Domains: Partners leveraging Stax custom domains must ensure the domain is correctly configured when constructing the payment link URL.

Dynamic Metadata: Utilize metadata to track payment context or add customer-specific details.

Testing Links: Always verify newly created payment links to ensure they direct customers to the intended payment page.

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!