Getting Started

Use this guide to onboard clients, request financing for eligible payments, track receivables, and reconcile repayments and refunds.

These guides describe the current PNSL API v2 workflow. Version 1 remains available in the API Reference for existing integrations.

Before implementing the workflows, read Concepts & Workflows to understand the relationship between clients, credit accounts, receivables, and events.

Base URLs

Sandbox and production use separate credentials and resources. Do not carry client or receivable identifiers between environments.

Data contract

The API Reference is authoritative for request and response shapes. In particular, monetary amounts are decimal strings so their precision survives serialization. Keep them as strings in transport and use a decimal type for calculation.

Recommended path

1. Prepare access

Obtain environment-specific OAuth credentials and configure your server to use the shared authentication, headers, and idempotency conventions.

2. Register and verify webhooks

Create a subscription, verify deliveries using their declared signature algorithm and public key, deduplicate by event ID, and fetch the relevant API resource when current state matters. Complete this before onboarding or funding a payment so you do not miss asynchronous changes.

3. Onboard a client

Onboard a client takes the legal entity from an onboarding case through compliance and underwriting review. Financing is not available until the client is active.

4. Check financing capacity

Use Check financing capacity to inspect the client's credit accounts for the currency and payment rail of the payment you intend to fund.

5. Fund and track a payment

Fund a payment creates the receivable. Then follow Track a receivable to process events and retrieve authoritative current state.

6. Close the financial loop

Implement repayment and refund handling, then reconcile activity using stable partner and Axiym identifiers.

Implementation guides

Shared fundamentals

The same conventions apply across Axiym APIs:

• Authentication
• Common headers
• Idempotency
• Pagination and query parameters
• Error handling and retries
• Rate limits
• Data formats and constants
• Payment rails

Production-readiness checklist

Before using production financing, your integration should be able to:

• refresh access tokens without exposing credentials;
• send request IDs and idempotency keys correctly;
• prevent funding requests for clients that are not active;
• check the relevant credit account before requesting funding;
• retain your payment identifier, clientId, and receivableId together;
• verify and deduplicate webhook deliveries;
• fetch current resource state instead of treating an event as a complete resource snapshot;
• retry only operations that are safe to retry; and
• reconcile disbursement, repayment, refund, and balance changes.