Skip to main content
POST
Create a Quick Pay claim link

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Headers

Idempotency-Key
string
required

Required. Replaying the same key + body returns the original response; a different body is 409.

Body

application/json

Create a shareable Quick Pay claim link. Debits the company wallet immediately and holds the funds as a pending payment until the link is claimed (or auto-refunded after 7 days). companyId is the token's tenant.

amount
number
required

Amount to hold for the claim link, in major currency units (dollars). Debited from the company wallet on creation.

Required range: 0.01 <= x <= 15000
note
string
required

Required. The message shown to the recipient on the claim page.

Minimum string length: 1
description
string

Optional internal memo (not shown to the recipient).

Response

Claim link created; the amount was debited from the company wallet and is held pending until claimed or auto-refunded after 7 days.

data
object
required