Axiym

Schemas

Data models used by the PNSL API.

View MarkdownView complete reference
17 schemas

Client

object
#
clientIdRequired
string

Client identifier (UUID).

Formatuuid
codeRequired
string

Human-readable client code.

legalEntityNameRequired
string

Official name of the company.

legalAddressRequired
Address

Legal address.

incorporationDateRequired
string

Date the legal entity was established.

Formatdate
registrationDateRequired
string

Date the company joined your network.

Formatdate
statusRequired
string

Client status.

Allowed values
ONBOARDINGACTIVEDISABLED
currencyRequired
Currency

Currency code (ISO 4217 fiat or supported stablecoin).

disbursementAccount
DisbursementAccount

Payment Network bank account that receives funding disbursements for this client.

partnerClientId
string

Your reference for this client.

paymentRailsRequired
string

Payment rail — a configured settlement channel Axiym uses to hold and move funds: a banking partner for fiat (e.g. `ZENUS_BANK`, `FREEMARKET`) or a blockchain network for crypto (e.g. `TRON`, `AVALANCHE`). Codes are returned by `GET /settings/payment-rails`.

PageInfo

object
#
hasNextPageRequired
boolean

When paginating forwards, are there more items?

endCursor
string

When paginating forwards, the cursor to continue.

Receivable

object
#
receivableIdRequired
string

Receivable identifier (UUID).

clientIdRequired
string

Client identifier (UUID).

Formatuuid
issueDateRequired
string

Issue date, formatted in ISO 8601.

Formatdate-time
initialPrincipalRequired
Decimal

Original principal amount.

currentPrincipalRequired
Decimal

Remaining unpaid principal.

repaymentAmountRequired
Decimal

Total amount due, including interest and fees.

currencyRequired
Currency

Currency code (ISO 4217 fiat or supported stablecoin).

statusRequired
ReceivableStatus

Receivable lifecycle status.

paymentTransactionRequired
TransactionRef

Details of the payment submitted for financing.

disbursedTransaction
TransactionRef

Reference to the disbursement transaction.

repaymentTransactions
TransactionRef[]

References to repayment transactions.

paymentRailsRequired
string

Payment rail — a configured settlement channel Axiym uses to hold and move funds: a banking partner for fiat (e.g. `ZENUS_BANK`, `FREEMARKET`) or a blockchain network for crypto (e.g. `TRON`, `AVALANCHE`). Codes are returned by `GET /settings/payment-rails`.

ReceivableStatus

string
#

`PENDING` while the funding request is accepted and the disbursement is in progress; `ACTIVE` once the disbursement settled and principal is outstanding (stays `ACTIVE` after a partial repayment); `PAID` when the obligation is fully repaid; `CANCELED` if the receivable did not complete.

Allowed values
PENDINGACTIVEPAIDCANCELED

Address

object
#
city
string

City portion of the address.

countryRequired
string

Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

Pattern^[A-Z]{2}$
addressRequired
string

Line one of the street address.

addressExtended
string

Line two of the street address.

district
string

State / County / Province / Region portion of the address. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision.

postalCodeRequired
string

Postal / ZIP code of the address.

RequestStatus

object
#
statusRequired
string

Request status.

Allowed values
OK

Default OK

Subscription

object
#
subscriptionIdRequired
string

Subscription identifier (UUID).

Formatuuid
endpointRequired
string

URL of the endpoint to subscribe to notifications. Must be publicly accessible, use HTTPS, and respond with a 2XX status to a POST request.

Formaturi

PublicKey

object
#
publicKeyIdRequired
string

Public key identifier (UUID).

Formatuuid
activeRequired
boolean

Indicates whether the key is active.

algorithmRequired
string

Signature algorithm.

publicKeyRequired
string

Public key used to verify webhook signatures.

createdAtRequired
string

Creation timestamp. Formatted in ISO 8601.

Formatdate-time

PaymentRails

object
#
codeRequired
string

Payment rail code (e.g. `ZENUS_BANK`, `TRON`).

descriptionRequired
string

Human-readable description.

currenciesRequired
Currency[]

Allowed currencies.

DisbursementAccount

object
#

Bank account at the Payment Network that receives funding disbursements.

accountNumber
string

Bank account number.

ValidationError

object
#

One field-level validation error.

codeRequired
string

Validation rule code (e.g. 'length', 'email', 'invalid_currency', 'disbursement_account_required').

message
string | null

Human-readable message.

paramsRequired
object

Rule-specific parameters. Always includes `value` (the offending input). Additional keys depend on the rule (e.g. `min`, `max` for length).

value
unknown

The submitted value that failed validation.

ValidationFieldErrors

ValidationError[] | object
#

Nested validation errors keyed by field name or array index. Leaf values are arrays of `ValidationError` objects.

Any of

TransactionRef

object
#

Reference to a settled transaction.

txIdRequired
string

Transaction identifier.

txTimestampRequired
string

Transaction timestamp, formatted in ISO 8601.

Formatdate-time

Currency

string
#

Currency code — ISO 4217 fiat (e.g. USD, EUR) or a supported stablecoin (USDT, USDC).

Decimal

string
#

Decimal number serialized as a string to preserve precision.

CreditAccount

object
#

A credit (borrowing) account.

creditAccountIdRequired
string

Credit account identifier (UUID).

Formatuuid
currencyRequired
Currency

Currency code (ISO 4217 fiat or supported stablecoin).

creditLimitRequired
Decimal

Maximum credit available to the client.

availableBalanceRequired
Decimal

Amount currently available to borrow — i.e., available to finance a payment.

balance
Decimal

Client settlement balance for this currency and payment rail: funds received from the client and not yet used for repayment. Absent until the client's settlement account is provisioned.

principalOutstandingRequired
Decimal

Total principal currently borrowed (outstanding).

totalRepaymentAmountRequired
Decimal

Total amount due to repay (principal, interest and fees).

totalInterestAmountRequired
Decimal

Total interest accrued.

statusRequired
string

Credit account status.

Allowed values
PENDINGACTIVEDISABLED
paymentRailsRequired
string

Payment rail — a configured settlement channel Axiym uses to hold and move funds: a banking partner for fiat (e.g. `ZENUS_BANK`, `FREEMARKET`) or a blockchain network for crypto (e.g. `TRON`, `AVALANCHE`). Codes are returned by `GET /settings/payment-rails`.

OnboardingCase

object
#

Snapshot of a client onboarding application. Created in the submitted state and reviewed by Axiym compliance; while the review is in progress the status stays ONBOARDING. An approved application ends in APPROVED; a rejected application ends in REJECTED.

clientIdRequired
string

Client identifier (UUID).

Formatuuid
codeRequired
string

Human-readable client code.

legalEntityNameRequired
string

Official name of the company.

legalAddress
Address

Legal address.

incorporationDate
string

Date the legal entity was established.

Formatdate
registrationDate
string

Date the company joined your network.

Formatdate
statusRequired
string

Onboarding application status.

Allowed values
ONBOARDINGAPPROVEDREJECTED
currency
Currency

Currency code (ISO 4217 fiat or supported stablecoin).

disbursementAccount
DisbursementAccount

Payment Network bank account that receives funding disbursements for this client.

partnerClientId
string

Your reference for this client.

paymentRails
string

Payment rail — a configured settlement channel Axiym uses to hold and move funds: a banking partner for fiat (e.g. `ZENUS_BANK`, `FREEMARKET`) or a blockchain network for crypto (e.g. `TRON`, `AVALANCHE`). Codes are returned by `GET /settings/payment-rails`.