Axiym

Overview

View Markdown

PNSL stands for Pay Now, Settle Later.

A Payment Network asks Axiym to fund a payment made by one of its clients. Axiym creates a receivable for that amount and disburses the funds to the Payment Network's bank account. The Payment Network executes the client payment in its own system. When repayment funds arrive at Axiym and are attributed to the client, they are applied to that client’s outstanding receivables, oldest first.

PNSL is a financing and repayment API, not a payment-processing API.

How it works

  1. Onboard the client. Submit the client with POST /onboardings. Axiym reviews it; once the client is ACTIVE, it can be funded.
  2. Check capacity. GET /clients/{clientId}/credit-accounts returns the client's availableBalance for each currency and payment rail.
  3. Fund a payment. POST /clients/{clientId}/receivables with the payment's amount, currency, and details. Axiym creates the receivable (PENDING) and starts the disbursement; when it settles, the receivable is ACTIVE and the funds are on your account.
  4. Repay. Funds sent to Axiym with the client's settlement reference or client code in the memo are applied to the client's receivables automatically. Funds that cannot be attributed to a client land on your settlement account; apply them with POST /clients/{clientId}/repayments.
  5. Track. Receivable events and GET /clients/{clientId}/receivables/{receivableId} show the remaining principal until the receivable is PAID.

The core resources

Client

A business whose payments you fund through PNSL, such as an MSB or a PSP. Identified by clientId; must be onboarded and ACTIVE.

Credit account

The client's financing facility for one currency and payment rail: credit limit, outstanding principal, and availableBalance. Its balance is money received from the client and not yet used for repayment.

Receivable

One funded payment: how much was funded, how much is still outstanding, the total due, and the disbursement and repayment transactions.

Webhook event

A signed notification that a client, credit account, or receivable changed. Read the resource for its current state.

Where to go next