pty_*), agent ID (agt_*), or handle and Natural sends the payment (pay_*). If an email or phone recipient is new to Natural, Natural sends a claim link and onboards them when they claim the funds. Handles, party IDs, and agent IDs must already exist. For the payment lifecycle, read the Payments overview.
Send the payment
Send it withPOST /payments. description is at most 80 characters.
id (pay_*) and its initial status:
A recipient who is not on Natural yet comes back as
PENDING_CLAIM. Natural emails or texts them
a claim link and moves the money once they onboard and claim it. The response also carries
claimLink, returned only here; anyone holding it can claim the funds, so store it as a secret.IN_REVIEW. The payment draws from the sending party’s default wallet. Pass walletId (wal_*) to spend from a specific wallet instead; an agent with access to more than one wallet must pass it.
Once sent, track the payment to follow it from PROCESSING to COMPLETED, or cancel a PENDING_CLAIM payment before the recipient claims it.