Create a checkout

Body

• payment_code string
  The code at the end of a payment's url. Send this or link_code.
• link_code string
  The code at the end of a link's url.
• rail string
  crypto or card. Defaults to crypto.
• asset string
  For crypto: USDC, USDT, BTC, ETH or SOL.
• network string
  For crypto: a network the business accepts the asset on, such as polygon.
• email string
  The customer's email, which you see on the payment. Required for cards, and when the business asks for it.
• country string
  The customer's two-letter country code, used to determine card-payment availability.
• replaces string
  The ID of the checkout this one replaces, when the customer goes back to choose again. The same choice returns the same quote and address, and a different one carries a link's pending payment over. Supersede the old checkout when the customer steps back: it stops being the quote on screen, but funds already on the way still count and can still be claimed.
• simulate string
  For testing only: how the transfer arrives, exact, underpaid, overpaid or wrong_network. late returns 400 here; it's only reachable through simulating a transfer. See testing.

Errors

• 400 invalid_request
  A field is missing or invalid, such as a simulate value it doesn't take.
• 400 idempotency_key_required
  The request has no Idempotency-Key header.
• 400 email_required
  The rail or the business needs the customer's email, and none was sent.
• 400 invalid_email
  email isn't a valid email address.
• 400 rail_unavailable
  The business doesn't accept this rail.
• 400 asset_unavailable
  The business doesn't accept this coin on this network.
• 400 amount_out_of_range
  The price is outside the available card-payment limits.
• 403 customer_blocked
  The business has blocked the customer with this email.
• 403 business_suspended
  402pay suspended the business, so it can't take new payments.
• 403 test_mode_unavailable
  A test key can't open a checkout on a live business, so send none, as a customer's browser does, or a live key.
• 404 link_not_found
  No active link has this code.
• 404 payment_not_found
  No payment has this code.
• 409 not_accepting
  The business isn't taking payments yet.
• 409 payment_paid
  Funds already arrived for the payment: it succeeded, or it's underpaid or needs_review.
• 409 payment_canceled
  The business canceled the payment.
• 410 payment_expired
  The payment passed its expires_at.
• 429 rate_limited
  Too many checkouts from one IP address. Wait for Retry-After seconds.
• 503 temporarily_unavailable
  402pay paused new checkouts, card payments, or payments on this network for now. Try again later.

Any request can also fail on its key or its body. See errors.