[Go to site: main page, start]
Skip to content

Quick Payments

Quick Payments is deprecated and will be removed at the end of December 2026.

Use Payment Links instead for creating, sharing, and managing shareable payment links.

Quick Payments are shareable payment links a merchant sends to a customer to collect payment.

A one-time link can be used once and expires after payment, unlike a reusable link. A reusable link stays active across multiple payments from different customers until deactivated. Every link must be activated before a customer can use it, as a security feature.

The Quick Payments endpoints support creating, listing, and retrieving both one-time and reusable links. Shared endpoints activate a link, deactivate it, and send it to a customer by SMS. A one-time link also deactivates automatically once the customer completes the payment. A reusable link stays active until it is manually deactivated or its time limit expires.

  • POST /pay-int-api/quick-payments/one-time. Creates a one-time payment link.
  • GET /pay-int-api/quick-payments/one-time. Lists one-time payment links.
  • GET /pay-int-api/quick-payments/one-time/{quickPaymentId}. Retrieves details of a one-time link.
  • POST /pay-int-api/quick-payments/reusable. Creates a reusable payment link.
  • GET /pay-int-api/quick-payments/reusable. Lists reusable payment links.
  • GET /pay-int-api/quick-payments/reusable/{quickPaymentId}. Retrieves details of a reusable link.
  • POST /pay-int-api/quick-payments/{quickPaymentId}/activate. Activates a payment link so it can be used.
  • POST /pay-int-api/quick-payments/{quickPaymentId}/deactivate. Deactivates a payment link.
  • POST /pay-int-api/quick-payments/{quickPaymentId}/send-sms-notification. Sends a payment link to the customer by SMS.
Operations

Creates a one-time payment link
deprecated

Request

POST {{baseURL}}/pay-int-api/quick-payments/one-time

This endpoint is deprecated. Quick Payments will be removed at the end of December 2026.

To create a payment link, use POST /v2/payment-links with linkType set to SingleUse instead.

This endpoint creates link for a one-time payment.

A one-time is one that can be used only once and then it expires. This can be used for cases like purchases or fee payments. It is limited to only one person. A one-time is in contrast to a reusable payment payment that can be use multiple times by different people.

The link must be activated before use as a security feature. To activate a one-time payment link, see POST /pay-int-api/quick-payments/{{quickPaymentId}}/activate

The link remains active until one of the following occurs:

  • The customer completes the payment
  • The link is manually deactivated
  • The link's time limit expires

See Also:
To list one-time payment links, see GET /pay-int-api/quick-payments/one-time.
To retrieve details of a one-time payment link, see GET /pay-int-api/quick-payments/one-time/{quickPaymentId}.
To activate a payment link, see POST /pay-int-api/quick-payments/{quickPaymentId}/activate.
To send a payment link by SMS, see POST /pay-int-api/quick-payments/{quickPaymentId}/send-sms-notification.

Security
Bearer
Headers
x-api-versionstring

Specifies the API version to use for the request.

Example: 1.0

Example:1.0
Bodyapplication/json

The one-time payment link creation request.

amountnumber, (double), decimal places <= 2, > 0

Specifies the amount (in USD) of the one-time payment.

Example: 45.99 (for $45.99)

Example:45.99
referenceIdstring or null, [ 0 .. 100 ]

Specifies the ReferenceId.

Example: 10001

Example:"10001"
customerIdstring or null, (uuid)

Specifies the customer identifier.

Example: c9ae4972-b934-41aa-8e1a-1e5d8ad34bec

Example:"c9ae4972-b934-41aa-8e1a-1e5d8ad34bec"
curl -i -X POST \
  https://developer.flute.com/_mock/api-reference/pay-int-api/quick-payments/one-time \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-api-version: 1.0' \
  -d '{
    "amount": 45.99,
    "referenceId": "10001",
    "customerId": "c9ae4972-b934-41aa-8e1a-1e5d8ad34bec"
  }'

Responses

OK

Bodyapplication/json
idstring, (uuid)

Indicates the payment reference link identifier, also known as the quickPaymentId.

Example: c8c67f32-aca5-47c4-b10e-123086a43075

Example:"c8c67f32-aca5-47c4-b10e-123086a43075"
Response
{
  "id": "c8c67f32-aca5-47c4-b10e-123086a43075"
}