Skip to content

Docs - Create Payout Endpoints API Feature PageΒ #35

@MantisClone

Description

@MantisClone

Problem

Payout endpoints (/v2/payouts/*) are the recommended approach for checkout use cases (bundle request creation + payment transaction generation), but we have no API Feature page documenting them. Use case pages currently link to non-existent /api-features/payouts.

Proposed Solution

Create /api-features/payouts.mdx documenting:

  • What payout endpoints are and when to use them
  • How they differ from request endpoints (bundle vs separate steps)
  • Best for immediate payment scenarios (checkout, instant payments)
  • Current limitations (no cross-chain, no crypto-to-fiat via payouts)
  • When to use request endpoints instead (for advanced features like cross-chain, conversion)
  • Code examples and integration patterns
  • API endpoint references

Considerations

  • Payout endpoints already exist in the API (/v2/payouts/*)
  • Should explain relationship to request endpoints clearly without confusing users
  • Need to document limitations honestly (cross-chain, conversion require request endpoints)
  • Consider if this should reference or be referenced by existing payment types overview page
  • Currently referenced from Checkout use case page (Issue Docs - Clean up Checkout use case pageΒ #33)
  • May also be relevant for future Payouts use case page

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

Status

πŸ”– Sprint Backlog (To do)

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions