API get list of PaymentLink
Returns a paginated list of payment links for the authenticated merchant as { meta: { count, totalPages, page, limit }, data: [...] }.
Money units: list rows return amount, taxes, totalAmount, paidAmount and surcharge as integer cents (1000 = $10.00), whereas GET /public/202104/payment-link/{id} returns them in dollars.
query Parameters
pagePage number for paginating
limitLimit items per page
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
API get list of PaymentLink › Responses
Paginated payment links. Money fields in cents.
Create payment link
Create a shareable payment link that allows customers to pay a specific amount.
amount — required. Integer amount in cents (1000 = $10.00).
customValues — optional array of { key, label, value } objects shown on the payment form. Important: All custom value keys must be pre-configured in the merchant setup. Any key not defined in the merchant configuration will result in an error.
taxes — optional array of tax IDs to apply. In the response, taxes is the computed tax amount (not the id list).
showBilling/showShipping — whether to request billing/shipping addresses on the payment form.
attachments — optional objects returned by the /upload-attachments endpoint.
Response money fields (amount, taxes, totalAmount, paidAmount, surcharge) are returned as stored, in cents.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Create payment link › Request Body
amountInteger amount in cents (1000 = $10.00). Note: the deprecated POST /public/payment-link endpoint interprets this value as whole dollars instead.
taxesList of tax ids to apply (send [] when none). In responses, taxes is the computed tax amount, not this list.
showBillingShow Billing
showShippingShow Shipping
custom values data
Objects returned by POST .../upload-attachments.
applyDiscountA discount may be applied to this payment link. If applicable, a discount of {%} will be deducted from credit card payments.
Create payment link › Responses
Payment link created. Money fields in cents; taxes is the computed tax amount.
API view paymentLink by id
Retrieve a single payment link by ID. Money fields (amount, taxes, totalAmount, paidAmount, surcharge) are in dollars; taxes is the computed tax amount.
path Parameters
idPayment link ID
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
API view paymentLink by id › Responses
Payment link returned. Money fields in dollars.
API delete paymentLink by id
Delete a payment link. The response is the raw underlying payment-request document (order, active: false, deletedAt, ...), not the public payment-link shape.
path Parameters
idPayment link ID
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
API delete paymentLink by id › Responses
Payment link deleted. Returns the raw payment-request document.
Share payment link by email
Send a payment link to a customer via email. Provide paymentLinkId and email in the request body.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Share payment link by email › Request Body
emailEmail to send the payment link or Invoice
paymentLinkIdPaymentLink Id to send by email
Share payment link by email › Responses
Email sent.
Share payment link by SMS
Send a payment link to a customer via SMS. Provide paymentLinkId and phoneNumber in the request body.
Phone format: ^[+]?[(]?[0-9]{3}[)]?[ ]?[0-9]{3}[-]?[0-9]{4}$ — e.g. (555) 555-5555 or 5555555555; 555-555-5555 and 786 322 0000 are rejected.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Share payment link by SMS › Request Body
phoneNumber^[+]?[(]?[0-9]{3}[)]… · requiredPhone to send the payment link or Invoice
paymentLinkIdPayment Link Id. Optional; ignored on routes that carry the id in the path
invoiceIdInvoice Id. Optional; ignored on routes that carry the id in the path
createdByName of the user who created the payment link or Invoice. Optional; ignored on routes that carry the id in the path
Share payment link by SMS › Responses
SMS sent.
Upload payment link attachments
Upload files to attach to a payment link. Returns file path objects to use in the attachments field when creating a payment link.
File limits: Up to 10 files per request, max 25 MB total size.
Supported formats: JPG, PNG, PDF.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Upload payment link attachments › Request Body
attachmentsMultipart field name: attachments
Upload payment link attachments › Responses
Files uploaded.