Payment links

Create a payment link

A link you can share anywhere, for a fixed amount or an amount the payer chooses. A short address is made from the title unless you give a slug.

Headers#

• Idempotency-KeystringRequired

  Client-generated key that makes the request safe to retry. Replaying the key with an identical payload returns the original response; replaying it with a different payload is rejected. Up to 255 characters.

Body parameters#

• pricingstringRequired

  One of fixed, flexible.

• titlestringRequired

  Up to 120 characters.

• amount_minorintegerOptional

  Required for fixed pricing. At least 1.

• descriptionstringOptional

  Up to 1000 characters.

• expires_attimestampOptional
• min_amount_minorintegerOptional

  The least a payer may enter. At least 1.

• redirect_urlstringOptional

  Where the payer goes after paying. Up to 2000 characters.

• slugstringOptional

  The short address. Made from the title when left out. Up to 60 characters.

• statusstringOptional

  One of active, disabled.

Responses#

• 201Payment link created
• 401The secret key is missing, invalid or revoked.
• 403The key is not allowed to do this, or the request came from an address that is not on its allowlist.
• 409The request clashes with the current state, such as a reference reused with different details.
• 422A field is missing or not valid.