# PNSL API

> Finance eligible client payments and manage receivables, disbursements, repayments, and refunds.

Product: PNSL API

Guides follow the current API reference (2.0.0) and event reference (1.0.0). Older reference versions are listed separately; the guides are not historical snapshots.

Operation references are compact. Follow the linked schemas for field details, or the complete-reference link to retrieve all related definitions in one document.

## Guides and concepts

- [Build with the PNSL API](https://docs.axiym.io/pnsl-api.md): Finance eligible client payments and manage the resulting receivables.
- [Overview](https://docs.axiym.io/pnsl-api/concepts/overview.md): Fund your clients' payments today and settle with Axiym once the funds arrive.
- [Accounts and money movement](https://docs.axiym.io/pnsl-api/concepts/accounts-and-money-movement.md): Where financing capacity and received funds live, and how they move.
- [Receivable and repayments](https://docs.axiym.io/pnsl-api/concepts/repayments.md): What a receivable records, its statuses, and how repayments are attributed and allocated.
- [Roles and responsibilities](https://docs.axiym.io/pnsl-api/concepts/roles-and-responsibilities.md): What the Payment Network, the client, and Axiym each do.
- [Operational lifecycle](https://docs.axiym.io/pnsl-api/concepts/operational-lifecycle.md): The end-to-end flow from onboarding to repayment, and where it is asynchronous.
- [Glossary](https://docs.axiym.io/pnsl-api/concepts/glossary.md): Terms used in the PNSL financing and repayment flow.
- [Getting started](https://docs.axiym.io/pnsl-api/integration-guide.md): Build a PNSL API integration step by step.
- [Integrate using AI](https://docs.axiym.io/pnsl-api/integration-guide/integrate-with-ai.md): Use Axiym documentation and an optional integration prompt with your coding agent.
- [Client onboarding](https://docs.axiym.io/pnsl-api/integration-guide/implementation-guides/client-onboarding.md): Submit a client and wait for it to become active.
- [Check financing capacity](https://docs.axiym.io/pnsl-api/integration-guide/implementation-guides/check-credit-capacity.md): Confirm that a client can be funded before you request funding.
- [Receivables funding and repayments](https://docs.axiym.io/pnsl-api/integration-guide/implementation-guides/receivables-funding-and-repayments.md): Fund a client payment, follow the receivable, and repay it.
- [Authentication](https://docs.axiym.io/pnsl-api/integration-guide/fundamentals/authentication.md): Obtain an OAuth 2.0 access token and authenticate Axiym API requests.
- [Common headers](https://docs.axiym.io/pnsl-api/integration-guide/fundamentals/common-headers.md): Use authentication, tracing, idempotency, and content-type headers consistently.
- [Idempotency](https://docs.axiym.io/pnsl-api/integration-guide/fundamentals/idempotency.md): Retry state-changing requests without creating duplicate operations.
- [Pagination and query parameters](https://docs.axiym.io/pnsl-api/integration-guide/fundamentals/pagination-and-query-parameters.md): Follow cursor-based pages and use list filters without changing resource scope.
- [Error handling and retries](https://docs.axiym.io/pnsl-api/integration-guide/fundamentals/error-handling-and-retries.md): Interpret structured API errors and retry only temporary or ambiguous failures.
- [Rate limits](https://docs.axiym.io/pnsl-api/integration-guide/fundamentals/rate-limits.md): Pace requests and handle throttling using the response headers.
- [Data formats and constants](https://docs.axiym.io/pnsl-api/integration-guide/fundamentals/data-formats-and-constants.md): Store and send identifiers, decimals, currencies, countries, dates, and timestamps correctly.
- [Payment rails](https://docs.axiym.io/pnsl-api/integration-guide/fundamentals/payment-rails.md): The settlement channel used for disbursements and repayments.
- [Webhooks overview](https://docs.axiym.io/pnsl-api/webhooks/overview.md)
- [Register and manage subscriptions](https://docs.axiym.io/pnsl-api/webhooks/registration-and-management.md)
- [Verify signatures](https://docs.axiym.io/pnsl-api/webhooks/verifying-signatures.md)

## API reference 2.0.0 (current)

[OpenAPI contract](https://docs.axiym.io/openapi/pnsl-api/2.0.0.json)

- [Axiym PNSL API](https://docs.axiym.io/pnsl-api/api-reference/2.0.0.md)
- [Get new access token](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/auth/getAccessToken.md)
- [Start Client Onboarding](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/onboarding/startOnboarding.md): Creates and immediately submits a client onboarding case for compliance review. Document intake is owned by Axiym's compliance KYB flow. The client is visible in `GET /clients` after approval; track the case with `GET /onboardings/{clientId}`.
- [Get Onboarding Status](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/onboarding/getOnboardingStatus.md)
- [List all Clients](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/clients/ListCompanies.md)
- [Get Client Profile](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/clients/GetCompany.md)
- [List Credit Accounts](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/credit-accounts/listCreditAccounts.md)
- [List Receivables](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/receivables/listReceivables.md)
- [Fund a Payment](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/receivables/fundPayment.md)
- [Repay a client from your balance](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/receivables/createRepayment.md): Applies funds from your own settlement balance to the client's outstanding receivables. Use it when incoming funds could not be attributed to a client automatically and were credited to your settlement account as unallocated. The funds must already be on your settlement account for `currency` and `paymentRails` (see `GET /accounts` in the Account API); an `amount` above that balance is rejected. Allocation is FIFO across the client's active receivables; the request does not select a particular receivable. Any amount beyond the client's `totalRepaymentAmount` remains on the client's settlement balance. The response acknowledges the request; read the receivable and credit account after settlement.
- [Transfer client balance to your account](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/receivables/createClientTransfer.md): Moves funds from the client's settlement balance to your own settlement account for the same currency and payment rail. Use it to return an overpayment or funds received in error: once on your account, withdraw them with the Account API. This is an instant book transfer; no bank movement occurs. Funds already applied to a receivable are not returned by this operation.
- [Get a Receivable](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/receivables/GetReceivable.md)
- [Payment Rails](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/settings/listPaymentRails.md)
- [List all Subscriptions](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/webhook-subscriptions/listWebhookSubscriptions.md)
- [Create Subscription](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/webhook-subscriptions/createWebhookSubscription.md)
- [Test Subscription](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/webhook-subscriptions/testWebhookSubscription.md)
- [Disable Subscription](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/webhook-subscriptions/disableWebhookSubscription.md)
- [Get Webhook Public Key](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/webhook-subscriptions/getWebhookPublicKey.md)
- [Schemas](https://docs.axiym.io/pnsl-api/api-reference/2.0.0/schemas.md): Data models used by the PNSL API.

## API reference 1.0.0 (deprecated)

[OpenAPI contract](https://docs.axiym.io/openapi/pnsl-api/1.0.0.json)

- [Axiym PNSL API (Legacy)](https://docs.axiym.io/pnsl-api/api-reference/1.0.0.md)
- [Get new access token](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/auth/getAccessToken.md)
- [List all Clients](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/clients/ListCompanies.md)
- [Start Client Onboarding](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/clients/startOnboarding.md): Creates and submits a client onboarding application. The application is reviewed by Axiym compliance; until it is approved the client is not returned by `GET /clients`.
- [Get Client Profile](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/clients/GetCompany.md)
- [List Credit Accounts](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/credit-accounts/listCreditAccounts.md)
- [List Receivables](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/receivables/listReceivables.md)
- [Fund a Payment](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/receivables/fundPayment.md)
- [Repay from Partner Balance](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/receivables/createRepayment.md): Transfers funds from your partner account to the client's account and starts repayment of the client's outstanding receivables. In the normal flow this is not needed: a deposit made to your partner account with the client's reference is routed to the client automatically and repayment starts on its own. Use this operation when a deposit could not be routed and remained on your partner balance.
- [Create a Refund](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/receivables/createRefund.md)
- [Get a Receivable](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/receivables/GetReceivable.md)
- [Payment Rails](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/settings/listPaymentRails.md)
- [List all Subscriptions](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/webhook-subscriptions/listWebhookSubscriptions.md)
- [Create Subscription](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/webhook-subscriptions/createWebhookSubscription.md)
- [Test Subscription](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/webhook-subscriptions/testWebhookSubscription.md)
- [Disable Subscription](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/webhook-subscriptions/disableWebhookSubscription.md)
- [Get Webhook Public Key](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/webhook-subscriptions/getWebhookPublicKey.md)
- [Schemas](https://docs.axiym.io/pnsl-api/api-reference/1.0.0/schemas.md): Data models used by the PNSL API.

## Event reference 1.0.0 (current)

[OpenAPI contract](https://docs.axiym.io/openapi/pnsl-api/events/1.0.0.json)

- [Axiym PNSL API events](https://docs.axiym.io/pnsl-api/events/1.0.0.md)
- [Client created](https://docs.axiym.io/pnsl-api/events/1.0.0/client/onClientCreated.md)
- [Client updated](https://docs.axiym.io/pnsl-api/events/1.0.0/client/onClientUpdated.md)
- [Client onboarding finished](https://docs.axiym.io/pnsl-api/events/1.0.0/client/onClientOnboardingFinished.md): Deprecated legacy activation event. It is emitted alongside client.activated until legacy integrators migrate.
- [Client activated](https://docs.axiym.io/pnsl-api/events/1.0.0/client/onClientActivated.md)
- [Client disabled](https://docs.axiym.io/pnsl-api/events/1.0.0/client/onClientDisabled.md): Emitted alongside client.updated when the client is disabled.
- [Credit account created](https://docs.axiym.io/pnsl-api/events/1.0.0/credit-account/onCreditAccountCreated.md)
- [Credit account updated](https://docs.axiym.io/pnsl-api/events/1.0.0/credit-account/onCreditAccountUpdated.md)
- [Receivable created](https://docs.axiym.io/pnsl-api/events/1.0.0/receivable/onReceivableCreated.md)
- [Receivable disbursed](https://docs.axiym.io/pnsl-api/events/1.0.0/receivable/onReceivableDisbursed.md)
- [Receivable repaid](https://docs.axiym.io/pnsl-api/events/1.0.0/receivable/onReceivableRepaid.md)
- [Receivable settled](https://docs.axiym.io/pnsl-api/events/1.0.0/receivable/onReceivableSettled.md)
- [Receivable canceled](https://docs.axiym.io/pnsl-api/events/1.0.0/receivable/onReceivableCanceled.md)
- [Subscription test](https://docs.axiym.io/pnsl-api/events/1.0.0/subscription/onSubscriptionTest.md)

- [Schemas](https://docs.axiym.io/pnsl-api/events/1.0.0/schemas.md): Individual event schema definitions.