APIErrorSchema
codeError code
detailsDetailed error information
messageError message
statusResponse status
APIResponseSchema-AccountSettlementAddressResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-AuthTokenResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-CreateNASPIPResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-CreatePaymentIntentionResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-CreateSubscriptionResponse
Response data (only for success status)
statusResponse status
APIResponseSchema-GetAccountResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-GetAccountSettlementAddressesResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-GetOrganizationResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-GetQRResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-GetSettlementAddressesResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-NotificationEmailResponse
Response data (only for success status)
statusResponse status
APIResponseSchema-OkResponse
Response data (only for success status)
statusResponse status
APIResponseSchema-PaginatedPointOfSaleResponse
Response data (only for success status)
statusResponse status
APIResponseSchema-PaginatedResponse-GetAllTransactionsResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-PaginatedResponse-ListSettlementsResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-PaginatedResponse-core-api_src_domain_model_WebhookLogModel
Response data (only for success status)
statusResponse status
APIResponseSchema-PaymentIntentionResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-PaymentRequestCheckoutResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-PaymentRequestResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-PointOfSaleResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-ReadNASPIPResponseData
Response data (only for success status)
statusResponse status
APIResponseSchema-SettlementAddressResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-SubscriptionParticipant
Response data (only for success status)
statusResponse status
APIResponseSchema-WebhookResponse
Response data (only for success status)
statusResponse status
APIResponseSchema-array_GetAccountResponseSchema
Response data (only for success status)
statusResponse status
APIResponseSchema-array_SupportedAssetResponse
Response data (only for success status)
statusResponse status
APIResponseSchema-array_WebhookResponse
Response data (only for success status)
statusResponse status
AccountSetSettlementAddressRequestSchema
addressAddress of the settlement address
networkNetwork of the settlement address
address_tagAddress tag of the settlement address - like memo or destination tag
AccountSettlementAddressResponseSchema
addressAddress of the settlement address
networkNetwork of the settlement address
address_tagAddress tag of the settlement address - like memo or destination tag
AccountUpdateSettlementAddressRequestSchema
addressAddress of the settlement address
networkNetwork of the settlement address
address_tagAddress tag of the settlement address - like memo or destination tag
AuthTokenRequestSchema
api_keyFluxis API key
api_secretFluxis API secret
AuthTokenResponseSchema
expired_atAccess token expiration date in UTC RFC3339 format
tokenAccess token
CreateAccountRequestSchema
nameAccount name in Fluxis database
external_idAccount external ID
CreatePaymentIntentionRequestSchema
amountRequested payment amount
coin_codeUnique identifier for the cryptocurrency asset
external_idOptional reference ID for tracking the payment request
CreatePaymentIntentionResponseSchema
expirationPayment request expiration timestamp
Payment intention data
tokenNASPIP token containing the payment intention payload
CreatePointOfSaleRequestSchema
nameHuman friendly name for the point of sale.
reference_currencyReference currency
typePoint of sale type
account_idOptional: Account ID
Merchant information. Omit to keep existing.
payment_optionsOptional: Allowed unique asset IDs for the point of sale
return_urlOptional: URL to redirect the shopper to after a successful payment
CreateSubscriptionRequest
amountanchor_dayassetintervalinterval_countpoint_of_sale_idexpires_atreturn_urlCreateSubscriptionResponse
hosted_checkout_urlidGetAccountResponseSchema
external_idAccount external ID
nameAccount name in Fluxis database
GetAllTransactionsResponseSchema
account_external_idAccount external ID
created_atTransaction creation date
currencyCurrency code
expected_amountExpected amount
financial_providerFinancial provider name
fromFrom address
from_typeFrom address type
gross_amountGross amount
idTransaction ID
net_amountNet amount
networkBlockchain network
statusTransaction status
toTo address
to_typeTo address type
transaction_hashTransaction hash
typeTransaction type
unique_asset_idUnique asset ID
updated_atTransaction last update date
GetOrganizationResponseSchema
countryISO 3166-1 alpha-2
created_atidnameowner_emailtax_idupdated_atListSettlementsResponseSchema
created_atgross_amountidmax_retriesretry_countsettled_atstatustransaction_hashunique_asset_idupdated_atNotificationEmailResponse
notification_emailAddress notified when a payment is credited. Null when unset.
sales_notifications_enabledFalse skips merchant sale emails. Reported true when the account has no stored switch.
PaginatedResponse-core-api_src_domain_model_WebhookLogModel
pagepage_sizetotaltotal_pagesPaymentIntentionResponseSchema
Payment intention data
Payment request data
tokenToken
PaymentRequestCheckoutRequestSchema
amountRequested payment amount
coin_codeUnique identifier for the cryptocurrency asset
Order data
reference_idOptional reference ID for tracking the payment request
PaymentRequestCheckoutResponseSchema
checkout_urlNASPIP-resolvable checkout URL (same value embedded in token); for backend-only/wallet-app consumption, not a browser page — resolve it via GET /public/checkout/pos/:posID/payment/:prID
expirationPayment request expiration timestamp
hosted_checkout_urlHosted checkout page URL for UI-based/browser payment flows — redirect the customer here directly. Distinct from checkout_url/token, which remain for backend-only NASPIP consumption.
idFluxis payment request ID
reference_idExternal payment request reference ID
statusPayment request status
tokenNASPIP token embedding checkout_url, for backend-only/wallet-app resolution
PaymentRequestRequestSchema
amountRequested payment amount
unique_asset_idUnique identifier for the cryptocurrency asset
Order data
reference_idOptional reference ID for tracking the payment request
PaymentRequestResponseSchema
expirationPayment request expiration timestamp
idFluxis payment request ID
reference_idExternal payment request reference ID
statusPayment request status
tokenNASPIP token, containing payment instructions
PointOfSaleResponseSchema
account_idAccount ID
account_nameAccount name (omitted if no account is associated with the point of sale)
Point of sale configuration
created_atPoint of sale creation date
idFluxis point of sale ID
namePoint of sale given name
organization_idOrganization ID
organization_nameOrganization name
typePoint of sale type
updated_atPoint of sale last update date
ReadNASPIPResponseData
Order data
payment_optionsurlSetNotificationEmailRequest
notification_emailAddress notified when a payment is credited. Omit to leave unchanged. Null or empty clears it.
sales_notifications_enabledWhen false, completed, overpaid, and underpaid merchant sale emails are not sent. Omit or null to leave unchanged. A missing stored value stays true.
SetSettlementAddressRequestSchema
addressAddress of the settlement address
networkNetwork of the settlement address
address_tagAddress tag of the settlement address - like memo or destination tag
SettlementAddressResponseSchema
addressAddress of the settlement address
networkNetwork of the settlement address
address_tagAddress tag of the settlement address - like memo or destination tag
SettlementItemResponseSchema
addressaddress_tagamountidtypeunique_asset_idSubscriptionParticipant
account_idconfigrolestatusSubscriptionResponse
expires_atidnext_charge_atstatuswallet_external_idSupportedAssetResponse
decimalsnetworknetwork_codenetwork_image_urlnetwork_namepayment_decimalsreference_assettoken_addresstoken_image_urltoken_symbolunique_asset_idUpdatePointOfSaleOptionsRequestSchema
Merchant information. Omit to keep existing.
nameHuman friendly name for the point of sale.
payment_optionsAllowed unique asset IDs. Omit to keep existing; send [] to clear.
reference_currencyReference currency. Omit to keep existing.
return_urlOptional: URL to redirect the shopper to after a successful payment. Omit to keep existing.
WebhookCreateRequest
event_typeurldescriptionWebhookResponse
account_idcreated_atdescriptionenabledevent_typeidsecretupdated_aturlcore-api_src_domain_model.AccountModel
external_idnameorganization_idcore-api_src_domain_model.OrganizationModel
countryISO 3166-1 alpha-2
nameowner_emailtax_idcore-api_src_domain_model.PaymentRequestModel
addresspoint_of_sale_idreference_amountreference_asset_idstatusPayment request status
typeunique_asset_idamountconsolidation_idexchange_rateexpected_amountexpirationexternal_idparent_addresspayer_addresstransaction_hashcore-api_src_domain_model.PointOfSaleModel
nameorganization_idtypePoint of sale type
account_idTODO: move this to uuid.UUID since orgs wont be able to have POS directly associated
checkout_amountconfigcore-api_src_domain_model.WebhookLogModel
account_idcreated_atduration_mserrorevent_typeidpayloadresponse_bodyresponse_statuswebhook_idcore-api_src_domain_types.EntityType
core-api_src_domain_types.MerchantSchema
descriptionMerchant description
nameMerchant name
core-api_src_domain_types.POSPaymentIntention
amountexpired_atexternal_idpayment_request_idpoint_of_sale_idreference_currencystatustokencore-api_src_domain_types.PaymentRequestStatus
Payment request status
core-api_src_domain_types.PaymentRequestType
core-api_src_domain_types.PointOfSaleConfigSchema
Merchant information. Omit to keep existing.
payment_optionsAllowed unique asset IDs for the point of sale
reference_currencyReference currency
return_urlURL to redirect the shopper to after a successful payment
underpayment_tolerance_percentMaximum shortfall as a percentage of expected that is still credited as paid. Nil uses the platform default (0). Zero is strict matching.
core-api_src_domain_types.PointOfSaleType
Point of sale type
core-api_src_domain_types.SettlementAddressSchema
address_tagaddress_typeownersettlement_addresssettlement_typecore-api_src_domain_types.TransactionDetailType
core-api_src_domain_types.TransactionStatus
Transaction status
core-api_src_domain_types.TransactionType
Transaction type
core-api_src_domain_types.WebhookEventType
core-api_src_infrastructure_http_types.ResponseStatus
Response status
core-api_src_pkg_utils.PasetoV4MerchantData
descriptionMerchant description
nameMerchant name
core-api_src_pkg_utils.PasetoV4OrderData
coin_codeOrder coin code (FIAT or crypto)
descriptionOrder description
Order items
Merchant information
totalOrder total amount