Payment Gateways

Overview

The payment gateways API allows you to view, and update individual payment gateways. Results are not paginated - all gateways will be returned.

Retrieve an payment gateway

This API lets you retrieve and view a specific payment gateway.

retrievePaymentGateway({required String id})

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
ApiData paymentGateway = await WooSignal.instance.retrievePaymentGateway(id: "payment gateway id");

Response

ApiData instance

Represents the following object - WooCommerce retrieve an payment gateway

List all payment gateways

This API helps you to view all the payment gateways.

getPaymentGateways()

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
List<PaymentGateWay> paymentGateways = await WooSignal.instance.getPaymentGateways();

Response

List<PaymentGateWay> instance

Represents the following object - WooCommerce list all payment gateways

Update a payment gateway

This API lets you make changes to a payment gateway.

updatePaymentGateway({})

Parameters

required String id,
Map<String, dynamic> data

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
PaymentGateWay paymentGateway = await WooSignal.instance.updatePaymentGateway(id: "payment gateway id", data: {});

Response

PaymentGateWay instance

Represents the following object - WooCommerce update a payment gateway