Schemas

Download schema

Money

string · pattern: ^[0-9]+(\.[0-9]+)?$

QuoteStatus

string · enum

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

PaymentStatus

string · enum

Enum values:

COMPLETED

FAILED

RETURNED

Outcome of the payout. The call performs the payout and answers with the outcome, so COMPLETED or FAILED can both come back synchronously. RETURNED, and a FAILED that only surfaces on the rail after a COMPLETED response, arrive later via the failure webhook.

RiskStatus

string · enum

Enum values:

unchecked

awaiting_decision

automatically_approved

manually_approved

automatically_rejected

manually_rejected

RiskStatusReason

risk_status_reason_type

string · enum · required

Enum values:

ENTITY

ACCOUNT

OWNERSHIP

COUNTERPARTY

INDIRECT

BEHAVIORAL

ERROR

risk_status_reason_category

string

risk_status_reason_message

string

ErrorEnvelope

object[] · required

request_id

string · required

WebhookEnvelope

event_id

string · uuid · required

event_type

string · required

occurred_at

string · date-time · required

data

object · required

CreateQuoteRequest

Quote request (§6.1).

tesser_quote_id

string · uuid · required

UUIDv4 minted by Tesser before the call; doubles as the idempotency key.

customer

string · enum · required

Closed enum at launch. Cross-checks the customer context carried by the API key.

Enum values:

FELIX

desired_gtq

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

GTQ the customer wants to end up with. Max 2 decimal places.

Quote

A quote as returned by create (§6.1).

tesser_quote_id

string · uuid · required

nexa_quote_id

string · required

Nexa's own reference, for support and reconciliation.

quote_status

QuoteStatus · enum · required

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

usdc_gtq_price

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

GTQ per 1 USDC. Max 6 decimal places.

quoted_gtq

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

GTQ Nexa will deliver. May be less than desired_gtq, which is a partial fill, and the remainder is a new quote.

usdc_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

USDC Tesser must deliver = quoted_gtq / usdc_gtq_price, rounded UP at 6dp. Nexa is the single calculator; Tesser echoes this value and never re-derives it.

expires_at

string · date-time · required

Acceptance deadline. Unaccepted quotes expire silently; there is no expiry webhook.

created_at

string · date-time · required

AcceptQuoteResponse

Acceptance acknowledgement (§6.2).

tesser_quote_id

string · uuid · required

quote_status

QuoteStatus · enum · required

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

deposit_deadline

string · date-time · required

How long Nexa holds the locked rate waiting for the first deposit report. Past it with no deposit reported, the quote is EXPIRED (window length: §11 Q2).

accepted_at

string · date-time · required

ReportDepositRequest

A report, not a request (§6.3): Tesser attests what it observed on-chain. Tesser always reports a deposit it observes, including when risk screening rejects. Nexa alone decides what to do with the report, asynchronously, by webhook.

tesser_deposit_id

string · uuid · required

UUIDv4 minted by Tesser; the idempotency key for this individual report.

usdc_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

USDC that actually arrived in this report. Max 6 decimal places.

risk_status

RiskStatus · enum · required

Enum values:

unchecked

awaiting_decision

automatically_approved

manually_approved

automatically_rejected

manually_rejected

RiskStatusReason[] · required

Tesser core-API RiskStatusReason objects, verbatim.

transaction_hashes

string[] · required

On-chain transaction hash(es) carrying this deposit, the anchor both ops teams reconcile against the chain with.

ReportDepositResponse

Acknowledgement that the report was recorded (§6.3). It carries no risk or amount verdict; Nexa's decision arrives later by webhook.

tesser_quote_id

string · uuid · required

tesser_deposit_id

string · uuid · required

quote_status

QuoteStatus · enum · required

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

usdc_total_reported

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

Sum across all reports on this quote.

reported_at

string · date-time · required

DepositReport

One recorded deposit report, as echoed in the quote GET.

tesser_deposit_id

string · uuid · required

usdc_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

risk_status

RiskStatus · enum · required

Enum values:

unchecked

awaiting_decision

automatically_approved

manually_approved

automatically_rejected

manually_rejected

RiskStatusReason[] · required

transaction_hashes

string[] · required

reported_at

string · date-time · required

CreatePaymentRequest

Payout instruction (§6.4).

tesser_quote_id

string · uuid · required

gtq_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

Must equal the amount Nexa reported in its own quote.credit.confirmed event. Deliberately redundant: cheap insurance against wrong-quote-ID bugs in a money-moving instruction.

Payment

A payment as returned by create (§6.4).

nexa_payment_id

string · required

tesser_quote_id

string · uuid · required

quote_status

QuoteStatus · enum · required

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

payment_status

PaymentStatus · enum · required

Outcome of the payout for this payment.

Enum values:

COMPLETED

FAILED

RETURNED

gtq_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

created_at

string · date-time · required

completed_at

string · date-time

When Nexa completed the payout. Present only when payment_status is COMPLETED.

status_metadata

object

Free-form: rail references, failure reasons. Shape varies by rail, so it is deliberately untyped. Carries the decline reason when a synchronous decline returns payment_status: "FAILED" on this call.

QuotePaymentSummary

The payment sub-object embedded in the quote GET, when one exists.

nexa_payment_id

string · required

payment_status

PaymentStatus · enum · required

Enum values:

COMPLETED

FAILED

RETURNED

gtq_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

created_at

string · date-time · required

QuoteDetail

The merged quote view (§6.5): the §6.1–6.3 fields, every deposit report, the credit-decision fields once Nexa has decided, and a payment sub-object when one exists.

tesser_quote_id

string · uuid · required

nexa_quote_id

string · required

Nexa's own reference, for support and reconciliation.

quote_status

QuoteStatus · enum · required

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

usdc_gtq_price

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

GTQ per 1 USDC. Max 6 decimal places.

quoted_gtq

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

GTQ Nexa will deliver. May be less than desired_gtq, which is a partial fill, and the remainder is a new quote.

usdc_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

USDC Tesser must deliver = quoted_gtq / usdc_gtq_price, rounded UP at 6dp. Nexa is the single calculator; Tesser echoes this value and never re-derives it.

expires_at

string · date-time · required

Acceptance deadline. Unaccepted quotes expire silently; there is no expiry webhook.

created_at

string · date-time · required

DepositReport[] · required

All reports on this quote, including late ones.

deposit_deadline

string · date-time

accepted_at

string · date-time

usdc_total_reported

Money · pattern: ^[0-9]+(\.[0-9]+)?$

credited_gtq

Money · pattern: ^[0-9]+(\.[0-9]+)?$

Authoritative credited amount; present once Nexa has decided to credit. May deviate from quoted_gtq.

credited_at

string · date-time

QuotePaymentSummary

The payment sub-object embedded in the quote GET, when one exists.

PaymentDetail

The payment view (§6.6): the §6.4 fields plus the current status, rail metadata and timestamps.

nexa_payment_id

string · required

tesser_quote_id

string · uuid · required

quote_status

QuoteStatus · enum · required

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

payment_status

PaymentStatus · enum · required

Outcome of the payout for this payment.

Enum values:

COMPLETED

FAILED

RETURNED

gtq_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

created_at

string · date-time · required

completed_at

string · date-time

When Nexa completed the payout. Present only when payment_status is COMPLETED.

status_metadata

object

updated_at

string · date-time

TesserWebhookEnvelope

Tesser's standard outbound webhook envelope, reproduced here for orientation only. https://docs.tesser.xyz is the normative definition (spec §6.7 documents the subscription Nexa needs rather than re-specifying Tesser's existing envelope). Note this is NOT the Nexa-to-Tesser WebhookEnvelope of §7; the two directions use each sender's own existing format.

id

string · required

Event identifier (UUID), the dedupe key.

type

string · required

Event type in scope.action form. The subscription Nexa needs is the withdrawal events behind §9.2: withdrawal.quote_created, withdrawal.steps_created, withdrawal.balance_updated, withdrawal.updated.

created_at

string · date-time · required

object · required

Event payload wrapper.

Nexa endpoints exposed to Tesser

Schemas

Download schema

Money

string · pattern: ^[0-9]+(\.[0-9]+)?$

QuoteStatus

string · enum

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

PaymentStatus

string · enum

Enum values:

COMPLETED

FAILED

RETURNED

RiskStatus

string · enum

Enum values:

unchecked

awaiting_decision

automatically_approved

manually_approved

automatically_rejected

manually_rejected

RiskStatusReason

risk_status_reason_type

string · enum · required

Enum values:

ENTITY

ACCOUNT

OWNERSHIP

COUNTERPARTY

INDIRECT

BEHAVIORAL

ERROR

risk_status_reason_category

string

risk_status_reason_message

string

ErrorEnvelope

object[] · required

request_id

string · required

WebhookEnvelope

event_id

string · uuid · required

event_type

string · required

occurred_at

string · date-time · required

data

object · required

CreateQuoteRequest

Quote request (§6.1).

tesser_quote_id

string · uuid · required

UUIDv4 minted by Tesser before the call; doubles as the idempotency key.

customer

string · enum · required

Closed enum at launch. Cross-checks the customer context carried by the API key.

Enum values:

FELIX

desired_gtq

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

GTQ the customer wants to end up with. Max 2 decimal places.

Quote

A quote as returned by create (§6.1).

tesser_quote_id

string · uuid · required

nexa_quote_id

string · required

Nexa's own reference, for support and reconciliation.

quote_status

QuoteStatus · enum · required

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

usdc_gtq_price

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

GTQ per 1 USDC. Max 6 decimal places.

quoted_gtq

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

GTQ Nexa will deliver. May be less than desired_gtq, which is a partial fill, and the remainder is a new quote.

usdc_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

USDC Tesser must deliver = quoted_gtq / usdc_gtq_price, rounded UP at 6dp. Nexa is the single calculator; Tesser echoes this value and never re-derives it.

expires_at

string · date-time · required

Acceptance deadline. Unaccepted quotes expire silently; there is no expiry webhook.

created_at

string · date-time · required

AcceptQuoteResponse

Acceptance acknowledgement (§6.2).

tesser_quote_id

string · uuid · required

quote_status

QuoteStatus · enum · required

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

deposit_deadline

string · date-time · required

How long Nexa holds the locked rate waiting for the first deposit report. Past it with no deposit reported, the quote is EXPIRED (window length: §11 Q2).

accepted_at

string · date-time · required

ReportDepositRequest

tesser_deposit_id

string · uuid · required

UUIDv4 minted by Tesser; the idempotency key for this individual report.

usdc_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

USDC that actually arrived in this report. Max 6 decimal places.

risk_status

RiskStatus · enum · required

Enum values:

unchecked

awaiting_decision

automatically_approved

manually_approved

automatically_rejected

manually_rejected

RiskStatusReason[] · required

Tesser core-API RiskStatusReason objects, verbatim.

transaction_hashes

string[] · required

On-chain transaction hash(es) carrying this deposit, the anchor both ops teams reconcile against the chain with.

ReportDepositResponse

Acknowledgement that the report was recorded (§6.3). It carries no risk or amount verdict; Nexa's decision arrives later by webhook.

tesser_quote_id

string · uuid · required

tesser_deposit_id

string · uuid · required

quote_status

QuoteStatus · enum · required

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

usdc_total_reported

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

Sum across all reports on this quote.

reported_at

string · date-time · required

DepositReport

One recorded deposit report, as echoed in the quote GET.

tesser_deposit_id

string · uuid · required

usdc_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

risk_status

RiskStatus · enum · required

Enum values:

unchecked

awaiting_decision

automatically_approved

manually_approved

automatically_rejected

manually_rejected

RiskStatusReason[] · required

transaction_hashes

string[] · required

reported_at

string · date-time · required

CreatePaymentRequest

Payout instruction (§6.4).

tesser_quote_id

string · uuid · required

gtq_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

Must equal the amount Nexa reported in its own quote.credit.confirmed event. Deliberately redundant: cheap insurance against wrong-quote-ID bugs in a money-moving instruction.

Payment

A payment as returned by create (§6.4).

nexa_payment_id

string · required

tesser_quote_id

string · uuid · required

quote_status

QuoteStatus · enum · required

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

payment_status

PaymentStatus · enum · required

Outcome of the payout for this payment.

Enum values:

COMPLETED

FAILED

RETURNED

gtq_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

created_at

string · date-time · required

completed_at

string · date-time

When Nexa completed the payout. Present only when payment_status is COMPLETED.

status_metadata

object

QuotePaymentSummary

The payment sub-object embedded in the quote GET, when one exists.

nexa_payment_id

string · required

payment_status

PaymentStatus · enum · required

Enum values:

COMPLETED

FAILED

RETURNED

gtq_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

created_at

string · date-time · required

QuoteDetail

The merged quote view (§6.5): the §6.1–6.3 fields, every deposit report, the credit-decision fields once Nexa has decided, and a payment sub-object when one exists.

tesser_quote_id

string · uuid · required

nexa_quote_id

string · required

Nexa's own reference, for support and reconciliation.

quote_status

QuoteStatus · enum · required

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

usdc_gtq_price

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

GTQ per 1 USDC. Max 6 decimal places.

quoted_gtq

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

GTQ Nexa will deliver. May be less than desired_gtq, which is a partial fill, and the remainder is a new quote.

usdc_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

USDC Tesser must deliver = quoted_gtq / usdc_gtq_price, rounded UP at 6dp. Nexa is the single calculator; Tesser echoes this value and never re-derives it.

expires_at

string · date-time · required

Acceptance deadline. Unaccepted quotes expire silently; there is no expiry webhook.

created_at

string · date-time · required

DepositReport[] · required

All reports on this quote, including late ones.

deposit_deadline

string · date-time

accepted_at

string · date-time

usdc_total_reported

Money · pattern: ^[0-9]+(\.[0-9]+)?$

credited_gtq

Money · pattern: ^[0-9]+(\.[0-9]+)?$

Authoritative credited amount; present once Nexa has decided to credit. May deviate from quoted_gtq.

credited_at

string · date-time

QuotePaymentSummary

The payment sub-object embedded in the quote GET, when one exists.

PaymentDetail

The payment view (§6.6): the §6.4 fields plus the current status, rail metadata and timestamps.

nexa_payment_id

string · required

tesser_quote_id

string · uuid · required

quote_status

QuoteStatus · enum · required

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

payment_status

PaymentStatus · enum · required

Outcome of the payout for this payment.

Enum values:

COMPLETED

FAILED

RETURNED

gtq_amount

Money · pattern: ^[0-9]+(\.[0-9]+)?$ · required

created_at

string · date-time · required

completed_at

string · date-time

When Nexa completed the payout. Present only when payment_status is COMPLETED.

status_metadata

object

updated_at

string · date-time

TesserWebhookEnvelope

id

string · required

Event identifier (UUID), the dedupe key.

type

string · required

Event type in scope.action form. The subscription Nexa needs is the withdrawal events behind §9.2: withdrawal.quote_created, withdrawal.steps_created, withdrawal.balance_updated, withdrawal.updated.

created_at

string · date-time · required

object · required

Event payload wrapper.