Skip to content

Request and Response Fields ​

This generated reference lists the exact field names and types in the backend models used by the integration APIs. Use the endpoint guides for HTTP status, envelopes, defaults, and service behavior. Download the field contracts.

Names are case-sensitive. JSON fields without omitempty remain present when empty or zero; pointers can be null. A Go time.Time is encoded as an RFC 3339 string and can remain present even with an omitempty tag. Array/map fields without omitempty can be null when uninitialized. Shared request validation tags describe declared constraints; controller/service behavior determines which are enforced. Request optionality is not implied by the response serialization column.

Webhook event data has its own complete reference; webhook management responses below are not the data object of an event. Engine amounts are decimal strings in base units in the engine response, while compatibility checkout uses display numbers for top-level amount fields.

Merchant payments ​

MerchantCreatePaymentLinkRequest ​

FieldTypeBindingSerializationDeclared validation
payment_namestringjsonIncludedrequired,min=1,max=100
descriptionstringjsonomitempty; nullableomitempty,max=1000
amountnumberjsonIncludedrequired,gt=0
currencystringjsonIncludedrequired,min=3,max=10
starts_atRFC 3339 stringjsonomitempty; nullable—
expires_atRFC 3339 stringjsonomitempty; nullable—
max_usesintegerjsonomitempty; nullableomitempty,gt=0
customer_idstringjsonomitempty; nullableomitempty,min=1,max=100
customer_namestringjsonomitempty; nullableomitempty,min=1,max=100
customer_emailstringjsonomitempty; nullableomitempty,email,max=100
product_namestringjsonomitempty; nullableomitempty,min=1,max=200
product_descriptionstringjsonomitempty; nullableomitempty,max=1000
cartobjectjsonomitempty; nullable—
order_idstringjsonomitempty; nullableomitempty,min=1,max=200
auto_fillbooleanjsonomitempty; nullable—
is_testbooleanjsonomitempty; nullable—
success_urlstringjsonomitempty; nullableomitempty,url,max=500
cancel_urlstringjsonomitempty; nullableomitempty,url,max=500
webhook_metadataobjectjsonomitempty; nullable—

PaymentLinkFilterRequest ​

FieldTypeBindingSerializationDeclared validation
pageintegerqueryIncludedomitempty,min=1
limitintegerqueryIncludedomitempty,min=1,max=100
statusstringqueryIncluded; nullableomitempty,oneof=pending completed expired cancelled
is_activebooleanqueryIncluded; nullable—
currencystringqueryIncluded; nullableomitempty,min=3,max=10
min_amountnumberqueryIncluded; nullableomitempty,gt=0
max_amountnumberqueryIncluded; nullableomitempty,gt=0
created_fromRFC 3339 stringqueryIncluded; nullable—
created_toRFC 3339 stringqueryIncluded; nullable—
searchstringqueryIncluded; nullableomitempty,max=100
sort_bystringqueryIncluded; nullableomitempty,oneof=created_at updated_at amount name
sort_orderstringqueryIncluded; nullableomitempty,oneof=asc desc

PaginationMeta ​

FieldTypeBindingSerializationDeclared validation
current_pageintegerjsonIncluded—
per_pageintegerjsonIncluded—
total_pagesintegerjsonIncluded—
total_recordsintegerjsonIncluded—
has_next_pagebooleanjsonIncluded—
has_prev_pagebooleanjsonIncluded—

ListPaymentLinksResponse ​

FieldTypeBindingSerializationDeclared validation
dataarray of MerchantPaymentLinkListResponse objectjsonIncluded; nullable—
paginationPaginationMeta objectjsonIncluded—
filtersAppliedFilters objectjsonomitempty; nullable—

AppliedFilters ​

FieldTypeBindingSerializationDeclared validation
statusstringjsonomitempty; nullable—
is_activebooleanjsonomitempty; nullable—
currencystringjsonomitempty; nullable—
min_amountnumberjsonomitempty; nullable—
max_amountnumberjsonomitempty; nullable—
created_fromRFC 3339 stringjsonomitempty; nullable—
created_toRFC 3339 stringjsonomitempty; nullable—
searchstringjsonomitempty; nullable—
sort_bystringjsonIncluded—
sort_orderstringjsonIncluded—

MerchantPaymentLinkResponse ​

FieldTypeBindingSerializationDeclared validation
idstringjsonIncluded—
receipt_numberstringjsonomitempty; nullable—
merchant_idstringjsonIncluded—
payment_namestringjsonIncluded—
descriptionstringjsonomitempty; nullable—
amountnumberjsonIncluded—
currencystringjsonIncluded—
payment_urlstringjsonIncluded—
payment_statusstringjsonIncluded—
payment_typestringjsonIncluded—
sourcestringjsonIncluded—
starts_atRFC 3339 stringjsonomitempty—
expires_atRFC 3339 stringjsonomitempty; nullable—
max_usesintegerjsonomitempty; nullable—
current_usesintegerjsonIncluded—
is_activebooleanjsonIncluded—
is_testbooleanjsonIncluded—
customer_idstringjsonomitempty; nullable—
customer_namestringjsonomitempty; nullable—
customer_emailstringjsonomitempty; nullable—
product_namestringjsonomitempty; nullable—
product_descriptionstringjsonomitempty; nullable—
cartobjectjsonomitempty; nullable—
success_urlstringjsonomitempty; nullable—
cancel_urlstringjsonomitempty; nullable—
webhook_metadataobjectjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonIncluded—

MerchantPaymentLinkCreateResponse ​

FieldTypeBindingSerializationDeclared validation
idstringjsonIncluded—
receipt_numberstringjsonomitempty; nullable—
payment_namestringjsonIncluded—
descriptionstringjsonomitempty; nullable—
amountnumberjsonIncluded—
currencystringjsonIncluded—
payment_urlstringjsonIncluded—
payment_statusstringjsonIncluded—
payment_typestringjsonIncluded—
sourcestringjsonIncluded—
starts_atRFC 3339 stringjsonomitempty—
expires_atRFC 3339 stringjsonomitempty; nullable—
max_usesintegerjsonomitempty; nullable—
current_usesintegerjsonIncluded—
is_activebooleanjsonIncluded—
is_testbooleanjsonIncluded—
customer_idstringjsonomitempty; nullable—
customer_namestringjsonomitempty; nullable—
customer_emailstringjsonomitempty; nullable—
product_namestringjsonomitempty; nullable—
product_descriptionstringjsonomitempty; nullable—
cartobjectjsonomitempty; nullable—
order_idstringjsonomitempty; nullable—
auto_fillbooleanjsonIncluded—
success_urlstringjsonomitempty; nullable—
cancel_urlstringjsonomitempty; nullable—
webhook_metadataobjectjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—

MerchantPaymentLinkListResponse ​

FieldTypeBindingSerializationDeclared validation
idstringjsonIncluded—
receipt_numberstringjsonomitempty; nullable—
payment_namestringjsonIncluded—
descriptionstringjsonomitempty; nullable—
amountnumberjsonIncluded—
currencystringjsonIncluded—
payment_urlstringjsonIncluded—
payment_statusstringjsonIncluded—
payment_typestringjsonIncluded—
sourcestringjsonIncluded—
starts_atRFC 3339 stringjsonomitempty—
expires_atRFC 3339 stringjsonomitempty; nullable—
max_usesintegerjsonomitempty; nullable—
current_usesintegerjsonIncluded—
is_activebooleanjsonIncluded—
is_expiredbooleanjsonIncluded—
is_testbooleanjsonIncluded—
customer_idstringjsonomitempty; nullable—
customer_namestringjsonomitempty; nullable—
customer_emailstringjsonomitempty; nullable—
product_namestringjsonomitempty; nullable—
product_descriptionstringjsonomitempty; nullable—
cartobjectjsonomitempty; nullable—
order_idstringjsonomitempty; nullable—
auto_fillbooleanjsonIncluded—
success_urlstringjsonomitempty; nullable—
cancel_urlstringjsonomitempty; nullable—
webhook_metadataobjectjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—

MerchantPaymentLinkDetailResponse ​

FieldTypeBindingSerializationDeclared validation
idstringjsonIncluded—
receipt_numberstringjsonomitempty; nullable—
payment_namestringjsonIncluded—
descriptionstringjsonomitempty; nullable—
amountnumberjsonIncluded—
currencystringjsonIncluded—
payment_urlstringjsonIncluded—
payment_statusstringjsonIncluded—
payment_typestringjsonIncluded—
sourcestringjsonIncluded—
starts_atRFC 3339 stringjsonomitempty—
expires_atRFC 3339 stringjsonomitempty; nullable—
max_usesintegerjsonomitempty; nullable—
current_usesintegerjsonIncluded—
is_activebooleanjsonIncluded—
is_expiredbooleanjsonIncluded—
is_testbooleanjsonIncluded—
settlement_statusstringjsonomitempty; nullable—
usd_valuenumberjsonomitempty; nullable—
customer_idstringjsonomitempty; nullable—
customer_namestringjsonomitempty; nullable—
customer_emailstringjsonomitempty; nullable—
product_namestringjsonomitempty; nullable—
product_descriptionstringjsonomitempty; nullable—
cartobjectjsonomitempty; nullable—
order_idstringjsonomitempty; nullable—
auto_fillbooleanjsonIncluded—
success_urlstringjsonomitempty; nullable—
cancel_urlstringjsonomitempty; nullable—
webhook_metadataobjectjsonomitempty; nullable—
payersarray of PayerDetailResponse objectjsonomitempty; nullable—
transactionsarray of TransactionDetailResponse objectjsonomitempty; nullable—
summaryPaymentSummary objectjsonIncluded—
created_atRFC 3339 stringjsonIncluded—

PayerDetailResponse ​

FieldTypeBindingSerializationDeclared validation
idstringjsonIncluded—
namestringjsonIncluded—
emailstringjsonIncluded—
countrystringjsonomitempty; nullable—
phonestringjsonomitempty; nullable—
wallet_addressstringjsonomitempty; nullable—
ip_addressstringjsonomitempty; nullable—
regionstringjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—

TransactionDetailResponse ​

FieldTypeBindingSerializationDeclared validation
idstringjsonIncluded—
total_amount_fiatnumberjsonomitempty; nullable—
total_amount_cryptonumberjsonIncluded—
tx_hashstringjsonomitempty; nullable—
tx_hash_send_timeRFC 3339 stringjsonomitempty; nullable—
tx_confirmation_timeRFC 3339 stringjsonomitempty; nullable—
tx_blockintegerjsonomitempty; nullable—
network_idstringjsonIncluded—
network_namestringjsonIncluded—
payment_currencystringjsonomitempty; nullable—
contract_addressstringjsonomitempty; nullable—
payment_typestringjsonomitempty; nullable—
statusstringjsonomitempty; nullable—
payment_statusstringjsonomitempty; nullable—
payment_walletstringjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—

PaymentSummary ​

FieldTypeBindingSerializationDeclared validation
total_payersintegerjsonIncluded—
total_transactionsintegerjsonIncluded—
total_amount_receivednumberjsonIncluded—
total_amount_received_cryptonumberjsonIncluded—
pending_transactionsintegerjsonIncluded—
completed_transactionsintegerjsonIncluded—
failed_transactionsintegerjsonIncluded—

Payer checkout ​

QuotationRequest ​

FieldTypeBindingSerializationDeclared validation
srctokenstringjsonIncludedrequired
currencystringjsonIncludedrequired
chainIdstringjsonIncludedrequired
paymentlinkIdstringjsonomitempty—
networkstringjsonomitempty—
currency_idstringjsonomitempty—
payment_typestringjsonomitempty—
payer_idstringjsonomitempty—
decimalsintegerjsonIncluded; nullable—

Tempmail ​

FieldTypeBindingSerializationDeclared validation
emailstringjsonIncludedrequired
namestringjsonIncludedrequired
hashstringjsonIncluded—
currencystringjsonIncluded—
idstringjsonIncluded—
merchantIdstringjsonIncluded—
expected_amountstringjsonIncludedrequired
received_amountstringjsonomitempty—
remaining_amountstringjsonomitempty—
payment_typestringjsonomitempty—
networkstringjsonomitempty—

TempmailResponse ​

FieldTypeBindingSerializationDeclared validation
emailstringjsonIncludedrequired
expected_amountstringjsonIncludedrequired
received_amountstringjsonomitempty—
remaining_amountstringjsonomitempty—
payment_typestringjsonomitempty—
networkstringjsonomitempty—
statusstringjsonIncluded—

PaymentLinkResponse ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
receipt_numberstringjsonomitempty; nullable—
namestringjsonIncluded—
descriptionstringjsonomitempty; nullable—
amountnumberjsonIncluded—
currencystringjsonIncluded—
payment_typestringjsonIncluded—
payment_statusstringjsonIncluded—
sourcestringjsonIncluded—
checkoutstringjsonIncluded—
settlement_statusstringjsonIncluded—
payment_updated_atRFC 3339 stringjsonIncluded; nullable—
payment_linkstringjsonIncluded—
starts_atRFC 3339 stringjsonomitempty—
expires_atRFC 3339 stringjsonomitempty; nullable—
is_activebooleanjsonIncluded—
max_usesintegerjsonomitempty; nullable—
current_usesintegerjsonIncluded—
merchant_user_idUUID stringjsonIncluded—
merchant_namestringjsonomitempty; nullable—
company_namestringjsonomitempty; nullable—
merchant_logostringjsonomitempty; nullable—
logo_urlstringjsonomitempty; nullable—
merchant_addressstringjsonomitempty; nullable—
merchant_citystringjsonomitempty; nullable—
merchant_countrystringjsonomitempty; nullable—
merchant_emailstringjsonomitempty; nullable—
merchant_vat_numberstringjsonIncluded; nullable—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonIncluded—
is_expiredbooleanjsonIncluded—
is_availablebooleanjsonIncluded—
is_testbooleanjsonIncluded—
fiat_assetFiatAssetResponse objectjsonIncluded; nullable—
quoteQuotation objectjsonIncluded; nullable—
payersarray of PayerWithTransactionResponse objectjsonIncluded; nullable—
merchant_customerMerchantCustomerResponse objectjsonomitempty; nullable—
product_namestringjsonomitempty; nullable—
product_descriptionstringjsonomitempty; nullable—
order_idstringjsonomitempty; nullable—
invoice_numberstringjsonomitempty; nullable—
auto_fillbooleanjsonIncluded—
success_urlstringjsonomitempty; nullable—
cancel_urlstringjsonomitempty; nullable—
cartobjectjsonomitempty; nullable—
webhook_metadataobjectjsonomitempty; nullable—
order_public_idstringjsonomitempty—
order_referencestringjsonomitempty—
order_statusstringjsonomitempty—
order_payerstringjsonomitempty—
order_depositstringjsonomitempty—
order_payment_txstringjsonomitempty; nullable—
order_sweep_txstringjsonomitempty; nullable—
order_payout_idintegerjsonomitempty; nullable—
order_settle_venuestringjsonomitempty—
order_settle_pricestringjsonomitempty—
order_settle_amountstringjsonomitempty—
order_fee_bpsintegerjsonomitempty—
order_confirmed_atRFC 3339 stringjsonomitempty; nullable—
order_expiryRFC 3339 stringjsonomitempty; nullable—
order_quote_expiryRFC 3339 stringjsonomitempty; nullable—
order_walletOrderWalletResponse objectjsonomitempty; nullable—

PaymentLinkValidationResponse ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
is_validbooleanjsonIncluded—
is_expiredbooleanjsonIncluded—
is_availablebooleanjsonIncluded—
is_overpaidbooleanjsonIncluded—
payment_statusstringjsonIncluded—
starts_atRFC 3339 stringjsonomitempty—
expires_atRFC 3339 stringjsonomitempty; nullable—
amountnumberjsonIncluded—
currencystringjsonIncluded—
max_usesintegerjsonomitempty; nullable—
current_usesintegerjsonIncluded—
remaining_usesintegerjsonomitempty; nullable—
messagestringjsonIncluded—
networkstringjsonIncluded; nullable—
chain_idstringjsonIncluded; nullable—
token_addressstringjsonIncluded; nullable—
engine_statusstringjsonomitempty; nullable—
payment_txstringjsonomitempty; nullable—
expected_amountnumberjsonomitempty; nullable—
total_amount_receivednumberjsonomitempty; nullable—
amount_remainingnumberjsonomitempty; nullable—
excess_amountnumberjsonomitempty; nullable—
unconfirmed_amount_receivednumberjsonomitempty; nullable—
confirmationsintegerjsonomitempty; nullable—
required_confirmationsintegerjsonomitempty; nullable—
breakdownEngineQuoteBreakdown objectjsonomitempty; nullable—

CreatePayerRequest ​

FieldTypeBindingSerializationDeclared validation
namestringjsonIncludedrequired,min=1,max=100
emailstringjsonIncludedrequired,email,max=100
countrystringjsonomitempty; nullableomitempty,max=100
phonestringjsonomitempty; nullableomitempty,max=100
payment_link_idUUID stringjsonIncludedrequired

PayerResponse ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
namestringjsonIncluded—
emailstringjsonIncluded—
countrystringjsonomitempty; nullable—
phonestringjsonomitempty; nullable—
wallet_addressstringjsonomitempty; nullable—
ip_addressstringjsonomitempty; nullable—
regionstringjsonomitempty; nullable—
payment_link_idUUID stringjsonIncluded—
merchant_user_idUUID stringjsonIncluded—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonIncluded—

PaymentLinkPollingResponse ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
is_activebooleanjsonIncluded—
is_expiredbooleanjsonIncluded—
starts_atRFC 3339 stringjsonomitempty—
expires_atRFC 3339 stringjsonomitempty; nullable—
expected_amountnumberjsonIncluded—
total_amount_receivednumberjsonIncluded—
amount_remainingnumberjsonIncluded—
excess_amountnumberjsonomitempty; nullable—
is_overpaidbooleanjsonIncluded—
payment_statusstringjsonIncluded—
max_usesintegerjsonomitempty; nullable—
current_usesintegerjsonIncluded—
remaining_usesintegerjsonomitempty; nullable—
time_remainingstringjsonomitempty; nullable—
time_remaining_secondsintegerjsonomitempty; nullable—
is_availablebooleanjsonIncluded—
disputesarray of DisputePollResponse objectjsonomitempty; nullable—
tokenaddressstringjsonIncluded; nullable—
chainidstringjsonIncluded; nullable—
success_urlstringjsonomitempty; nullable—
cancel_urlstringjsonomitempty; nullable—
order_idstringjsonomitempty; nullable—
auto_fillbooleanjsonIncluded—
engine_statusstringjsonomitempty; nullable—
payment_txstringjsonomitempty; nullable—
unconfirmed_amount_receivednumberjsonomitempty; nullable—
confirmationsintegerjsonomitempty; nullable—
required_confirmationsintegerjsonomitempty; nullable—
breakdownEngineQuoteBreakdown objectjsonomitempty; nullable—

QuotationResponse ​

FieldTypeBindingSerializationDeclared validation
successbooleanjsonIncluded—
statusintegerjsonIncluded—
walletAddressstringjsonIncluded—
tokenAmountnumberjsonIncluded—
tokenAmountWithoutFeenumberjsonIncluded—
feePercentagenumberjsonIncluded—
feeAmountTokennumberjsonIncluded—
expiryTimeintegerjsonIncluded—
paymentexchangeRatenumberjsonIncluded—
tokenaddressstringjsonIncluded—
chainIdstringjsonIncluded—
hasTransactionsbooleanjsonIncluded—
totalAmountReceivednumberjsonIncluded—
amountRemainingnumberjsonIncluded—
isOverpaidbooleanjsonIncluded—
breakdownEngineQuoteBreakdown objectjsonomitempty; nullable—
engine_quoteJSON valuejsonomitempty—

EngineQuoteBreakdown ​

FieldTypeBindingSerializationDeclared validation
gross_amountstringjsonomitempty—
insurance_amountstringjsonomitempty—
fee_amountstringjsonomitempty—
fee_fixed_amountstringjsonomitempty—
gas_amountstringjsonomitempty—
pay_amountstringjsonomitempty—
fee_bpsintegerjsonIncluded—
taker_fee_bpsintegerjsonIncluded—
safety_margin_bpsintegerjsonIncluded—
raw_pricestringjsonomitempty—
final_pricestringjsonomitempty—
venuestringjsonomitempty—
gas_sidestringjsonomitempty—
gas_native_weistringjsonomitempty—
gas_ratestringjsonomitempty—

PaymentTransactionRequestV2 ​

FieldTypeBindingSerializationDeclared validation
payment_link_idUUID stringjsonIncludedrequired
total_amount_fiatnumberjsonomitempty; nullableomitempty,gte=0
total_amount_cryptonumberjsonIncludedrequired,gt=0
tx_hashstringjsonomitempty; nullable—
tx_hash_send_timeRFC 3339 stringjsonomitempty; nullable—
tx_confirmation_timeRFC 3339 stringjsonomitempty; nullable—
tx_blockintegerjsonomitempty; nullable—
network_idstringjsonIncludedrequired
network_namestringjsonIncludedrequired
decimalsintegerjsonIncludedrequired
payment_walletstringjsonIncludedrequired
emailstringjsonomitempty—
payment_currencystringjsonomitempty; nullable—
contract_addressstringjsonomitempty; nullable—
payer_idUUID stringjsonomitempty; nullable—
payment_typestringjsonomitempty; nullable—
statusstringjsonomitempty; nullable—

PaymentTransactionResponseV2 ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
payment_link_idUUID stringjsonIncluded—
total_amount_fiatnumberjsonomitempty; nullable—
total_amount_cryptonumberjsonIncluded—
tx_hashstringjsonomitempty; nullable—
tx_hash_send_timeRFC 3339 stringjsonomitempty; nullable—
tx_confirmation_timeRFC 3339 stringjsonomitempty; nullable—
tx_blockintegerjsonomitempty; nullable—
network_idstringjsonIncluded—
network_namestringjsonIncluded—
payment_currencystringjsonomitempty; nullable—
contract_addressstringjsonomitempty; nullable—
payerUUID stringjsonomitempty; nullable—
payment_typestringjsonomitempty; nullable—
statusstringjsonomitempty; nullable—
paymentwalletstringjsonomitempty; nullable—
paymentstatusstringjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonIncluded—

Engine checkout ​

payScreenOrder ​

FieldTypeBindingSerializationDeclared validation
link_idstringjsonIncluded—
statusstringjsonIncluded—
chain_idintegerjsonIncluded—
tokenstringjsonIncluded—
currencystringjsonIncluded—
pay_amountstringjsonIncluded—
depositstringjsonIncluded—
quote_expirystringjsonIncluded—
expirystringjsonIncluded—
observedstringjsonIncluded—
payment_txstringjsonomitempty—
simulatedbooleanjsonomitempty—
observed_lateststringjsonomitempty—
confirmationsintegerjsonIncluded—
required_confirmationsintegerjsonIncluded—

quoteRequest ​

FieldTypeBindingSerializationDeclared validation
chain_idintegerjsonIncluded—
tokenstringjsonomitempty—
assetstringjsonomitempty—

Checkout catalog ​

CatalogToken ​

FieldTypeBindingSerializationDeclared validation
tokenstringjsonIncluded—
symbolstringjsonIncluded—
decimalsintegerjsonIncluded—
currenciesarray of stringjsonIncluded; nullable—

CatalogChain ​

FieldTypeBindingSerializationDeclared validation
chain_idintegerjsonIncluded—
familystringjsonIncluded—
tokensarray of CatalogToken objectjsonIncluded; nullable—

Catalog ​

FieldTypeBindingSerializationDeclared validation
currenciesarray of stringjsonIncluded; nullable—
chainsarray of CatalogChain objectjsonIncluded; nullable—

OrderOptions ​

FieldTypeBindingSerializationDeclared validation
currenciesarray of stringjsonIncluded; nullable—
chainsarray of CatalogChain objectjsonIncluded; nullable—
lockedbooleanjsonIncluded—
notestringjsonIncluded—

Subscription plans ​

CreateSubscriptionPlanRequest ​

FieldTypeBindingSerializationDeclared validation
network_idUUID stringjsonIncluded—
currency_idUUID stringjsonIncluded—
merchantstringjsonIncludedrequired
destinationstringjsonIncludedrequired
tokenstringjsonIncluded—
currencystringjsonIncluded—
amountstringjsonIncluded—
valuestringjsonIncluded—
periodintegerjsonIncluded—
intervalintegerjsonIncludedrequired
trial_periodintegerjsonIncluded—
max_arrearsintegerjsonIncludedrequired,min=1
auto_cancel_after_missedintegerjsonIncluded—
subscribe_deadlineintegerjsonIncluded—
plan_nonceintegerjsonIncludedrequired
merchant_sigstringjsonIncludedrequired
metadata_uristringjsonIncluded—
namestringjsonIncludedrequired
descriptionstringjsonIncluded—
kindstringjsonIncluded—

UpdateSubscriptionPlanRequest ​

FieldTypeBindingSerializationDeclared validation
namestringjsonIncluded; nullable—
metadata_uristringjsonIncluded; nullable—
statusstringjsonIncluded—

NetworkResponse ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
namestringjsonIncluded—
chain_idintegerjsonomitempty; nullable—
symbolstringjsonomitempty; nullable—
is_activebooleanjsonIncluded—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonIncluded—

SubscriptionLinkSummary ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
statusstringjsonIncluded—
wallet_addressstringjsonomitempty; nullable—
customer_idstringjsonomitempty; nullable—
customer_emailstringjsonomitempty; nullable—
customer_namestringjsonomitempty; nullable—
subscribed_atRFC 3339 stringjsonomitempty; nullable—
trial_ends_atRFC 3339 stringjsonomitempty; nullable—
expires_atRFC 3339 stringjsonomitempty; nullable—
last_payment_atRFC 3339 stringjsonomitempty; nullable—
last_payment_tx_hashstringjsonomitempty; nullable—
failed_attemptsintegerjsonIncluded—
is_activebooleanjsonIncluded—
transaction_countintegerjsonIncluded—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonIncluded—

SubscriptionPlanResponse ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
merchant_idUUID stringjsonIncluded—
network_idUUID stringjsonIncluded—
chain_idintegerjsonIncluded—
networkNetworkResponse objectjsonomitempty; nullable—
merchant_addressstringjsonIncluded—
destination_addressstringjsonIncluded—
tokenstringjsonomitempty—
currency_idUUID stringjsonomitempty; nullable—
currencystringjsonomitempty—
currency_symbolstringjsonomitempty—
amountstringjsonIncluded—
formatted_amountstringjsonIncluded—
intervalintegerjsonIncluded—
trial_periodintegerjsonIncluded—
max_arrearsintegerjsonIncluded—
auto_cancel_after_missedintegerjsonIncluded—
subscribe_deadlineintegerjsonIncluded—
plan_nonceintegerjsonIncluded—
plan_idstringjsonomitempty—
digeststringjsonomitempty—
revokedbooleanjsonIncluded—
sourcestringjsonomitempty—
metadata_uristringjsonIncluded—
namestringjsonIncluded—
descriptionstringjsonIncluded—
is_deprecatedbooleanjsonIncluded—
deprecated_atRFC 3339 stringjsonomitempty; nullable—
statusstringjsonIncluded—
total_subscribersintegerjsonIncluded—
active_subscribersintegerjsonIncluded—
trial_subscribersintegerjsonIncluded—
failed_subscribersintegerjsonIncluded—
subscribersarray of SubscriberWithLinkResponse objectjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonIncluded—

SubscriptionPlanListResponse ​

FieldTypeBindingSerializationDeclared validation
plansarray of SubscriptionPlanResponse objectjsonIncluded; nullable—
totalintegerjsonIncluded—
pageintegerjsonIncluded—
page_sizeintegerjsonIncluded—
total_pagesintegerjsonIncluded—

SubscriptionPlanListRequest ​

FieldTypeBindingSerializationDeclared validation
pageintegerqueryIncluded—
page_sizeintegerqueryIncluded—
searchstringqueryIncluded—
deprecatedbooleanqueryIncluded; nullable—
start_dateRFC 3339 stringqueryIncluded; nullable—
end_dateRFC 3339 stringqueryIncluded; nullable—
SortOrderstringjsonIncluded—

Subscription enrollment ​

ApprovalDetail ​

FieldTypeBindingSerializationDeclared validation
approval_hashstringjsonIncludedomitempty
token_addressstringjsonIncludedrequired
amount_approvedstringjsonIncludedrequired
network_namestringjsonIncludedrequired
chain_idintegerjsonIncludedrequired
decimalsintegerjsonIncludedrequired

CreateSubscriptionLinkRequest ​

FieldTypeBindingSerializationDeclared validation
subscription_plan_idUUID stringjsonIncludedrequired
subscriber_idUUID stringjsonomitempty; nullable—
subscription_onchain_idintegerjsonIncluded; nullable—
subscribed_atRFC 3339 stringjsonIncluded; nullable—
trial_ends_atRFC 3339 stringjsonIncluded; nullable—
wallet_addressstringjsonIncludedrequired
subscribe_hashstringjsonIncludedrequired
owedstringjsonIncluded—
paid_periodsintegerjsonIncluded—
lockedbooleanjsonIncluded—
approvalsarray of ApprovalDetail objectjsonIncluded; nullablerequired,min=1,dive
customer_idstringjsonIncluded; nullable—
customer_emailstringjsonIncluded; nullable—
customer_namestringjsonIncluded; nullable—
expires_atRFC 3339 stringjsonIncluded; nullable—

UpdateSubscriptionLinkRequest ​

FieldTypeBindingSerializationDeclared validation
trial_ends_atRFC 3339 stringjsonIncluded; nullable—
customer_emailstringjsonIncluded; nullable—
customer_namestringjsonIncluded; nullable—
expires_atRFC 3339 stringjsonIncluded; nullable—
is_activebooleanjsonIncluded; nullable—
lockedbooleanjsonIncluded; nullable—
owedstringjsonIncluded—

SubscriptionLinkListRequest ​

FieldTypeBindingSerializationDeclared validation
pageintegerqueryIncluded—
page_sizeintegerqueryIncluded—
searchstringqueryIncluded—
is_activebooleanqueryIncluded; nullable—
plan_idUUID stringqueryIncluded; nullable—
start_dateRFC 3339 stringqueryIncluded; nullable—
end_dateRFC 3339 stringqueryIncluded; nullable—

SubscriptionPlanSummary ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
namestringjsonIncluded—
plan_idstringjsonIncluded—
amountstringjsonIncluded—
tokenstringjsonIncluded—
billing_periodintegerjsonIncluded—
trial_periodintegerjsonIncluded—
is_deprecatedbooleanjsonIncluded—

SubscriptionLinkResponse ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
merchant_user_idUUID stringjsonIncluded—
subscription_plan_idUUID stringjsonIncluded—
subscribed_atRFC 3339 stringjsonomitempty; nullable—
trial_ends_atRFC 3339 stringjsonomitempty; nullable—
wallet_addressstringjsonomitempty; nullable—
subscribe_hashstringjsonomitempty; nullable—
approvalsarray of ApprovalDetail objectjsonomitempty; nullable—
owedstringjsonIncluded—
paid_periodsintegerjsonIncluded—
lockedbooleanjsonIncluded—
customer_idstringjsonomitempty; nullable—
customer_emailstringjsonomitempty; nullable—
customer_namestringjsonomitempty; nullable—
expires_atRFC 3339 stringjsonomitempty; nullable—
is_activebooleanjsonIncluded—
subscription_transactionsarray of SubscriptionResponse objectjsonomitempty; nullable—
planSubscriptionPlanSummary objectjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonIncluded—

SubscriptionLinkListResponse ​

FieldTypeBindingSerializationDeclared validation
linksarray of SubscriptionLinkResponse objectjsonIncluded; nullable—
totalintegerjsonIncluded—
pageintegerjsonIncluded—
page_sizeintegerjsonIncluded—
total_pagesintegerjsonIncluded—

RecordSubscriptionPaymentRequest ​

FieldTypeBindingSerializationDeclared validation
sub_link_idUUID stringjsonIncludedrequired
merchant_keystringjsonIncludedrequired
tx_hashstringjsonIncludedrequired
block_numberintegerjsonomitempty; nullable—
block_hashstringjsonomitempty; nullable—
network_idUUID stringjsonIncludedrequired
currency_idUUID stringjsonIncludedrequired
amount_paidstringjsonIncludedrequired
wallet_usedstringjsonIncludedrequired

SubscriptionResponse ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
merchant_idUUID stringjsonIncluded—
sub_link_idUUID stringjsonIncluded—
tx_hashstringjsonIncluded—
block_numberintegerjsonomitempty; nullable—
block_hashstringjsonomitempty; nullable—
confirmationsintegerjsonIncluded—
currency_idUUID stringjsonIncluded—
network_idUUID stringjsonIncluded—
amountstringjsonIncluded—
user_wallet_addressstringjsonIncluded—
paid_atRFC 3339 stringjsonomitempty; nullable—
statusstringjsonIncluded—
starts_atRFC 3339 stringjsonIncluded—
ends_atRFC 3339 stringjsonomitempty; nullable—
next_billing_atRFC 3339 stringjsonomitempty; nullable—
planSubscriptionLinkResponse objectjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonIncluded—

CreateSubscriberRequest ​

FieldTypeBindingSerializationDeclared validation
subscription_plan_idUUID stringjsonIncludedrequired
customer_idstringjsonomitempty; nullableomitempty,max=100
customer_namestringjsonomitempty; nullableomitempty,max=255
customer_emailstringjsonomitempty; nullableomitempty,email,max=255
webhook_metadataobjectjsonomitempty; nullable—
failure_return_urlstringjsonomitempty; nullable—
success_return_urlstringjsonomitempty; nullable—

SubscriberResponse ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
subscription_plan_idUUID stringjsonIncluded—
merchant_user_idUUID stringjsonIncluded—
customer_idstringjsonomitempty; nullable—
customer_namestringjsonomitempty; nullable—
customer_emailstringjsonomitempty; nullable—
subscription_link_urlstringjsonIncluded—
statusstringjsonIncluded; nullable—
subscription_planSubscriptionPlan objectjsonomitempty; nullable—
subscription_linkSubscriptionLink objectjsonomitempty; nullable—
webhook_metadataobjectjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonIncluded—

SubscriberListRequest ​

FieldTypeBindingSerializationDeclared validation
plan_idUUID stringqueryIncluded; nullable—
searchstringqueryIncluded—
start_dateRFC 3339 stringqueryIncluded; nullable—
end_dateRFC 3339 stringqueryIncluded; nullable—
pageintegerqueryIncluded—
page_sizeintegerqueryIncluded—
sort_orderstringqueryIncluded—

UpdateSubscriberRequest ​

FieldTypeBindingSerializationDeclared validation
customer_namestringjsonomitempty; nullable—
customer_emailstringjsonomitempty; nullable—
statusstringjsonomitempty; nullable—

SubscriberListResponse ​

FieldTypeBindingSerializationDeclared validation
subscribersarray of SubscriberResponse objectjsonIncluded; nullable—
dataarray of Subscriber objectjsonIncluded; nullable—
totalintegerjsonIncluded—
pageintegerjsonIncluded—
page_sizeintegerjsonIncluded—
total_pagesintegerjsonIncluded—

InvitationListResponse ​

FieldTypeBindingSerializationDeclared validation
invitationsarray of SubscriberResponse objectjsonIncluded; nullable—
dataarray of Subscriber objectjsonIncluded; nullable—
totalintegerjsonIncluded—
pageintegerjsonIncluded—
page_sizeintegerjsonIncluded—
total_pagesintegerjsonIncluded—

SubscriberWithLinkResponse ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
subscription_plan_idUUID stringjsonIncluded—
merchant_user_idUUID stringjsonIncluded—
customer_idstringjsonomitempty; nullable—
customer_namestringjsonomitempty; nullable—
customer_emailstringjsonomitempty; nullable—
subscription_linkSubscriptionLinkSummary objectjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonIncluded—

SubscriptionMetaAttribute ​

FieldTypeBindingSerializationDeclared validation
trait_typestringjsonIncluded—
valuestringjsonIncluded—

SubscriptionMetaResponse ​

FieldTypeBindingSerializationDeclared validation
namestringjsonIncluded—
descriptionstringjsonIncluded—
imagestringjsonomitempty—
external_urlstringjsonomitempty—
attributesarray of SubscriptionMetaAttribute objectjsonIncluded; nullable—

Subscription preparation ​

PrepareToken ​

FieldTypeBindingSerializationDeclared validation
addressstringjsonIncluded—
symbolstringjsonIncluded—
decimalsintegerjsonIncluded—
quotablebooleanjsonIncluded—
pricestringjsonomitempty—
amountstringjsonomitempty—
errorstringjsonomitempty—

PrepareNetwork ​

FieldTypeBindingSerializationDeclared validation
chain_idintegerjsonIncluded—
tokensarray of PrepareToken objectjsonIncluded; nullable—

PrepareSubscriptionResponse ​

FieldTypeBindingSerializationDeclared validation
subscriber_idUUID stringjsonIncluded—
plan_idUUID stringjsonIncluded—
wallet_addressstringjsonIncluded—
currencystringjsonIncluded—
valuestringjsonIncluded—
networksarray of PrepareNetwork objectjsonIncluded; nullable—

Stored subscriber model ​

Subscriber ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
subscription_plan_idUUID stringjsonIncluded—
merchant_user_idUUID stringjsonIncluded—
customer_idstringjsonomitempty; nullable—
customer_namestringjsonomitempty; nullable—
customer_emailstringjsonomitempty; nullable—
StatusstringjsonIncluded; nullable—
WebhookMetadataJSON valuejsonIncluded—
failure_return_urlstringjsonomitempty; nullable—
success_return_urlstringjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonIncluded—
subscription_linkSubscriptionLink objectjsonomitempty; nullable—
subscription_planSubscriptionPlan objectjsonomitempty; nullable—
FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
merchant_user_idUUID stringjsonIncluded—
subscription_plan_idUUID stringjsonIncluded—
subscriber_idUUID stringjsonomitempty; nullable—
subscribed_atRFC 3339 stringjsonomitempty; nullable—
trial_ends_atRFC 3339 stringjsonomitempty; nullable—
wallet_addressstringjsonomitempty; nullable—
subscribe_hashstringjsonomitempty; nullable—
Approvalsarray of ApprovalDetail objectsjsonIncluded; nullable—
approved_contractstringjsonomitempty; nullable—
subscription_onchain_idintegerjsonomitempty; nullable—
owedstringjsonIncluded—
paid_periodsintegerjsonIncluded—
lockedbooleanjsonIncluded—
statusstringjsonIncluded—
last_payment_atRFC 3339 stringjsonomitempty; nullable—
last_payment_tx_hashstringjsonomitempty; nullable—
failed_attemptsintegerjsonIncluded—
next_billing_atRFC 3339 stringjsonIncluded; nullable—
next_retry_atRFC 3339 stringjsonIncluded; nullable—
error_messagestringjsonomitempty; nullable—
customer_idstringjsonomitempty; nullable—
customer_emailstringjsonomitempty; nullable—
customer_namestringjsonomitempty; nullable—
webhook_metadataJSON valuejsonomitempty—
expires_atRFC 3339 stringjsonomitempty; nullable—
is_activebooleanjsonIncluded—
is_on_trialbooleanjsonIncluded; nullable—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonIncluded—
subscription_planSubscriptionPlan objectjsonomitempty; nullable—
subscriberSubscriber objectjsonomitempty; nullable—
subscription_transactionsarray of SubscriptionPayment objectjsonomitempty; nullable—

Webhook management ​

CreateWebhookRequest ​

FieldTypeBindingSerializationDeclared validation
urlstringjsonIncludedrequired,url
secretstringjsonomitempty; nullable—
event_subscriptionsarray of CreateEventSubscriptionItem objectjsonomitempty; nullable—

CreateEventSubscriptionItem ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncludedrequired
is_activebooleanjsonIncluded—

UpdateWebhookRequest ​

FieldTypeBindingSerializationDeclared validation
urlstringjsonIncluded; nullableomitempty,url
secretstringjsonomitempty; nullable—
is_activebooleanjsonomitempty; nullable—
event_idsarray of UUID stringjsonomitempty; nullable—
event_subscriptionsarray of CreateEventSubscriptionItem objectjsonomitempty; nullable—

WebhookEventSubscriptionResponse ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
event_idUUID stringjsonIncluded—
is_activebooleanjsonIncluded—
created_atRFC 3339 stringjsonIncluded—
eventEventResponse objectjsonomitempty; nullable—

EventResponse ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
codestringjsonIncluded—
descriptionstringjsonIncluded—
sourcestringjsonIncluded—
is_activebooleanjsonIncluded—
created_atRFC 3339 stringjsonIncluded—

WebhookResponse ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
urlstringjsonIncluded—
secretstringjsonomitempty; nullable—
is_activebooleanjsonIncluded—
event_subscriptionsarray of WebhookEventSubscriptionResponse objectjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—
updated_atRFC 3339 stringjsonomitempty; nullable—

WebhookListResponse ​

FieldTypeBindingSerializationDeclared validation
webhooksarray of WebhookResponse objectjsonIncluded; nullable—
totalintegerjsonIncluded—
pageintegerjsonIncluded—
page_sizeintegerjsonIncluded—
total_pagesintegerjsonIncluded—
shared_secretstringjsonomitempty; nullable—

WebhookDeleteResponse ​

FieldTypeBindingSerializationDeclared validation
successbooleanjsonIncluded—
messagestringjsonomitempty—
deleted_idUUID stringjsonIncluded—

RegenerateSecretResponse ​

FieldTypeBindingSerializationDeclared validation
successbooleanjsonIncluded—
secretstringjsonIncluded—
messagestringjsonIncluded—

ValidateSecretRequest ​

FieldTypeBindingSerializationDeclared validation
secretstringjsonIncludedrequired

ValidateSecretResponse ​

FieldTypeBindingSerializationDeclared validation
validbooleanjsonIncluded—
messagestringjsonIncluded—

BulkToggleWebhookSubscriptionsRequest ​

FieldTypeBindingSerializationDeclared validation
webhook_idUUID stringjsonIncludedrequired
subscriptionsarray of SubscriptionToggleItem objectjsonIncluded; nullablerequired,min=1

SubscriptionToggleItem ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncludedrequired
is_activebooleanjsonIncluded—

BulkToggleWebhookSubscriptionsResponse ​

FieldTypeBindingSerializationDeclared validation
successbooleanjsonIncluded—
messagestringjsonIncluded—
updated_countintegerjsonIncluded—
updated_itemsarray of SubscriptionToggleItem objectjsonIncluded; nullable—

WebhookActivityLog ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
webhook_idUUID stringjsonIncluded—
webhook_urlstringjsonIncluded—
event_typestringjsonIncluded—
actionstringjsonIncluded—
descriptionstringjsonIncluded—
statusstringjsonIncluded—
attemptsintegerjsonIncluded—
last_attempt_atRFC 3339 stringjsonomitempty; nullable—
scheduled_atRFC 3339 stringjsonIncluded—
payloadJSON valuejsonomitempty—
delivery_attemptsarray of WebhookDeliveryAttempt objectjsonomitempty; nullable—
created_atRFC 3339 stringjsonIncluded—

WebhookDeliveryAttempt ​

FieldTypeBindingSerializationDeclared validation
idUUID stringjsonIncluded—
attempt_numberintegerjsonIncluded—
http_statusintegerjsonomitempty; nullable—
successbooleanjsonIncluded—
error_messagestringjsonomitempty; nullable—
request_payloadJSON valuejsonomitempty—
response_payloadJSON valuejsonomitempty—
created_atRFC 3339 stringjsonIncluded—

WebhookActivityResponse ​

FieldTypeBindingSerializationDeclared validation
activitiesarray of WebhookActivityLog objectjsonIncluded; nullable—
totalintegerjsonIncluded—
pageintegerjsonIncluded—
page_sizeintegerjsonIncluded—
total_pagesintegerjsonIncluded—

RegisterNotificationRequest ​

FieldTypeBindingSerializationDeclared validation
event_codestringjsonIncludedrequired
payloadobjectjsonIncluded; nullablerequired
channelsarray of stringjsonomitempty; nullable—

RegisterNotificationResponse ​

FieldTypeBindingSerializationDeclared validation
successbooleanjsonIncluded—
messagestringjsonIncluded—
event_codestringjsonIncluded—
triggered_channelsarray of stringjsonIncluded; nullable—
job_idsobjectjsonIncluded; nullable—

AcknowledgeWebhookRequest ​

FieldTypeBindingSerializationDeclared validation
job_idstringjsonIncludedrequired
status_codeintegerjsonIncludedrequired,min=200,max=599
responsestringjsonomitempty—

AcknowledgeWebhookResponse ​

FieldTypeBindingSerializationDeclared validation
successbooleanjsonIncluded—
messagestringjsonIncluded—
job_idstringjsonIncluded—

PollingInfo ​

FieldTypeBindingSerializationDeclared validation
next_poll_afterRFC 3339 stringjsonIncluded—
recommended_wait_msintegerjsonIncluded—

WebhookEventPayload ​

FieldTypeBindingSerializationDeclared validation
idstringjsonIncluded—
event_typestringjsonIncluded—
event_idstringjsonIncluded—
timestampstringjsonIncluded—
dataobjectjsonIncluded; nullable—

WebhookPollingEvent ​

FieldTypeBindingSerializationDeclared validation
attempt_idstringjsonIncluded—
webhook_idstringjsonIncluded—
webhook_urlstringjsonIncluded—
statusstringjsonIncluded—
attempt_numberintegerjsonIncluded—
http_statusintegerjsonomitempty; nullable—
error_messagestringjsonomitempty; nullable—
payloadWebhookEventPayload objectjsonIncluded—
sent_atRFC 3339 stringjsonIncluded—
response_bodyJSON valuejsonomitempty—

WebhookEventsPollingResponse ​

FieldTypeBindingSerializationDeclared validation
has_new_eventsbooleanjsonIncluded—
eventsarray of WebhookPollingEvent objectjsonIncluded; nullable—
countintegerjsonIncluded—
latest_atRFC 3339 stringjsonomitempty; nullable—
polling_infoPollingInfo objectjsonIncluded—