Struct ZebedeeClient

pub struct ZebedeeClient { /* private fields */ }

Implementations

impl ZebedeeClient

pub fn new<'a>(apikey: impl Into<Cow<'a, str>>) -> Self

pub fn domain(self, domain: String) -> Self

Zebedee REST API url

pub fn reqw_cli(self, reqw_cli: Client) -> Self

pub fn oauth( self, client_id: String, secret: String, redirect_uri: String, state: String, scope: String, ) -> Self

pub async fn get_wallet_details(&self) -> Result<WalletInfoResponse>

Retrieves the total balance of a given Project Wallet.

pub async fn keysend( &self, keysend_payload: &Keysend, ) -> Result<KeysendResponse>

Make payment directly to a Lightning Network node Public Key, without the need for a Payment Request / Charge.

pub async fn create_charge( &self, charge: &Charge, ) -> Result<FetchOneChargeResponse>

Creates a new Charge / Payment Request in the Bitcoin Lightning Network, payable by any Lightning Network wallet. These payment requests are single-use, fixed-amount QR codes. If you’re looking for multi-use and multi-amount payment requests you want Static Charges.

pub async fn get_charges(&self) -> Result<FetchChargesResponse>

pub async fn get_charge<T>( &self, charge_id: T, ) -> Result<FetchOneChargeResponse>

where T: AsRef<str>,

Retrieves all information relating a specific Charge / Payment Request.

pub async fn pay_gamertag( &self, payment: &GamertagPayment, ) -> Result<GamertagPayResponse>

Send Bitcoin payments directly to a user’s ZBD Gamertag

pub async fn fetch_charge_from_gamertag( &self, payment: &GamertagPayment, ) -> Result<GamertagChargeResponse>

Create a bolt 11 invoice so you can pay a specified gamertag

pub async fn get_gamertag_tx<T>( &self, transaction_id: T, ) -> Result<GamertagTxResponse>

where T: AsRef<str>,

Get data on payments sent to ZBD Gamertags. The data payload returned will inform you of the status of that transaction as well as any associated fees.

pub async fn get_userid_by_gamertag<T>( &self, gamertag: T, ) -> Result<IdFromGamertagResponse>

where T: AsRef<str>,

Get a given User’s ID when provided with a ZBD Gamertag.

pub async fn get_gamertag_by_userid<T>( &self, user_id: T, ) -> Result<GamertagUserIdResponse>

where T: AsRef<str>,

Get a given user’s ZBD Gamertag from user id

pub async fn internal_transfer( &self, internal_transfer_payload: &InternalTransfer, ) -> Result<InternalTransferResponse>

Initiates a transfer of funds between two Project Wallets you own.

pub async fn pay_ln_address( &self, payment: &LnPayment, ) -> Result<PayLnAddressResponse>

Send Bitcoin payments directly to a Lightning Address.

pub async fn fetch_charge_ln_address( &self, payment: &LnFetchCharge, ) -> Result<FetchLnChargeResponse>

Create a Charge / Payment Request QR code for a Lightning Address

pub async fn validate_ln_address( &self, lightning_address: &LnAddress, ) -> Result<ValidateLnAddrResponse>

Validate whether a user’s entered Lightning Address is indeed a real Lightning Address

pub async fn pay_invoice( &self, payment: &Payment, ) -> Result<PaymentInvoiceResponse>

Pays a Charge / Payment Request in the Bitcoin Lightning Network

pub async fn get_payments(&self) -> Result<FetchPaymentsResponse>

pub async fn get_payment<T>( &self, payment_id: T, ) -> Result<FetchOnePaymentsResponse>

where T: AsRef<str>,

Retrieves all the information related to a specific Payment

pub async fn get_is_supported_region_by_ip<T>( &self, ip: T, ) -> Result<SupportedIpResponse>

where T: AsRef<str>,

Check if provided ip address will be supported by Zebedee REST API

pub async fn get_prod_ips(&self) -> Result<ProdIpsResponse>

Check if callback response is from legit Zebedee ip address

pub async fn get_btc_usd(&self) -> Result<BtcToUsdResponse>

Get the latest price for Bitcoin in US Dollars. The exchange rate feed is refreshed every 5 seconds and is based upon a combination of industry-leading partner exchange providers’s price feeds.

pub async fn create_withdrawal_request( &self, withdrawal_request: &WithdrawalReqest, ) -> Result<CreateWithdrawalResponse>

Withdrawal Requests can be thought of as exact opposites to Charges. Charges in the ZEBEDEE API are QR codes that represent Payment Requests in the Bitcoin Lightning Network. These QR codes expect that a payer will scan and perform a payment against it.

---

Charges: Lightning QR codes that YOU SPEND

---

Withdrawal Requests: Lightning QR codes that YOU RECEIVE

pub async fn get_withdrawal_requests(&self) -> Result<FetchWithdrawalsResponse>

pub async fn get_withdrawal_request<T>( &self, withdrawal_id: T, ) -> Result<FetchOneWithdrawalResponse>

where T: AsRef<str>,

Retrieves details about a specific Withdrawal Request.

pub async fn pay_email( &self, email_payment_request: &EmailPaymentReqest, ) -> Result<EmailPaymentResponse>

Send instant Bitcoin payments to any email.

pub async fn create_auth_url<T>(&self, challenge: T) -> Result<String>

where T: AsRef<str>,

pub async fn fetch_token<A, B>( &self, code: A, verifier: B, ) -> Result<FetchAccessTokenRes>

where A: AsRef<str>, B: AsRef<str>,

pub async fn refresh_token<T>(&self, refresh_token: T) -> Result<FetchPostRes>

where T: AsRef<str>,

In order to fetch a new accessToken for a given ZBD User, make sure to use the refreshToken using the token endpoint.

pub async fn fetch_user_data<T>(&self, token: T) -> Result<StdResp<ZBDUserData>>

where T: AsRef<str>,

You can use this API endpoint to fetch information about a given ZBD User, granted you can pass the provided accessToken.

pub async fn fetch_user_wallet_data<T>( &self, token: T, ) -> Result<StdResp<ZBDUserWalletData>>

where T: AsRef<str>,

You can use this API endpoint to fetch information about a given ZBD User’s Wallet, granted you can pass the provided accessToken.

Trait Implementations

impl Clone for ZebedeeClient

fn clone(&self) -> ZebedeeClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ZebedeeClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.