Zynk
Getting StartedProduct GuidesAPI ReferenceFAQ'sRecipes
Getting StartedProduct GuidesAPI ReferenceFAQ'sRecipes
  1. Transformer - Cross Border Transfer
  • General
    • Getting Started
    • Integration
  • Technical
    • Transformer - Cross Border Transfer
      • API Questions
      • Troubleshooting
      • General FAQ's
    • Continuum - Wallet Infrastructure
  1. Transformer - Cross Border Transfer

API Questions

What is an Entity ?#

An Entity refers to an individual or business whose identity is verified through KYC before any transactions can be made.

What types of entities are supported?#

Both individual and business entities are supported for KYC and onboarding.

What does the KYC lifecycle look like?#

Status values include: not_started, initiated, reviewing, approved, rejected. Use webhook events or polling to track progress.

How do I simulate a transfer?#

Call POST /transfers/simulate with the source, destination, currency, and amount. You’ll receive a breakdown of fees and estimated final amount.

How do I execute a transfer?#

Use POST /transfers/execute with the required parameters. Be sure to simulate beforehand to confirm fees.

What is the Partner Payments system?#

This allows pre-funding a centralized wallet which is then used to process future transactions faster and cheaper.

How do I top up my balance?#

Call GET /payments/balance to get a deposit address. Transfer funds and then call POST /payments/deposit with the transaction hash and signature.

How do I validate my current balance?#

Use the same GET /payments/balance endpoint to view your available funds and wallet info.

How do I register a webhook?#

Call PUT /utility/webhook with your webhook URL to receive event notifications

What events can I subscribe to?#

We currently support webhook events for: kyc.transitioned, transfers.status, and webhook.updated.

How do I verify webhook authenticity?#

Every webhook payload includes a z-webhook-signature header. Verify it using HMAC-SHA256 with your x-api-token.

Will Zynk retry failed webhook deliveries?#

Yes, webhooks are retried up to 3 times with exponential backoff for all non-2xx responses. Ensure your endpoint returns 200 to acknowledge.
Modified at 2025-10-28 09:03:09
Previous
Integration
Next
Troubleshooting
Built with