Coinbase class - coinbase library

Constructors

Coinbase(String _apiKey, {bool debug = false}): Default for the coinbase API

Properties

debug ↔ bool: the debug value controls whether the responses are logged on the terminal
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
retrieveAllCharges → Future<List<ChargeObject>>: Returns a list of the Charges associated with the Coinbase account TODO: The List of retrieved charges should be looped through
no setter
retrieveAllCheckouts → Future<List<CheckoutObject>>: Returns all Charges
no setter
retrieveAllInvoices → Future<List<InvoiceObject>>: Returns all Invoices as a List Object
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

cancelCharge(String code) → Future<ChargeObject>: Cancels a charge that has been previously created. Supply the unique charge code that was returned when the charge was created. Note: Only new charges can be successfully canceled. Once payment is detected, charge can no longer be canceled.
checkChargeStatus(ChargeObject chargeObject) → StatusObject: Retrieve the status of a given Charge
createCharge({int? amount, required String name, CurrencyType? currency, required String description, required PricingType pricingType}) → Future<ChargeObject>: To request a cryptocurrency payment, you create a charge. You can create and view charges. Since cryptocurrency payments are push payments, a charge will expire after a waiting period (payment window) no payment has been detected. Charges are identified by a unique code.
createCheckout({required String description, required String name, int? amount, required PricingType pricingType, required CurrencyType currency}) → Future<CheckoutObject>: Checkouts make it possible to sell a single fixed price item or accept arbitrary amounts of cryptocurrency very easily. Checkouts can have many charges and each charge is automatically generated on a per customer basis. Creates a new checkout.
createInvoice({required String businessName, required String customerEmail, required String customerName, required CurrencyType currency, required int amount, String? memo}) → Future<InvoiceObject>: To send an invoice in cryptocurrency, you need to create an invoice object and provide the user with the hosted url where they will be able to pay. Once an invoice is viewed at the hosted url, a charge will be generated on the invoice.
deleteCheckout({required String checkoutID}) → Future<CheckoutObject>: Deletes a previously Created checkout. Needs to be supplied with the CheckOut ID
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
resolveCharge(String code) → Future<ChargeObject>: Resolve a charge that has been previously marked as unresolved. Supply the unique charge code that was returned when the charge was created. Note: Only unresolved charges can be successfully resolved.
toString() → String: A string representation of this object.
inherited
updateCheckout({required String checkoutID, required String description, required String name, int? amount, required PricingType pricingType, required CurrencyType currency}) → Future<CheckoutObject>: Updates a previously updated checkout. amount amount to be charged.
viewCharge(String code) → Future<ChargeObject>: Retrieves the details of a charge that has been previously created. Supply the unique charge code that was returned when the charge was created. This information is also returned when a charge is first created.
viewCheckout(String code) → Future<CheckoutObject>: View a Created Checkout
viewInvoice(String code) → Future<InvoiceObject>: Returns an InvoiceObject for the invoice with the supplied Invoice code
voidInvoice({required String code}) → Future<InvoiceObject>: TODO: Figure out how to get this API to work it is not working even when you try using curl requests on PostMan This function receives an Invoice code argument and voids the invoice Returning an InvoiceObject with null parameters

Operators

operator ==(Object other) → bool: The equality operator.
inherited