CryptoPayr Docs
Dashboard Get API key

Changelog

API changes

What changed in the API, newest first. We add fields and endpoints without breaking existing integrations: code that ignores unknown fields keeps working.

Error codes, safer idempotency, test webhooks match live

  • ChangedIdempotency keys are kept per endpoint, and a key is held while its first request runs: a duplicate sent at the same time gets 409 instead of a second payment, refund, payout or transfer. Retries after the first request finished replay as before, including keys stored before this change. Idempotency
  • FixedA test-mode payment/create no longer replays a live payment that used the same key, and test payments now replay too.
  • ChangedTest webhooks have the live shape: amount is a decimal string (it was a number), and paid payments carry settlement, amount_paid and underpaid. test-complete takes underpaid and amount_paid to rehearse a short payment. Live webhooks are unchanged.
  • Fixedaccounts/update accepts email (contact address) and the managed_fee_* names, and its answer includes email.
  • FixedA form-encoded false is read as false for active on accounts/update, include_crypto on accounts/sweep and make_default on payout-addresses. JSON booleans and 0/1 behave as before.
  • NewHourly limits (429) send a Retry-After header.
  • FixedSwap amounts are stored without float noise: 0.004 ETH no longer became 0.004000000000000001.
  • NewError responses carry a code next to error (e.g. unauthorized, invalid_request, rate_limited). status, error and timestamp are unchanged. Errors
  • ChangedPOST /payment/recheck also accepts a JSON body or ?tid=; form fields work as before.
  • NewPOST /payment/test-complete is in the OpenAPI spec and the Postman collection (new testKey variable).
  • FixedPHP SDK 1.1.1: transfers->lookup() accepts the txf_… id that transfers->create() returns.
  • NewDocs: SDK examples in PHP, Node.js and Python, guides, a webhook event reference, sub-account docs and a test-mode console.

Choose the coins buyers see

  • Newallowed_coins on POST /payment/create limits the checkout to the coins and networks you list; it is echoed back. An unknown entry is refused with 422. Limit the coins
  • NewGET /payment/methods with your secret key returns only the coins your checkout allows; add ?tid= for one payment.
  • Changedmetadata: "topup" is refused on payment/create. It is reserved for wallet top-ups from the dashboard.

Underpayments are visible to your code

  • NewThe webhook and payment/lookup carry amount_paid and underpaid for completed payments. Handle underpayments
  • ChangedUnderpayment tolerance is capped at 50%. Refunds are capped at what actually arrived.
  • ChangedHourly ceilings per account: 150 API payments, 10 refunds, 10 transfers, 10 payout-link cancellations (429).
  • ChangedManual payouts are limited per 24 hours (3 by default). Payouts, refunds and payout-link claims to one of our own deposit addresses are refused.
  • ChangedProbe-style text (scripts, injections) in a refund reason, transfer note or payout-link label/note/metadata is refused with 422.
  • NewSDKs 1.1.0: isUnderpaid() / amountPaid() webhook helpers.

New pricing, refund fee, receipts

  • NewGET /account returns fee_schedule (current or legacy) and fee_addons. Fees
  • NewRefunds on the current pricing carry a 1% fee: REFUNDED webhooks add refund_fee and refund_net; GET /refunds rows add fee_usd and net_usd.
  • NewA PDF receipt for every completed payment in the dashboard.

Safer webhooks and sub-accounts

  • ChangedWebhook URLs must be public http(s) addresses on port 80 or 443. Other targets are refused and logged, with no request made.
  • ChangedPayments complete after the network confirmations, not when the deposit is first seen.
  • ChangedSub-accounts: email is stored as a contact address only; our fee can't be set below 2% + $0.10; active: true can't lift a block we set. Sub-accounts

Payout links

  • Newpayout-link/create, lookup, cancel, resend and GET /payout-links, plus the PAYOUT_LINK_* webhooks. Guide