api

type Amount struct {
	// AssetCode The assetCode is a code that indicates the underlying asset. An ISO4217 currency code should be used whenever possible. The ISO4217 representation of the US Dollar is USD.
	AssetCode string `json:"assetCode"`

	// AssetScale The number of decimal places that defines the scale of the smallest divisible unit for the given asset code. It determines how an integer amount is scaled to derive the actual monetary value. For example, USD has an asset scale of 2 with the smallest unit being 0.01. An integer amount of `1000` with an `assetCode` of `USD` and `assetScale` of `2` translates to $10.00.
	AssetScale int `json:"assetScale"`

	// Value The value is an unsigned 64-bit integer amount, represented as a string.
	Value string `json:"value"`
}

type CompleteIncomingPaymentParams struct {
	// SignatureInput The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message.  Each member describes a single message signature.  The member's key is the label that uniquely identifies the message signature within the context of the HTTP message.  The member's value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label.  The following components MUST be included: - "@method" - "@target-uri" - "authorization".  When the message contains a request body, the covered components MUST also include the following: - "content-digest"  The keyid parameter of the signature MUST be set to the kid value of the JWK.      See [ietf-httpbis-message-signatures](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures#section-4.1) for more details.
	SignatureInput SignatureInput `json:"Signature-Input"`

	// Signature The signature generated based on the Signature-Input, using the signing algorithm specified in the "alg" field of the JWK.
	Signature Signature `json:"Signature"`
}

type CreateIncomingPaymentJSONRequestBody = CreateIncomingPaymentRequest

type CreateIncomingPaymentParams struct {
	// SignatureInput The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message.  Each member describes a single message signature.  The member's key is the label that uniquely identifies the message signature within the context of the HTTP message.  The member's value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label.  The following components MUST be included: - "@method" - "@target-uri" - "authorization".  When the message contains a request body, the covered components MUST also include the following: - "content-digest"  The keyid parameter of the signature MUST be set to the kid value of the JWK.      See [ietf-httpbis-message-signatures](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures#section-4.1) for more details.
	SignatureInput SignatureInput `json:"Signature-Input"`

	// Signature The signature generated based on the Signature-Input, using the signing algorithm specified in the "alg" field of the JWK.
	Signature Signature `json:"Signature"`
}

type CreateIncomingPaymentRequest struct {
	// ExpiresAt The date and time when payments into the incoming payment must no longer be accepted.
	ExpiresAt      *time.Time `json:"expiresAt,omitempty"`
	IncomingAmount *Amount    `json:"incomingAmount,omitempty"`

	// Metadata Additional metadata associated with the incoming payment. (Optional)
	Metadata *map[string]interface{} `json:"metadata,omitempty"`

	// WalletAddressSchema The URL of an Open Payments wallet address
	WalletAddressSchema WalletAddressSchema `json:"walletAddress"`
}

type CreateOutgoingPaymentJSONRequestBody = CreateOutgoingPaymentRequest

type CreateOutgoingPaymentParams struct {
	// SignatureInput The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message.  Each member describes a single message signature.  The member's key is the label that uniquely identifies the message signature within the context of the HTTP message.  The member's value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label.  The following components MUST be included: - "@method" - "@target-uri" - "authorization".  When the message contains a request body, the covered components MUST also include the following: - "content-digest"  The keyid parameter of the signature MUST be set to the kid value of the JWK.      See [ietf-httpbis-message-signatures](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures#section-4.1) for more details.
	SignatureInput SignatureInput `json:"Signature-Input"`

	// Signature The signature generated based on the Signature-Input, using the signing algorithm specified in the "alg" field of the JWK.
	Signature Signature `json:"Signature"`
}

type CreateOutgoingPaymentRequest struct {
	// contains filtered or unexported fields
}

type CreateOutgoingPaymentRequestFromIncomingPayment struct {
	DebitAmount Amount `json:"debitAmount"`

	// IncomingPayment The URL of the incoming payment this outgoing payment will fulfill.
	IncomingPayment string `json:"incomingPayment"`

	// Metadata Additional metadata associated with the outgoing payment. (Optional)
	Metadata *map[string]interface{} `json:"metadata,omitempty"`

	// WalletAddressSchema The URL of an Open Payments wallet address
	WalletAddressSchema WalletAddressSchema `json:"walletAddress"`
}

type CreateOutgoingPaymentRequestFromQuote struct {
	// Metadata Additional metadata associated with the outgoing payment. (Optional)
	Metadata *map[string]interface{} `json:"metadata,omitempty"`

	// QuoteId The URL of the quote defining this payment's amounts.
	QuoteId string `json:"quoteId"`

	// WalletAddressSchema The URL of an Open Payments wallet address
	WalletAddressSchema WalletAddressSchema `json:"walletAddress"`
}

type CreateQuoteJSONRequestBody = CreateQuoteRequest

type CreateQuoteParams struct {
	// SignatureInput The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message.  Each member describes a single message signature.  The member's key is the label that uniquely identifies the message signature within the context of the HTTP message.  The member's value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label.  The following components MUST be included: - "@method" - "@target-uri" - "authorization".  When the message contains a request body, the covered components MUST also include the following: - "content-digest"  The keyid parameter of the signature MUST be set to the kid value of the JWK.      See [ietf-httpbis-message-signatures](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures#section-4.1) for more details.
	SignatureInput SignatureInput `json:"Signature-Input"`

	// Signature The signature generated based on the Signature-Input, using the signing algorithm specified in the "alg" field of the JWK.
	Signature Signature `json:"Signature"`
}

type CreateQuoteRequest struct {
	// contains filtered or unexported fields
}

type CreateQuoteRequestByReceiver struct {
	Method PaymentMethod `json:"method"`

	// Receiver The URL of the incoming payment that is being paid.
	Receiver Receiver `json:"receiver"`

	// WalletAddressSchema The URL of an Open Payments wallet address
	WalletAddressSchema WalletAddressSchema `json:"walletAddress"`
}

type CreateQuoteRequestWithDebitAmount struct {
	DebitAmount Amount        `json:"debitAmount"`
	Method      PaymentMethod `json:"method"`

	// Receiver The URL of the incoming payment that is being paid.
	Receiver Receiver `json:"receiver"`

	// WalletAddressSchema The URL of an Open Payments wallet address
	WalletAddressSchema WalletAddressSchema `json:"walletAddress"`
}

type CreateQuoteRequestWithReceiveAmount struct {
	Method        PaymentMethod `json:"method"`
	ReceiveAmount Amount        `json:"receiveAmount"`

	// Receiver The URL of the incoming payment that is being paid.
	Receiver Receiver `json:"receiver"`

	// WalletAddressSchema The URL of an Open Payments wallet address
	WalletAddressSchema WalletAddressSchema `json:"walletAddress"`
}

type Cursor = string

type ErrorResponse struct {
	Error struct {
		Code        string `json:"code"`
		Description string `json:"description"`

		// Details Additional details about the error.
		Details *map[string]interface{} `json:"details,omitempty"`
	} `json:"error"`
}

type First = int

type GetIncomingPaymentParams struct {
	// SignatureInput The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message.  Each member describes a single message signature.  The member's key is the label that uniquely identifies the message signature within the context of the HTTP message.  The member's value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label.  The following components MUST be included: - "@method" - "@target-uri" - "authorization".  When the message contains a request body, the covered components MUST also include the following: - "content-digest"  The keyid parameter of the signature MUST be set to the kid value of the JWK.      See [ietf-httpbis-message-signatures](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures#section-4.1) for more details.
	SignatureInput *OptionalSignatureInput `json:"Signature-Input,omitempty"`

	// Signature The signature generated based on the Signature-Input, using the signing algorithm specified in the "alg" field of the JWK.
	Signature *OptionalSignature `json:"Signature,omitempty"`
}

type GetOutgoingPaymentGrantParams struct {
	// SignatureInput The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message.  Each member describes a single message signature.  The member's key is the label that uniquely identifies the message signature within the context of the HTTP message.  The member's value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label.  The following components MUST be included: - "@method" - "@target-uri" - "authorization".  When the message contains a request body, the covered components MUST also include the following: - "content-digest"  The keyid parameter of the signature MUST be set to the kid value of the JWK.      See [ietf-httpbis-message-signatures](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures#section-4.1) for more details.
	SignatureInput SignatureInput `json:"Signature-Input"`

	// Signature The signature generated based on the Signature-Input, using the signing algorithm specified in the "alg" field of the JWK.
	Signature Signature `json:"Signature"`
}

type GetOutgoingPaymentParams struct {
	// SignatureInput The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message.  Each member describes a single message signature.  The member's key is the label that uniquely identifies the message signature within the context of the HTTP message.  The member's value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label.  The following components MUST be included: - "@method" - "@target-uri" - "authorization".  When the message contains a request body, the covered components MUST also include the following: - "content-digest"  The keyid parameter of the signature MUST be set to the kid value of the JWK.      See [ietf-httpbis-message-signatures](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures#section-4.1) for more details.
	SignatureInput SignatureInput `json:"Signature-Input"`

	// Signature The signature generated based on the Signature-Input, using the signing algorithm specified in the "alg" field of the JWK.
	Signature Signature `json:"Signature"`
}

type GetQuoteParams struct {
	// SignatureInput The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message.  Each member describes a single message signature.  The member's key is the label that uniquely identifies the message signature within the context of the HTTP message.  The member's value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label.  The following components MUST be included: - "@method" - "@target-uri" - "authorization".  When the message contains a request body, the covered components MUST also include the following: - "content-digest"  The keyid parameter of the signature MUST be set to the kid value of the JWK.      See [ietf-httpbis-message-signatures](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures#section-4.1) for more details.
	SignatureInput SignatureInput `json:"Signature-Input"`

	// Signature The signature generated based on the Signature-Input, using the signing algorithm specified in the "alg" field of the JWK.
	Signature Signature `json:"Signature"`
}

type Id = string

type IlpPaymentMethod struct {
	// IlpAddress The ILP address to use when establishing a STREAM connection.
	IlpAddress string `json:"ilpAddress"`

	// SharedSecret The base64 url-encoded shared secret to use when establishing a STREAM connection.
	SharedSecret string               `json:"sharedSecret"`
	Type         IlpPaymentMethodType `json:"type"`
}

type IlpPaymentMethodType string

type IncomingPayment struct {
	// Completed Describes whether the incoming payment has completed receiving fund.
	Completed bool `json:"completed"`

	// CreatedAt The date and time when the incoming payment was created.
	CreatedAt time.Time `json:"createdAt"`

	// ExpiresAt The date and time when payments under this incoming payment will no longer be accepted.
	ExpiresAt *time.Time `json:"expiresAt,omitempty"`

	// Id The URL identifying the incoming payment.
	Id             *string `json:"id,omitempty"`
	IncomingAmount *Amount `json:"incomingAmount,omitempty"`

	// Metadata Additional metadata associated with the incoming payment. (Optional)
	Metadata       *map[string]interface{} `json:"metadata,omitempty"`
	ReceivedAmount Amount                  `json:"receivedAmount"`

	// WalletAddress The URL of the wallet address this payment is being made into.
	WalletAddress *string `json:"walletAddress,omitempty"`
}

type IncomingPaymentWithMethods struct {
	// Completed Describes whether the incoming payment has completed receiving fund.
	Completed bool `json:"completed"`

	// CreatedAt The date and time when the incoming payment was created.
	CreatedAt time.Time `json:"createdAt"`

	// ExpiresAt The date and time when payments under this incoming payment will no longer be accepted.
	ExpiresAt *time.Time `json:"expiresAt,omitempty"`

	// Id The URL identifying the incoming payment.
	Id             *string `json:"id,omitempty"`
	IncomingAmount *Amount `json:"incomingAmount,omitempty"`

	// Metadata Additional metadata associated with the incoming payment. (Optional)
	Metadata *map[string]interface{} `json:"metadata,omitempty"`

	// Methods The list of payment methods supported by this incoming payment.
	Methods        []IncomingPaymentWithMethods_Methods_Item `json:"methods"`
	ReceivedAmount Amount                                    `json:"receivedAmount"`

	// WalletAddress The URL of the wallet address this payment is being made into.
	WalletAddress *string `json:"walletAddress,omitempty"`
}

type IncomingPaymentWithMethods_Methods_Item struct {
	// contains filtered or unexported fields
}

type Last = int

type ListIncomingPaymentsParams struct {
	// WalletAddressParam URL of a wallet address hosted by a Rafiki instance.
	WalletAddressParam WalletAddressParam `form:"wallet-address" json:"wallet-address"`

	// Cursor The cursor key to list from.
	Cursor *Cursor `form:"cursor,omitempty" json:"cursor,omitempty"`

	// First The number of items to return after the cursor.
	First *First `form:"first,omitempty" json:"first,omitempty"`

	// Last The number of items to return before the cursor.
	Last *Last `form:"last,omitempty" json:"last,omitempty"`

	// SignatureInput The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message.  Each member describes a single message signature.  The member's key is the label that uniquely identifies the message signature within the context of the HTTP message.  The member's value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label.  The following components MUST be included: - "@method" - "@target-uri" - "authorization".  When the message contains a request body, the covered components MUST also include the following: - "content-digest"  The keyid parameter of the signature MUST be set to the kid value of the JWK.      See [ietf-httpbis-message-signatures](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures#section-4.1) for more details.
	SignatureInput SignatureInput `json:"Signature-Input"`

	// Signature The signature generated based on the Signature-Input, using the signing algorithm specified in the "alg" field of the JWK.
	Signature Signature `json:"Signature"`
}

type ListOutgoingPaymentsParams struct {
	// WalletAddressParam URL of a wallet address hosted by a Rafiki instance.
	WalletAddressParam WalletAddressParam `form:"wallet-address" json:"wallet-address"`

	// Cursor The cursor key to list from.
	Cursor *Cursor `form:"cursor,omitempty" json:"cursor,omitempty"`

	// First The number of items to return after the cursor.
	First *First `form:"first,omitempty" json:"first,omitempty"`

	// Last The number of items to return before the cursor.
	Last *Last `form:"last,omitempty" json:"last,omitempty"`

	// SignatureInput The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message.  Each member describes a single message signature.  The member's key is the label that uniquely identifies the message signature within the context of the HTTP message.  The member's value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label.  The following components MUST be included: - "@method" - "@target-uri" - "authorization".  When the message contains a request body, the covered components MUST also include the following: - "content-digest"  The keyid parameter of the signature MUST be set to the kid value of the JWK.      See [ietf-httpbis-message-signatures](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures#section-4.1) for more details.
	SignatureInput SignatureInput `json:"Signature-Input"`

	// Signature The signature generated based on the Signature-Input, using the signing algorithm specified in the "alg" field of the JWK.
	Signature Signature `json:"Signature"`
}

type N400 = ErrorResponse

type N401 = ErrorResponse

type N403 = ErrorResponse

type N404 = ErrorResponse

type OptionalSignature = string

type OptionalSignatureInput = string

type OutgoingPayment struct {
	// CreatedAt The date and time when the outgoing payment was created.
	CreatedAt   time.Time `json:"createdAt"`
	DebitAmount Amount    `json:"debitAmount"`

	// Failed Describes whether the payment failed to send its full amount.
	Failed *bool `json:"failed,omitempty"`

	// Id The URL identifying the outgoing payment.
	Id *string `json:"id,omitempty"`

	// Metadata Additional metadata associated with the outgoing payment. (Optional)
	Metadata *map[string]interface{} `json:"metadata,omitempty"`

	// QuoteId The URL of the quote defining this payment's amounts.
	QuoteId       *string `json:"quoteId,omitempty"`
	ReceiveAmount Amount  `json:"receiveAmount"`

	// Receiver The URL of the incoming payment that is being paid.
	Receiver   Receiver `json:"receiver"`
	SentAmount Amount   `json:"sentAmount"`

	// WalletAddress The URL of the wallet address from which this payment is sent.
	WalletAddress *string `json:"walletAddress,omitempty"`
}

type OutgoingPaymentWithSpentAmounts struct {
	// CreatedAt The date and time when the outgoing payment was created.
	CreatedAt   time.Time `json:"createdAt"`
	DebitAmount Amount    `json:"debitAmount"`

	// Failed Describes whether the payment failed to send its full amount.
	Failed                  *bool   `json:"failed,omitempty"`
	GrantSpentDebitAmount   *Amount `json:"grantSpentDebitAmount,omitempty"`
	GrantSpentReceiveAmount *Amount `json:"grantSpentReceiveAmount,omitempty"`

	// Id The URL identifying the outgoing payment.
	Id *string `json:"id,omitempty"`

	// Metadata Additional metadata associated with the outgoing payment. (Optional)
	Metadata *map[string]interface{} `json:"metadata,omitempty"`

	// QuoteId The URL of the quote defining this payment's amounts.
	QuoteId       *string `json:"quoteId,omitempty"`
	ReceiveAmount Amount  `json:"receiveAmount"`

	// Receiver The URL of the incoming payment that is being paid.
	Receiver   Receiver `json:"receiver"`
	SentAmount Amount   `json:"sentAmount"`

	// WalletAddress The URL of the wallet address from which this payment is sent.
	WalletAddress *string `json:"walletAddress,omitempty"`
}

type PageInfo struct {
	// EndCursor Cursor corresponding to the last element in the result array.
	EndCursor *string `json:"endCursor,omitempty"`

	// HasNextPage Describes whether the data set has further entries.
	HasNextPage bool `json:"hasNextPage"`

	// HasPreviousPage Describes whether the data set has previous entries.
	HasPreviousPage bool `json:"hasPreviousPage"`

	// StartCursor Cursor corresponding to the first element in the result array.
	StartCursor *string `json:"startCursor,omitempty"`
}

type PaymentMethod string

type PublicIncomingPayment struct {
	// AuthServer The URL of the authorization server endpoint for getting grants and access tokens for this wallet address.
	AuthServer     string  `json:"authServer"`
	ReceivedAmount *Amount `json:"receivedAmount,omitempty"`
}

type Quote struct {
	// CreatedAt The date and time when the quote was created.
	CreatedAt   time.Time `json:"createdAt"`
	DebitAmount Amount    `json:"debitAmount"`

	// ExpiresAt The date and time when the calculated `debitAmount` is no longer valid.
	ExpiresAt *string `json:"expiresAt,omitempty"`

	// Id The URL identifying the quote.
	Id            *string       `json:"id,omitempty"`
	Method        PaymentMethod `json:"method"`
	ReceiveAmount Amount        `json:"receiveAmount"`

	// Receiver The URL of the incoming payment that is being paid.
	Receiver Receiver `json:"receiver"`

	// WalletAddress The URL of the wallet address from which this quote's payment would be sent.
	WalletAddress *string `json:"walletAddress,omitempty"`
}

type Receiver = string

type Signature = string

type SignatureInput = string

type WalletAddressParam = string

type WalletAddressSchema = string