Business onboarding
Planned endpoints for business profile submission, document collection, ownership details, and review status retrieval.
Documentation
API documentation preview for compliant payment operations.
This page gives product, engineering, compliance, and partner teams a shared view of future API concepts, webhook events, workflow states, and implementation guardrails before backend delivery is finalized.
Documentation is a product preview only. Real API URLs, credentials, request signing, limits, rails, settlement timing, and production access require backend, partner, and compliance approval.
Developer consoleAPI readiness
PreviewAPI versionv0Planning reference
AuthScopedKey model TBD
WebhooksPlannedEvents under review
Status modelDraftCompliance aligned
POST/v0/businesses
POST/v0/payment-instructions
GET/v0/payment-instructions/:id
POST/v0/webhooks/test
API preview
Describe integration capabilities without pretending the backend is live.
These modules define the product surface that backend work can later implement. The page should help technical buyers understand direction while keeping production claims conservative.
Payment instructions
Conceptual payment instruction objects for recipients, amount, purpose, approvals, review states, and operational tracking.
Compliance review
Review states for KYB/KYC, sanctions screening, risk rating, transaction monitoring, and analyst escalation.
Reporting exports
Future reporting resources for payment status, reconciliation, exception records, and audit-ready operational exports.
Webhook events
Event concepts for status changes, review requests, failed instructions, document updates, and compliance exceptions.
Authentication model
API keys, scoped permissions, signing, rate limits, and production access controls should be finalized with backend implementation.
Integration workflow
Start with operational readiness before issuing production credentials.
For payment products, integration readiness is not only technical. It also depends on business verification, risk review, monitoring, reporting, and partner coverage.
Confirm use case
Define paying entity, recipient types, countries, currencies, expected volume, and required reporting outputs.
Complete business review
Submit KYB/KYC details, ownership information, expected activity, and supporting documentation.
Map workflow states
Align internal product states with onboarding, payment instruction, compliance review, exception, and reporting states.
Prepare integration controls
Define API access scopes, webhook receivers, retry logic, audit logs, and operational escalation owners.
Webhook events
Events should map to business, payment, compliance, and reporting states.
Webhook events are shown as planning references. Final payloads, retry behavior, signature verification, and delivery guarantees should be confirmed during backend design.
event
business.review_requestedAdditional business or ownership information is required.
event
business.approvedThe business profile has passed the applicable review step.
event
payment.createdA payment instruction has been created and is pending required checks.
event
payment.review_requiredThe payment needs compliance, risk, or operations review before continuing.
event
payment.rejectedThe payment instruction cannot proceed under current requirements.
event
report.availableA reconciliation or audit export is available for retrieval.
Status model
Status codes should make review, exception, and completion states explicit.
Clear states reduce customer confusion and help operations, compliance, and finance teams align on what happened and what is needed next.
Payment instruction is being prepared and has not entered review.
KYB/KYC, sanctions, risk, or transaction monitoring checks are pending.
Additional documents, recipient details, or payment purpose information is required.
The instruction passed current review and may proceed through the applicable workflow.
The instruction is being handled by the applicable channel or operations workflow.
The workflow has reached a completed state based on available operational records.
The instruction failed because of channel, review, data, or operational reasons.
The instruction cannot proceed because of policy, compliance, partner, or risk requirements.
Readiness guardrails
Keep the documentation useful, but clearly pre-production.
This keeps the website credible for technical reviewers while protecting the business from unsupported promises before backend, legal, and partner details are final.
API endpoints, schemas, authentication, and signing rules are not final until backend scope is confirmed.
Final wording should be aligned with the approved implementation and legal review.
Webhook names and status codes are product planning references and may change during implementation.
Final wording should be aligned with the approved implementation and legal review.
No documentation page should imply unsupported countries, currencies, rails, custody, or settlement guarantees.
Final wording should be aligned with the approved implementation and legal review.
Production API access should require approved onboarding, permission scopes, monitoring, and audit logging.
Final wording should be aligned with the approved implementation and legal review.
Developer access
Discuss API scopeProduction API access should follow business and compliance approval.
Before backend work starts, the next useful step is to confirm the core API objects, webhook events, status transitions, permission model, and reporting outputs.