Files
sdk/docs/X402Receipt.md

12 KiB

X402Receipt

Properties

Name Type Description Notes
Amount Pointer to string Amount is what actually moved, as an exact 18-decimal-place USD string. It is NOT the atomic-unit figure the client signed: the challenge quotes the asset's own units (USDC's 6 dp) and truncates to fit them, while the ledger moves this exact value. [optional]
Category Pointer to string Category is what the payment was for — service, goods, transfer or royalty — as the price table said it: a tool call is a service, a job is what its parties agreed. [optional]
From Pointer to string From is the payer's EVM address: the account that signed the EIP-3009 authorization, recovered from the signature rather than taken on trust. [optional]
Id Pointer to string ID is the settle-once key: "x402_" + keccak(from nonce) in hex. It is DERIVED, not minted, so a client that re-submits the same authorization addresses the same settlement and is served again for free rather than charged twice. It is also the id GET /v1/x402/settlements/:id takes.
Network Pointer to string Network is the CAIP-2 identifier the payment was settled under, e.g. "eip155:36963". Its eip155 reference is the chain id in the EIP-712 domain the payer signed, so it is not a label — changing it invalidates the signature. [optional]
Nonce Pointer to string Nonce is the client-chosen nonce from the authorization, hex — up to 32 bytes, left-padded to the contract's bytes32. It is the replay anchor: the token contract refuses a second on-chain transfer for one (from, nonce), and this rail refuses a second settlement for the same pair, so a ledger settlement inherits the identical guarantee. [optional]
Payee Pointer to string Payee is the recipient's EVM address — the `payTo` the challenge advertised and the authorization named. A payment to any other address never settles. [optional]
PayeeOrg Pointer to string PayeeOrg is the tenant that owns the recipient wallet, resolved at settlement. It is who got PAID, as Payer is who paid. [optional]
Payer Pointer to string Payer is the payer ORG — the tenant whose ledger was debited — and not an address. It is the org the request was authenticated as, so it answers who is billed, which the payer address alone cannot. [optional]
Resource Pointer to string Resource is what was paid for, in the same spelling the price table and the challenge used: the request path for a priced route, &quot;tool:<id>&quot; for a priced tool. [optional]
SettledAt Pointer to int64 SettledAt is when this settlement was CLAIMED, in unix seconds — the moment the authorization was accepted, which is also the moment the time window it carried stopped applying. A settlement finished later by reconciliation keeps this instant. [optional]
SettledVia Pointer to string SettledVia is which rail moved the money: &quot;ledger&quot;, the live default, or &quot;chain&quot; when the authorization is broadcast. Those two values and no others. [optional]
TxHash Pointer to string TxHash is the chain transaction hash, present only for a &quot;chain&quot; settlement. Empty on a ledger settlement — that is the normal case today, and it means the money moved without a chain, not that it failed. The wire's PAYMENT-RESPONSE `transaction` falls back to ID when this is empty. [optional]

Methods

NewX402Receipt

func NewX402Receipt() *X402Receipt

NewX402Receipt instantiates a new X402Receipt object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewX402ReceiptWithDefaults

func NewX402ReceiptWithDefaults() *X402Receipt

NewX402ReceiptWithDefaults instantiates a new X402Receipt object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetAmount

func (o *X402Receipt) GetAmount() string

GetAmount returns the Amount field if non-nil, zero value otherwise.

GetAmountOk

func (o *X402Receipt) GetAmountOk() (*string, bool)

GetAmountOk returns a tuple with the Amount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAmount

func (o *X402Receipt) SetAmount(v string)

SetAmount sets Amount field to given value.

HasAmount

func (o *X402Receipt) HasAmount() bool

HasAmount returns a boolean if a field has been set.

GetCategory

func (o *X402Receipt) GetCategory() string

GetCategory returns the Category field if non-nil, zero value otherwise.

GetCategoryOk

func (o *X402Receipt) GetCategoryOk() (*string, bool)

GetCategoryOk returns a tuple with the Category field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCategory

func (o *X402Receipt) SetCategory(v string)

SetCategory sets Category field to given value.

HasCategory

func (o *X402Receipt) HasCategory() bool

HasCategory returns a boolean if a field has been set.

GetFrom

func (o *X402Receipt) GetFrom() string

GetFrom returns the From field if non-nil, zero value otherwise.

GetFromOk

func (o *X402Receipt) GetFromOk() (*string, bool)

GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetFrom

func (o *X402Receipt) SetFrom(v string)

SetFrom sets From field to given value.

HasFrom

func (o *X402Receipt) HasFrom() bool

HasFrom returns a boolean if a field has been set.

GetId

func (o *X402Receipt) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *X402Receipt) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *X402Receipt) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *X402Receipt) HasId() bool

HasId returns a boolean if a field has been set.

GetNetwork

func (o *X402Receipt) GetNetwork() string

GetNetwork returns the Network field if non-nil, zero value otherwise.

GetNetworkOk

func (o *X402Receipt) GetNetworkOk() (*string, bool)

GetNetworkOk returns a tuple with the Network field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetNetwork

func (o *X402Receipt) SetNetwork(v string)

SetNetwork sets Network field to given value.

HasNetwork

func (o *X402Receipt) HasNetwork() bool

HasNetwork returns a boolean if a field has been set.

GetNonce

func (o *X402Receipt) GetNonce() string

GetNonce returns the Nonce field if non-nil, zero value otherwise.

GetNonceOk

func (o *X402Receipt) GetNonceOk() (*string, bool)

GetNonceOk returns a tuple with the Nonce field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetNonce

func (o *X402Receipt) SetNonce(v string)

SetNonce sets Nonce field to given value.

HasNonce

func (o *X402Receipt) HasNonce() bool

HasNonce returns a boolean if a field has been set.

GetPayee

func (o *X402Receipt) GetPayee() string

GetPayee returns the Payee field if non-nil, zero value otherwise.

GetPayeeOk

func (o *X402Receipt) GetPayeeOk() (*string, bool)

GetPayeeOk returns a tuple with the Payee field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPayee

func (o *X402Receipt) SetPayee(v string)

SetPayee sets Payee field to given value.

HasPayee

func (o *X402Receipt) HasPayee() bool

HasPayee returns a boolean if a field has been set.

GetPayeeOrg

func (o *X402Receipt) GetPayeeOrg() string

GetPayeeOrg returns the PayeeOrg field if non-nil, zero value otherwise.

GetPayeeOrgOk

func (o *X402Receipt) GetPayeeOrgOk() (*string, bool)

GetPayeeOrgOk returns a tuple with the PayeeOrg field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPayeeOrg

func (o *X402Receipt) SetPayeeOrg(v string)

SetPayeeOrg sets PayeeOrg field to given value.

HasPayeeOrg

func (o *X402Receipt) HasPayeeOrg() bool

HasPayeeOrg returns a boolean if a field has been set.

GetPayer

func (o *X402Receipt) GetPayer() string

GetPayer returns the Payer field if non-nil, zero value otherwise.

GetPayerOk

func (o *X402Receipt) GetPayerOk() (*string, bool)

GetPayerOk returns a tuple with the Payer field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPayer

func (o *X402Receipt) SetPayer(v string)

SetPayer sets Payer field to given value.

HasPayer

func (o *X402Receipt) HasPayer() bool

HasPayer returns a boolean if a field has been set.

GetResource

func (o *X402Receipt) GetResource() string

GetResource returns the Resource field if non-nil, zero value otherwise.

GetResourceOk

func (o *X402Receipt) GetResourceOk() (*string, bool)

GetResourceOk returns a tuple with the Resource field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetResource

func (o *X402Receipt) SetResource(v string)

SetResource sets Resource field to given value.

HasResource

func (o *X402Receipt) HasResource() bool

HasResource returns a boolean if a field has been set.

GetSettledAt

func (o *X402Receipt) GetSettledAt() int64

GetSettledAt returns the SettledAt field if non-nil, zero value otherwise.

GetSettledAtOk

func (o *X402Receipt) GetSettledAtOk() (*int64, bool)

GetSettledAtOk returns a tuple with the SettledAt field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSettledAt

func (o *X402Receipt) SetSettledAt(v int64)

SetSettledAt sets SettledAt field to given value.

HasSettledAt

func (o *X402Receipt) HasSettledAt() bool

HasSettledAt returns a boolean if a field has been set.

GetSettledVia

func (o *X402Receipt) GetSettledVia() string

GetSettledVia returns the SettledVia field if non-nil, zero value otherwise.

GetSettledViaOk

func (o *X402Receipt) GetSettledViaOk() (*string, bool)

GetSettledViaOk returns a tuple with the SettledVia field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSettledVia

func (o *X402Receipt) SetSettledVia(v string)

SetSettledVia sets SettledVia field to given value.

HasSettledVia

func (o *X402Receipt) HasSettledVia() bool

HasSettledVia returns a boolean if a field has been set.

GetTxHash

func (o *X402Receipt) GetTxHash() string

GetTxHash returns the TxHash field if non-nil, zero value otherwise.

GetTxHashOk

func (o *X402Receipt) GetTxHashOk() (*string, bool)

GetTxHashOk returns a tuple with the TxHash field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTxHash

func (o *X402Receipt) SetTxHash(v string)

SetTxHash sets TxHash field to given value.

HasTxHash

func (o *X402Receipt) HasTxHash() bool

HasTxHash returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]