AAntilFi

Documentation

Illustrative developer reference for integrating with the AntilFi platform.

These examples describe how integrations are expected to work once connected to the live AntilFi platform. Endpoints, keys, and payloads shown here are illustrative and not callable.

Getting started

Provision a sandbox session and confirm connectivity

After your integration request is scoped, you receive sandbox credentials tied to your partner ID. Use them to open a session and begin testing.

bash
curl -X POST https://sandbox.antilfi.example/v1/partners/session \
  -H "Authorization: Bearer sk_sandbox_XXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{"partner_id": "PTR-DEMO-01"}'

Authentication concepts

How requests are expected to be authenticated

Every request carries a bearer token scoped to your partner ID. Production keys are issued only after a partner completes the relevant certification program.

javascript
// Illustrative example only — sandbox keys are issued after certification.
const headers = {
  "Authorization": "Bearer sk_sandbox_XXXXXXXX",
  "X-AntilFi-Partner-Id": "PTR-DEMO-01",
};

Webhooks

Illustrative event payload shape

Webhooks notify your systems of settlement, onboarding, and certification events. Each payload includes an event type, identifier, and timestamp.

json
{
  "event": "settlement.completed",
  "id": "evt_8a12",
  "created_at": "2026-07-31T18:22:00Z",
  "data": {
    "partner_id": "PTR-DEMO-01",
    "amount_minor": 1250000,
    "currency": "HTG"
  }
}

Sandbox environment

What the sandbox is for

  • Isolated environment seeded with synthetic accounts and balances in HTG.
  • Rate-limited to encourage realistic integration testing rather than load testing.
  • Reset weekly; do not store long-lived state that depends on sandbox data persisting.

Error handling

Illustrative error response shape

Errors return a structured object with a stable code, human-readable message, and request ID for support correlation.

json
{
  "error": {
    "code": "invalid_signature",
    "message": "Webhook signature could not be verified.",
    "request_id": "req_c93f1"
  }
}

Changelog

Illustrative history of documentation and API notes